|
2284 | 2284 | },
|
2285 | 2285 | "RemoteIpDetails":{
|
2286 | 2286 | "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>" |
2288 | 2288 | },
|
2289 | 2289 | "DomainDetails":{
|
2290 | 2290 | "shape":"AwsApiCallActionDomainDetails",
|
@@ -15845,30 +15845,30 @@
|
15845 | 15845 | "members":{
|
15846 | 15846 | "Status":{
|
15847 | 15847 | "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>" |
15849 | 15849 | },
|
15850 | 15850 | "RelatedRequirements":{
|
15851 | 15851 | "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>" |
15853 | 15853 | },
|
15854 | 15854 | "StatusReasons":{
|
15855 | 15855 | "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>" |
15857 | 15857 | },
|
15858 | 15858 | "SecurityControlId":{
|
15859 | 15859 | "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>" |
15861 | 15861 | },
|
15862 | 15862 | "AssociatedStandards":{
|
15863 | 15863 | "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>" |
15865 | 15865 | },
|
15866 | 15866 | "SecurityControlParameters":{
|
15867 | 15867 | "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>" |
15869 | 15869 | }
|
15870 | 15870 | },
|
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>" |
15872 | 15872 | },
|
15873 | 15873 | "ComplianceStatus":{
|
15874 | 15874 | "type":"string",
|
|
0 commit comments