You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clients/client-securityhub/README.md
+39-15
Original file line number
Diff line number
Diff line change
@@ -6,23 +6,47 @@
6
6
7
7
AWS SDK for JavaScript SecurityHub Client for Node.js, Browser and React Native.
8
8
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 <ahref="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 <ahref="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 <ahref="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
18
43
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
19
44
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 <ahref="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>
* <p>Security Hub provides you with a comprehensive view of the security state of
1724
-
* your Amazon Web Services environment and resources. It also provides you with the readiness
1725
-
* status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and
1726
-
* integrated third-party products and helps you analyze security trends in your environment
1727
-
* 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">
1728
-
* <i>Security Hub User
1729
-
* Guide</i>
1730
-
* </a>.</p>
1731
-
* <p>When you use operations in the Security Hub API, the requests are executed only in
1723
+
* <p>Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
1724
+
* you assess your Amazon Web Services environment against security industry standards and best practices.</p>
1725
+
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
1726
+
* supported third-party products and helps you analyze your security trends and identify the highest priority security
1727
+
* issues.</p>
1728
+
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
1729
+
* These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services,
1730
+
* and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data
1731
+
* Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
1732
+
* several security controls, each of which represents a security best practice. Security Hub runs checks against
1733
+
* security controls and generates control findings to help you assess your compliance against security best practices.</p>
1734
+
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
1735
+
* such as Amazon GuardDuty and Amazon Inspector, and
1736
+
* supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You
1737
+
* can also send Security Hub findings to other Amazon Web Services and supported third-party products.</p>
1738
+
* <p>Security Hub offers automation features that help you triage and remediate security issues. For example,
1739
+
* you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
1740
+
* Amazon EventBridge to trigger automatic responses to specific findings.</p>
1741
+
* <p>This guide, the <i>Security Hub API Reference</i>, provides
1742
+
* information about the Security Hub API. This includes supported resources, HTTP methods, parameters,
1743
+
* 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">
1744
+
* <i>Security Hub User Guide</i>
1745
+
* </a>. The
1746
+
* user guide explains key concepts and provides procedures
1747
+
* that demonstrate how to use Security Hub features. It also provides information about topics such as
1748
+
* integrating Security Hub with other Amazon Web Services.</p>
1749
+
* <p>In addition to interacting with Security Hub by making calls to the Security Hub API, you can
1750
+
* use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
1751
+
* and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
1752
+
* Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to
1753
+
* Security Hub and other Amazon Web Services . They also handle tasks such as signing requests,
1754
+
* managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
1755
+
* and SDKs, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
1756
+
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
1732
1757
* 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
1733
1758
* that results from the operation is applied only to that Region. To make the same change in
1734
-
* other Regions, run the same command for each Region in which you want to apply the change.</p>
1735
-
* <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
1736
-
* the member account with the administrator account is created only in the <code>us-west-2</code>
1737
-
* Region. Security Hub must be enabled for the member account in the same Region that the invitation
1738
-
* was sent from.</p>
1739
-
* <p>The following throttling limits apply to using Security Hub API operations.</p>
1759
+
* other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration,
1760
+
* API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of
1761
+
* central configuration operations, see the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html#central-configuration-concepts">Central configuration
1762
+
* terms and concepts</a> section of the <i>Security Hub User Guide</i>.</p>
1763
+
* <p>The following throttling limits apply to Security Hub API operations.</p>
* <p>Security Hub provides you with a comprehensive view of the security state of
635
-
* your Amazon Web Services environment and resources. It also provides you with the readiness
636
-
* status of your environment based on controls from supported security standards. Security Hub collects security data from Amazon Web Services accounts, services, and
637
-
* integrated third-party products and helps you analyze security trends in your environment
638
-
* 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">
639
-
* <i>Security Hub User
640
-
* Guide</i>
641
-
* </a>.</p>
642
-
* <p>When you use operations in the Security Hub API, the requests are executed only in
634
+
* <p>Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps
635
+
* you assess your Amazon Web Services environment against security industry standards and best practices.</p>
636
+
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
637
+
* supported third-party products and helps you analyze your security trends and identify the highest priority security
638
+
* issues.</p>
639
+
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
640
+
* These include the Amazon Web Services Foundational Security Best Practices (FSBP) standard developed by Amazon Web Services,
641
+
* and external compliance frameworks such as the Center for Internet Security (CIS), the Payment Card Industry Data
642
+
* Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes
643
+
* several security controls, each of which represents a security best practice. Security Hub runs checks against
644
+
* security controls and generates control findings to help you assess your compliance against security best practices.</p>
645
+
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
646
+
* such as Amazon GuardDuty and Amazon Inspector, and
647
+
* supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You
648
+
* can also send Security Hub findings to other Amazon Web Services and supported third-party products.</p>
649
+
* <p>Security Hub offers automation features that help you triage and remediate security issues. For example,
650
+
* you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with
651
+
* Amazon EventBridge to trigger automatic responses to specific findings.</p>
652
+
* <p>This guide, the <i>Security Hub API Reference</i>, provides
653
+
* information about the Security Hub API. This includes supported resources, HTTP methods, parameters,
654
+
* 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">
655
+
* <i>Security Hub User Guide</i>
656
+
* </a>. The
657
+
* user guide explains key concepts and provides procedures
658
+
* that demonstrate how to use Security Hub features. It also provides information about topics such as
659
+
* integrating Security Hub with other Amazon Web Services.</p>
660
+
* <p>In addition to interacting with Security Hub by making calls to the Security Hub API, you can
661
+
* use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools
662
+
* and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell,
663
+
* Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to
664
+
* Security Hub and other Amazon Web Services . They also handle tasks such as signing requests,
665
+
* managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools
666
+
* and SDKs, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
667
+
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
643
668
* 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
644
669
* that results from the operation is applied only to that Region. To make the same change in
645
-
* other Regions, run the same command for each Region in which you want to apply the change.</p>
646
-
* <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
647
-
* the member account with the administrator account is created only in the <code>us-west-2</code>
648
-
* Region. Security Hub must be enabled for the member account in the same Region that the invitation
649
-
* was sent from.</p>
650
-
* <p>The following throttling limits apply to using Security Hub API operations.</p>
670
+
* other Regions, call the same API operation in each Region in which you want to apply the change. When you use central configuration,
671
+
* API requests for enabling Security Hub, standards, and controls are executed in the home Region and all linked Regions. For a list of
672
+
* central configuration operations, see the <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/central-configuration-intro.html#central-configuration-concepts">Central configuration
673
+
* terms and concepts</a> section of the <i>Security Hub User Guide</i>.</p>
674
+
* <p>The following throttling limits apply to Security Hub API operations.</p>
0 commit comments