@aws-sdk/client-securityhub 3.325.0 → 3.327.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/README.md +8 -0
  2. package/dist-cjs/SecurityHub.js +2 -0
  3. package/dist-cjs/commands/GetFindingHistoryCommand.js +45 -0
  4. package/dist-cjs/commands/index.js +1 -0
  5. package/dist-cjs/models/models_2.js +5 -1
  6. package/dist-cjs/pagination/GetFindingHistoryPaginator.js +29 -0
  7. package/dist-cjs/pagination/index.js +1 -0
  8. package/dist-cjs/protocols/Aws_restJson1.js +90 -3
  9. package/dist-es/SecurityHub.js +2 -0
  10. package/dist-es/commands/GetFindingHistoryCommand.js +41 -0
  11. package/dist-es/commands/index.js +1 -0
  12. package/dist-es/models/models_2.js +4 -0
  13. package/dist-es/pagination/GetFindingHistoryPaginator.js +25 -0
  14. package/dist-es/pagination/index.js +1 -0
  15. package/dist-es/protocols/Aws_restJson1.js +85 -0
  16. package/dist-types/SecurityHub.d.ts +7 -0
  17. package/dist-types/SecurityHubClient.d.ts +3 -2
  18. package/dist-types/commands/AcceptAdministratorInvitationCommand.d.ts +4 -0
  19. package/dist-types/commands/AcceptInvitationCommand.d.ts +4 -0
  20. package/dist-types/commands/BatchDisableStandardsCommand.d.ts +18 -0
  21. package/dist-types/commands/BatchEnableStandardsCommand.d.ts +18 -0
  22. package/dist-types/commands/BatchGetSecurityControlsCommand.d.ts +23 -0
  23. package/dist-types/commands/BatchGetStandardsControlAssociationsCommand.d.ts +33 -0
  24. package/dist-types/commands/BatchImportFindingsCommand.d.ts +14 -0
  25. package/dist-types/commands/BatchUpdateFindingsCommand.d.ts +21 -0
  26. package/dist-types/commands/BatchUpdateStandardsControlAssociationsCommand.d.ts +17 -0
  27. package/dist-types/commands/CreateActionTargetCommand.d.ts +6 -0
  28. package/dist-types/commands/CreateFindingAggregatorCommand.d.ts +11 -0
  29. package/dist-types/commands/CreateInsightCommand.d.ts +6 -0
  30. package/dist-types/commands/CreateMembersCommand.d.ts +11 -0
  31. package/dist-types/commands/DeclineInvitationsCommand.d.ts +11 -0
  32. package/dist-types/commands/DeleteActionTargetCommand.d.ts +6 -0
  33. package/dist-types/commands/DeleteFindingAggregatorCommand.d.ts +4 -0
  34. package/dist-types/commands/DeleteInsightCommand.d.ts +6 -0
  35. package/dist-types/commands/DeleteInvitationsCommand.d.ts +11 -0
  36. package/dist-types/commands/DeleteMembersCommand.d.ts +11 -0
  37. package/dist-types/commands/DescribeActionTargetsCommand.d.ts +13 -0
  38. package/dist-types/commands/DescribeHubCommand.d.ts +9 -0
  39. package/dist-types/commands/DescribeOrganizationConfigurationCommand.d.ts +8 -0
  40. package/dist-types/commands/DescribeProductsCommand.d.ts +23 -0
  41. package/dist-types/commands/DescribeStandardsCommand.d.ts +18 -0
  42. package/dist-types/commands/DescribeStandardsControlsCommand.d.ts +22 -0
  43. package/dist-types/commands/DisableImportFindingsForProductCommand.d.ts +4 -0
  44. package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts +4 -0
  45. package/dist-types/commands/DisableSecurityHubCommand.d.ts +4 -0
  46. package/dist-types/commands/DisassociateFromAdministratorAccountCommand.d.ts +4 -0
  47. package/dist-types/commands/DisassociateFromMasterAccountCommand.d.ts +4 -0
  48. package/dist-types/commands/DisassociateMembersCommand.d.ts +4 -0
  49. package/dist-types/commands/EnableImportFindingsForProductCommand.d.ts +6 -0
  50. package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts +4 -0
  51. package/dist-types/commands/EnableSecurityHubCommand.d.ts +4 -0
  52. package/dist-types/commands/GetAdministratorAccountCommand.d.ts +11 -0
  53. package/dist-types/commands/GetEnabledStandardsCommand.d.ts +19 -0
  54. package/dist-types/commands/GetFindingAggregatorCommand.d.ts +11 -0
  55. package/dist-types/commands/GetFindingHistoryCommand.d.ts +157 -0
  56. package/dist-types/commands/GetFindingsCommand.d.ts +3760 -0
  57. package/dist-types/commands/GetInsightResultsCommand.d.ts +15 -0
  58. package/dist-types/commands/GetInsightsCommand.d.ts +264 -0
  59. package/dist-types/commands/GetInvitationsCountCommand.d.ts +6 -0
  60. package/dist-types/commands/GetMasterAccountCommand.d.ts +11 -0
  61. package/dist-types/commands/GetMembersCommand.d.ts +22 -0
  62. package/dist-types/commands/InviteMembersCommand.d.ts +11 -0
  63. package/dist-types/commands/ListEnabledProductsForImportCommand.d.ts +9 -0
  64. package/dist-types/commands/ListFindingAggregatorsCommand.d.ts +11 -0
  65. package/dist-types/commands/ListInvitationsCommand.d.ts +14 -0
  66. package/dist-types/commands/ListMembersCommand.d.ts +17 -0
  67. package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +12 -0
  68. package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +16 -0
  69. package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts +21 -0
  70. package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -0
  71. package/dist-types/commands/TagResourceCommand.d.ts +4 -0
  72. package/dist-types/commands/UntagResourceCommand.d.ts +4 -0
  73. package/dist-types/commands/UpdateActionTargetCommand.d.ts +4 -0
  74. package/dist-types/commands/UpdateFindingAggregatorCommand.d.ts +11 -0
  75. package/dist-types/commands/UpdateFindingsCommand.d.ts +4 -0
  76. package/dist-types/commands/UpdateInsightCommand.d.ts +4 -0
  77. package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +4 -0
  78. package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts +4 -0
  79. package/dist-types/commands/UpdateStandardsControlCommand.d.ts +4 -0
  80. package/dist-types/commands/index.d.ts +1 -0
  81. package/dist-types/models/models_1.d.ts +16 -16
  82. package/dist-types/models/models_2.d.ts +196 -1
  83. package/dist-types/pagination/GetFindingHistoryPaginator.d.ts +7 -0
  84. package/dist-types/pagination/index.d.ts +1 -0
  85. package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
  86. package/dist-types/ts3.4/SecurityHub.d.ts +17 -0
  87. package/dist-types/ts3.4/SecurityHubClient.d.ts +6 -0
  88. package/dist-types/ts3.4/commands/GetFindingHistoryCommand.d.ts +38 -0
  89. package/dist-types/ts3.4/commands/index.d.ts +1 -0
  90. package/dist-types/ts3.4/models/models_2.d.ts +35 -0
  91. package/dist-types/ts3.4/pagination/GetFindingHistoryPaginator.d.ts +11 -0
  92. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  93. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
  94. package/package.json +7 -7
@@ -34,6 +34,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
34
34
  * };
35
35
  * const command = new UntagResourceCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
@@ -52,6 +54,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
52
54
  * @throws {@link ResourceNotFoundException} (client fault)
53
55
  * <p>The request was rejected because we can't find the specified resource.</p>
54
56
  *
57
+ * @throws {@link SecurityHubServiceException}
58
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
55
59
  *
56
60
  * @example To remove tags from a resource
57
61
  * ```javascript
@@ -33,6 +33,8 @@ export interface UpdateActionTargetCommandOutput extends UpdateActionTargetRespo
33
33
  * };
34
34
  * const command = new UpdateActionTargetCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param UpdateActionTargetCommandInput - {@link UpdateActionTargetCommandInput}
@@ -54,6 +56,8 @@ export interface UpdateActionTargetCommandOutput extends UpdateActionTargetRespo
54
56
  * @throws {@link ResourceNotFoundException} (client fault)
55
57
  * <p>The request was rejected because we can't find the specified resource.</p>
56
58
  *
59
+ * @throws {@link SecurityHubServiceException}
60
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
57
61
  *
58
62
  * @example To update the name and description of a custom action target
59
63
  * ```javascript
@@ -37,6 +37,15 @@ export interface UpdateFindingAggregatorCommandOutput extends UpdateFindingAggre
37
37
  * };
38
38
  * const command = new UpdateFindingAggregatorCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // UpdateFindingAggregatorResponse
41
+ * // FindingAggregatorArn: "STRING_VALUE",
42
+ * // FindingAggregationRegion: "STRING_VALUE",
43
+ * // RegionLinkingMode: "STRING_VALUE",
44
+ * // Regions: [ // StringList
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // };
48
+ *
40
49
  * ```
41
50
  *
42
51
  * @param UpdateFindingAggregatorCommandInput - {@link UpdateFindingAggregatorCommandInput}
@@ -65,6 +74,8 @@ export interface UpdateFindingAggregatorCommandOutput extends UpdateFindingAggre
65
74
  * @throws {@link ResourceNotFoundException} (client fault)
66
75
  * <p>The request was rejected because we can't find the specified resource.</p>
67
76
  *
77
+ * @throws {@link SecurityHubServiceException}
78
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
68
79
  *
69
80
  * @example To update cross-Region aggregation settings
70
81
  * ```javascript
@@ -291,6 +291,8 @@ export interface UpdateFindingsCommandOutput extends UpdateFindingsResponse, __M
291
291
  * };
292
292
  * const command = new UpdateFindingsCommand(input);
293
293
  * const response = await client.send(command);
294
+ * // {};
295
+ *
294
296
  * ```
295
297
  *
296
298
  * @param UpdateFindingsCommandInput - {@link UpdateFindingsCommandInput}
@@ -316,6 +318,8 @@ export interface UpdateFindingsCommandOutput extends UpdateFindingsResponse, __M
316
318
  * @throws {@link ResourceNotFoundException} (client fault)
317
319
  * <p>The request was rejected because we can't find the specified resource.</p>
318
320
  *
321
+ * @throws {@link SecurityHubServiceException}
322
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
319
323
  *
320
324
  */
321
325
  export declare class UpdateFindingsCommand extends $Command<UpdateFindingsCommandInput, UpdateFindingsCommandOutput, SecurityHubClientResolvedConfig> {
@@ -284,6 +284,8 @@ export interface UpdateInsightCommandOutput extends UpdateInsightResponse, __Met
284
284
  * };
285
285
  * const command = new UpdateInsightCommand(input);
286
286
  * const response = await client.send(command);
287
+ * // {};
288
+ *
287
289
  * ```
288
290
  *
289
291
  * @param UpdateInsightCommandInput - {@link UpdateInsightCommandInput}
@@ -309,6 +311,8 @@ export interface UpdateInsightCommandOutput extends UpdateInsightResponse, __Met
309
311
  * @throws {@link ResourceNotFoundException} (client fault)
310
312
  * <p>The request was rejected because we can't find the specified resource.</p>
311
313
  *
314
+ * @throws {@link SecurityHubServiceException}
315
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
312
316
  *
313
317
  * @example To update an insight
314
318
  * ```javascript
@@ -33,6 +33,8 @@ export interface UpdateOrganizationConfigurationCommandOutput extends UpdateOrga
33
33
  * };
34
34
  * const command = new UpdateOrganizationConfigurationCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param UpdateOrganizationConfigurationCommandInput - {@link UpdateOrganizationConfigurationCommandInput}
@@ -55,6 +57,8 @@ export interface UpdateOrganizationConfigurationCommandOutput extends UpdateOrga
55
57
  * <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
56
58
  * account or throttling limits. The error code describes the limit exceeded.</p>
57
59
  *
60
+ * @throws {@link SecurityHubServiceException}
61
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
58
62
  *
59
63
  * @example To update organization configuration
60
64
  * ```javascript
@@ -32,6 +32,8 @@ export interface UpdateSecurityHubConfigurationCommandOutput extends UpdateSecur
32
32
  * };
33
33
  * const command = new UpdateSecurityHubConfigurationCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // {};
36
+ *
35
37
  * ```
36
38
  *
37
39
  * @param UpdateSecurityHubConfigurationCommandInput - {@link UpdateSecurityHubConfigurationCommandInput}
@@ -57,6 +59,8 @@ export interface UpdateSecurityHubConfigurationCommandOutput extends UpdateSecur
57
59
  * @throws {@link ResourceNotFoundException} (client fault)
58
60
  * <p>The request was rejected because we can't find the specified resource.</p>
59
61
  *
62
+ * @throws {@link SecurityHubServiceException}
63
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
60
64
  *
61
65
  * @example To update Security Hub settings
62
66
  * ```javascript
@@ -34,6 +34,8 @@ export interface UpdateStandardsControlCommandOutput extends UpdateStandardsCont
34
34
  * };
35
35
  * const command = new UpdateStandardsControlCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // {};
38
+ *
37
39
  * ```
38
40
  *
39
41
  * @param UpdateStandardsControlCommandInput - {@link UpdateStandardsControlCommandInput}
@@ -55,6 +57,8 @@ export interface UpdateStandardsControlCommandOutput extends UpdateStandardsCont
55
57
  * @throws {@link ResourceNotFoundException} (client fault)
56
58
  * <p>The request was rejected because we can't find the specified resource.</p>
57
59
  *
60
+ * @throws {@link SecurityHubServiceException}
61
+ * <p>Base exception class for all service exceptions from SecurityHub service.</p>
58
62
  *
59
63
  * @example To update the enablement status of a standard control
60
64
  * ```javascript
@@ -35,6 +35,7 @@ export * from "./EnableSecurityHubCommand";
35
35
  export * from "./GetAdministratorAccountCommand";
36
36
  export * from "./GetEnabledStandardsCommand";
37
37
  export * from "./GetFindingAggregatorCommand";
38
+ export * from "./GetFindingHistoryCommand";
38
39
  export * from "./GetFindingsCommand";
39
40
  export * from "./GetInsightResultsCommand";
40
41
  export * from "./GetInsightsCommand";
@@ -7528,7 +7528,7 @@ export interface AwsSecurityFinding {
7528
7528
  Region?: string;
7529
7529
  /**
7530
7530
  * <p>The identifier for the solution-specific component (a discrete unit of logic) that
7531
- * generated a finding. In various security-findings providers' solutions, this generator can
7531
+ * generated a finding. In various security findings providers' solutions, this generator can
7532
7532
  * be called a rule, a check, a detector, a plugin, etc. </p>
7533
7533
  */
7534
7534
  GeneratorId: string | undefined;
@@ -7544,7 +7544,7 @@ export interface AwsSecurityFinding {
7544
7544
  */
7545
7545
  Types?: string[];
7546
7546
  /**
7547
- * <p>Indicates when the security-findings provider first observed the potential security
7547
+ * <p>Indicates when the security findings provider first observed the potential security
7548
7548
  * issue that a finding captured.</p>
7549
7549
  * <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
7550
7550
  * Date/Time Format</a>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For example,
@@ -7552,7 +7552,7 @@ export interface AwsSecurityFinding {
7552
7552
  */
7553
7553
  FirstObservedAt?: string;
7554
7554
  /**
7555
- * <p>Indicates when the security-findings provider most recently observed the potential
7555
+ * <p>Indicates when the security findings provider most recently observed the potential
7556
7556
  * security issue that a finding captured.</p>
7557
7557
  * <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
7558
7558
  * Date/Time Format</a>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For example,
@@ -7560,7 +7560,7 @@ export interface AwsSecurityFinding {
7560
7560
  */
7561
7561
  LastObservedAt?: string;
7562
7562
  /**
7563
- * <p>Indicates when the security-findings provider created the potential security issue that
7563
+ * <p>Indicates when the security findings provider created the potential security issue that
7564
7564
  * a finding captured.</p>
7565
7565
  * <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
7566
7566
  * Date/Time Format</a>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For example,
@@ -7568,7 +7568,7 @@ export interface AwsSecurityFinding {
7568
7568
  */
7569
7569
  CreatedAt: string | undefined;
7570
7570
  /**
7571
- * <p>Indicates when the security-findings provider last updated the finding record.</p>
7571
+ * <p>Indicates when the security findings provider last updated the finding record.</p>
7572
7572
  * <p>Uses the <code>date-time</code> format specified in <a href="https://tools.ietf.org/html/rfc3339#section-5.6">RFC 3339 section 5.6, Internet
7573
7573
  * Date/Time Format</a>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For example,
7574
7574
  * <code>2020-03-22T13:22:13.933Z</code>.</p>
@@ -7610,12 +7610,12 @@ export interface AwsSecurityFinding {
7610
7610
  */
7611
7611
  Remediation?: Remediation;
7612
7612
  /**
7613
- * <p>A URL that links to a page about the current finding in the security-findings provider's
7613
+ * <p>A URL that links to a page about the current finding in the security findings provider's
7614
7614
  * solution.</p>
7615
7615
  */
7616
7616
  SourceUrl?: string;
7617
7617
  /**
7618
- * <p>A data type where security-findings providers can include additional solution-specific
7618
+ * <p>A data type where security findings providers can include additional solution-specific
7619
7619
  * details that aren't part of the defined <code>AwsSecurityFinding</code> format.</p>
7620
7620
  * <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 2048 characters.</p>
7621
7621
  */
@@ -7992,7 +7992,7 @@ export interface AwsSecurityFindingFilters {
7992
7992
  Id?: StringFilter[];
7993
7993
  /**
7994
7994
  * <p>The identifier for the solution-specific component (a discrete unit of logic) that
7995
- * generated a finding. In various security-findings providers' solutions, this generator can
7995
+ * generated a finding. In various security findings providers' solutions, this generator can
7996
7996
  * be called a rule, a check, a detector, a plugin, etc.</p>
7997
7997
  */
7998
7998
  GeneratorId?: StringFilter[];
@@ -8006,25 +8006,25 @@ export interface AwsSecurityFindingFilters {
8006
8006
  */
8007
8007
  Type?: StringFilter[];
8008
8008
  /**
8009
- * <p>An ISO8601-formatted timestamp that indicates when the security-findings provider first
8009
+ * <p>An ISO8601-formatted timestamp that indicates when the security findings provider first
8010
8010
  * observed the potential security issue that a finding captured.</p>
8011
8011
  * <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
8012
8012
  */
8013
8013
  FirstObservedAt?: DateFilter[];
8014
8014
  /**
8015
- * <p>An ISO8601-formatted timestamp that indicates when the security-findings provider most
8015
+ * <p>An ISO8601-formatted timestamp that indicates when the security findings provider most
8016
8016
  * recently observed the potential security issue that a finding captured.</p>
8017
8017
  * <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
8018
8018
  */
8019
8019
  LastObservedAt?: DateFilter[];
8020
8020
  /**
8021
- * <p>An ISO8601-formatted timestamp that indicates when the security-findings provider
8021
+ * <p>An ISO8601-formatted timestamp that indicates when the security findings provider
8022
8022
  * captured the potential security issue that a finding captured.</p>
8023
8023
  * <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
8024
8024
  */
8025
8025
  CreatedAt?: DateFilter[];
8026
8026
  /**
8027
- * <p>An ISO8601-formatted timestamp that indicates when the security-findings provider last
8027
+ * <p>An ISO8601-formatted timestamp that indicates when the security findings provider last
8028
8028
  * updated the finding record. </p>
8029
8029
  * <p>A correctly formatted example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6, Internet Date/Time Format</a>.</p>
8030
8030
  */
@@ -8032,7 +8032,7 @@ export interface AwsSecurityFindingFilters {
8032
8032
  /**
8033
8033
  * @deprecated
8034
8034
  *
8035
- * <p>The native severity as defined by the security-findings provider's solution that
8035
+ * <p>The native severity as defined by the security findings provider's solution that
8036
8036
  * generated the finding.</p>
8037
8037
  */
8038
8038
  SeverityProduct?: NumberFilter[];
@@ -8072,12 +8072,12 @@ export interface AwsSecurityFindingFilters {
8072
8072
  */
8073
8073
  RecommendationText?: StringFilter[];
8074
8074
  /**
8075
- * <p>A URL that links to a page about the current finding in the security-findings provider's
8075
+ * <p>A URL that links to a page about the current finding in the security findings provider's
8076
8076
  * solution.</p>
8077
8077
  */
8078
8078
  SourceUrl?: StringFilter[];
8079
8079
  /**
8080
- * <p>A data type where security-findings providers can include additional solution-specific
8080
+ * <p>A data type where security findings providers can include additional solution-specific
8081
8081
  * details that aren't part of the defined <code>AwsSecurityFinding</code> format.</p>
8082
8082
  */
8083
8083
  ProductFields?: MapFilter[];
@@ -8492,7 +8492,7 @@ export interface AwsSecurityFindingFilters {
8492
8492
  }
8493
8493
  /**
8494
8494
  * @public
8495
- * <p>Identifies a finding to update using <code>BatchUpdateFindings</code>.</p>
8495
+ * <p>Identifies which finding to get the finding history for.</p>
8496
8496
  */
8497
8497
  export interface AwsSecurityFindingIdentifier {
8498
8498
  /**
@@ -1,5 +1,5 @@
1
1
  import { AccountDetails, ActionTarget, AdminAccount, AssociationStatus, AutoEnableStandards } from "./models_0";
2
- import { AwsSecurityFinding, AwsSecurityFindingFilters, ControlFindingGenerator, ControlStatus, NoteUpdate, RecordState, SeverityRating, StandardsSubscription } from "./models_1";
2
+ import { AwsSecurityFinding, AwsSecurityFindingFilters, AwsSecurityFindingIdentifier, ControlFindingGenerator, ControlStatus, NoteUpdate, RecordState, SeverityRating, StandardsSubscription } from "./models_1";
3
3
  /**
4
4
  * @public
5
5
  */
@@ -700,6 +700,126 @@ export interface FindingAggregator {
700
700
  */
701
701
  FindingAggregatorArn?: string;
702
702
  }
703
+ /**
704
+ * @public
705
+ * <p> An array of objects that provides details about a change to a finding, including the
706
+ * Amazon Web Services Security Finding Format (ASFF) field that changed, the value of
707
+ * the field before the change, and the value of the field after the change. </p>
708
+ */
709
+ export interface FindingHistoryUpdate {
710
+ /**
711
+ * <p>
712
+ * The ASFF field that changed during the finding change event.
713
+ * </p>
714
+ */
715
+ UpdatedField?: string;
716
+ /**
717
+ * <p>
718
+ * The value of the ASFF field before the finding change event.
719
+ * </p>
720
+ */
721
+ OldValue?: string;
722
+ /**
723
+ * <p>
724
+ * The value of the ASFF field after the finding change event. To preserve storage and readability, Security Hub omits this value
725
+ * if <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_FindingHistoryRecord.html">
726
+ * <code>FindingHistoryRecord</code>
727
+ * </a> exceeds database limits.
728
+ * </p>
729
+ */
730
+ NewValue?: string;
731
+ }
732
+ /**
733
+ * @public
734
+ * @enum
735
+ */
736
+ export declare const FindingHistoryUpdateSourceType: {
737
+ readonly BATCH_IMPORT_FINDINGS: "BATCH_IMPORT_FINDINGS";
738
+ readonly BATCH_UPDATE_FINDINGS: "BATCH_UPDATE_FINDINGS";
739
+ };
740
+ /**
741
+ * @public
742
+ */
743
+ export type FindingHistoryUpdateSourceType = (typeof FindingHistoryUpdateSourceType)[keyof typeof FindingHistoryUpdateSourceType];
744
+ /**
745
+ * @public
746
+ * <p>
747
+ * Identifies the source of the finding change event.
748
+ * </p>
749
+ */
750
+ export interface FindingHistoryUpdateSource {
751
+ /**
752
+ * <p>
753
+ * Describes the type of finding change event, such as a call to <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html">
754
+ * <code>BatchImportFindings</code>
755
+ * </a> (by an integrated Amazon Web Service or third party partner integration) or <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html">
756
+ * <code>BatchUpdateFindings</code>
757
+ * </a> (by a Security Hub customer).
758
+ * </p>
759
+ */
760
+ Type?: FindingHistoryUpdateSourceType | string;
761
+ /**
762
+ * <p>
763
+ * The identity of the source that initiated the finding change event. For example, the Amazon Resource Name (ARN) of a partner that calls BatchImportFindings or of a customer that calls BatchUpdateFindings.
764
+ * </p>
765
+ */
766
+ Identity?: string;
767
+ }
768
+ /**
769
+ * @public
770
+ * <p>
771
+ * A list of events that changed the specified finding during the specified time period. Each record represents a single
772
+ * finding change event.
773
+ * </p>
774
+ */
775
+ export interface FindingHistoryRecord {
776
+ /**
777
+ * <p>Identifies which finding to get the finding history for.</p>
778
+ */
779
+ FindingIdentifier?: AwsSecurityFindingIdentifier;
780
+ /**
781
+ * <p> An ISO 8601-formatted timestamp that indicates when the security findings provider last
782
+ * updated the finding record. A correctly formatted example is
783
+ * <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and
784
+ * time should be separated by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339 section 5.6,
785
+ * Internet Date/Time Format</a>. </p>
786
+ */
787
+ UpdateTime?: Date;
788
+ /**
789
+ * <p>
790
+ * Identifies whether the event marks the creation of a new finding. A value of <code>True</code> means that the finding is
791
+ * newly created. A value of <code>False</code> means that the finding isn’t newly created.
792
+ * </p>
793
+ */
794
+ FindingCreated?: boolean;
795
+ /**
796
+ * <p> Identifies the source of the event that changed the finding. For example, an integrated
797
+ * Amazon Web Service or third-party partner integration may call <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchImportFindings.html">
798
+ * <code>BatchImportFindings</code>
799
+ * </a>, or an Security Hub customer
800
+ * may call <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_BatchUpdateFindings.html">
801
+ * <code>BatchUpdateFindings</code>
802
+ * </a>. </p>
803
+ */
804
+ UpdateSource?: FindingHistoryUpdateSource;
805
+ /**
806
+ * <p>
807
+ * An array of objects that provides details about the finding change event, including the Amazon Web Services Security
808
+ * Finding Format (ASFF) field that changed, the value of the field before the change, and the value of the field after
809
+ * the change.
810
+ * </p>
811
+ */
812
+ Updates?: FindingHistoryUpdate[];
813
+ /**
814
+ * <p>
815
+ * A token for pagination purposes. Provide this token in the subsequent request to <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_GetFindingsHistory.html">
816
+ * <code>GetFindingsHistory</code>
817
+ * </a> to get
818
+ * up to an additional 100 results of history for the same finding that you specified in your initial request.
819
+ * </p>
820
+ */
821
+ NextToken?: string;
822
+ }
703
823
  /**
704
824
  * @public
705
825
  */
@@ -801,6 +921,81 @@ export interface GetFindingAggregatorResponse {
801
921
  */
802
922
  Regions?: string[];
803
923
  }
924
+ /**
925
+ * @public
926
+ */
927
+ export interface GetFindingHistoryRequest {
928
+ /**
929
+ * <p>Identifies which finding to get the finding history for.</p>
930
+ */
931
+ FindingIdentifier: AwsSecurityFindingIdentifier | undefined;
932
+ /**
933
+ * <p>
934
+ * An ISO 8601-formatted timestamp that indicates the start time of the requested finding history. A correctly formatted
935
+ * example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated
936
+ * by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339
937
+ * section 5.6, Internet Date/Time Format</a>.</p>
938
+ * <p>If you provide values for both <code>StartTime</code> and <code>EndTime</code>,
939
+ * Security Hub returns finding history for the specified time period. If you
940
+ * provide a value for <code>StartTime</code> but not for <code>EndTime</code>, Security Hub returns finding history from the <code>StartTime</code> to the time at
941
+ * which the API is called. If you provide a value for <code>EndTime</code> but not for
942
+ * <code>StartTime</code>, Security Hub returns finding history from the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt">CreatedAt</a> timestamp of the finding to the <code>EndTime</code>. If you
943
+ * provide neither <code>StartTime</code> nor <code>EndTime</code>, Security Hub
944
+ * returns finding history from the CreatedAt timestamp of the finding to the time at which
945
+ * the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is
946
+ * limited to 90 days. </p>
947
+ */
948
+ StartTime?: Date;
949
+ /**
950
+ * <p>
951
+ * An ISO 8601-formatted timestamp that indicates the end time of the requested finding history. A correctly formatted
952
+ * example is <code>2020-05-21T20:16:34.724Z</code>. The value cannot contain spaces, and date and time should be separated
953
+ * by <code>T</code>. For more information, see <a href="https://www.rfc-editor.org/rfc/rfc3339#section-5.6">RFC 3339
954
+ * section 5.6, Internet Date/Time Format</a>.</p>
955
+ * <p>If you provide values for both <code>StartTime</code> and <code>EndTime</code>,
956
+ * Security Hub returns finding history for the specified time period. If you
957
+ * provide a value for <code>StartTime</code> but not for <code>EndTime</code>, Security Hub returns finding history from the <code>StartTime</code> to the time at
958
+ * which the API is called. If you provide a value for <code>EndTime</code> but not for
959
+ * <code>StartTime</code>, Security Hub returns finding history from the <a href="https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_AwsSecurityFindingFilters.html#securityhub-Type-AwsSecurityFindingFilters-CreatedAt">CreatedAt</a> timestamp of the finding to the <code>EndTime</code>. If you
960
+ * provide neither <code>StartTime</code> nor <code>EndTime</code>, Security Hub
961
+ * returns finding history from the CreatedAt timestamp of the finding to the time at which
962
+ * the API is called. In all of these scenarios, the response is limited to 100 results, and the maximum time period is
963
+ * limited to 90 days.</p>
964
+ */
965
+ EndTime?: Date;
966
+ /**
967
+ * <p>
968
+ * A token for pagination purposes. Provide <code>NULL</code> as the initial value. In subsequent requests, provide the
969
+ * token included in the response to get up to an additional 100 results of finding history. If you don’t provide
970
+ * <code>NextToken</code>, Security Hub returns up to 100 results of finding history for each request.
971
+ * </p>
972
+ */
973
+ NextToken?: string;
974
+ /**
975
+ * <p>
976
+ * The maximum number of results to be returned. If you don’t provide it, Security Hub returns up to 100 results of finding history.
977
+ * </p>
978
+ */
979
+ MaxResults?: number;
980
+ }
981
+ /**
982
+ * @public
983
+ */
984
+ export interface GetFindingHistoryResponse {
985
+ /**
986
+ * <p>
987
+ * A list of events that altered the specified finding during the specified time period.
988
+ * </p>
989
+ */
990
+ Records?: FindingHistoryRecord[];
991
+ /**
992
+ * <p>
993
+ * A token for pagination purposes. Provide this token in the subsequent request to <code>GetFindingsHistory</code> to
994
+ * get up to an additional 100 results of history for the same finding that you specified in your initial request.
995
+ * </p>
996
+ */
997
+ NextToken?: string;
998
+ }
804
999
  /**
805
1000
  * @public
806
1001
  * @enum
@@ -0,0 +1,7 @@
1
+ import { Paginator } from "@aws-sdk/types";
2
+ import { GetFindingHistoryCommandInput, GetFindingHistoryCommandOutput } from "../commands/GetFindingHistoryCommand";
3
+ import { SecurityHubPaginationConfiguration } from "./Interfaces";
4
+ /**
5
+ * @public
6
+ */
7
+ export declare function paginateGetFindingHistory(config: SecurityHubPaginationConfiguration, input: GetFindingHistoryCommandInput, ...additionalArguments: any): Paginator<GetFindingHistoryCommandOutput>;
@@ -3,6 +3,7 @@ export * from "./DescribeProductsPaginator";
3
3
  export * from "./DescribeStandardsControlsPaginator";
4
4
  export * from "./DescribeStandardsPaginator";
5
5
  export * from "./GetEnabledStandardsPaginator";
6
+ export * from "./GetFindingHistoryPaginator";
6
7
  export * from "./GetFindingsPaginator";
7
8
  export * from "./GetInsightsPaginator";
8
9
  export * from "./Interfaces";
@@ -37,6 +37,7 @@ import { EnableSecurityHubCommandInput, EnableSecurityHubCommandOutput } from ".
37
37
  import { GetAdministratorAccountCommandInput, GetAdministratorAccountCommandOutput } from "../commands/GetAdministratorAccountCommand";
38
38
  import { GetEnabledStandardsCommandInput, GetEnabledStandardsCommandOutput } from "../commands/GetEnabledStandardsCommand";
39
39
  import { GetFindingAggregatorCommandInput, GetFindingAggregatorCommandOutput } from "../commands/GetFindingAggregatorCommand";
40
+ import { GetFindingHistoryCommandInput, GetFindingHistoryCommandOutput } from "../commands/GetFindingHistoryCommand";
40
41
  import { GetFindingsCommandInput, GetFindingsCommandOutput } from "../commands/GetFindingsCommand";
41
42
  import { GetInsightResultsCommandInput, GetInsightResultsCommandOutput } from "../commands/GetInsightResultsCommand";
42
43
  import { GetInsightsCommandInput, GetInsightsCommandOutput } from "../commands/GetInsightsCommand";
@@ -209,6 +210,10 @@ export declare const se_GetEnabledStandardsCommand: (input: GetEnabledStandardsC
209
210
  * serializeAws_restJson1GetFindingAggregatorCommand
210
211
  */
211
212
  export declare const se_GetFindingAggregatorCommand: (input: GetFindingAggregatorCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
213
+ /**
214
+ * serializeAws_restJson1GetFindingHistoryCommand
215
+ */
216
+ export declare const se_GetFindingHistoryCommand: (input: GetFindingHistoryCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
212
217
  /**
213
218
  * serializeAws_restJson1GetFindingsCommand
214
219
  */
@@ -453,6 +458,10 @@ export declare const de_GetEnabledStandardsCommand: (output: __HttpResponse, con
453
458
  * deserializeAws_restJson1GetFindingAggregatorCommand
454
459
  */
455
460
  export declare const de_GetFindingAggregatorCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetFindingAggregatorCommandOutput>;
461
+ /**
462
+ * deserializeAws_restJson1GetFindingHistoryCommand
463
+ */
464
+ export declare const de_GetFindingHistoryCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetFindingHistoryCommandOutput>;
456
465
  /**
457
466
  * deserializeAws_restJson1GetFindingsCommand
458
467
  */
@@ -147,6 +147,10 @@ import {
147
147
  GetFindingAggregatorCommandInput,
148
148
  GetFindingAggregatorCommandOutput,
149
149
  } from "./commands/GetFindingAggregatorCommand";
150
+ import {
151
+ GetFindingHistoryCommandInput,
152
+ GetFindingHistoryCommandOutput,
153
+ } from "./commands/GetFindingHistoryCommand";
150
154
  import {
151
155
  GetFindingsCommandInput,
152
156
  GetFindingsCommandOutput,
@@ -750,6 +754,19 @@ export interface SecurityHub {
750
754
  options: __HttpHandlerOptions,
751
755
  cb: (err: any, data?: GetFindingAggregatorCommandOutput) => void
752
756
  ): void;
757
+ getFindingHistory(
758
+ args: GetFindingHistoryCommandInput,
759
+ options?: __HttpHandlerOptions
760
+ ): Promise<GetFindingHistoryCommandOutput>;
761
+ getFindingHistory(
762
+ args: GetFindingHistoryCommandInput,
763
+ cb: (err: any, data?: GetFindingHistoryCommandOutput) => void
764
+ ): void;
765
+ getFindingHistory(
766
+ args: GetFindingHistoryCommandInput,
767
+ options: __HttpHandlerOptions,
768
+ cb: (err: any, data?: GetFindingHistoryCommandOutput) => void
769
+ ): void;
753
770
  getFindings(
754
771
  args: GetFindingsCommandInput,
755
772
  options?: __HttpHandlerOptions
@@ -192,6 +192,10 @@ import {
192
192
  GetFindingAggregatorCommandInput,
193
193
  GetFindingAggregatorCommandOutput,
194
194
  } from "./commands/GetFindingAggregatorCommand";
195
+ import {
196
+ GetFindingHistoryCommandInput,
197
+ GetFindingHistoryCommandOutput,
198
+ } from "./commands/GetFindingHistoryCommand";
195
199
  import {
196
200
  GetFindingsCommandInput,
197
201
  GetFindingsCommandOutput,
@@ -331,6 +335,7 @@ export type ServiceInputTypes =
331
335
  | GetAdministratorAccountCommandInput
332
336
  | GetEnabledStandardsCommandInput
333
337
  | GetFindingAggregatorCommandInput
338
+ | GetFindingHistoryCommandInput
334
339
  | GetFindingsCommandInput
335
340
  | GetInsightResultsCommandInput
336
341
  | GetInsightsCommandInput
@@ -393,6 +398,7 @@ export type ServiceOutputTypes =
393
398
  | GetAdministratorAccountCommandOutput
394
399
  | GetEnabledStandardsCommandOutput
395
400
  | GetFindingAggregatorCommandOutput
401
+ | GetFindingHistoryCommandOutput
396
402
  | GetFindingsCommandOutput
397
403
  | GetInsightResultsCommandOutput
398
404
  | GetInsightsCommandOutput