Skip to content

Commit 3dbd81a

Browse files
Documentation update for ECR GetAccountSetting and PutAccountSetting APIs.
1 parent 0d4dc7f commit 3dbd81a

File tree

12 files changed

+49
-54
lines changed

12 files changed

+49
-54
lines changed

generator/ServiceModels/ecr/ecr-2015-09-21.docs.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"DescribeRegistry": "<p>Describes the settings for a registry. The replication configuration for a repository can be created or updated with the <a>PutReplicationConfiguration</a> API action.</p>",
2424
"DescribeRepositories": "<p>Describes image repositories in a registry.</p>",
2525
"DescribeRepositoryCreationTemplates": "<p>Returns details about the repository creation templates in a registry. The <code>prefixes</code> request parameter can be used to return the details for a specific repository creation template.</p>",
26-
"GetAccountSetting": "<p>Retrieves the basic scan type version name.</p>",
26+
"GetAccountSetting": "<p>Retrieves the account setting value for the specified setting name.</p>",
2727
"GetAuthorizationToken": "<p>Retrieves an authorization token. An authorization token represents your IAM authentication credentials and can be used to access any Amazon ECR registry that your IAM principal has access to. The authorization token is valid for 12 hours.</p> <p>The <code>authorizationToken</code> returned is a base64 encoded string that can be decoded and used in a <code>docker login</code> command to authenticate to a registry. The CLI offers an <code>get-login-password</code> command that simplifies the login process. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/Registries.html#registry_auth\">Registry authentication</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>",
2828
"GetDownloadUrlForLayer": "<p>Retrieves the pre-signed Amazon S3 download URL corresponding to an image layer. You can only get URLs for image layers that are referenced in an image.</p> <p>When an image is pulled, the GetDownloadUrlForLayer API is called once per image layer that is not already cached.</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>",
2929
"GetLifecyclePolicy": "<p>Retrieves the lifecycle policy for the specified repository.</p>",
@@ -34,7 +34,7 @@
3434
"InitiateLayerUpload": "<p>Notifies Amazon ECR that you intend to upload an image layer.</p> <p>When an image is pushed, the InitiateLayerUpload API is called once per image layer that has not already been uploaded. Whether or not an image layer has been uploaded is determined by the BatchCheckLayerAvailability API action.</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>",
3535
"ListImages": "<p>Lists all the image IDs for the specified repository.</p> <p>You can filter images based on whether or not they are tagged by using the <code>tagStatus</code> filter and specifying either <code>TAGGED</code>, <code>UNTAGGED</code> or <code>ANY</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>",
3636
"ListTagsForResource": "<p>List the tags for an Amazon ECR resource.</p>",
37-
"PutAccountSetting": "<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>",
37+
"PutAccountSetting": "<p>Allows you to change the basic scan type version or registry policy scope.</p>",
3838
"PutImage": "<p>Creates or updates the image manifest and tags associated with an image.</p> <p>When an image is pushed and all new image layers have been uploaded, the PutImage API is called once to create or update the image manifest and the tags associated with the image.</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>",
3939
"PutImageScanningConfiguration": "<important> <p>The <code>PutImageScanningConfiguration</code> API is being deprecated, in favor of specifying the image scanning configuration at the registry level. For more information, see <a>PutRegistryScanningConfiguration</a>.</p> </important> <p>Updates the image scanning configuration for the specified repository.</p>",
4040
"PutImageTagMutability": "<p>Updates the image tag mutability settings for the specified repository. For more information, see <a href=\"https://docs.aws.amazon.com/AmazonECR/latest/userguide/image-tag-mutability.html\">Image tag mutability</a> in the <i>Amazon Elastic Container Registry User Guide</i>.</p>",
@@ -56,18 +56,18 @@
5656
"AccountSettingName": {
5757
"base": null,
5858
"refs": {
59-
"GetAccountSettingRequest$name": "<p>Basic scan type version name. </p>",
60-
"GetAccountSettingResponse$name": "<p>Retrieves the basic scan type version name.</p>",
61-
"GetAccountSettingResponse$value": "<p>Retrieves the value that specifies what basic scan type is being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>",
62-
"PutAccountSettingRequest$name": "<p>Basic scan type version name. </p>",
63-
"PutAccountSettingResponse$name": "<p>Retrieves the the basic scan type version name.</p>"
59+
"GetAccountSettingRequest$name": "<p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or <code>REGISTRY_POLICY_SCOPE</code>. </p>",
60+
"GetAccountSettingResponse$name": "<p>Retrieves the name of the account setting.</p>",
61+
"GetAccountSettingResponse$value": "<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>",
62+
"PutAccountSettingRequest$name": "<p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or <code>REGISTRY_POLICY_SCOPE</code>. </p>",
63+
"PutAccountSettingResponse$name": "<p>Retrieves the name of the account setting.</p>"
6464
}
6565
},
6666
"AccountSettingValue": {
6767
"base": null,
6868
"refs": {
69-
"PutAccountSettingRequest$value": "<p>Setting value that determines what basic scan type is being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>",
70-
"PutAccountSettingResponse$value": "<p>Retrieves the basic scan type value, either <code>AWS_NATIVE</code> or <code>-</code>.</p>"
69+
"PutAccountSettingRequest$value": "<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>",
70+
"PutAccountSettingResponse$value": "<p>Retrieves the value of the specified account setting.</p>"
7171
}
7272
},
7373
"Arch": {

generator/ServiceModels/ecr/ecr-2015-09-21.normal.json

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -380,7 +380,7 @@
380380
{"shape":"ValidationException"},
381381
{"shape":"InvalidParameterException"}
382382
],
383-
"documentation":"<p>Retrieves the basic scan type version name.</p>"
383+
"documentation":"<p>Retrieves the account setting value for the specified setting name.</p>"
384384
},
385385
"GetAuthorizationToken":{
386386
"name":"GetAuthorizationToken",
@@ -555,7 +555,7 @@
555555
{"shape":"InvalidParameterException"},
556556
{"shape":"LimitExceededException"}
557557
],
558-
"documentation":"<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>"
558+
"documentation":"<p>Allows you to change the basic scan type version or registry policy scope.</p>"
559559
},
560560
"PutImage":{
561561
"name":"PutImage",
@@ -1950,7 +1950,7 @@
19501950
"members":{
19511951
"name":{
19521952
"shape":"AccountSettingName",
1953-
"documentation":"<p>Basic scan type version name. </p>"
1953+
"documentation":"<p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or <code>REGISTRY_POLICY_SCOPE</code>. </p>"
19541954
}
19551955
}
19561956
},
@@ -1959,11 +1959,11 @@
19591959
"members":{
19601960
"name":{
19611961
"shape":"AccountSettingName",
1962-
"documentation":"<p>Retrieves the basic scan type version name.</p>"
1962+
"documentation":"<p>Retrieves the name of the account setting.</p>"
19631963
},
19641964
"value":{
19651965
"shape":"AccountSettingName",
1966-
"documentation":"<p>Retrieves the value that specifies what basic scan type is being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>"
1966+
"documentation":"<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>"
19671967
}
19681968
}
19691969
},
@@ -3105,11 +3105,11 @@
31053105
"members":{
31063106
"name":{
31073107
"shape":"AccountSettingName",
3108-
"documentation":"<p>Basic scan type version name. </p>"
3108+
"documentation":"<p>The name of the account setting, such as <code>BASIC_SCAN_TYPE_VERSION</code> or <code>REGISTRY_POLICY_SCOPE</code>. </p>"
31093109
},
31103110
"value":{
31113111
"shape":"AccountSettingValue",
3112-
"documentation":"<p>Setting value that determines what basic scan type is being used: <code>AWS_NATIVE</code> or <code>CLAIR</code>.</p>"
3112+
"documentation":"<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>"
31133113
}
31143114
}
31153115
},
@@ -3118,11 +3118,11 @@
31183118
"members":{
31193119
"name":{
31203120
"shape":"AccountSettingName",
3121-
"documentation":"<p>Retrieves the the basic scan type version name.</p>"
3121+
"documentation":"<p>Retrieves the name of the account setting.</p>"
31223122
},
31233123
"value":{
31243124
"shape":"AccountSettingValue",
3125-
"documentation":"<p>Retrieves the basic scan type value, either <code>AWS_NATIVE</code> or <code>-</code>.</p>"
3125+
"documentation":"<p>Retrieves the value of the specified account setting.</p>"
31263126
}
31273127
}
31283128
},

sdk/src/Services/ECR/Generated/Model/GetAccountSettingRequest.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ namespace Amazon.ECR.Model
3131
{
3232
/// <summary>
3333
/// Container for the parameters to the GetAccountSetting operation.
34-
/// Retrieves the basic scan type version name.
34+
/// Retrieves the account setting value for the specified setting name.
3535
/// </summary>
3636
public partial class GetAccountSettingRequest : AmazonECRRequest
3737
{
@@ -40,7 +40,8 @@ public partial class GetAccountSettingRequest : AmazonECRRequest
4040
/// <summary>
4141
/// Gets and sets the property Name.
4242
/// <para>
43-
/// Basic scan type version name.
43+
/// The name of the account setting, such as <c>BASIC_SCAN_TYPE_VERSION</c> or <c>REGISTRY_POLICY_SCOPE</c>.
44+
///
4445
/// </para>
4546
/// </summary>
4647
[AWSProperty(Required=true, Min=1, Max=64)]

sdk/src/Services/ECR/Generated/Model/GetAccountSettingResponse.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public partial class GetAccountSettingResponse : AmazonWebServiceResponse
4040
/// <summary>
4141
/// Gets and sets the property Name.
4242
/// <para>
43-
/// Retrieves the basic scan type version name.
43+
/// Retrieves the name of the account setting.
4444
/// </para>
4545
/// </summary>
4646
[AWSProperty(Min=1, Max=64)]
@@ -59,8 +59,9 @@ internal bool IsSetName()
5959
/// <summary>
6060
/// Gets and sets the property Value.
6161
/// <para>
62-
/// Retrieves the value that specifies what basic scan type is being used: <c>AWS_NATIVE</c>
63-
/// or <c>CLAIR</c>.
62+
/// The setting value for the setting name. The following are valid values for the basic
63+
/// scan type being used: <c>AWS_NATIVE</c> or <c>CLAIR</c>. The following are valid values
64+
/// for the registry policy scope being used: <c>V1</c> or <c>V2</c>.
6465
/// </para>
6566
/// </summary>
6667
[AWSProperty(Min=1, Max=64)]

sdk/src/Services/ECR/Generated/Model/PutAccountSettingRequest.cs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ namespace Amazon.ECR.Model
3131
{
3232
/// <summary>
3333
/// Container for the parameters to the PutAccountSetting operation.
34-
/// Allows you to change the basic scan type version by setting the <c>name</c> parameter
35-
/// to either <c>CLAIR</c> to <c>AWS_NATIVE</c>.
34+
/// Allows you to change the basic scan type version or registry policy scope.
3635
/// </summary>
3736
public partial class PutAccountSettingRequest : AmazonECRRequest
3837
{
@@ -42,7 +41,8 @@ public partial class PutAccountSettingRequest : AmazonECRRequest
4241
/// <summary>
4342
/// Gets and sets the property Name.
4443
/// <para>
45-
/// Basic scan type version name.
44+
/// The name of the account setting, such as <c>BASIC_SCAN_TYPE_VERSION</c> or <c>REGISTRY_POLICY_SCOPE</c>.
45+
///
4646
/// </para>
4747
/// </summary>
4848
[AWSProperty(Required=true, Min=1, Max=64)]
@@ -61,8 +61,9 @@ internal bool IsSetName()
6161
/// <summary>
6262
/// Gets and sets the property Value.
6363
/// <para>
64-
/// Setting value that determines what basic scan type is being used: <c>AWS_NATIVE</c>
65-
/// or <c>CLAIR</c>.
64+
/// Setting value that is specified. The following are valid values for the basic scan
65+
/// type being used: <c>AWS_NATIVE</c> or <c>CLAIR</c>. The following are valid values
66+
/// for the registry policy scope being used: <c>V1</c> or <c>V2</c>.
6667
/// </para>
6768
/// </summary>
6869
[AWSProperty(Required=true)]

sdk/src/Services/ECR/Generated/Model/PutAccountSettingResponse.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public partial class PutAccountSettingResponse : AmazonWebServiceResponse
4040
/// <summary>
4141
/// Gets and sets the property Name.
4242
/// <para>
43-
/// Retrieves the the basic scan type version name.
43+
/// Retrieves the name of the account setting.
4444
/// </para>
4545
/// </summary>
4646
[AWSProperty(Min=1, Max=64)]
@@ -59,7 +59,7 @@ internal bool IsSetName()
5959
/// <summary>
6060
/// Gets and sets the property Value.
6161
/// <para>
62-
/// Retrieves the basic scan type value, either <c>AWS_NATIVE</c> or <c>-</c>.
62+
/// Retrieves the value of the specified account setting.
6363
/// </para>
6464
/// </summary>
6565
public string Value

sdk/src/Services/ECR/Generated/_bcl35/AmazonECRClient.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1815,7 +1815,7 @@ public virtual DescribeRepositoryCreationTemplatesResponse EndDescribeRepository
18151815
#region GetAccountSetting
18161816

18171817
/// <summary>
1818-
/// Retrieves the basic scan type version name.
1818+
/// Retrieves the account setting value for the specified setting name.
18191819
/// </summary>
18201820
/// <param name="request">Container for the necessary parameters to execute the GetAccountSetting service method.</param>
18211821
///
@@ -2593,8 +2593,7 @@ public virtual ListTagsForResourceResponse EndListTagsForResource(IAsyncResult a
25932593
#region PutAccountSetting
25942594

25952595
/// <summary>
2596-
/// Allows you to change the basic scan type version by setting the <c>name</c> parameter
2597-
/// to either <c>CLAIR</c> to <c>AWS_NATIVE</c>.
2596+
/// Allows you to change the basic scan type version or registry policy scope.
25982597
/// </summary>
25992598
/// <param name="request">Container for the necessary parameters to execute the PutAccountSetting service method.</param>
26002599
///

sdk/src/Services/ECR/Generated/_bcl35/IAmazonECR.cs

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1303,7 +1303,7 @@ public partial interface IAmazonECR : IAmazonService, IDisposable
13031303

13041304

13051305
/// <summary>
1306-
/// Retrieves the basic scan type version name.
1306+
/// Retrieves the account setting value for the specified setting name.
13071307
/// </summary>
13081308
/// <param name="request">Container for the necessary parameters to execute the GetAccountSetting service method.</param>
13091309
///
@@ -1927,8 +1927,7 @@ public partial interface IAmazonECR : IAmazonService, IDisposable
19271927

19281928

19291929
/// <summary>
1930-
/// Allows you to change the basic scan type version by setting the <c>name</c> parameter
1931-
/// to either <c>CLAIR</c> to <c>AWS_NATIVE</c>.
1930+
/// Allows you to change the basic scan type version or registry policy scope.
19321931
/// </summary>
19331932
/// <param name="request">Container for the necessary parameters to execute the PutAccountSetting service method.</param>
19341933
///

sdk/src/Services/ECR/Generated/_bcl45/AmazonECRClient.cs

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1943,7 +1943,7 @@ public virtual DescribeRepositoryCreationTemplatesResponse DescribeRepositoryCre
19431943

19441944

19451945
/// <summary>
1946-
/// Retrieves the basic scan type version name.
1946+
/// Retrieves the account setting value for the specified setting name.
19471947
/// </summary>
19481948
/// <param name="request">Container for the necessary parameters to execute the GetAccountSetting service method.</param>
19491949
///
@@ -1969,7 +1969,7 @@ public virtual GetAccountSettingResponse GetAccountSetting(GetAccountSettingRequ
19691969

19701970

19711971
/// <summary>
1972-
/// Retrieves the basic scan type version name.
1972+
/// Retrieves the account setting value for the specified setting name.
19731973
/// </summary>
19741974
/// <param name="request">Container for the necessary parameters to execute the GetAccountSetting service method.</param>
19751975
/// <param name="cancellationToken">
@@ -2762,8 +2762,7 @@ public virtual ListTagsForResourceResponse ListTagsForResource(ListTagsForResour
27622762

27632763

27642764
/// <summary>
2765-
/// Allows you to change the basic scan type version by setting the <c>name</c> parameter
2766-
/// to either <c>CLAIR</c> to <c>AWS_NATIVE</c>.
2765+
/// Allows you to change the basic scan type version or registry policy scope.
27672766
/// </summary>
27682767
/// <param name="request">Container for the necessary parameters to execute the PutAccountSetting service method.</param>
27692768
///
@@ -2794,8 +2793,7 @@ public virtual PutAccountSettingResponse PutAccountSetting(PutAccountSettingRequ
27942793

27952794

27962795
/// <summary>
2797-
/// Allows you to change the basic scan type version by setting the <c>name</c> parameter
2798-
/// to either <c>CLAIR</c> to <c>AWS_NATIVE</c>.
2796+
/// Allows you to change the basic scan type version or registry policy scope.
27992797
/// </summary>
28002798
/// <param name="request">Container for the necessary parameters to execute the PutAccountSetting service method.</param>
28012799
/// <param name="cancellationToken">

0 commit comments

Comments
 (0)