Skip to content

Commit

Permalink
feat(client-securityhub): Security Hub documentation and definition u…
Browse files Browse the repository at this point in the history
…pdates
  • Loading branch information
awstools committed Aug 21, 2024
1 parent 6fff363 commit 17db5f7
Show file tree
Hide file tree
Showing 9 changed files with 76 additions and 61 deletions.
10 changes: 5 additions & 5 deletions clients/client-securityhub/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ AWS SDK for JavaScript SecurityHub Client for Node.js, Browser and React Native.

<p>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.</p>
<p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
<p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and
supported third-party products and helps you analyze your security trends and identify the highest priority security
issues.</p>
<p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
Expand All @@ -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.</p>
<p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
<p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices,
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 Services and supported third-party products.</p>
can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.</p>
<p>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.</p>
Expand All @@ -31,12 +31,12 @@ and schemas. If you're new to Security Hub, you might find it helpful to also re
</a>. 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 Services.</p>
integrating Security Hub with other Amazon Web Servicesservices.</p>
<p>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 Services . They also handle tasks such as signing requests,
Security Hub and other Amazon Web Servicesservices . 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 <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
<p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
Expand Down
10 changes: 5 additions & 5 deletions clients/client-securityhub/src/SecurityHub.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1746,7 +1746,7 @@ export interface SecurityHub {
/**
* <p>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.</p>
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and
* supported third-party products and helps you analyze your security trends and identify the highest priority security
* issues.</p>
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
Expand All @@ -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.</p>
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices,
* 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 Services and supported third-party products.</p>
* can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.</p>
* <p>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.</p>
Expand All @@ -1769,12 +1769,12 @@ export interface SecurityHub {
* </a>. 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 Services.</p>
* integrating Security Hub with other Amazon Web Servicesservices.</p>
* <p>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 Services . They also handle tasks such as signing requests,
* Security Hub and other Amazon Web Servicesservices . 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 <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
Expand Down
10 changes: 5 additions & 5 deletions clients/client-securityhub/src/SecurityHubClient.ts
Original file line number Diff line number Diff line change
Expand Up @@ -638,7 +638,7 @@ export interface SecurityHubClientResolvedConfig extends SecurityHubClientResolv
/**
* <p>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.</p>
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and
* supported third-party products and helps you analyze your security trends and identify the highest priority security
* issues.</p>
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
Expand All @@ -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.</p>
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices,
* 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 Services and supported third-party products.</p>
* can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.</p>
* <p>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.</p>
Expand All @@ -661,12 +661,12 @@ export interface SecurityHubClientResolvedConfig extends SecurityHubClientResolv
* </a>. 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 Services.</p>
* integrating Security Hub with other Amazon Web Servicesservices.</p>
* <p>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 Services . They also handle tasks such as signing requests,
* Security Hub and other Amazon Web Servicesservices . 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 <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,12 @@ export interface UpdateFindingsCommandOutput extends UpdateFindingsResponse, __M
* <p>
* <code>UpdateFindings</code> is a deprecated operation. Instead of <code>UpdateFindings</code>, use
* the <code>BatchUpdateFindings</code> operation.</p>
* <p>Updates the <code>Note</code> and <code>RecordState</code> of the Security Hub-aggregated
* <p>The <code>UpdateFindings</code> operation updates the <code>Note</code> and <code>RecordState</code> of the Security Hub aggregated
* findings that the filter attributes specify. Any member account that can view the finding
* also sees the update to the finding.</p>
* <p>Finding updates made with <code>UpdateFindings</code> might not be persisted if the same finding is later updated by the
* finding provider through the <code>BatchImportFindings</code> operation.</p>
* can also see the update to the finding.</p>
* <p>Finding updates made with <code>UpdateFindings</code> aren't persisted if the same finding is later updated by the
* finding provider through the <code>BatchImportFindings</code> operation. In addition, Security Hub doesn't
* record updates made with <code>UpdateFindings</code> in the finding history.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
Expand Down
10 changes: 5 additions & 5 deletions clients/client-securityhub/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
/**
* <p>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.</p>
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Services, and
* <p>Security Hub collects security data across Amazon Web Services accounts, Amazon Web Servicesservices, and
* supported third-party products and helps you analyze your security trends and identify the highest priority security
* issues.</p>
* <p>To help you manage the security state of your organization, Security Hub supports multiple security standards.
Expand All @@ -12,10 +12,10 @@
* 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.</p>
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Services,
* <p>In addition to generating control findings, Security Hub also receives findings from other Amazon Web Servicesservices,
* 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 Services and supported third-party products.</p>
* can also send Security Hub findings to other Amazon Web Servicesservices and supported third-party products.</p>
* <p>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.</p>
Expand All @@ -26,12 +26,12 @@
* </a>. 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 Services.</p>
* integrating Security Hub with other Amazon Web Servicesservices.</p>
* <p>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 Services . They also handle tasks such as signing requests,
* Security Hub and other Amazon Web Servicesservices . 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 <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>.</p>
* <p>With the exception of operations that are related to central configuration, Security Hub API requests are executed only in
Expand Down
4 changes: 2 additions & 2 deletions clients/client-securityhub/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1965,7 +1965,7 @@ export interface AutomationRulesFindingFilters {
* <p>
* The identifier for the given resource type. For Amazon Web Services resources that are identified by
* Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs,
* this is the identifier as defined by the Amazon Web Service that created the resource.
* this is the identifier as defined by the Amazon Web Servicesservice that created the resource.
* For non-Amazon Web Services resources, this is a unique identifier that is associated with the
* resource.
* </p>
Expand Down Expand Up @@ -10662,7 +10662,7 @@ export interface RouteSetDetails {

/**
* <p>
* The prefix of the destination Amazon Web Service.
* The prefix of the destination Amazon Web Servicesservice.
* </p>
* @public
*/
Expand Down
2 changes: 1 addition & 1 deletion clients/client-securityhub/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10045,7 +10045,7 @@ export interface Compliance {
/**
* <p>
* The unique identifier of a control across standards. Values for this field typically consist of an
* Amazon Web Service and a number, such as APIGateway.5.
* Amazon Web Servicesservice and a number, such as APIGateway.5.
* </p>
* @public
*/
Expand Down
Loading

0 comments on commit 17db5f7

Please sign in to comment.