docs(client-ecr): Documentation update for ECR GetAccountSetting and …

…PutAccountSetting APIs.
aws · Dec 23, 2024 · 22b585a · 22b585a
1 parent f88136b
commit 22b585a
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 27 deletions.
diff --git a/clients/client-ecr/src/commands/GetAccountSettingCommand.ts b/clients/client-ecr/src/commands/GetAccountSettingCommand.ts
@@ -28,7 +28,7 @@ export interface GetAccountSettingCommandInput extends GetAccountSettingRequest
 export interface GetAccountSettingCommandOutput extends GetAccountSettingResponse, __MetadataBearer {}
 
 /**
- * <p>Retrieves the basic scan type version name.</p>
+ * <p>Retrieves the account setting value for the specified setting name.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-ecr/src/commands/PutAccountSettingCommand.ts b/clients/client-ecr/src/commands/PutAccountSettingCommand.ts
@@ -28,8 +28,7 @@ export interface PutAccountSettingCommandInput extends PutAccountSettingRequest
 export interface PutAccountSettingCommandOutput extends PutAccountSettingResponse, __MetadataBearer {}
 
 /**
- * <p>Allows you to change the basic scan type version by setting the <code>name</code>
- *             parameter to either <code>CLAIR</code> to <code>AWS_NATIVE</code>.</p>
+ * <p>Allows you to change the basic scan type version or registry policy scope.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-ecr/src/models/models_0.ts b/clients/client-ecr/src/models/models_0.ts
@@ -1065,14 +1065,14 @@ export interface EncryptionConfiguration {
    *             for Amazon ECR, or specify your own KMS key, which you already created.</p>
    *          <p>If you use the <code>KMS_DSSE</code> encryption type, the contents of the repository
    *             will be encrypted with two layers of encryption using server-side encryption with the
-   *             KMS Management Service key stored in KMS. Similar to the <code>KMS</code> encryption type, you
-   *             can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS
-   *             key, which you've already created. </p>
+   *             KMS Management Service key stored in KMS. Similar to the <code>KMS</code> encryption
+   *             type, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your
+   *             own KMS key, which you've already created. </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
    *             AES256 encryption algorithm.</p>
    *          <p>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>
+   *                 rest</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
    * @public
    */
   encryptionType: EncryptionType | undefined;
@@ -3370,7 +3370,8 @@ export interface DescribeRepositoryCreationTemplatesResponse {
  */
 export interface GetAccountSettingRequest {
   /**
-   * <p>Basic scan type version name. </p>
+   * <p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or
+   *                 <code>REGISTRY_POLICY_SCOPE</code>. </p>
    * @public
    */
   name: string | undefined;
@@ -3381,14 +3382,16 @@ export interface GetAccountSettingRequest {
  */
 export interface GetAccountSettingResponse {
   /**
-   * <p>Retrieves the basic scan type version name.</p>
+   * <p>Retrieves the name of the account setting.</p>
    * @public
    */
   name?: string | undefined;
 
   /**
-   * <p>Retrieves the value that specifies what basic scan type is being used:
-   *                 <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>
+   * <p>The setting value for the setting name. The following are valid values for the basic scan
+   *             type being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>. The following are valid
+   *             values for the registry policy scope being used: <code>V1</code> or
+   *             <code>V2</code>.</p>
    * @public
    */
   value?: string | undefined;
@@ -4126,14 +4129,17 @@ export interface ListTagsForResourceResponse {
  */
 export interface PutAccountSettingRequest {
   /**
-   * <p>Basic scan type version name. </p>
+   * <p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or
+   *                 <code>REGISTRY_POLICY_SCOPE</code>. </p>
    * @public
    */
   name: string | undefined;
 
   /**
-   * <p>Setting value that determines what basic scan type is being used:
-   *                 <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>
+   * <p>Setting value that is specified. The following are valid values for the basic scan
+   *             type being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>. The following are valid
+   *             values for the registry policy scope being used: <code>V1</code> or
+   *             <code>V2</code>.</p>
    * @public
    */
   value: string | undefined;
@@ -4144,14 +4150,13 @@ export interface PutAccountSettingRequest {
  */
 export interface PutAccountSettingResponse {
   /**
-   * <p>Retrieves the the basic scan type version name.</p>
+   * <p>Retrieves the name of the account setting.</p>
    * @public
    */
   name?: string | undefined;
 
   /**
-   * <p>Retrieves the basic scan type value, either <code>AWS_NATIVE</code> or
-   *             <code>-</code>.</p>
+   * <p>Retrieves the value of the specified account setting.</p>
    * @public
    */
   value?: string | undefined;

diff --git a/codegen/sdk-codegen/aws-models/ecr.json b/codegen/sdk-codegen/aws-models/ecr.json
@@ -3499,7 +3499,7 @@
         "encryptionType": {
           "target": "com.amazonaws.ecr#EncryptionType",
           "traits": {
-            "smithy.api#documentation": "<p>The encryption type to use.</p>\n         <p>If you use the <code>KMS</code> encryption type, the contents of the repository will\n            be encrypted using server-side encryption with Key Management Service key stored in KMS. When you\n            use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key\n            for Amazon ECR, or specify your own KMS key, which you already created.</p>\n         <p>If you use the <code>KMS_DSSE</code> encryption type, the contents of the repository\n            will be encrypted with two layers of encryption using server-side encryption with the\n            KMS Management Service key stored in KMS. Similar to the <code>KMS</code> encryption type, you\n            can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS\n            key, which you've already created. </p>\n         <p>If you use the <code>AES256</code> encryption type, Amazon ECR uses server-side encryption\n            with Amazon S3-managed encryption keys which encrypts the images in the repository using an\n            AES256 encryption algorithm.</p>\n         <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html\">Amazon ECR encryption at\n            rest</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>",
+            "smithy.api#documentation": "<p>The encryption type to use.</p>\n         <p>If you use the <code>KMS</code> encryption type, the contents of the repository will\n            be encrypted using server-side encryption with Key Management Service key stored in KMS. When you\n            use KMS to encrypt your data, you can either use the default Amazon Web Services managed KMS key\n            for Amazon ECR, or specify your own KMS key, which you already created.</p>\n         <p>If you use the <code>KMS_DSSE</code> encryption type, the contents of the repository\n            will be encrypted with two layers of encryption using server-side encryption with the\n            KMS Management Service key stored in KMS. Similar to the <code>KMS</code> encryption\n            type, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your\n            own KMS key, which you've already created. </p>\n         <p>If you use the <code>AES256</code> encryption type, Amazon ECR uses server-side encryption\n            with Amazon S3-managed encryption keys which encrypts the images in the repository using an\n            AES256 encryption algorithm.</p>\n         <p>For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html\">Amazon ECR encryption at\n                rest</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>",
             "smithy.api#required": {}
           }
         },
@@ -3784,7 +3784,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Retrieves the basic scan type version name.</p>"
+        "smithy.api#documentation": "<p>Retrieves the account setting value for the specified setting name.</p>"
       }
     },
     "com.amazonaws.ecr#GetAccountSettingRequest": {
@@ -3793,7 +3793,7 @@
         "name": {
           "target": "com.amazonaws.ecr#AccountSettingName",
           "traits": {
-            "smithy.api#documentation": "<p>Basic scan type version name. </p>",
+            "smithy.api#documentation": "<p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or\n                <code>REGISTRY_POLICY_SCOPE</code>. </p>",
             "smithy.api#required": {}
           }
         }
@@ -3808,13 +3808,13 @@
         "name": {
           "target": "com.amazonaws.ecr#AccountSettingName",
           "traits": {
-            "smithy.api#documentation": "<p>Retrieves the basic scan type version name.</p>"
+            "smithy.api#documentation": "<p>Retrieves the name of the account setting.</p>"
           }
         },
         "value": {
           "target": "com.amazonaws.ecr#AccountSettingName",
           "traits": {
-            "smithy.api#documentation": "<p>Retrieves the value that specifies what basic scan type is being used:\n                <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>"
+            "smithy.api#documentation": "<p>The setting value for the setting name. The following are valid values for the basic scan\n            type being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>. The following are valid\n            values for the registry policy scope being used: <code>V1</code> or\n            <code>V2</code>.</p>"
           }
         }
       },
@@ -5995,7 +5995,7 @@
         }
       ],
       "traits": {
-        "smithy.api#documentation": "<p>Allows you to change the basic scan type version by setting the <code>name</code>\n            parameter to either <code>CLAIR</code> to <code>AWS_NATIVE</code>.</p>"
+        "smithy.api#documentation": "<p>Allows you to change the basic scan type version or registry policy scope.</p>"
       }
     },
     "com.amazonaws.ecr#PutAccountSettingRequest": {
@@ -6004,14 +6004,14 @@
         "name": {
           "target": "com.amazonaws.ecr#AccountSettingName",
           "traits": {
-            "smithy.api#documentation": "<p>Basic scan type version name. </p>",
+            "smithy.api#documentation": "<p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or\n                <code>REGISTRY_POLICY_SCOPE</code>. </p>",
             "smithy.api#required": {}
           }
         },
         "value": {
           "target": "com.amazonaws.ecr#AccountSettingValue",
           "traits": {
-            "smithy.api#documentation": "<p>Setting value that determines what basic scan type is being used:\n                <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>",
+            "smithy.api#documentation": "<p>Setting value that is specified. The following are valid values for the basic scan\n            type being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>. The following are valid\n            values for the registry policy scope being used: <code>V1</code> or\n            <code>V2</code>.</p>",
             "smithy.api#required": {}
           }
         }
@@ -6026,13 +6026,13 @@
         "name": {
           "target": "com.amazonaws.ecr#AccountSettingName",
           "traits": {
-            "smithy.api#documentation": "<p>Retrieves the the basic scan type version name.</p>"
+            "smithy.api#documentation": "<p>Retrieves the name of the account setting.</p>"
           }
         },
         "value": {
           "target": "com.amazonaws.ecr#AccountSettingValue",
           "traits": {
-            "smithy.api#documentation": "<p>Retrieves the basic scan type value, either <code>AWS_NATIVE</code> or\n            <code>-</code>.</p>"
+            "smithy.api#documentation": "<p>Retrieves the value of the specified account setting.</p>"
           }
         }
       },