From 2953ff4ddd10a561097b3195aef5b17de9580d2c Mon Sep 17 00:00:00 2001 From: awstools Date: Fri, 27 Sep 2024 18:43:01 +0000 Subject: [PATCH] docs(client-securityhub): Documentation updates for AWS Security Hub --- clients/client-securityhub/README.md | 10 +- clients/client-securityhub/src/SecurityHub.ts | 10 +- .../src/SecurityHubClient.ts | 10 +- .../AcceptAdministratorInvitationCommand.ts | 7 +- .../commands/BatchUpdateFindingsCommand.ts | 2 +- .../CreateFindingAggregatorCommand.ts | 7 +- .../src/commands/CreateMembersCommand.ts | 2 +- .../src/commands/DeclineInvitationsCommand.ts | 9 +- .../DeleteFindingAggregatorCommand.ts | 9 +- .../src/commands/DeleteInvitationsCommand.ts | 11 +- .../src/commands/DescribeProductsCommand.ts | 2 +- .../commands/GetFindingAggregatorCommand.ts | 6 +- .../src/commands/GetFindingsCommand.ts | 2 +- .../commands/GetInvitationsCountCommand.ts | 9 +- .../src/commands/InviteMembersCommand.ts | 13 ++- .../commands/ListFindingAggregatorsCommand.ts | 3 +- .../src/commands/ListInvitationsCommand.ts | 11 +- .../UpdateFindingAggregatorCommand.ts | 8 +- clients/client-securityhub/src/index.ts | 10 +- .../client-securityhub/src/models/models_0.ts | 25 ++--- .../client-securityhub/src/models/models_1.ts | 4 +- .../client-securityhub/src/models/models_2.ts | 51 ++++----- .../sdk-codegen/aws-models/securityhub.json | 102 +++++++++--------- 23 files changed, 184 insertions(+), 139 deletions(-) diff --git a/clients/client-securityhub/README.md b/clients/client-securityhub/README.md index 8c140737a0bb..3addb08d5417 100644 --- a/clients/client-securityhub/README.md +++ b/clients/client-securityhub/README.md @@ -8,7 +8,7 @@ AWS SDK for JavaScript SecurityHub Client for Node.js, Browser and React Native.

Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps you assess your Amazon Web Services environment against security industry standards and best practices.

-

Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and +

Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services services, and supported third-party products and helps you analyze your security trends and identify the highest priority security issues.

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 Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes several security controls, each of which represents a security best practice. Security Hub runs checks against security controls and generates control findings to help you assess your compliance against security best practices.

-

In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices, +

In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services services, such as Amazon GuardDuty and Amazon Inspector, and supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You -can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.

+can also send Security Hub findings to other Amazon Web Services services and supported third-party products.

Security Hub offers automation features that help you triage and remediate security issues. For example, you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with Amazon EventBridge to trigger automatic responses to specific findings.

@@ -31,12 +31,12 @@ and schemas. If you're new to Security Hub, you might find it helpful to also re . The user guide explains key concepts and provides procedures that demonstrate how to use Security Hub features. It also provides information about topics such as -integrating Security Hub with other Amazon Web Servicesservices.

+integrating Security Hub with other Amazon Web Services services.

In addition to interacting with Security Hub by making calls to the Security Hub API, you can use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell, Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to -Security Hub and other Amazon Web Servicesservices . They also handle tasks such as signing requests, +Security Hub and other Amazon Web Services services . They also handle tasks such as signing requests, managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools and SDKs, see Tools to Build on Amazon Web Services.

With the exception of operations that are related to central configuration, Security Hub API requests are executed only in diff --git a/clients/client-securityhub/src/SecurityHub.ts b/clients/client-securityhub/src/SecurityHub.ts index 728f3d9abca7..4712657e5fba 100644 --- a/clients/client-securityhub/src/SecurityHub.ts +++ b/clients/client-securityhub/src/SecurityHub.ts @@ -1746,7 +1746,7 @@ export interface SecurityHub { /** *

Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps * you assess your Amazon Web Services environment against security industry standards and best practices.

- *

Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and + *

Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services services, and * supported third-party products and helps you analyze your security trends and identify the highest priority security * issues.

*

To help you manage the security state of your organization, Security Hub supports multiple security standards. @@ -1755,10 +1755,10 @@ export interface SecurityHub { * Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes * several security controls, each of which represents a security best practice. Security Hub runs checks against * security controls and generates control findings to help you assess your compliance against security best practices.

- *

In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices, + *

In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services services, * such as Amazon GuardDuty and Amazon Inspector, and * supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You - * can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.

+ * can also send Security Hub findings to other Amazon Web Services services and supported third-party products.

*

Security Hub offers automation features that help you triage and remediate security issues. For example, * you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with * Amazon EventBridge to trigger automatic responses to specific findings.

@@ -1769,12 +1769,12 @@ export interface SecurityHub { * . The * user guide explains key concepts and provides procedures * that demonstrate how to use Security Hub features. It also provides information about topics such as - * integrating Security Hub with other Amazon Web Servicesservices.

+ * integrating Security Hub with other Amazon Web Services services.

*

In addition to interacting with Security Hub by making calls to the Security Hub API, you can * use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools * and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell, * Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to - * Security Hub and other Amazon Web Servicesservices . They also handle tasks such as signing requests, + * Security Hub and other Amazon Web Services services . They also handle tasks such as signing requests, * managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools * and SDKs, see Tools to Build on Amazon Web Services.

*

With the exception of operations that are related to central configuration, Security Hub API requests are executed only in diff --git a/clients/client-securityhub/src/SecurityHubClient.ts b/clients/client-securityhub/src/SecurityHubClient.ts index 3fcb5911a997..455b4881dde9 100644 --- a/clients/client-securityhub/src/SecurityHubClient.ts +++ b/clients/client-securityhub/src/SecurityHubClient.ts @@ -638,7 +638,7 @@ export interface SecurityHubClientResolvedConfig extends SecurityHubClientResolv /** *

Security Hub provides you with a comprehensive view of your security state in Amazon Web Services and helps * you assess your Amazon Web Services environment against security industry standards and best practices.

- *

Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and + *

Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services services, and * supported third-party products and helps you analyze your security trends and identify the highest priority security * issues.

*

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 * Security Standard (PCI DSS), and the National Institute of Standards and Technology (NIST). Each standard includes * several security controls, each of which represents a security best practice. Security Hub runs checks against * security controls and generates control findings to help you assess your compliance against security best practices.

- *

In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices, + *

In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services services, * such as Amazon GuardDuty and Amazon Inspector, and * supported third-party products. This gives you a single pane of glass into a variety of security-related issues. You - * can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.

+ * can also send Security Hub findings to other Amazon Web Services services and supported third-party products.

*

Security Hub offers automation features that help you triage and remediate security issues. For example, * you can use automation rules to automatically update critical findings when a security check fails. You can also leverage the integration with * Amazon EventBridge to trigger automatic responses to specific findings.

@@ -661,12 +661,12 @@ export interface SecurityHubClientResolvedConfig extends SecurityHubClientResolv * . The * user guide explains key concepts and provides procedures * that demonstrate how to use Security Hub features. It also provides information about topics such as - * integrating Security Hub with other Amazon Web Servicesservices.

+ * integrating Security Hub with other Amazon Web Services services.

*

In addition to interacting with Security Hub by making calls to the Security Hub API, you can * use a current version of an Amazon Web Services command line tool or SDK. Amazon Web Services provides tools * and SDKs that consist of libraries and sample code for various languages and platforms, such as PowerShell, * Java, Go, Python, C++, and .NET. These tools and SDKs provide convenient, programmatic access to - * Security Hub and other Amazon Web Servicesservices . They also handle tasks such as signing requests, + * Security Hub and other Amazon Web Services services . They also handle tasks such as signing requests, * managing errors, and retrying requests automatically. For information about installing and using the Amazon Web Services tools * and SDKs, see Tools to Build on Amazon Web Services.

*

With the exception of operations that are related to central configuration, Security Hub API requests are executed only in diff --git a/clients/client-securityhub/src/commands/AcceptAdministratorInvitationCommand.ts b/clients/client-securityhub/src/commands/AcceptAdministratorInvitationCommand.ts index b22b9b3d6699..a7f5a02275f5 100644 --- a/clients/client-securityhub/src/commands/AcceptAdministratorInvitationCommand.ts +++ b/clients/client-securityhub/src/commands/AcceptAdministratorInvitationCommand.ts @@ -33,7 +33,12 @@ export interface AcceptAdministratorInvitationCommandOutput __MetadataBearer {} /** - *

Accepts the invitation to be a member account and be monitored by the Security Hub administrator + * + *

We recommend using Organizations instead of Security Hub invitations to manage your member accounts. + * For information, see Managing Security Hub administrator and member accounts with Organizations + * in the Security Hub User Guide.

+ * + *

Accepts the invitation to be a member account and be monitored by the Security Hub administrator * account that the invitation was sent from.

*

This operation is only used by member accounts that are not added through * Organizations.

diff --git a/clients/client-securityhub/src/commands/BatchUpdateFindingsCommand.ts b/clients/client-securityhub/src/commands/BatchUpdateFindingsCommand.ts index 257d849b3b32..f9d74364cb8d 100644 --- a/clients/client-securityhub/src/commands/BatchUpdateFindingsCommand.ts +++ b/clients/client-securityhub/src/commands/BatchUpdateFindingsCommand.ts @@ -32,7 +32,7 @@ export interface BatchUpdateFindingsCommandOutput extends BatchUpdateFindingsRes * Requested by administrator accounts or member accounts. Administrator accounts can update findings for * their account and their member accounts. Member accounts can update findings for their * account.

- *

Updates from BatchUpdateFindings do not affect the value of + *

Updates from BatchUpdateFindings don't affect the value of * UpdatedAt for a finding.

*

Administrator and member accounts can use BatchUpdateFindings to update the * following finding fields and objects.

diff --git a/clients/client-securityhub/src/commands/CreateFindingAggregatorCommand.ts b/clients/client-securityhub/src/commands/CreateFindingAggregatorCommand.ts index 1e33bfe8b3a4..e82ad0be9940 100644 --- a/clients/client-securityhub/src/commands/CreateFindingAggregatorCommand.ts +++ b/clients/client-securityhub/src/commands/CreateFindingAggregatorCommand.ts @@ -28,8 +28,11 @@ export interface CreateFindingAggregatorCommandInput extends CreateFindingAggreg export interface CreateFindingAggregatorCommandOutput extends CreateFindingAggregatorResponse, __MetadataBearer {} /** - *

Used to enable finding aggregation. Must be called from the aggregation Region.

- *

For more details about cross-Region replication, see Configuring finding aggregation in the Security Hub User Guide. + * + *

The aggregation Region is now called the home Region.

+ * + *

Used to enable cross-Region aggregation. This operation can be invoked from the home Region only.

+ *

For information about how cross-Region aggregation works, see Understanding cross-Region aggregation in Security Hub in the Security Hub User Guide. *

* @example * Use a bare-bones client and the command you need to make an API call. diff --git a/clients/client-securityhub/src/commands/CreateMembersCommand.ts b/clients/client-securityhub/src/commands/CreateMembersCommand.ts index 0e354bf620f8..088f81b42a30 100644 --- a/clients/client-securityhub/src/commands/CreateMembersCommand.ts +++ b/clients/client-securityhub/src/commands/CreateMembersCommand.ts @@ -50,7 +50,7 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met * then send an invitation to the member account. To send the invitation, you use the * InviteMembers operation. If the account owner accepts * the invitation, the account becomes a member account in Security Hub.

- *

Accounts that are managed using Organizations do not receive an invitation. They + *

Accounts that are managed using Organizations don't receive an invitation. They * automatically become a member account in Security Hub.

* - *

If you provide Normalized and do not provide Label, then + *

If you provide Normalized and don't provide Label, then * Label is set automatically as follows.

*