Skip to content

Commit 3be771e

Browse files
author
awstools
committed
docs(client-securityhub): Documentation updates for AWS Security Hub
1 parent 7b321a2 commit 3be771e

File tree

8 files changed

+2651
-447
lines changed

8 files changed

+2651
-447
lines changed

Diff for: clients/client-securityhub/README.md

+39-15
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,47 @@
66

77
AWS SDK for JavaScript SecurityHub Client for Node.js, Browser and React Native.
88

9-
<p>Security Hub provides you with a comprehensive view of the security state of
10-
your Amazon Web Services environment and resources. It also provides you with the readiness
11-
status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and
12-
integrated third-party products and helps you analyze security trends in your environment
13-
to identify the highest priority security issues. For more information about Security Hub, see the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html">
14-
<i>Security Hub User
15-
Guide</i>
16-
</a>.</p>
17-
<p>When you use operations in the Security Hub API, the requests are executed only in
9+
<p>Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
10+
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
12+
supported third-party products and helps you analyze your security trends and identify the highest priority security
13+
issues.</p>
14+
<p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
15+
These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services,
16+
and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data
17+
Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
18+
several security controls, each of which represents a security best practice. Security Hub runs checks against
19+
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,
21+
such as Amazon GuardDuty and Amazon Inspector, and
22+
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>
24+
<p>Security Hub offers automation features that help you triage and remediate security issues. For example,
25+
you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
26+
Amazon EventBridge to trigger automatic responses to specific findings.</p>
27+
<p>This guide, the <i>Security Hub API Reference</i>, provides
28+
information about the Security Hub API. This includes supported resources, HTTP methods, parameters,
29+
and schemas. If you're new to Security Hub, you might find it helpful to also review the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html">
30+
<i>Security Hub User Guide</i>
31+
</a>. The
32+
user guide explains key concepts and provides procedures
33+
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>
35+
<p>In addition to interacting with Security Hub by making calls to the Security Hub API, you can
36+
use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
37+
and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
38+
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,
40+
managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
41+
and SDKs, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
42+
<p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
1843
the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change
1944
that results from the operation is applied only to that Region. To make the same change in
20-
other Regions, run the same command for each Region in which you want to apply the change.</p>
21-
<p>For example, if your Region is set to <code>us-west-2</code>, when you use <code>CreateMembers</code> to add a member account to Security Hub, the association of
22-
the member account with the administrator account is created only in the <code>us-west-2</code>
23-
Region. Security Hub must be enabled for the member account in the same Region that the invitation
24-
was sent from.</p>
25-
<p>The following throttling limits apply to using Security Hub API operations.</p>
45+
other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration,
46+
API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of
47+
central configuration operations, see the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html#central-configuration-concepts">Central configuration
48+
terms and concepts</a> section of the <i>Security Hub User Guide</i>.</p>
49+
<p>The following throttling limits apply to Security Hub API operations.</p>
2650
<ul>
2751
<li>
2852
<p>

Diff for: clients/client-securityhub/src/SecurityHub.ts

+39-15
Original file line numberDiff line numberDiff line change
@@ -1744,23 +1744,47 @@ export interface SecurityHub {
17441744
}
17451745

17461746
/**
1747-
* <p>Security Hub provides you with a comprehensive view of the security state of
1748-
* your Amazon Web Services environment and resources. It also provides you with the readiness
1749-
* status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and
1750-
* integrated third-party products and helps you analyze security trends in your environment
1751-
* to identify the highest priority security issues. For more information about Security Hub, see the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html">
1752-
* <i>Security Hub User
1753-
* Guide</i>
1754-
* </a>.</p>
1755-
* <p>When you use operations in the Security Hub API, the requests are executed only in
1747+
* <p>Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
1748+
* 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
1750+
* supported third-party products and helps you analyze your security trends and identify the highest priority security
1751+
* issues.</p>
1752+
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
1753+
* These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services,
1754+
* and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data
1755+
* Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
1756+
* several security controls, each of which represents a security best practice. Security Hub runs checks against
1757+
* 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,
1759+
* such as Amazon GuardDuty and Amazon Inspector, and
1760+
* 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>
1762+
* <p>Security Hub offers automation features that help you triage and remediate security issues. For example,
1763+
* you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
1764+
* Amazon EventBridge to trigger automatic responses to specific findings.</p>
1765+
* <p>This guide, the <i>Security Hub API Reference</i>, provides
1766+
* information about the Security Hub API. This includes supported resources, HTTP methods, parameters,
1767+
* and schemas. If you're new to Security Hub, you might find it helpful to also review the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html">
1768+
* <i>Security Hub User Guide</i>
1769+
* </a>. The
1770+
* user guide explains key concepts and provides procedures
1771+
* 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>
1773+
* <p>In addition to interacting with Security Hub by making calls to the Security Hub API, you can
1774+
* use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
1775+
* and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
1776+
* 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,
1778+
* managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
1779+
* and SDKs, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
1780+
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
17561781
* the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change
17571782
* that results from the operation is applied only to that Region. To make the same change in
1758-
* other Regions, run the same command for each Region in which you want to apply the change.</p>
1759-
* <p>For example, if your Region is set to <code>us-west-2</code>, when you use <code>CreateMembers</code> to add a member account to Security Hub, the association of
1760-
* the member account with the administrator account is created only in the <code>us-west-2</code>
1761-
* Region. Security Hub must be enabled for the member account in the same Region that the invitation
1762-
* was sent from.</p>
1763-
* <p>The following throttling limits apply to using Security Hub API operations.</p>
1783+
* other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration,
1784+
* API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of
1785+
* central configuration operations, see the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html#central-configuration-concepts">Central configuration
1786+
* terms and concepts</a> section of the <i>Security Hub User Guide</i>.</p>
1787+
* <p>The following throttling limits apply to Security Hub API operations.</p>
17641788
* <ul>
17651789
* <li>
17661790
* <p>

Diff for: clients/client-securityhub/src/SecurityHubClient.ts

+39-15
Original file line numberDiff line numberDiff line change
@@ -636,23 +636,47 @@ export type SecurityHubClientResolvedConfigType = __SmithyResolvedConfiguration<
636636
export interface SecurityHubClientResolvedConfig extends SecurityHubClientResolvedConfigType {}
637637

638638
/**
639-
* <p>Security Hub provides you with a comprehensive view of the security state of
640-
* your Amazon Web Services environment and resources. It also provides you with the readiness
641-
* status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and
642-
* integrated third-party products and helps you analyze security trends in your environment
643-
* to identify the highest priority security issues. For more information about Security Hub, see the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html">
644-
* <i>Security Hub User
645-
* Guide</i>
646-
* </a>.</p>
647-
* <p>When you use operations in the Security Hub API, the requests are executed only in
639+
* <p>Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
640+
* 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
642+
* supported third-party products and helps you analyze your security trends and identify the highest priority security
643+
* issues.</p>
644+
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
645+
* These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services,
646+
* and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data
647+
* Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
648+
* several security controls, each of which represents a security best practice. Security Hub runs checks against
649+
* 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,
651+
* such as Amazon GuardDuty and Amazon Inspector, and
652+
* 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>
654+
* <p>Security Hub offers automation features that help you triage and remediate security issues. For example,
655+
* you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
656+
* Amazon EventBridge to trigger automatic responses to specific findings.</p>
657+
* <p>This guide, the <i>Security Hub API Reference</i>, provides
658+
* information about the Security Hub API. This includes supported resources, HTTP methods, parameters,
659+
* and schemas. If you're new to Security Hub, you might find it helpful to also review the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/what-is-securityhub.html">
660+
* <i>Security Hub User Guide</i>
661+
* </a>. The
662+
* user guide explains key concepts and provides procedures
663+
* 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>
665+
* <p>In addition to interacting with Security Hub by making calls to the Security Hub API, you can
666+
* use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
667+
* and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
668+
* 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,
670+
* managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
671+
* and SDKs, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
672+
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
648673
* the Amazon Web Services Region that is currently active or in the specific Amazon Web Services Region that you specify in your request. Any configuration or settings change
649674
* that results from the operation is applied only to that Region. To make the same change in
650-
* other Regions, run the same command for each Region in which you want to apply the change.</p>
651-
* <p>For example, if your Region is set to <code>us-west-2</code>, when you use <code>CreateMembers</code> to add a member account to Security Hub, the association of
652-
* the member account with the administrator account is created only in the <code>us-west-2</code>
653-
* Region. Security Hub must be enabled for the member account in the same Region that the invitation
654-
* was sent from.</p>
655-
* <p>The following throttling limits apply to using Security Hub API operations.</p>
675+
* other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration,
676+
* API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of
677+
* central configuration operations, see the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html#central-configuration-concepts">Central configuration
678+
* terms and concepts</a> section of the <i>Security Hub User Guide</i>.</p>
679+
* <p>The following throttling limits apply to Security Hub API operations.</p>
656680
* <ul>
657681
* <li>
658682
* <p>

0 commit comments

Comments
 (0)