Skip to content

Commit 190e920

Browse files
author
AWS
committed
AWS SecurityHub Update: Documentation update for Security Hub
1 parent 113ddc4 commit 190e920

File tree

2 files changed

+14
-8
lines changed

2 files changed

+14
-8
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS SecurityHub",
4+
"contributor": "",
5+
"description": "Documentation update for Security Hub"
6+
}

services/securityhub/src/main/resources/codegen-resources/service-2.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2284,7 +2284,7 @@
22842284
},
22852285
"RemoteIpDetails":{
22862286
"shape":"ActionRemoteIpDetails",
2287-
"documentation":"<p>Provided if <code>CallerType</code> is <code>remoteIp</code>. Provides information about the remote IP address that the API call originated from.</p>"
2287+
"documentation":"<p>Provided if <code>CallerType</code> is <code>remoteip</code>. Provides information about the remote IP address that the API call originated from.</p>"
22882288
},
22892289
"DomainDetails":{
22902290
"shape":"AwsApiCallActionDomainDetails",
@@ -15845,30 +15845,30 @@
1584515845
"members":{
1584615846
"Status":{
1584715847
"shape":"ComplianceStatus",
15848-
"documentation":"<p>The result of a standards check.</p> <p>The valid values for <code>Status</code> are as follows.</p> <ul> <li> <ul> <li> <p> <code>PASSED</code> - Standards check passed for all evaluated resources.</p> </li> <li> <p> <code>WARNING</code> - Some information is missing or this check is not supported for your configuration.</p> </li> <li> <p> <code>FAILED</code> - Standards check failed for at least one evaluated resource.</p> </li> <li> <p> <code>NOT_AVAILABLE</code> - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was <code>NOT_APPLICABLE</code>. If the Config evaluation result was <code>NOT_APPLICABLE</code> for a Security Hub control, Security Hub automatically archives the finding after 3 days.</p> </li> </ul> </li> </ul>"
15848+
"documentation":"<p>Typically summarizes the result of a control check.</p> <p>For Security Hub controls, valid values for <code>Status</code> are as follows.</p> <ul> <li> <ul> <li> <p> <code>PASSED</code> - Standards check passed for all evaluated resources.</p> </li> <li> <p> <code>WARNING</code> - Some information is missing or this check is not supported for your configuration.</p> </li> <li> <p> <code>FAILED</code> - Standards check failed for at least one evaluated resource.</p> </li> <li> <p> <code>NOT_AVAILABLE</code> - Check could not be performed due to a service outage, API error, or because the result of the Config evaluation was <code>NOT_APPLICABLE</code>. If the Config evaluation result was <code>NOT_APPLICABLE</code> for a Security Hub control, Security Hub automatically archives the finding after 3 days.</p> </li> </ul> </li> </ul>"
1584915849
},
1585015850
"RelatedRequirements":{
1585115851
"shape":"RelatedRequirementsList",
15852-
"documentation":"<p>For a control, the industry or regulatory framework requirements that are related to the control. The check for that control is aligned with these requirements.</p> <p>Array Members: Maximum number of 32 items.</p>"
15852+
"documentation":"<p>Typically provides the industry or regulatory framework requirements that are related to a control. The check for that control is aligned with these requirements.</p> <p>Array Members: Maximum number of 32 items.</p>"
1585315853
},
1585415854
"StatusReasons":{
1585515855
"shape":"StatusReasonsList",
15856-
"documentation":"<p>For findings generated from controls, a list of reasons behind the value of <code>Status</code>. For the list of status reason codes and their meanings, see <a href=\"https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-results.html#securityhub-standards-results-asff\">Standards-related information in the ASFF</a> in the <i>Security Hub User Guide</i>. </p>"
15856+
"documentation":"<p>Typically used to provide a list of reasons for the value of <code>Status</code>.</p>"
1585715857
},
1585815858
"SecurityControlId":{
1585915859
"shape":"NonEmptyString",
15860-
"documentation":"<p> The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Servicesservice and a number, such as APIGateway.5. </p>"
15860+
"documentation":"<p> Typically provides the unique identifier of a control across standards. For Security Hub controls, this field consists of an Amazon Web Servicesservice and a unique number, such as <code>APIGateway.5</code>. </p>"
1586115861
},
1586215862
"AssociatedStandards":{
1586315863
"shape":"AssociatedStandardsList",
15864-
"documentation":"<p>The enabled security standards in which a security control is currently enabled. </p>"
15864+
"documentation":"<p>Typically provides an array of enabled security standards in which a security control is currently enabled. </p>"
1586515865
},
1586615866
"SecurityControlParameters":{
1586715867
"shape":"SecurityControlParametersList",
15868-
"documentation":"<p> An object that includes security control parameter names and values. </p>"
15868+
"documentation":"<p> Typically an object that includes security control parameter names and values. </p>"
1586915869
}
1587015870
},
15871-
"documentation":"<p>Contains finding details that are specific to control-based findings. Only returned for findings generated from controls.</p>"
15871+
"documentation":"<p>This object typically provides details about a control finding, such as applicable standards and the status of control checks. While finding providers can add custom content in <code>Compliance</code> object fields, they are typically used to review details of Security Hub control findings.</p>"
1587215872
},
1587315873
"ComplianceStatus":{
1587415874
"type":"string",

0 commit comments

Comments
 (0)