From 511c677be3b02d3055323c1cbfccb410fb1e2154 Mon Sep 17 00:00:00 2001 From: awstools Date: Wed, 15 May 2024 18:11:49 +0000 Subject: [PATCH] docs(client-securityhub): Documentation-only update for AWS Security Hub --- .../client-securityhub/src/models/models_0.ts | 8 ++ .../client-securityhub/src/models/models_1.ts | 30 +++- .../client-securityhub/src/models/models_2.ts | 53 +++++-- .../sdk-codegen/aws-models/securityhub.json | 132 +++++++++--------- 4 files changed, 141 insertions(+), 82 deletions(-) diff --git a/clients/client-securityhub/src/models/models_0.ts b/clients/client-securityhub/src/models/models_0.ts index 4fe4bb2f75480..8489b4880398a 100644 --- a/clients/client-securityhub/src/models/models_0.ts +++ b/clients/client-securityhub/src/models/models_0.ts @@ -219,6 +219,7 @@ export interface AccountDetails { export interface AwsApiCallActionDomainDetails { /** *

The name of the DNS domain that issued the API call.

+ *

Length Constraints: 128.

* @public */ Domain?: string; @@ -349,12 +350,14 @@ export interface ActionRemoteIpDetails { export interface AwsApiCallAction { /** *

The name of the API method that was issued.

+ *

Length Constraints: 128.

* @public */ Api?: string; /** *

The name of the Amazon Web Services service that the API method belongs to.

+ *

Length Constraints: 128.

* @public */ ServiceName?: string; @@ -459,12 +462,14 @@ export interface AwsApiCallAction { export interface DnsRequestAction { /** *

The DNS domain that is associated with the DNS request.

+ *

Length Constraints: 128.

* @public */ Domain?: string; /** *

The protocol that was used for the DNS request.

+ *

Length Constraints: Minimum length of 1. Maximum length of 64.

* @public */ Protocol?: string; @@ -491,6 +496,7 @@ export interface ActionLocalPortDetails { /** *

The port name of the local connection.

+ *

Length Constraints: 128.

* @public */ PortName?: string; @@ -510,6 +516,7 @@ export interface ActionRemotePortDetails { /** *

The port name of the remote connection.

+ *

Length Constraints: 128.

* @public */ PortName?: string; @@ -549,6 +556,7 @@ export interface NetworkConnectionAction { /** *

The protocol used to make the network connection request.

+ *

Length Constraints: Minimum length of 1. Maximum length of 64.

* @public */ Protocol?: string; diff --git a/clients/client-securityhub/src/models/models_1.ts b/clients/client-securityhub/src/models/models_1.ts index 1181930860af2..d796507f2298c 100644 --- a/clients/client-securityhub/src/models/models_1.ts +++ b/clients/client-securityhub/src/models/models_1.ts @@ -10016,8 +10016,8 @@ export interface Compliance { * NOT_AVAILABLE - Check could not be performed due to a service * outage, API error, or because the result of the Config evaluation was * NOT_APPLICABLE. If the Config evaluation result was - * NOT_APPLICABLE, then after 3 days, Security Hub automatically archives - * the finding.

+ * NOT_APPLICABLE for a Security Hub control, Security Hub automatically archives + * the finding after 3 days.

* * * @@ -10029,6 +10029,7 @@ export interface Compliance { /** *

For a control, the industry or regulatory framework requirements that are related to the * control. The check for that control is aligned with these requirements.

+ *

Array Members: Maximum number of 32 items.

* @public */ RelatedRequirements?: string[]; @@ -10079,6 +10080,7 @@ export interface FindingProviderSeverity { /** *

The finding provider's original value for the severity.

+ *

Length Constraints: Minimum length of 1. Maximum length of 64.

* @public */ Original?: string; @@ -10158,6 +10160,7 @@ export interface GeneratorDetails { *

* An array of tags used to identify the detector associated with the finding. *

+ *

Array Members: Minimum number of 0 items. Maximum number of 10 items.

* @public */ Labels?: string[]; @@ -10212,6 +10215,7 @@ export type MalwareType = (typeof MalwareType)[keyof typeof MalwareType]; export interface Malware { /** *

The name of the malware that was observed.

+ *

Length Constraints: Minimum of 1. Maximum of 64.

* @public */ Name: string | undefined; @@ -10224,6 +10228,7 @@ export interface Malware { /** *

The file system path of the malware that was observed.

+ *

Length Constraints: Minimum of 1. Maximum of 512.

* @public */ Path?: string; @@ -10280,6 +10285,7 @@ export interface Network { /** *

The protocol of network-related information about a finding.

+ *

Length Constraints: Minimum of 1. Maximum of 16.

* @public */ Protocol?: string; @@ -10310,6 +10316,7 @@ export interface Network { /** *

The source domain of network-related information about a finding.

+ *

Length Constraints: Minimum of 1. Maximum of 128.

* @public */ SourceDomain?: string; @@ -10341,6 +10348,7 @@ export interface Network { /** *

The destination domain of network-related information about a finding.

+ *

Length Constraints: Minimum of 1. Maximum of 128.

* @public */ DestinationDomain?: string; @@ -10372,6 +10380,7 @@ export interface NetworkPathComponentDetails { export interface NetworkHeader { /** *

The protocol used for the component.

+ *

Length Constraints: Minimum of 1. Maximum of 16.

* @public */ Protocol?: string; @@ -10396,12 +10405,14 @@ export interface NetworkHeader { export interface NetworkPathComponent { /** *

The identifier of a component in the network path.

+ *

Length Constraints: Minimum of 1. Maximum of 32.

* @public */ ComponentId?: string; /** *

The type of component.

+ *

Length Constraints: Minimum of 1. Maximum of 32.

* @public */ ComponentType?: string; @@ -10428,6 +10439,7 @@ export interface NetworkPathComponent { export interface Note { /** *

The text of a note.

+ *

Length Constraints: Minimum of 1. Maximum of 512.

* @public */ Text: string | undefined; @@ -10479,6 +10491,7 @@ export interface PatchSummary { /** *

The identifier of the compliance standard that was used to determine the patch * compliance status.

+ *

Length Constraints: Minimum length of 1. Maximum length of 256.

* @public */ Id: string | undefined; @@ -10486,6 +10499,7 @@ export interface PatchSummary { /** *

The number of patches from the compliance standard that were installed * successfully.

+ *

The value can be an integer from 0 to 100000.

* @public */ InstalledCount?: number; @@ -10493,18 +10507,21 @@ export interface PatchSummary { /** *

The number of patches that are part of the compliance standard but are not installed. * The count includes patches that failed to install.

+ *

The value can be an integer from 0 to 100000.

* @public */ MissingCount?: number; /** *

The number of patches from the compliance standard that failed to install.

+ *

The value can be an integer from 0 to 100000.

* @public */ FailedCount?: number; /** *

The number of installed patches that are not part of the compliance standard.

+ *

The value can be an integer from 0 to 100000.

* @public */ InstalledOtherCount?: number; @@ -10512,6 +10529,7 @@ export interface PatchSummary { /** *

The number of patches that are installed but are also on a list of patches that the * customer rejected.

+ *

The value can be an integer from 0 to 100000.

* @public */ InstalledRejectedCount?: number; @@ -10519,6 +10537,7 @@ export interface PatchSummary { /** *

The number of patches that were applied, but that require the instance to be rebooted in * order to be marked as installed.

+ *

The value can be an integer from 0 to 100000.

* @public */ InstalledPendingReboot?: number; @@ -10587,13 +10606,15 @@ export interface PatchSummary { /** *

The reboot option specified for the instance.

+ *

Length Constraints: Minimum length of 1. Maximum length of 256.

* @public */ RebootOption?: string; /** *

The type of patch operation performed. For Patch Manager, the values are - * SCAN and INSTALL.

+ * SCAN and INSTALL.

+ *

Length Constraints: Minimum length of 1. Maximum length of 256.

* @public */ Operation?: string; @@ -10606,12 +10627,14 @@ export interface PatchSummary { export interface ProcessDetails { /** *

The name of the process.

+ *

Length Constraints: Minimum of 1. Maximum of 64.

* @public */ Name?: string; /** *

The path to the process executable.

+ *

Length Constraints: Minimum of 1. Maximum of 512.

* @public */ Path?: string; @@ -10712,6 +10735,7 @@ export type RecordState = (typeof RecordState)[keyof typeof RecordState]; export interface Recommendation { /** *

Describes the recommended steps to take to remediate an issue identified in a finding.

+ *

Length Constraints: Minimum of 1 length. Maximum of 512 length.

* @public */ Text?: string; diff --git a/clients/client-securityhub/src/models/models_2.ts b/clients/client-securityhub/src/models/models_2.ts index 0e29f28d9d885..7fa544de0c9a9 100644 --- a/clients/client-securityhub/src/models/models_2.ts +++ b/clients/client-securityhub/src/models/models_2.ts @@ -1851,6 +1851,7 @@ export interface Resource { * is an EC2 instance, then set Type to AwsEc2Instance.

*

If the resource does not match any of the provided types, then set Type to * Other.

+ *

Length Constraints: Minimum length of 1. Maximum length of 256.

* @public */ Type: string | undefined; @@ -1869,6 +1870,7 @@ export interface Resource { /** *

The canonical Amazon Web Services external Region name where this resource is located.

+ *

Length Constraints: Minimum length of 1. Maximum length of 16.

* @public */ Region?: string; @@ -1881,7 +1883,7 @@ export interface Resource { /** *

A list of Amazon Web Services tags associated with a resource at the time the finding was - * processed.

+ * processed. Tags must follow Amazon Web Services tag naming limits and requirements.

* @public */ Tags?: Record; @@ -1992,6 +1994,7 @@ export interface Severity { /** *

Deprecated. The normalized severity of a finding. * Instead of providing Normalized, provide Label.

+ *

The value of Normalized can be an integer between 0 and 100.

*

If you provide Label and do not provide Normalized, then * Normalized is set automatically as follows.

*