@aws-sdk/client-securityhub 3.576.0 → 3.577.0

package/dist-types/models/models_0.d.ts

@@ -150,6 +150,7 @@ export interface AccountDetails {
 export interface AwsApiCallActionDomainDetails {
     /**
      * <p>The name of the DNS domain that issued the API call.</p>
+     *          <p>Length Constraints: 128.</p>
      * @public
      */
     Domain?: string;
@@ -265,11 +266,13 @@ export interface ActionRemoteIpDetails {
 export interface AwsApiCallAction {
     /**
      * <p>The name of the API method that was issued.</p>
+     *          <p>Length Constraints: 128.</p>
      * @public
      */
     Api?: string;
     /**
      * <p>The name of the Amazon Web Services service that the API method belongs to.</p>
+     *          <p>Length Constraints: 128.</p>
      * @public
      */
     ServiceName?: string;
@@ -367,11 +370,13 @@ export interface AwsApiCallAction {
 export interface DnsRequestAction {
     /**
      * <p>The DNS domain that is associated with the DNS request.</p>
+     *          <p>Length Constraints: 128.</p>
      * @public
      */
     Domain?: string;
     /**
      * <p>The protocol that was used for the DNS request.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 64.</p>
      * @public
      */
     Protocol?: string;
@@ -395,6 +400,7 @@ export interface ActionLocalPortDetails {
     Port?: number;
     /**
      * <p>The port name of the local connection.</p>
+     *          <p>Length Constraints: 128.</p>
      * @public
      */
     PortName?: string;
@@ -412,6 +418,7 @@ export interface ActionRemotePortDetails {
     Port?: number;
     /**
      * <p>The port name of the remote connection.</p>
+     *          <p>Length Constraints: 128.</p>
      * @public
      */
     PortName?: string;
@@ -446,6 +453,7 @@ export interface NetworkConnectionAction {
     LocalPortDetails?: ActionLocalPortDetails;
     /**
      * <p>The protocol used to make the network connection request.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 64.</p>
      * @public
      */
     Protocol?: string;

package/dist-types/models/models_1.d.ts

@@ -8920,8 +8920,8 @@ export interface Compliance {
      *                         <code>NOT_AVAILABLE</code> - Check could not be performed due to a service
      *                      outage, API error, or because the result of the Config evaluation was
      *                         <code>NOT_APPLICABLE</code>. If the Config evaluation result was
-     *                      <code>NOT_APPLICABLE</code>, then after 3 days, Security Hub automatically archives
-     *                      the finding.</p>
+     *                      <code>NOT_APPLICABLE</code> for a Security Hub control, Security Hub automatically archives
+     *                      the finding after 3 days.</p>
      *                   </li>
      *                </ul>
      *             </li>
@@ -8932,6 +8932,7 @@ export interface Compliance {
     /**
      * <p>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.</p>
+     *          <p>Array Members: Maximum number of 32 items.</p>
      * @public
      */
     RelatedRequirements?: string[];
@@ -8976,6 +8977,7 @@ export interface FindingProviderSeverity {
     Label?: SeverityLabel;
     /**
      * <p>The finding provider's original value for the severity.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 64.</p>
      * @public
      */
     Original?: string;
@@ -9047,6 +9049,7 @@ export interface GeneratorDetails {
      * <p>
      *             An array of tags used to identify the detector associated with the finding.
      *         </p>
+     *          <p>Array Members: Minimum number of 0 items. Maximum number of 10 items.</p>
      * @public
      */
     Labels?: string[];
@@ -9096,6 +9099,7 @@ export type MalwareType = (typeof MalwareType)[keyof typeof MalwareType];
 export interface Malware {
     /**
      * <p>The name of the malware that was observed.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 64.</p>
      * @public
      */
     Name: string | undefined;
@@ -9106,6 +9110,7 @@ export interface Malware {
     Type?: MalwareType;
     /**
      * <p>The file system path of the malware that was observed.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 512.</p>
      * @public
      */
     Path?: string;
@@ -9155,6 +9160,7 @@ export interface Network {
     Direction?: NetworkDirection;
     /**
      * <p>The protocol of network-related information about a finding.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 16.</p>
      * @public
      */
     Protocol?: string;
@@ -9180,6 +9186,7 @@ export interface Network {
     SourcePort?: number;
     /**
      * <p>The source domain of network-related information about a finding.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 128.</p>
      * @public
      */
     SourceDomain?: string;
@@ -9206,6 +9213,7 @@ export interface Network {
     DestinationPort?: number;
     /**
      * <p>The destination domain of network-related information about a finding.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 128.</p>
      * @public
      */
     DestinationDomain?: string;
@@ -9234,6 +9242,7 @@ export interface NetworkPathComponentDetails {
 export interface NetworkHeader {
     /**
      * <p>The protocol used for the component.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 16.</p>
      * @public
      */
     Protocol?: string;
@@ -9255,11 +9264,13 @@ export interface NetworkHeader {
 export interface NetworkPathComponent {
     /**
      * <p>The identifier of a component in the network path.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 32.</p>
      * @public
      */
     ComponentId?: string;
     /**
      * <p>The type of component.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 32.</p>
      * @public
      */
     ComponentType?: string;
@@ -9283,6 +9294,7 @@ export interface NetworkPathComponent {
 export interface Note {
     /**
      * <p>The text of a note.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 512.</p>
      * @public
      */
     Text: string | undefined;
@@ -9331,40 +9343,47 @@ export interface PatchSummary {
     /**
      * <p>The identifier of the compliance standard that was used to determine the patch
      *          compliance status.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>
      * @public
      */
     Id: string | undefined;
     /**
      * <p>The number of patches from the compliance standard that were installed
      *          successfully.</p>
+     *          <p>The value can be an integer from <code>0</code> to <code>100000</code>.</p>
      * @public
      */
     InstalledCount?: number;
     /**
      * <p>The number of patches that are part of the compliance standard but are not installed.
      *          The count includes patches that failed to install.</p>
+     *          <p>The value can be an integer from <code>0</code> to <code>100000</code>.</p>
      * @public
      */
     MissingCount?: number;
     /**
      * <p>The number of patches from the compliance standard that failed to install.</p>
+     *          <p>The value can be an integer from <code>0</code> to <code>100000</code>.</p>
      * @public
      */
     FailedCount?: number;
     /**
      * <p>The number of installed patches that are not part of the compliance standard.</p>
+     *          <p>The value can be an integer from <code>0</code> to <code>100000</code>.</p>
      * @public
      */
     InstalledOtherCount?: number;
     /**
      * <p>The number of patches that are installed but are also on a list of patches that the
      *          customer rejected.</p>
+     *          <p>The value can be an integer from <code>0</code> to <code>100000</code>.</p>
      * @public
      */
     InstalledRejectedCount?: number;
     /**
      * <p>The number of patches that were applied, but that require the instance to be rebooted in
      *          order to be marked as installed.</p>
+     *          <p>The value can be an integer from <code>0</code> to <code>100000</code>.</p>
      * @public
      */
     InstalledPendingReboot?: number;
@@ -9430,12 +9449,14 @@ export interface PatchSummary {
     OperationEndTime?: string;
     /**
      * <p>The reboot option specified for the instance.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>
      * @public
      */
     RebootOption?: string;
     /**
      * <p>The type of patch operation performed. For Patch Manager, the values are
-     *             <code>SCAN</code> and <code>INSTALL</code>. </p>
+     *             <code>SCAN</code> and <code>INSTALL</code>.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>
      * @public
      */
     Operation?: string;
@@ -9447,11 +9468,13 @@ export interface PatchSummary {
 export interface ProcessDetails {
     /**
      * <p>The name of the process.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 64.</p>
      * @public
      */
     Name?: string;
     /**
      * <p>The path to the process executable.</p>
+     *          <p>Length Constraints: Minimum of 1. Maximum of 512.</p>
      * @public
      */
     Path?: string;
@@ -9545,6 +9568,7 @@ export type RecordState = (typeof RecordState)[keyof typeof RecordState];
 export interface Recommendation {
     /**
      * <p>Describes the recommended steps to take to remediate an issue identified in a finding.</p>
+     *          <p>Length Constraints: Minimum of 1 length. Maximum of 512 length.</p>
      * @public
      */
     Text?: string;

package/dist-types/models/models_2.d.ts

@@ -1518,6 +1518,7 @@ export interface Resource {
      *          is an EC2 instance, then set <code>Type</code> to <code>AwsEc2Instance</code>.</p>
      *          <p>If the resource does not match any of the provided types, then set <code>Type</code> to
      *             <code>Other</code>. </p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>
      * @public
      */
     Type: string | undefined;
@@ -1533,6 +1534,7 @@ export interface Resource {
     Partition?: Partition;
     /**
      * <p>The canonical Amazon Web Services external Region name where this resource is located.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 16.</p>
      * @public
      */
     Region?: string;
@@ -1543,7 +1545,7 @@ export interface Resource {
     ResourceRole?: string;
     /**
      * <p>A list of Amazon Web Services tags associated with a resource at the time the finding was
-     *          processed.</p>
+     *           processed. Tags must follow <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/tagging.html#tag-conventions">Amazon Web Services tag naming limits and requirements</a>.</p>
      * @public
      */
     Tags?: Record<string, string>;
@@ -1647,6 +1649,7 @@ export interface Severity {
     /**
      * <p>Deprecated. The normalized severity of a finding.
      *          Instead of providing <code>Normalized</code>, provide <code>Label</code>.</p>
+     *          <p>The value of <code>Normalized</code> can be an integer between <code>0</code> and <code>100</code>.</p>
      *          <p>If you provide <code>Label</code> and do not provide <code>Normalized</code>, then
      *             <code>Normalized</code> is set automatically as follows.</p>
      *          <ul>
@@ -1676,6 +1679,7 @@ export interface Severity {
     Normalized?: number;
     /**
      * <p>The native severity from the finding product that generated the finding.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 64.</p>
      * @public
      */
     Original?: string;
@@ -1729,6 +1733,7 @@ export interface ThreatIntelIndicator {
     Type?: ThreatIntelIndicatorType;
     /**
      * <p>The value of a threat intelligence indicator.</p>
+     *          <p>Length Constraints: Minimum of 1 length. Maximum of 512 length.</p>
      * @public
      */
     Value?: string;
@@ -1770,6 +1775,7 @@ export interface ThreatIntelIndicator {
     LastObservedAt?: string;
     /**
      * <p>The source of the threat intelligence indicator.</p>
+     *          <p>Length Constraints: Minimum of 1 length. Maximum of 64 length.</p>
      * @public
      */
     Source?: string;
@@ -1789,24 +1795,28 @@ export interface FilePaths {
     /**
      * <p>Path to the infected or suspicious file on the resource it was detected on.
      * 		</p>
+     *          <p>Length Constraints: Minimum of 1 length. Maximum of 128 length.</p>
      * @public
      */
     FilePath?: string;
     /**
      * <p>The name of the infected or suspicious file corresponding to the hash.
      * 		</p>
+     *          <p>Length Constraints: Minimum of 1 length. Maximum of 128 length.</p>
      * @public
      */
     FileName?: string;
     /**
      * <p>The Amazon Resource Name (ARN) of the resource on which the threat was detected.
      * 		</p>
+     *          <p>Length Constraints: Minimum of 1 length. Maximum of 128 length.</p>
      * @public
      */
     ResourceId?: string;
     /**
      * <p>The hash value for the infected or suspicious file.
      * 		</p>
+     *          <p>Length Constraints: Minimum of 1 length. Maximum of 128 length.</p>
      * @public
      */
     Hash?: string;
@@ -1820,12 +1830,14 @@ export interface Threat {
     /**
      * <p>The name of the threat.
      * 		</p>
+     *          <p>Length Constraints: Minimum of 1 length. Maximum of 128 length.</p>
      * @public
      */
     Name?: string;
     /**
      * <p>The severity of the threat.
      * 		</p>
+     *          <p>Length Constraints: Minimum of 1 length. Maximum of 128 length.</p>
      * @public
      */
     Severity?: string;
@@ -1838,6 +1850,7 @@ export interface Threat {
     /**
      * <p>Provides information about the file paths that were affected by the threat.
      * 		</p>
+     *          <p>Array Members: Minimum number of 1 item. Maximum number of 5 items.</p>
      * @public
      */
     FilePaths?: FilePaths[];
@@ -2270,12 +2283,13 @@ export type WorkflowState = (typeof WorkflowState)[keyof typeof WorkflowState];
  */
 export interface AwsSecurityFinding {
     /**
-     * <p>The schema version that a finding is formatted for.</p>
+     * <p>The schema version that a finding is formatted for. The value is <code>2018-10-08</code>.</p>
      * @public
      */
     SchemaVersion: string | undefined;
     /**
      * <p>The security findings provider-specific identifier for a finding.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 512.</p>
      * @public
      */
     Id: string | undefined;
@@ -2283,6 +2297,7 @@ export interface AwsSecurityFinding {
      * <p>The ARN generated by Security Hub that uniquely identifies a product that generates findings.
      *          This can be the ARN for a third-party product that is integrated with Security Hub, or the ARN for
      *          a custom integration.</p>
+     *          <p>Length Constraints: Minimum length of 12. Maximum length of 2048.</p>
      * @public
      */
     ProductArn: string | undefined;
@@ -2290,6 +2305,7 @@ export interface AwsSecurityFinding {
      * <p>The name of the product that generated the finding.</p>
      *          <p>Security Hub populates this attribute automatically for each finding. You cannot update this attribute with <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is a custom integration.</p>
      *          <p>When you use the Security Hub console or API to filter findings by product name, you use this attribute.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 128.</p>
      * @public
      */
     ProductName?: string;
@@ -2297,24 +2313,30 @@ export interface AwsSecurityFinding {
      * <p>The name of the company for the product that generated the finding.</p>
      *          <p>Security Hub populates this attribute automatically for each finding. You cannot update this attribute with <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>. The exception to this is a custom integration.</p>
      *          <p>When you use the Security Hub console or API to filter findings by company name, you use this attribute.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 128.
+     *        </p>
      * @public
      */
     CompanyName?: string;
     /**
      * <p>The Region from which the finding was generated.</p>
      *          <p>Security Hub populates this attribute automatically for each finding. You cannot update it using <code>BatchImportFindings</code> or <code>BatchUpdateFindings</code>.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 16.
+     *        </p>
      * @public
      */
     Region?: string;
     /**
      * <p>The identifier for the solution-specific component (a discrete unit of logic) that
      *          generated a finding. In various security findings providers' solutions, this generator can
-     *          be called a rule, a check, a detector, a plugin, etc. </p>
+     *          be called a rule, a check, a detector, a plugin, or something else.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 512.</p>
      * @public
      */
     GeneratorId: string | undefined;
     /**
      * <p>The Amazon Web Services account ID that a finding is generated in.</p>
+     *          <p>Length Constraints: 12.</p>
      * @public
      */
     AwsAccountId: string | undefined;
@@ -2323,6 +2345,7 @@ export interface AwsSecurityFinding {
      *          that classify a finding.</p>
      *          <p>Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual
      *          Behaviors | Sensitive Data Identifications</p>
+     *          <p>Array Members: Maximum number of 50 items.</p>
      * @public
      */
     Types?: string[];
@@ -2470,18 +2493,14 @@ export interface AwsSecurityFinding {
      */
     Criticality?: number;
     /**
-     * <p>A finding's title.</p>
-     *          <note>
-     *             <p>In this release, <code>Title</code> is a required property.</p>
-     *          </note>
+     * <p>A finding's title. <code>Title</code> is a required property.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 256.</p>
      * @public
      */
     Title: string | undefined;
     /**
-     * <p>A finding's description.</p>
-     *          <note>
-     *             <p>In this release, <code>Description</code> is a required property.</p>
-     *          </note>
+     * <p>A finding's description. <code>Description</code> is a required property.</p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 1024.</p>
      * @public
      */
     Description: string | undefined;
@@ -2505,12 +2524,14 @@ export interface AwsSecurityFinding {
     ProductFields?: Record<string, string>;
     /**
      * <p>A list of name/value string pairs associated with the finding. These are custom,
-     *          user-defined fields added to a finding. </p>
+     *          user-defined fields added to a finding.</p>
+     *          <p>Can contain up to 50 key-value pairs. For each key-value pair, the key can contain up to 128 characters, and the value can contain up to 1024 characters.</p>
      * @public
      */
     UserDefinedFields?: Record<string, string>;
     /**
      * <p>A list of malware related to a finding.</p>
+     *          <p>Array Members: Maximum number of 5 items.</p>
      * @public
      */
     Malware?: Malware[];
@@ -2533,17 +2554,20 @@ export interface AwsSecurityFinding {
     /**
      * <p>Details about the threat detected in a security finding and the file paths that were affected by the threat.
      *       </p>
+     *          <p>Array Members: Minimum number of 1 item. Maximum number of 32 items.</p>
      * @public
      */
     Threats?: Threat[];
     /**
      * <p>Threat intelligence details related to a finding.</p>
+     *          <p>Array Members: Minimum number of 1 item. Maximum number of 5 items.</p>
      * @public
      */
     ThreatIntelIndicators?: ThreatIntelIndicator[];
     /**
      * <p>A set of resource data types that describe the resources that the finding refers
      *          to.</p>
+     *          <p>Array Members: Minimum number of 1 item. Maximum number of 32 items.</p>
      * @public
      */
     Resources: Resource[] | undefined;
@@ -2578,6 +2602,7 @@ export interface AwsSecurityFinding {
     RecordState?: RecordState;
     /**
      * <p>A list of related findings.</p>
+     *          <p>Array Members: Minimum number of 1 item. Maximum number of 10 items.</p>
      * @public
      */
     RelatedFindings?: RelatedFinding[];
@@ -2622,7 +2647,7 @@ export interface AwsSecurityFinding {
      */
     GeneratorDetails?: GeneratorDetails;
     /**
-     * <p>A imestamp that indicates when Security Hub received a finding and begins to process it.</p>
+     * <p>A timestamp that indicates when Security Hub received a finding and begins to process it.</p>
      *          <p>This field accepts only the specified formats. Timestamps
      * can end with <code>Z</code> or <code>("+" / "-") time-hour [":" time-minute]</code>. The time-secfrac after seconds is limited
      * to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:</p>
@@ -2654,6 +2679,8 @@ export interface AwsSecurityFinding {
     /**
      * <p>The name of the Amazon Web Services account from which a finding was generated.
      *         </p>
+     *          <p>Length Constraints: Minimum length of 1. Maximum length of 50.
+     *         </p>
      * @public
      */
     AwsAccountName?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-securityhub",
   "description": "AWS SDK for JavaScript Securityhub Client for Node.js, Browser and React Native",
-  "version": "3.576.0",
+  "version": "3.577.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-securityhub",
@@ -20,19 +20,19 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "3.0.0",
     "@aws-crypto/sha256-js": "3.0.0",
-    "@aws-sdk/client-sso-oidc": "3.576.0",
-    "@aws-sdk/client-sts": "3.576.0",
+    "@aws-sdk/client-sso-oidc": "3.577.0",
+    "@aws-sdk/client-sts": "3.577.0",
     "@aws-sdk/core": "3.576.0",
-    "@aws-sdk/credential-provider-node": "3.576.0",
-    "@aws-sdk/middleware-host-header": "3.575.0",
-    "@aws-sdk/middleware-logger": "3.575.0",
-    "@aws-sdk/middleware-recursion-detection": "3.575.0",
-    "@aws-sdk/middleware-user-agent": "3.575.0",
-    "@aws-sdk/region-config-resolver": "3.575.0",
-    "@aws-sdk/types": "3.575.0",
-    "@aws-sdk/util-endpoints": "3.575.0",
-    "@aws-sdk/util-user-agent-browser": "3.575.0",
-    "@aws-sdk/util-user-agent-node": "3.575.0",
+    "@aws-sdk/credential-provider-node": "3.577.0",
+    "@aws-sdk/middleware-host-header": "3.577.0",
+    "@aws-sdk/middleware-logger": "3.577.0",
+    "@aws-sdk/middleware-recursion-detection": "3.577.0",
+    "@aws-sdk/middleware-user-agent": "3.577.0",
+    "@aws-sdk/region-config-resolver": "3.577.0",
+    "@aws-sdk/types": "3.577.0",
+    "@aws-sdk/util-endpoints": "3.577.0",
+    "@aws-sdk/util-user-agent-browser": "3.577.0",
+    "@aws-sdk/util-user-agent-node": "3.577.0",
     "@smithy/config-resolver": "^3.0.0",
     "@smithy/core": "^2.0.0",
     "@smithy/fetch-http-handler": "^3.0.0",