Skip to content

Commit 2953ff4

Browse files
author
awstools
committed
docs(client-securityhub): Documentation updates for AWS Security Hub
1 parent c087759 commit 2953ff4

23 files changed

+184
-139
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 Servicesservices, and
11+
<p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services services, 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 Servicesservices,
20+
<p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services services,
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 Servicesservices and supported third-party products.</p>
23+
can also send Security Hub findings to other Amazon Web Services services 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 Servicesservices.</p>
34+
integrating Security Hub with other Amazon Web Services services.</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 Servicesservices . They also handle tasks such as signing requests,
39+
Security Hub and other Amazon Web Services services . 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 Servicesservices, and
1749+
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services services, 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 Servicesservices,
1758+
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services services,
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 Servicesservices and supported third-party products.</p>
1761+
* can also send Security Hub findings to other Amazon Web Services services 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 Servicesservices.</p>
1772+
* integrating Security Hub with other Amazon Web Services services.</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 Servicesservices . They also handle tasks such as signing requests,
1777+
* Security Hub and other Amazon Web Services services . 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 Servicesservices, and
641+
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services services, 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 Servicesservices,
650+
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services services,
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 Servicesservices and supported third-party products.</p>
653+
* can also send Security Hub findings to other Amazon Web Services services 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 Servicesservices.</p>
664+
* integrating Security Hub with other Amazon Web Services services.</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 Servicesservices . They also handle tasks such as signing requests,
669+
* Security Hub and other Amazon Web Services services . 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/AcceptAdministratorInvitationCommand.ts

+6-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,12 @@ export interface AcceptAdministratorInvitationCommandOutput
3333
__MetadataBearer {}
3434

3535
/**
36-
* <p>Accepts the invitation to be a member account and be monitored by the Security Hub administrator
36+
* <note>
37+
* <p>We recommend using Organizations instead of Security Hub invitations to manage your member accounts.
38+
* For information, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html">Managing Security Hub administrator and member accounts with Organizations</a>
39+
* in the <i>Security Hub User Guide</i>.</p>
40+
* </note>
41+
* <p>Accepts the invitation to be a member account and be monitored by the Security Hub administrator
3742
* account that the invitation was sent from.</p>
3843
* <p>This operation is only used by member accounts that are not added through
3944
* Organizations.</p>

‎clients/client-securityhub/src/commands/BatchUpdateFindingsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export interface BatchUpdateFindingsCommandOutput extends BatchUpdateFindingsRes
3232
* Requested by administrator accounts or member accounts. Administrator accounts can update findings for
3333
* their account and their member accounts. Member accounts can update findings for their
3434
* account.</p>
35-
* <p>Updates from <code>BatchUpdateFindings</code> do not affect the value of
35+
* <p>Updates from <code>BatchUpdateFindings</code> don't affect the value of
3636
* <code>UpdatedAt</code> for a finding.</p>
3737
* <p>Administrator and member accounts can use <code>BatchUpdateFindings</code> to update the
3838
* following finding fields and objects.</p>

‎clients/client-securityhub/src/commands/CreateFindingAggregatorCommand.ts

+5-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,11 @@ export interface CreateFindingAggregatorCommandInput extends CreateFindingAggreg
2828
export interface CreateFindingAggregatorCommandOutput extends CreateFindingAggregatorResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Used to enable finding aggregation. Must be called from the aggregation Region.</p>
32-
* <p>For more details about cross-Region replication, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html">Configuring finding aggregation</a> in the <i>Security Hub User Guide</i>.
31+
* <note>
32+
* <p>The <i>aggregation Region</i> is now called the <i>home Region</i>.</p>
33+
* </note>
34+
* <p>Used to enable cross-Region aggregation. This operation can be invoked from the home Region only.</p>
35+
* <p>For information about how cross-Region aggregation works, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/finding-aggregation.html">Understanding cross-Region aggregation in Security Hub</a> in the <i>Security Hub User Guide</i>.
3336
* </p>
3437
* @example
3538
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-securityhub/src/commands/CreateMembersCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
5050
* then send an invitation to the member account. To send the invitation, you use the
5151
* <code>InviteMembers</code> operation. If the account owner accepts
5252
* the invitation, the account becomes a member account in Security Hub.</p>
53-
* <p>Accounts that are managed using Organizations do not receive an invitation. They
53+
* <p>Accounts that are managed using Organizations don't receive an invitation. They
5454
* automatically become a member account in Security Hub.</p>
5555
* <ul>
5656
* <li>

‎clients/client-securityhub/src/commands/DeclineInvitationsCommand.ts

+7-2
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,14 @@ export interface DeclineInvitationsCommandInput extends DeclineInvitationsReques
2828
export interface DeclineInvitationsCommandOutput extends DeclineInvitationsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Declines invitations to become a member account.</p>
31+
* <note>
32+
* <p>We recommend using Organizations instead of Security Hub invitations to manage your member accounts.
33+
* For information, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html">Managing Security Hub administrator and member accounts with Organizations</a>
34+
* in the <i>Security Hub User Guide</i>.</p>
35+
* </note>
36+
* <p>Declines invitations to become a Security Hub member account.</p>
3237
* <p>A prospective member account uses this operation to decline an invitation to become a member.</p>
33-
* <p>This operation is only called by member accounts that aren't part of an organization.
38+
* <p>Only member accounts that aren't part of an Amazon Web Services organization should use this operation.
3439
* Organization accounts don't receive invitations.</p>
3540
* @example
3641
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-securityhub/src/commands/DeleteFindingAggregatorCommand.ts

+7-2
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,13 @@ export interface DeleteFindingAggregatorCommandInput extends DeleteFindingAggreg
2828
export interface DeleteFindingAggregatorCommandOutput extends DeleteFindingAggregatorResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes a finding aggregator. When you delete the finding aggregator, you stop finding aggregation.</p>
32-
* <p>When you stop finding aggregation, findings that were already aggregated to the aggregation Region are still visible from the aggregation Region. New findings and finding updates are not aggregated.
31+
* <note>
32+
* <p>The <i>aggregation Region</i> is now called the <i>home Region</i>.</p>
33+
* </note>
34+
* <p>Deletes a finding aggregator. When you delete the finding aggregator, you stop cross-Region aggregation. Finding replication stops
35+
* occurring from the linked Regions to the home Region.</p>
36+
* <p>When you stop cross-Region aggregation, findings that were already replicated and sent to the home Region are still visible from
37+
* the home Region. However, new findings and finding updates are no longer replicated and sent to the home Region.
3338
* </p>
3439
* @example
3540
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-securityhub/src/commands/DeleteInvitationsCommand.ts

+8-3
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,14 @@ export interface DeleteInvitationsCommandInput extends DeleteInvitationsRequest
2828
export interface DeleteInvitationsCommandOutput extends DeleteInvitationsResponse, __MetadataBearer {}
2929

3030
/**
31-
* <p>Deletes invitations received by the Amazon Web Services account to become a member account.</p>
32-
* <p>A Security Hub administrator account can use this operation to delete invitations sent to one or more member accounts.</p>
33-
* <p>This operation is only used to delete invitations that are sent to member accounts that aren't part of an organization.
31+
* <note>
32+
* <p>We recommend using Organizations instead of Security Hub invitations to manage your member accounts.
33+
* For information, see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-accounts-orgs.html">Managing Security Hub administrator and member accounts with Organizations</a>
34+
* in the <i>Security Hub User Guide</i>.</p>
35+
* </note>
36+
* <p>Deletes invitations to become a Security Hub member account.</p>
37+
* <p>A Security Hub administrator account can use this operation to delete invitations sent to one or more prospective member accounts.</p>
38+
* <p>This operation is only used to delete invitations that are sent to prospective member accounts that aren't part of an Amazon Web Services organization.
3439
* Organization accounts don't receive invitations.</p>
3540
* @example
3641
* Use a bare-bones client and the command you need to make an API call.

‎clients/client-securityhub/src/commands/DescribeProductsCommand.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export interface DescribeProductsCommandOutput extends DescribeProductsResponse,
3131
* <p>Returns information about product integrations in Security Hub.</p>
3232
* <p>You can optionally provide an integration ARN. If you provide an integration ARN, then
3333
* the results only include that integration.</p>
34-
* <p>If you do not provide an integration ARN, then the results include all of the available
34+
* <p>If you don't provide an integration ARN, then the results include all of the available
3535
* product integrations. </p>
3636
* @example
3737
* Use a bare-bones client and the command you need to make an API call.

0 commit comments

Comments
 (0)