|
1 | 1 | { |
2 | 2 | "version": "2.0", |
3 | | - "service": "<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 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>", |
4 | 4 | "operations": { |
5 | 5 | "BatchCheckLayerAvailability": "<p>Check the availability of multiple image layers in a specified registry and repository.</p> <note> <p>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 <code>docker</code> CLI to pull, tag, and push images.</p> </note>", |
6 | 6 | "BatchDeleteImage": "<p>Deletes a list of specified images within a specified repository. Images are specified with either <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>", |
|
21 | 21 | "ListImages": "<p>Lists all the image IDs for a given repository.</p> <p>You can filter images based on whether or not they are tagged by setting the <code>tagStatus</code> parameter to <code>TAGGED</code> or <code>UNTAGGED</code>. For example, you can filter your results to return only <code>UNTAGGED</code> images and then pipe that result to a <a>BatchDeleteImage</a> operation to delete them. Or, you can filter your results to return only <code>TAGGED</code> images to list all of the tags in your repository.</p>", |
22 | 22 | "ListTagsForResource": "<p>List the tags for an Amazon ECR resource.</p>", |
23 | 23 | "PutImage": "<p>Creates or updates the image manifest and tags associated with an image.</p> <note> <p>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 <code>docker</code> CLI to pull, tag, and push images.</p> </note>", |
24 | | - "PutLifecyclePolicy": "<p>Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see <a href=\"http://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html\">Lifecycle Policy Template</a>.</p>", |
25 | | - "SetRepositoryPolicy": "<p>Applies a repository policy on a specified repository to control access permissions.</p>", |
| 24 | + "PutImageTagMutability": "<p>Updates the image tag mutability settings for a repository.</p>", |
| 25 | + "PutLifecyclePolicy": "<p>Creates or updates a lifecycle policy. For information about lifecycle policy syntax, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/LifecyclePolicies.html\">Lifecycle Policy Template</a>.</p>", |
| 26 | + "SetRepositoryPolicy": "<p>Applies a repository policy on a specified repository to control access permissions. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicies.html\">Amazon ECR Repository Policies</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>", |
26 | 27 | "StartLifecyclePolicyPreview": "<p>Starts a preview of the specified lifecycle policy. This allows you to see the results before creating the lifecycle policy.</p>", |
27 | 28 | "TagResource": "<p>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.</p>", |
28 | 29 | "UntagResource": "<p>Deletes specified tags from a resource.</p>", |
|
199 | 200 | "EmptyUploadException$message": "<p>The error message associated with the exception.</p>", |
200 | 201 | "ImageAlreadyExistsException$message": "<p>The error message associated with the exception.</p>", |
201 | 202 | "ImageNotFoundException$message": null, |
| 203 | + "ImageTagAlreadyExistsException$message": null, |
202 | 204 | "InvalidLayerException$message": "<p>The error message associated with the exception.</p>", |
203 | 205 | "InvalidLayerPartException$message": "<p>The error message associated with the exception.</p>", |
204 | 206 | "InvalidParameterException$message": "<p>The error message associated with the exception.</p>", |
|
409 | 411 | "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>" |
410 | 412 | } |
411 | 413 | }, |
| 414 | + "ImageTagAlreadyExistsException": { |
| 415 | + "base": "<p>The specified image is tagged with a tag that already exists. The repository is configured for tag immutability.</p>", |
| 416 | + "refs": { |
| 417 | + } |
| 418 | + }, |
412 | 419 | "ImageTagList": { |
413 | 420 | "base": null, |
414 | 421 | "refs": { |
415 | 422 | "ImageDetail$imageTags": "<p>The list of tags associated with this image.</p>", |
416 | 423 | "LifecyclePolicyPreviewResult$imageTags": "<p>The list of tags associated with this image.</p>" |
417 | 424 | } |
418 | 425 | }, |
| 426 | + "ImageTagMutability": { |
| 427 | + "base": null, |
| 428 | + "refs": { |
| 429 | + "CreateRepositoryRequest$imageTagMutability": "<p>The tag mutability setting for the repository. If this parameter is omitted, the default setting of <code>MUTABLE</code> will be used which will allow image tags to be overwritten. If <code>IMMUTABLE</code> is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.</p>", |
| 430 | + "PutImageTagMutabilityRequest$imageTagMutability": "<p>The tag mutability setting for the repository. If <code>MUTABLE</code> is specified, image tags can be overwritten. If <code>IMMUTABLE</code> is specified, all image tags within the repository will be immutable which will prevent them from being overwritten.</p>", |
| 431 | + "PutImageTagMutabilityResponse$imageTagMutability": "<p>The image tag mutability setting for the repository.</p>", |
| 432 | + "Repository$imageTagMutability": "<p>The tag mutability setting for the repository.</p>" |
| 433 | + } |
| 434 | + }, |
419 | 435 | "InitiateLayerUploadRequest": { |
420 | 436 | "base": null, |
421 | 437 | "refs": { |
|
613 | 629 | } |
614 | 630 | }, |
615 | 631 | "LimitExceededException": { |
616 | | - "base": "<p>The operation did not succeed because it would have exceeded a service limit for your account. For more information, see <a href=\"http://docs.aws.amazon.com/AmazonECR/latest/userguide/service_limits.html\">Amazon ECR Default Service Limits</a> in the Amazon Elastic Container Registry User Guide.</p>", |
| 632 | + "base": "<p>The operation did not succeed because it would have exceeded a service limit for your account. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/service_limits.html\">Amazon ECR Default Service Limits</a> in the Amazon Elastic Container Registry User Guide.</p>", |
617 | 633 | "refs": { |
618 | 634 | } |
619 | 635 | }, |
|
710 | 726 | "refs": { |
711 | 727 | } |
712 | 728 | }, |
| 729 | + "PutImageTagMutabilityRequest": { |
| 730 | + "base": null, |
| 731 | + "refs": { |
| 732 | + } |
| 733 | + }, |
| 734 | + "PutImageTagMutabilityResponse": { |
| 735 | + "base": null, |
| 736 | + "refs": { |
| 737 | + } |
| 738 | + }, |
713 | 739 | "PutLifecyclePolicyRequest": { |
714 | 740 | "base": null, |
715 | 741 | "refs": { |
|
749 | 775 | "InvalidLayerPartException$registryId": "<p>The registry ID associated with the exception.</p>", |
750 | 776 | "ListImagesRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository in which to list images. If you do not specify a registry, the default registry is assumed.</p>", |
751 | 777 | "PutImageRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository in which to put the image. If you do not specify a registry, the default registry is assumed.</p>", |
| 778 | + "PutImageTagMutabilityRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository in which to update the image tag mutability settings. If you do not specify a registry, the default registry is assumed.</p>", |
| 779 | + "PutImageTagMutabilityResponse$registryId": "<p>The registry ID associated with the request.</p>", |
752 | 780 | "PutLifecyclePolicyRequest$registryId": "<p>The AWS account ID associated with the registry that contains the repository. If you do
 not specify a registry, the default registry is assumed.</p>", |
753 | 781 | "PutLifecyclePolicyResponse$registryId": "<p>The registry ID associated with the request.</p>", |
754 | 782 | "Repository$registryId": "<p>The AWS account ID associated with the registry that contains the repository.</p>", |
|
793 | 821 | "DeleteRepositoryPolicyRequest$repositoryName": "<p>The name of the repository that is associated with the repository policy to delete.</p>", |
794 | 822 | "DeleteRepositoryPolicyResponse$repositoryName": "<p>The repository name associated with the request.</p>", |
795 | 823 | "DeleteRepositoryRequest$repositoryName": "<p>The name of the repository to delete.</p>", |
796 | | - "DescribeImagesRequest$repositoryName": "<p>A list of repositories to describe.</p>", |
| 824 | + "DescribeImagesRequest$repositoryName": "<p>The repository that contains the images to describe.</p>", |
797 | 825 | "GetDownloadUrlForLayerRequest$repositoryName": "<p>The name of the repository that is associated with the image layer to download.</p>", |
798 | 826 | "GetLifecyclePolicyPreviewRequest$repositoryName": "<p>The name of the repository.</p>", |
799 | 827 | "GetLifecyclePolicyPreviewResponse$repositoryName": "<p>The repository name associated with the request.</p>", |
|
807 | 835 | "InvalidLayerPartException$repositoryName": "<p>The repository name associated with the exception.</p>", |
808 | 836 | "ListImagesRequest$repositoryName": "<p>The repository with image IDs to be listed.</p>", |
809 | 837 | "PutImageRequest$repositoryName": "<p>The name of the repository in which to put the image.</p>", |
| 838 | + "PutImageTagMutabilityRequest$repositoryName": "<p>The name of the repository in which to update the image tag mutability settings.</p>", |
| 839 | + "PutImageTagMutabilityResponse$repositoryName": "<p>The repository name associated with the request.</p>", |
810 | 840 | "PutLifecyclePolicyRequest$repositoryName": "<p>The name of the repository to receive the policy.</p>", |
811 | 841 | "PutLifecyclePolicyResponse$repositoryName": "<p>The repository name associated with the request.</p>", |
812 | 842 | "Repository$repositoryName": "<p>The name of the repository.</p>", |
|
845 | 875 | "refs": { |
846 | 876 | "DeleteRepositoryPolicyResponse$policyText": "<p>The JSON repository policy that was deleted from the repository.</p>", |
847 | 877 | "GetRepositoryPolicyResponse$policyText": "<p>The JSON repository policy text associated with the repository.</p>", |
848 | | - "SetRepositoryPolicyRequest$policyText": "<p>The JSON repository policy text to apply to the repository.</p>", |
| 878 | + "SetRepositoryPolicyRequest$policyText": "<p>The JSON repository policy text to apply to the repository. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/RepositoryPolicyExamples.html\">Amazon ECR Repository Policy Examples</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>", |
849 | 879 | "SetRepositoryPolicyResponse$policyText": "<p>The JSON repository policy text applied to the repository.</p>" |
850 | 880 | } |
851 | 881 | }, |
|
896 | 926 | "TagList": { |
897 | 927 | "base": null, |
898 | 928 | "refs": { |
899 | | - "CreateRepositoryRequest$tags": "<p/>", |
| 929 | + "CreateRepositoryRequest$tags": "<p>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.</p>", |
900 | 930 | "ListTagsForResourceResponse$tags": "<p>The tags for the resource.</p>", |
901 | 931 | "TagResourceRequest$tags": "<p>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.</p>" |
902 | 932 | } |
|
0 commit comments