docs(client-ecr): Fix for customer issues related to AWS account ID and size limitation for token.

Author: awstools

clients/client-ecr/src/commands/DescribeImagesCommand.ts

@@ -30,10 +30,10 @@ export interface DescribeImagesCommandOutput extends DescribeImagesResponse, __M
 /**
  * <p>Returns metadata about the images in a repository.</p>
  *          <note>
- *             <p>Beginning with Docker version 1.9, the Docker client compresses image layers
- *                 before pushing them to a V2 Docker registry. The output of the <code>docker
- *                     images</code> command shows the uncompressed image size, so it may return a
- *                 larger image size than the image sizes returned by <a>DescribeImages</a>.</p>
+ *             <p>Starting with Docker version 1.9, the Docker client compresses image layers before
+ *                 pushing them to a V2 Docker registry. The output of the <code>docker images</code>
+ *                 command shows the uncompressed image size. Therefore, Docker might return a larger
+ *                 image than the image shown in the Amazon Web Services Management Console.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

clients/client-ecr/src/models/models_0.ts

@@ -836,7 +836,7 @@ export interface CreatePullThroughCacheRuleRequest {
    *          <ul>
    *             <li>
    *                <p>Amazon ECR (<code>ecr</code>) –
-   *                     <code>dkr.ecr.<region>.amazonaws.com</code>
+   *                     <code><accountId>.dkr.ecr.<region>.amazonaws.com</code>
    *                </p>
    *             </li>
    *             <li>
@@ -2308,7 +2308,7 @@ export interface ImageDetail {
    *             <p>Starting with Docker version 1.9, the Docker client compresses image layers before
    *                 pushing them to a V2 Docker registry. The output of the <code>docker images</code>
    *                 command shows the uncompressed image size. Therefore, Docker might return a larger
-   *                 image than the image sizes returned by <a>DescribeImages</a>.</p>
+   *                 image than the image shown in the Amazon Web Services Management Console.</p>
    *          </note>
    * @public
    */
@@ -3518,6 +3518,10 @@ export interface GetAuthorizationTokenResponse {
   /**
    * <p>A list of authorization token data objects that correspond to the
    *                 <code>registryIds</code> values in the request.</p>
+   *          <note>
+   *             <p>The size of the authorization token returned by Amazon ECR is not fixed. We recommend
+   *                 that you don't make assumptions about the maximum size.</p>
+   *          </note>
    * @public
    */
   authorizationData?: AuthorizationData[] | undefined;

codegen/sdk-codegen/aws-models/ecr.json

@@ -1935,7 +1935,7 @@
         "upstreamRegistryUrl": {
           "target": "com.amazonaws.ecr#Url",
           "traits": {
-            "smithy.api#documentation": "<p>The registry URL of the upstream public registry to use as the source for the pull\n            through cache rule. The following is the syntax to use for each supported upstream\n            registry.</p>\n         <ul>\n            <li>\n               <p>Amazon ECR (<code>ecr</code>) –\n                    <code>dkr.ecr.<region>.amazonaws.com</code>\n               </p>\n            </li>\n            <li>\n               <p>Amazon ECR Public (<code>ecr-public</code>) – <code>public.ecr.aws</code>\n               </p>\n            </li>\n            <li>\n               <p>Docker Hub (<code>docker-hub</code>) –\n                    <code>registry-1.docker.io</code>\n               </p>\n            </li>\n            <li>\n               <p>GitHub Container Registry (<code>github-container-registry</code>) –\n                        <code>ghcr.io</code>\n               </p>\n            </li>\n            <li>\n               <p>GitLab Container Registry (<code>gitlab-container-registry</code>) –\n                        <code>registry.gitlab.com</code>\n               </p>\n            </li>\n            <li>\n               <p>Kubernetes (<code>k8s</code>) – <code>registry.k8s.io</code>\n               </p>\n            </li>\n            <li>\n               <p>Microsoft Azure Container Registry (<code>azure-container-registry</code>) –\n                        <code><custom>.azurecr.io</code>\n               </p>\n            </li>\n            <li>\n               <p>Quay (<code>quay</code>) – <code>quay.io</code>\n               </p>\n            </li>\n         </ul>",
+            "smithy.api#documentation": "<p>The registry URL of the upstream public registry to use as the source for the pull\n            through cache rule. The following is the syntax to use for each supported upstream\n            registry.</p>\n         <ul>\n            <li>\n               <p>Amazon ECR (<code>ecr</code>) –\n                    <code><accountId>.dkr.ecr.<region>.amazonaws.com</code>\n               </p>\n            </li>\n            <li>\n               <p>Amazon ECR Public (<code>ecr-public</code>) – <code>public.ecr.aws</code>\n               </p>\n            </li>\n            <li>\n               <p>Docker Hub (<code>docker-hub</code>) –\n                    <code>registry-1.docker.io</code>\n               </p>\n            </li>\n            <li>\n               <p>GitHub Container Registry (<code>github-container-registry</code>) –\n                        <code>ghcr.io</code>\n               </p>\n            </li>\n            <li>\n               <p>GitLab Container Registry (<code>gitlab-container-registry</code>) –\n                        <code>registry.gitlab.com</code>\n               </p>\n            </li>\n            <li>\n               <p>Kubernetes (<code>k8s</code>) – <code>registry.k8s.io</code>\n               </p>\n            </li>\n            <li>\n               <p>Microsoft Azure Container Registry (<code>azure-container-registry</code>) –\n                        <code><custom>.azurecr.io</code>\n               </p>\n            </li>\n            <li>\n               <p>Quay (<code>quay</code>) – <code>quay.io</code>\n               </p>\n            </li>\n         </ul>",
             "smithy.api#required": {}
           }
         },
@@ -3097,7 +3097,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Returns metadata about the images in a repository.</p>\n         <note>\n            <p>Beginning with Docker version 1.9, the Docker client compresses image layers\n                before pushing them to a V2 Docker registry. The output of the <code>docker\n                    images</code> command shows the uncompressed image size, so it may return a\n                larger image size than the image sizes returned by <a>DescribeImages</a>.</p>\n         </note>",
+        "smithy.api#documentation": "<p>Returns metadata about the images in a repository.</p>\n         <note>\n            <p>Starting with Docker version 1.9, the Docker client compresses image layers before\n                pushing them to a V2 Docker registry. The output of the <code>docker images</code>\n                command shows the uncompressed image size. Therefore, Docker might return a larger\n                image than the image shown in the Amazon Web Services Management Console.</p>\n         </note>",
         "smithy.api#paginated": {
           "inputToken": "nextToken",
           "outputToken": "nextToken",
@@ -3913,7 +3913,7 @@
         "authorizationData": {
           "target": "com.amazonaws.ecr#AuthorizationDataList",
           "traits": {
-            "smithy.api#documentation": "<p>A list of authorization token data objects that correspond to the\n                <code>registryIds</code> values in the request.</p>"
+            "smithy.api#documentation": "<p>A list of authorization token data objects that correspond to the\n                <code>registryIds</code> values in the request.</p>\n         <note>\n            <p>The size of the authorization token returned by Amazon ECR is not fixed. We recommend\n                that you don't make assumptions about the maximum size.</p>\n         </note>"
           }
         }
       },
@@ -4533,7 +4533,7 @@
         "imageSizeInBytes": {
           "target": "com.amazonaws.ecr#ImageSizeInBytes",
           "traits": {
-            "smithy.api#documentation": "<p>The size, in bytes, of the image in the repository.</p>\n         <p>If the image is a manifest list, this will be the max size of all manifests in the\n            list.</p>\n         <note>\n            <p>Starting with Docker version 1.9, the Docker client compresses image layers before\n                pushing them to a V2 Docker registry. The output of the <code>docker images</code>\n                command shows the uncompressed image size. Therefore, Docker might return a larger\n                image than the image sizes returned by <a>DescribeImages</a>.</p>\n         </note>"
+            "smithy.api#documentation": "<p>The size, in bytes, of the image in the repository.</p>\n         <p>If the image is a manifest list, this will be the max size of all manifests in the\n            list.</p>\n         <note>\n            <p>Starting with Docker version 1.9, the Docker client compresses image layers before\n                pushing them to a V2 Docker registry. The output of the <code>docker images</code>\n                command shows the uncompressed image size. Therefore, Docker might return a larger\n                image than the image shown in the Amazon Web Services Management Console.</p>\n         </note>"
           }
         },
         "imagePushedAt": {