Skip to content

Commit 7b78c40

Browse files
Documentation updates for AWS Security Hub.
1 parent a35f8e8 commit 7b78c40

File tree

5 files changed

+30
-38
lines changed

5 files changed

+30
-38
lines changed

generator/ServiceModels/securityhub/securityhub-2018-10-26.docs.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8032,7 +8032,7 @@
80328032
"SoftwarePackage$SourceLayerHash": "<p>The source layer hash of the vulnerable package. </p>",
80338033
"SoftwarePackage$SourceLayerArn": "<p>The Amazon Resource Name (ARN) of the source layer. </p>",
80348034
"SortCriterion$Field": "<p>The finding attribute used to sort findings.</p>",
8035-
"Standard$StandardsArn": "<p>The ARN of a standard.</p>",
8035+
"Standard$StandardsArn": "<p>The ARN of the standard.</p>",
80368036
"Standard$Name": "<p>The name of the standard.</p>",
80378037
"Standard$Description": "<p>A description of the standard.</p>",
80388038
"StandardsControl$StandardsControlArn": "<p>The ARN of the security standard control.</p>",
@@ -8063,8 +8063,8 @@
80638063
"StandardsInputParameterMap$value": null,
80648064
"StandardsManagedBy$Company": "<p>An identifier for the company that manages a specific security standard. For existing standards, the value is equal to <code>Amazon Web Services</code>.</p>",
80658065
"StandardsManagedBy$Product": "<p>An identifier for the product that manages a specific security standard. For existing standards, the value is equal to the Amazon Web Services service that manages the standard.</p>",
8066-
"StandardsSubscription$StandardsSubscriptionArn": "<p>The ARN of a resource that represents your subscription to a supported standard.</p>",
8067-
"StandardsSubscription$StandardsArn": "<p>The ARN of a standard.</p>",
8066+
"StandardsSubscription$StandardsSubscriptionArn": "<p>The ARN of the resource that represents your subscription to the standard.</p>",
8067+
"StandardsSubscription$StandardsArn": "<p>The ARN of the standard.</p>",
80688068
"StandardsSubscriptionArns$member": null,
80698069
"StandardsSubscriptionRequest$StandardsArn": "<p>The ARN of the standard that you want to enable. To view the list of available standards and their ARNs, use the <code>DescribeStandards</code> operation.</p>",
80708070
"StartConfigurationPolicyAssociationRequest$ConfigurationPolicyIdentifier": "<p> The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a configuration policy, or a value of <code>SELF_MANAGED_SECURITY_HUB</code> for a self-managed configuration. </p>",
@@ -9062,7 +9062,7 @@
90629062
"StandardsControlsUpdatable": {
90639063
"base": null,
90649064
"refs": {
9065-
"StandardsSubscription$StandardsControlsUpdatable": "<p>Indicates whether the controls associated with this standards subscription can be viewed and updated.</p> <p>The values are as follows:</p> <ul> <li> <p> <code>READY_FOR_UPDATES</code> - Controls associated with this standards subscription can be viewed and updated.</p> </li> <li> <p> <code>NOT_READY_FOR_UPDATES</code> - Controls associated with this standards subscription cannot be retrieved or updated yet. Security Hub is still processing a request to create the controls.</p> </li> </ul>"
9065+
"StandardsSubscription$StandardsControlsUpdatable": "<p>Specifies whether you can retrieve information about and configure individual controls that apply to the standard. Possible values are:</p> <ul> <li> <p> <code>READY_FOR_UPDATES</code> - Controls in the standard can be retrieved and configured.</p> </li> <li> <p> <code>NOT_READY_FOR_UPDATES</code> - Controls in the standard cannot be retrieved or configured.</p> </li> </ul>"
90669066
}
90679067
},
90689068
"StandardsInputParameterMap": {
@@ -9081,11 +9081,11 @@
90819081
"StandardsStatus": {
90829082
"base": null,
90839083
"refs": {
9084-
"StandardsSubscription$StandardsStatus": "<p>The status of the standard subscription.</p> <p>The status values are as follows:</p> <ul> <li> <p> <code>PENDING</code> - Standard is in the process of being enabled.</p> </li> <li> <p> <code>READY</code> - Standard is enabled.</p> </li> <li> <p> <code>INCOMPLETE</code> - Standard could not be enabled completely. Some controls may not be available.</p> </li> <li> <p> <code>DELETING</code> - Standard is in the process of being disabled.</p> </li> <li> <p> <code>FAILED</code> - Standard could not be disabled.</p> </li> </ul>"
9084+
"StandardsSubscription$StandardsStatus": "<p>The status of your subscription to the standard. Possible values are:</p> <ul> <li> <p> <code>PENDING</code> - The standard is in the process of being enabled. Or the standard is already enabled and Security Hub is adding new controls to the standard.</p> </li> <li> <p> <code>READY</code> - The standard is enabled.</p> </li> <li> <p> <code>INCOMPLETE</code> - The standard could not be enabled completely. One or more errors (<code>StandardsStatusReason</code>) occurred when Security Hub attempted to enable the standard.</p> </li> <li> <p> <code>DELETING</code> - The standard is in the process of being disabled.</p> </li> <li> <p> <code>FAILED</code> - The standard could not be disabled. One or more errors (<code>StandardsStatusReason</code>) occurred when Security Hub attempted to disable the standard.</p> </li> </ul>"
90859085
}
90869086
},
90879087
"StandardsStatusReason": {
9088-
"base": "<p>The reason for the current status of a standard subscription.</p>",
9088+
"base": "<p>The reason for the current status of your subscription to the standard.</p>",
90899089
"refs": {
90909090
"StandardsSubscription$StandardsStatusReason": "<p>The reason for the current status.</p>"
90919091
}

generator/ServiceModels/securityhub/securityhub-2018-10-26.normal.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20776,7 +20776,7 @@
2077620776
"members":{
2077720777
"StandardsArn":{
2077820778
"shape":"NonEmptyString",
20779-
"documentation":"<p>The ARN of a standard.</p>"
20779+
"documentation":"<p>The ARN of the standard.</p>"
2078020780
},
2078120781
"Name":{
2078220782
"shape":"NonEmptyString",
@@ -21061,7 +21061,7 @@
2106121061
"documentation":"<p>The reason code that represents the reason for the current status of a standard subscription.</p>"
2106221062
}
2106321063
},
21064-
"documentation":"<p>The reason for the current status of a standard subscription.</p>"
21064+
"documentation":"<p>The reason for the current status of your subscription to the standard.</p>"
2106521065
},
2106621066
"StandardsSubscription":{
2106721067
"type":"structure",
@@ -21074,23 +21074,23 @@
2107421074
"members":{
2107521075
"StandardsSubscriptionArn":{
2107621076
"shape":"NonEmptyString",
21077-
"documentation":"<p>The ARN of a resource that represents your subscription to a supported standard.</p>"
21077+
"documentation":"<p>The ARN of the resource that represents your subscription to the standard.</p>"
2107821078
},
2107921079
"StandardsArn":{
2108021080
"shape":"NonEmptyString",
21081-
"documentation":"<p>The ARN of a standard.</p>"
21081+
"documentation":"<p>The ARN of the standard.</p>"
2108221082
},
2108321083
"StandardsInput":{
2108421084
"shape":"StandardsInputParameterMap",
2108521085
"documentation":"<p>A key-value pair of input for the standard.</p>"
2108621086
},
2108721087
"StandardsStatus":{
2108821088
"shape":"StandardsStatus",
21089-
"documentation":"<p>The status of the standard subscription.</p> <p>The status values are as follows:</p> <ul> <li> <p> <code>PENDING</code> - Standard is in the process of being enabled.</p> </li> <li> <p> <code>READY</code> - Standard is enabled.</p> </li> <li> <p> <code>INCOMPLETE</code> - Standard could not be enabled completely. Some controls may not be available.</p> </li> <li> <p> <code>DELETING</code> - Standard is in the process of being disabled.</p> </li> <li> <p> <code>FAILED</code> - Standard could not be disabled.</p> </li> </ul>"
21089+
"documentation":"<p>The status of your subscription to the standard. Possible values are:</p> <ul> <li> <p> <code>PENDING</code> - The standard is in the process of being enabled. Or the standard is already enabled and Security Hub is adding new controls to the standard.</p> </li> <li> <p> <code>READY</code> - The standard is enabled.</p> </li> <li> <p> <code>INCOMPLETE</code> - The standard could not be enabled completely. One or more errors (<code>StandardsStatusReason</code>) occurred when Security Hub attempted to enable the standard.</p> </li> <li> <p> <code>DELETING</code> - The standard is in the process of being disabled.</p> </li> <li> <p> <code>FAILED</code> - The standard could not be disabled. One or more errors (<code>StandardsStatusReason</code>) occurred when Security Hub attempted to disable the standard.</p> </li> </ul>"
2109021090
},
2109121091
"StandardsControlsUpdatable":{
2109221092
"shape":"StandardsControlsUpdatable",
21093-
"documentation":"<p>Indicates whether the controls associated with this standards subscription can be viewed and updated.</p> <p>The values are as follows:</p> <ul> <li> <p> <code>READY_FOR_UPDATES</code> - Controls associated with this standards subscription can be viewed and updated.</p> </li> <li> <p> <code>NOT_READY_FOR_UPDATES</code> - Controls associated with this standards subscription cannot be retrieved or updated yet. Security Hub is still processing a request to create the controls.</p> </li> </ul>"
21093+
"documentation":"<p>Specifies whether you can retrieve information about and configure individual controls that apply to the standard. Possible values are:</p> <ul> <li> <p> <code>READY_FOR_UPDATES</code> - Controls in the standard can be retrieved and configured.</p> </li> <li> <p> <code>NOT_READY_FOR_UPDATES</code> - Controls in the standard cannot be retrieved or configured.</p> </li> </ul>"
2109421094
},
2109521095
"StandardsStatusReason":{
2109621096
"shape":"StandardsStatusReason",

sdk/src/Services/SecurityHub/Generated/Model/Standard.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ internal bool IsSetName()
104104
/// <summary>
105105
/// Gets and sets the property StandardsArn.
106106
/// <para>
107-
/// The ARN of a standard.
107+
/// The ARN of the standard.
108108
/// </para>
109109
/// </summary>
110110
public string StandardsArn

sdk/src/Services/SecurityHub/Generated/Model/StandardsStatusReason.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
namespace Amazon.SecurityHub.Model
3131
{
3232
/// <summary>
33-
/// The reason for the current status of a standard subscription.
33+
/// The reason for the current status of your subscription to the standard.
3434
/// </summary>
3535
public partial class StandardsStatusReason
3636
{

sdk/src/Services/SecurityHub/Generated/Model/StandardsSubscription.cs

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public partial class StandardsSubscription
4444
/// <summary>
4545
/// Gets and sets the property StandardsArn.
4646
/// <para>
47-
/// The ARN of a standard.
47+
/// The ARN of the standard.
4848
/// </para>
4949
/// </summary>
5050
[AWSProperty(Required=true)]
@@ -63,23 +63,16 @@ internal bool IsSetStandardsArn()
6363
/// <summary>
6464
/// Gets and sets the property StandardsControlsUpdatable.
6565
/// <para>
66-
/// Indicates whether the controls associated with this standards subscription can be
67-
/// viewed and updated.
68-
/// </para>
69-
///
70-
/// <para>
71-
/// The values are as follows:
66+
/// Specifies whether you can retrieve information about and configure individual controls
67+
/// that apply to the standard. Possible values are:
7268
/// </para>
7369
/// <ul> <li>
7470
/// <para>
75-
/// <c>READY_FOR_UPDATES</c> - Controls associated with this standards subscription can
76-
/// be viewed and updated.
71+
/// <c>READY_FOR_UPDATES</c> - Controls in the standard can be retrieved and configured.
7772
/// </para>
7873
/// </li> <li>
7974
/// <para>
80-
/// <c>NOT_READY_FOR_UPDATES</c> - Controls associated with this standards subscription
81-
/// cannot be retrieved or updated yet. Security Hub is still processing a request to
82-
/// create the controls.
75+
/// <c>NOT_READY_FOR_UPDATES</c> - Controls in the standard cannot be retrieved or configured.
8376
/// </para>
8477
/// </li> </ul>
8578
/// </summary>
@@ -117,32 +110,31 @@ internal bool IsSetStandardsInput()
117110
/// <summary>
118111
/// Gets and sets the property StandardsStatus.
119112
/// <para>
120-
/// The status of the standard subscription.
121-
/// </para>
122-
///
123-
/// <para>
124-
/// The status values are as follows:
113+
/// The status of your subscription to the standard. Possible values are:
125114
/// </para>
126115
/// <ul> <li>
127116
/// <para>
128-
/// <c>PENDING</c> - Standard is in the process of being enabled.
117+
/// <c>PENDING</c> - The standard is in the process of being enabled. Or the standard
118+
/// is already enabled and Security Hub is adding new controls to the standard.
129119
/// </para>
130120
/// </li> <li>
131121
/// <para>
132-
/// <c>READY</c> - Standard is enabled.
122+
/// <c>READY</c> - The standard is enabled.
133123
/// </para>
134124
/// </li> <li>
135125
/// <para>
136-
/// <c>INCOMPLETE</c> - Standard could not be enabled completely. Some controls may not
137-
/// be available.
126+
/// <c>INCOMPLETE</c> - The standard could not be enabled completely. One or more errors
127+
/// (<c>StandardsStatusReason</c>) occurred when Security Hub attempted to enable the
128+
/// standard.
138129
/// </para>
139130
/// </li> <li>
140131
/// <para>
141-
/// <c>DELETING</c> - Standard is in the process of being disabled.
132+
/// <c>DELETING</c> - The standard is in the process of being disabled.
142133
/// </para>
143134
/// </li> <li>
144135
/// <para>
145-
/// <c>FAILED</c> - Standard could not be disabled.
136+
/// <c>FAILED</c> - The standard could not be disabled. One or more errors (<c>StandardsStatusReason</c>)
137+
/// occurred when Security Hub attempted to disable the standard.
146138
/// </para>
147139
/// </li> </ul>
148140
/// </summary>
@@ -180,7 +172,7 @@ internal bool IsSetStandardsStatusReason()
180172
/// <summary>
181173
/// Gets and sets the property StandardsSubscriptionArn.
182174
/// <para>
183-
/// The ARN of a resource that represents your subscription to a supported standard.
175+
/// The ARN of the resource that represents your subscription to the standard.
184176
/// </para>
185177
/// </summary>
186178
[AWSProperty(Required=true)]

0 commit comments

Comments
 (0)