Skip to content

Commit 17db5f7

Browse files
author
awstools
committed
feat(client-securityhub): Security Hub documentation and definition updates
1 parent 6fff363 commit 17db5f7

File tree

9 files changed

+76
-61
lines changed

9 files changed

+76
-61
lines changed

clients/client-securityhub/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ AWS SDK for JavaScript SecurityHub Client for Node.js, Browser and React Native.
88

99
<p>Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
1010
you assess your Amazon Web Services environment against security industry standards and best practices.</p>
11-
<p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
11+
<p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and
1212
supported third-party products and helps you analyze your security trends and identify the highest priority security
1313
issues.</p>
1414
<p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
@@ -17,10 +17,10 @@ and external compliance frameworks such as the Center for Internet Security (CIS
1717
Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
1818
several security controls, each of which represents a security best practice. Security Hub runs checks against
1919
security controls and generates control findings to help you assess your compliance against security best practices.</p>
20-
<p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
20+
<p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices,
2121
such as Amazon GuardDuty and Amazon Inspector, and
2222
supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You
23-
can also send Security Hub findings to other Amazon Web Services and supported third-party products.</p>
23+
can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.</p>
2424
<p>Security Hub offers automation features that help you triage and remediate security issues. For example,
2525
you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
2626
Amazon EventBridge to trigger automatic responses to specific findings.</p>
@@ -31,12 +31,12 @@ and schemas. If you're new to Security Hub, you might find it helpful to also re
3131
</a>. The
3232
user guide explains key concepts and provides procedures
3333
that demonstrate how to use Security Hub features. It also provides information about topics such as
34-
integrating Security Hub with other Amazon Web Services.</p>
34+
integrating Security Hub with other Amazon Web Servicesservices.</p>
3535
<p>In addition to interacting with Security Hub by making calls to the Security Hub API, you can
3636
use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
3737
and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
3838
Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to
39-
Security Hub and other Amazon Web Services . They also handle tasks such as signing requests,
39+
Security Hub and other Amazon Web Servicesservices . They also handle tasks such as signing requests,
4040
managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
4141
and SDKs, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
4242
<p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in

clients/client-securityhub/src/SecurityHub.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -1746,7 +1746,7 @@ export interface SecurityHub {
17461746
/**
17471747
* <p>Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
17481748
* you assess your Amazon Web Services environment against security industry standards and best practices.</p>
1749-
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
1749+
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and
17501750
* supported third-party products and helps you analyze your security trends and identify the highest priority security
17511751
* issues.</p>
17521752
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
@@ -1755,10 +1755,10 @@ export interface SecurityHub {
17551755
* Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
17561756
* several security controls, each of which represents a security best practice. Security Hub runs checks against
17571757
* security controls and generates control findings to help you assess your compliance against security best practices.</p>
1758-
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
1758+
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices,
17591759
* such as Amazon GuardDuty and Amazon Inspector, and
17601760
* supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You
1761-
* can also send Security Hub findings to other Amazon Web Services and supported third-party products.</p>
1761+
* can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.</p>
17621762
* <p>Security Hub offers automation features that help you triage and remediate security issues. For example,
17631763
* you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
17641764
* Amazon EventBridge to trigger automatic responses to specific findings.</p>
@@ -1769,12 +1769,12 @@ export interface SecurityHub {
17691769
* </a>. The
17701770
* user guide explains key concepts and provides procedures
17711771
* that demonstrate how to use Security Hub features. It also provides information about topics such as
1772-
* integrating Security Hub with other Amazon Web Services.</p>
1772+
* integrating Security Hub with other Amazon Web Servicesservices.</p>
17731773
* <p>In addition to interacting with Security Hub by making calls to the Security Hub API, you can
17741774
* use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
17751775
* and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
17761776
* Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to
1777-
* Security Hub and other Amazon Web Services . They also handle tasks such as signing requests,
1777+
* Security Hub and other Amazon Web Servicesservices . They also handle tasks such as signing requests,
17781778
* managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
17791779
* and SDKs, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
17801780
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in

clients/client-securityhub/src/SecurityHubClient.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -638,7 +638,7 @@ export interface SecurityHubClientResolvedConfig extends SecurityHubClientResolv
638638
/**
639639
* <p>Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
640640
* you assess your Amazon Web Services environment against security industry standards and best practices.</p>
641-
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
641+
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and
642642
* supported third-party products and helps you analyze your security trends and identify the highest priority security
643643
* issues.</p>
644644
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
@@ -647,10 +647,10 @@ export interface SecurityHubClientResolvedConfig extends SecurityHubClientResolv
647647
* Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
648648
* several security controls, each of which represents a security best practice. Security Hub runs checks against
649649
* security controls and generates control findings to help you assess your compliance against security best practices.</p>
650-
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
650+
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices,
651651
* such as Amazon GuardDuty and Amazon Inspector, and
652652
* supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You
653-
* can also send Security Hub findings to other Amazon Web Services and supported third-party products.</p>
653+
* can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.</p>
654654
* <p>Security Hub offers automation features that help you triage and remediate security issues. For example,
655655
* you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
656656
* Amazon EventBridge to trigger automatic responses to specific findings.</p>
@@ -661,12 +661,12 @@ export interface SecurityHubClientResolvedConfig extends SecurityHubClientResolv
661661
* </a>. The
662662
* user guide explains key concepts and provides procedures
663663
* that demonstrate how to use Security Hub features. It also provides information about topics such as
664-
* integrating Security Hub with other Amazon Web Services.</p>
664+
* integrating Security Hub with other Amazon Web Servicesservices.</p>
665665
* <p>In addition to interacting with Security Hub by making calls to the Security Hub API, you can
666666
* use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
667667
* and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
668668
* Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to
669-
* Security Hub and other Amazon Web Services . They also handle tasks such as signing requests,
669+
* Security Hub and other Amazon Web Servicesservices . They also handle tasks such as signing requests,
670670
* managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
671671
* and SDKs, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
672672
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in

clients/client-securityhub/src/commands/UpdateFindingsCommand.ts

+5-4
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,12 @@ export interface UpdateFindingsCommandOutput extends UpdateFindingsResponse, __M
3131
* <p>
3232
* <code>UpdateFindings</code> is a deprecated operation. Instead of <code>UpdateFindings</code>, use
3333
* the <code>BatchUpdateFindings</code> operation.</p>
34-
* <p>Updates the <code>Note</code> and <code>RecordState</code> of the Security Hub-aggregated
34+
* <p>The <code>UpdateFindings</code> operation updates the <code>Note</code> and <code>RecordState</code> of the Security Hub aggregated
3535
* findings that the filter attributes specify. Any member account that can view the finding
36-
* also sees the update to the finding.</p>
37-
* <p>Finding updates made with <code>UpdateFindings</code> might not be persisted if the same finding is later updated by the
38-
* finding provider through the <code>BatchImportFindings</code> operation.</p>
36+
* can also see the update to the finding.</p>
37+
* <p>Finding updates made with <code>UpdateFindings</code> aren't persisted if the same finding is later updated by the
38+
* finding provider through the <code>BatchImportFindings</code> operation. In addition, Security Hub doesn't
39+
* record updates made with <code>UpdateFindings</code> in the finding history.</p>
3940
* @example
4041
* Use a bare-bones client and the command you need to make an API call.
4142
* ```javascript

clients/client-securityhub/src/index.ts

+5-5
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
/**
44
* <p>Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
55
* you assess your Amazon Web Services environment against security industry standards and best practices.</p>
6-
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
6+
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and
77
* supported third-party products and helps you analyze your security trends and identify the highest priority security
88
* issues.</p>
99
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
@@ -12,10 +12,10 @@
1212
* Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
1313
* several security controls, each of which represents a security best practice. Security Hub runs checks against
1414
* security controls and generates control findings to help you assess your compliance against security best practices.</p>
15-
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
15+
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices,
1616
* such as Amazon GuardDuty and Amazon Inspector, and
1717
* supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You
18-
* can also send Security Hub findings to other Amazon Web Services and supported third-party products.</p>
18+
* can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.</p>
1919
* <p>Security Hub offers automation features that help you triage and remediate security issues. For example,
2020
* you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
2121
* Amazon EventBridge to trigger automatic responses to specific findings.</p>
@@ -26,12 +26,12 @@
2626
* </a>. The
2727
* user guide explains key concepts and provides procedures
2828
* that demonstrate how to use Security Hub features. It also provides information about topics such as
29-
* integrating Security Hub with other Amazon Web Services.</p>
29+
* integrating Security Hub with other Amazon Web Servicesservices.</p>
3030
* <p>In addition to interacting with Security Hub by making calls to the Security Hub API, you can
3131
* use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
3232
* and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
3333
* Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to
34-
* Security Hub and other Amazon Web Services . They also handle tasks such as signing requests,
34+
* Security Hub and other Amazon Web Servicesservices . They also handle tasks such as signing requests,
3535
* managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
3636
* and SDKs, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
3737
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in

clients/client-securityhub/src/models/models_0.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -1965,7 +1965,7 @@ export interface AutomationRulesFindingFilters {
19651965
* <p>
19661966
* The identifier for the given resource type. For Amazon Web Services resources that are identified by
19671967
* Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs,
1968-
* this is the identifier as defined by the Amazon Web Service that created the resource.
1968+
* this is the identifier as defined by the Amazon Web Servicesservice that created the resource.
19691969
* For non-Amazon Web Services resources, this is a unique identifier that is associated with the
19701970
* resource.
19711971
* </p>
@@ -10662,7 +10662,7 @@ export interface RouteSetDetails {
1066210662

1066310663
/**
1066410664
* <p>
10665-
* The prefix of the destination Amazon Web Service.
10665+
* The prefix of the destination Amazon Web Servicesservice.
1066610666
* </p>
1066710667
* @public
1066810668
*/

clients/client-securityhub/src/models/models_1.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -10045,7 +10045,7 @@ export interface Compliance {
1004510045
/**
1004610046
* <p>
1004710047
* The unique identifier of a control across standards. Values for this field typically consist of an
10048-
* Amazon Web Service and a number, such as APIGateway.5.
10048+
* Amazon Web Servicesservice and a number, such as APIGateway.5.
1004910049
* </p>
1005010050
* @public
1005110051
*/

0 commit comments

Comments
 (0)