Skip to content

Commit 22b585a

Browse files
author
awstools
committed
docs(client-ecr): Documentation update for ECR GetAccountSetting and PutAccountSetting APIs.
1 parent f88136b commit 22b585a

File tree

4 files changed

+31
-27
lines changed

4 files changed

+31
-27
lines changed

‎clients/client-ecr/src/commands/GetAccountSettingCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export interface GetAccountSettingCommandInput extends GetAccountSettingRequest
2828
export interface GetAccountSettingCommandOutput extends GetAccountSettingResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Retrieves the basic scan type version name.</p>
31+
* <p>Retrieves the account setting value for the specified setting name.</p>
3232
* @example
3333
* Use a bare-bones client and the command you need to make an API call.
3434
* ```javascript

‎clients/client-ecr/src/commands/PutAccountSettingCommand.ts

+1-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,7 @@ export interface PutAccountSettingCommandInput extends PutAccountSettingRequest
2828
export interface PutAccountSettingCommandOutput extends PutAccountSettingResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Allows you to change the basic scan type version by setting the <code>name</code>
32-
* parameter to either <code>CLAIR</code> to <code>AWS_NATIVE</code>.</p>
31+
* <p>Allows you to change the basic scan type version or registry policy scope.</p>
3332
* @example
3433
* Use a bare-bones client and the command you need to make an API call.
3534
* ```javascript

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

+19-14
Original file line numberDiff line numberDiff line change
@@ -1065,14 +1065,14 @@ export interface EncryptionConfiguration {
10651065
* for Amazon ECR, or specify your own KMS key, which you already created.</p>
10661066
* <p>If you use the <code>KMS_DSSE</code> encryption type, the contents of the repository
10671067
* will be encrypted with two layers of encryption using server-side encryption with the
1068-
* KMS Management Service key stored in KMS. Similar to the <code>KMS</code> encryption type, you
1069-
* can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your own KMS
1070-
* key, which you've already created. </p>
1068+
* KMS Management Service key stored in KMS. Similar to the <code>KMS</code> encryption
1069+
* type, you can either use the default Amazon Web Services managed KMS key for Amazon ECR, or specify your
1070+
* own KMS key, which you've already created. </p>
10711071
* <p>If you use the <code>AES256</code> encryption type, Amazon ECR uses server-side encryption
10721072
* with Amazon S3-managed encryption keys which encrypts the images in the repository using an
10731073
* AES256 encryption algorithm.</p>
10741074
* <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonECR/latest/userguide/encryption-at-rest.html">Amazon ECR encryption at
1075-
* rest</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
1075+
* rest</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>
10761076
* @public
10771077
*/
10781078
encryptionType: EncryptionType | undefined;
@@ -3370,7 +3370,8 @@ export interface DescribeRepositoryCreationTemplatesResponse {
33703370
*/
33713371
export interface GetAccountSettingRequest {
33723372
/**
3373-
* <p>Basic scan type version name. </p>
3373+
* <p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or
3374+
* <code>REGISTRY_POLICY_SCOPE</code>. </p>
33743375
* @public
33753376
*/
33763377
name: string | undefined;
@@ -3381,14 +3382,16 @@ export interface GetAccountSettingRequest {
33813382
*/
33823383
export interface GetAccountSettingResponse {
33833384
/**
3384-
* <p>Retrieves the basic scan type version name.</p>
3385+
* <p>Retrieves the name of the account setting.</p>
33853386
* @public
33863387
*/
33873388
name?: string | undefined;
33883389

33893390
/**
3390-
* <p>Retrieves the value that specifies what basic scan type is being used:
3391-
* <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>
3391+
* <p>The setting value for the setting name. The following are valid values for the basic scan
3392+
* type being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>. The following are valid
3393+
* values for the registry policy scope being used: <code>V1</code> or
3394+
* <code>V2</code>.</p>
33923395
* @public
33933396
*/
33943397
value?: string | undefined;
@@ -4126,14 +4129,17 @@ export interface ListTagsForResourceResponse {
41264129
*/
41274130
export interface PutAccountSettingRequest {
41284131
/**
4129-
* <p>Basic scan type version name. </p>
4132+
* <p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or
4133+
* <code>REGISTRY_POLICY_SCOPE</code>. </p>
41304134
* @public
41314135
*/
41324136
name: string | undefined;
41334137

41344138
/**
4135-
* <p>Setting value that determines what basic scan type is being used:
4136-
* <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>
4139+
* <p>Setting value that is specified. The following are valid values for the basic scan
4140+
* type being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>. The following are valid
4141+
* values for the registry policy scope being used: <code>V1</code> or
4142+
* <code>V2</code>.</p>
41374143
* @public
41384144
*/
41394145
value: string | undefined;
@@ -4144,14 +4150,13 @@ export interface PutAccountSettingRequest {
41444150
*/
41454151
export interface PutAccountSettingResponse {
41464152
/**
4147-
* <p>Retrieves the the basic scan type version name.</p>
4153+
* <p>Retrieves the name of the account setting.</p>
41484154
* @public
41494155
*/
41504156
name?: string | undefined;
41514157

41524158
/**
4153-
* <p>Retrieves the basic scan type value, either <code>AWS_NATIVE</code> or
4154-
* <code>-</code>.</p>
4159+
* <p>Retrieves the value of the specified account setting.</p>
41554160
* @public
41564161
*/
41574162
value?: string | undefined;

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

+10-10
Original file line numberDiff line numberDiff line change
@@ -3499,7 +3499,7 @@
34993499
"encryptionType": {
35003500
"target": "com.amazonaws.ecr#EncryptionType",
35013501
"traits": {
3502-
"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>",
3502+
"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>",
35033503
"smithy.api#required": {}
35043504
}
35053505
},
@@ -3784,7 +3784,7 @@
37843784
}
37853785
],
37863786
"traits": {
3787-
"smithy.api#documentation": "<p>Retrieves the basic scan type version name.</p>"
3787+
"smithy.api#documentation": "<p>Retrieves the account setting value for the specified setting name.</p>"
37883788
}
37893789
},
37903790
"com.amazonaws.ecr#GetAccountSettingRequest": {
@@ -3793,7 +3793,7 @@
37933793
"name": {
37943794
"target": "com.amazonaws.ecr#AccountSettingName",
37953795
"traits": {
3796-
"smithy.api#documentation": "<p>Basic scan type version name. </p>",
3796+
"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>",
37973797
"smithy.api#required": {}
37983798
}
37993799
}
@@ -3808,13 +3808,13 @@
38083808
"name": {
38093809
"target": "com.amazonaws.ecr#AccountSettingName",
38103810
"traits": {
3811-
"smithy.api#documentation": "<p>Retrieves the basic scan type version name.</p>"
3811+
"smithy.api#documentation": "<p>Retrieves the name of the account setting.</p>"
38123812
}
38133813
},
38143814
"value": {
38153815
"target": "com.amazonaws.ecr#AccountSettingName",
38163816
"traits": {
3817-
"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>"
3817+
"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>"
38183818
}
38193819
}
38203820
},
@@ -5995,7 +5995,7 @@
59955995
}
59965996
],
59975997
"traits": {
5998-
"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>"
5998+
"smithy.api#documentation": "<p>Allows you to change the basic scan type version or registry policy scope.</p>"
59995999
}
60006000
},
60016001
"com.amazonaws.ecr#PutAccountSettingRequest": {
@@ -6004,14 +6004,14 @@
60046004
"name": {
60056005
"target": "com.amazonaws.ecr#AccountSettingName",
60066006
"traits": {
6007-
"smithy.api#documentation": "<p>Basic scan type version name. </p>",
6007+
"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>",
60086008
"smithy.api#required": {}
60096009
}
60106010
},
60116011
"value": {
60126012
"target": "com.amazonaws.ecr#AccountSettingValue",
60136013
"traits": {
6014-
"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>",
6014+
"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>",
60156015
"smithy.api#required": {}
60166016
}
60176017
}
@@ -6026,13 +6026,13 @@
60266026
"name": {
60276027
"target": "com.amazonaws.ecr#AccountSettingName",
60286028
"traits": {
6029-
"smithy.api#documentation": "<p>Retrieves the the basic scan type version name.</p>"
6029+
"smithy.api#documentation": "<p>Retrieves the name of the account setting.</p>"
60306030
}
60316031
},
60326032
"value": {
60336033
"target": "com.amazonaws.ecr#AccountSettingValue",
60346034
"traits": {
6035-
"smithy.api#documentation": "<p>Retrieves the basic scan type value, either <code>AWS_NATIVE</code> or\n <code>-</code>.</p>"
6035+
"smithy.api#documentation": "<p>Retrieves the value of the specified account setting.</p>"
60366036
}
60376037
}
60386038
},

0 commit comments

Comments
 (0)