@aws-sdk/client-securityhub 3.326.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.
- package/README.md +8 -0
- package/dist-cjs/SecurityHub.js +2 -0
- package/dist-cjs/commands/GetFindingHistoryCommand.js +45 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_2.js +5 -1
- package/dist-cjs/pagination/GetFindingHistoryPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_restJson1.js +90 -3
- package/dist-es/SecurityHub.js +2 -0
- package/dist-es/commands/GetFindingHistoryCommand.js +41 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_2.js +4 -0
- package/dist-es/pagination/GetFindingHistoryPaginator.js +25 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +85 -0
- package/dist-types/SecurityHub.d.ts +7 -0
- package/dist-types/SecurityHubClient.d.ts +3 -2
- package/dist-types/commands/GetFindingHistoryCommand.d.ts +157 -0
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/models/models_1.d.ts +16 -16
- package/dist-types/models/models_2.d.ts +196 -1
- package/dist-types/pagination/GetFindingHistoryPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +9 -0
- package/dist-types/ts3.4/SecurityHub.d.ts +17 -0
- package/dist-types/ts3.4/SecurityHubClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/GetFindingHistoryCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_2.d.ts +35 -0
- package/dist-types/ts3.4/pagination/GetFindingHistoryPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +12 -0
- package/package.json +7 -7
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
|
|
4
|
+
import { GetFindingHistoryRequest, GetFindingHistoryResponse } from "../models/models_2";
|
|
5
|
+
import { SecurityHubClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecurityHubClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
9
|
+
* The input for {@link GetFindingHistoryCommand}.
|
|
10
|
+
*/
|
|
11
|
+
export interface GetFindingHistoryCommandInput extends GetFindingHistoryRequest {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
16
|
+
* The output of {@link GetFindingHistoryCommand}.
|
|
17
|
+
*/
|
|
18
|
+
export interface GetFindingHistoryCommandOutput extends GetFindingHistoryResponse, __MetadataBearer {
|
|
19
|
+
}
|
|
20
|
+
/**
|
|
21
|
+
* @public
|
|
22
|
+
* <p>
|
|
23
|
+
* Returns history for a Security Hub finding in the last 90 days. The history includes changes made to any fields in
|
|
24
|
+
* the Amazon Web Services Security Finding Format (ASFF).
|
|
25
|
+
* </p>
|
|
26
|
+
* @example
|
|
27
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
28
|
+
* ```javascript
|
|
29
|
+
* import { SecurityHubClient, GetFindingHistoryCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
|
|
30
|
+
* // const { SecurityHubClient, GetFindingHistoryCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
|
|
31
|
+
* const client = new SecurityHubClient(config);
|
|
32
|
+
* const input = { // GetFindingHistoryRequest
|
|
33
|
+
* FindingIdentifier: { // AwsSecurityFindingIdentifier
|
|
34
|
+
* Id: "STRING_VALUE", // required
|
|
35
|
+
* ProductArn: "STRING_VALUE", // required
|
|
36
|
+
* },
|
|
37
|
+
* StartTime: new Date("TIMESTAMP"),
|
|
38
|
+
* EndTime: new Date("TIMESTAMP"),
|
|
39
|
+
* NextToken: "STRING_VALUE",
|
|
40
|
+
* MaxResults: Number("int"),
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetFindingHistoryCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetFindingHistoryResponse
|
|
45
|
+
* // Records: [ // FindingHistoryRecordList
|
|
46
|
+
* // { // FindingHistoryRecord
|
|
47
|
+
* // FindingIdentifier: { // AwsSecurityFindingIdentifier
|
|
48
|
+
* // Id: "STRING_VALUE", // required
|
|
49
|
+
* // ProductArn: "STRING_VALUE", // required
|
|
50
|
+
* // },
|
|
51
|
+
* // UpdateTime: new Date("TIMESTAMP"),
|
|
52
|
+
* // FindingCreated: true || false,
|
|
53
|
+
* // UpdateSource: { // FindingHistoryUpdateSource
|
|
54
|
+
* // Type: "BATCH_UPDATE_FINDINGS" || "BATCH_IMPORT_FINDINGS",
|
|
55
|
+
* // Identity: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // Updates: [ // FindingHistoryUpdatesList
|
|
58
|
+
* // { // FindingHistoryUpdate
|
|
59
|
+
* // UpdatedField: "STRING_VALUE",
|
|
60
|
+
* // OldValue: "STRING_VALUE",
|
|
61
|
+
* // NewValue: "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // ],
|
|
64
|
+
* // NextToken: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // NextToken: "STRING_VALUE",
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param GetFindingHistoryCommandInput - {@link GetFindingHistoryCommandInput}
|
|
73
|
+
* @returns {@link GetFindingHistoryCommandOutput}
|
|
74
|
+
* @see {@link GetFindingHistoryCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link GetFindingHistoryCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InternalException} (server fault)
|
|
79
|
+
* <p>Internal server error.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InvalidAccessException} (client fault)
|
|
82
|
+
* <p>The account doesn't have permission to perform this action.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
85
|
+
* <p>The request was rejected because you supplied an invalid or out-of-range value for an
|
|
86
|
+
* input parameter.</p>
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
89
|
+
* <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
|
|
90
|
+
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link SecurityHubServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
94
|
+
*
|
|
95
|
+
* @example To get finding history
|
|
96
|
+
* ```javascript
|
|
97
|
+
* // The following example retrieves the history of the specified finding during the specified time frame. If the time frame permits, Security Hub returns finding history for the last 90 days.
|
|
98
|
+
* const input = {
|
|
99
|
+
* "EndTime": "2021-09-31T15:53:35.573Z",
|
|
100
|
+
* "FindingIdentifier": {
|
|
101
|
+
* "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
102
|
+
* "ProductArn": "arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default"
|
|
103
|
+
* },
|
|
104
|
+
* "MaxResults": 2,
|
|
105
|
+
* "StartTime": "2021-09-30T15:53:35.573Z"
|
|
106
|
+
* };
|
|
107
|
+
* const command = new GetFindingHistoryCommand(input);
|
|
108
|
+
* const response = await client.send(command);
|
|
109
|
+
* /* response ==
|
|
110
|
+
* {
|
|
111
|
+
* "Records": [
|
|
112
|
+
* {
|
|
113
|
+
* "FindingCreated": false,
|
|
114
|
+
* "FindingIdentifier": {
|
|
115
|
+
* "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
116
|
+
* "ProductArn": "arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default"
|
|
117
|
+
* },
|
|
118
|
+
* "UpdateSource": {
|
|
119
|
+
* "Identity": "arn:aws:iam::444455556666:role/Admin",
|
|
120
|
+
* "Type": "BATCH_UPDATE_FINDINGS"
|
|
121
|
+
* },
|
|
122
|
+
* "UpdateTime": "2021-09-31T15:52:25.573Z",
|
|
123
|
+
* "Updates": [
|
|
124
|
+
* {
|
|
125
|
+
* "NewValue": "MEDIUM",
|
|
126
|
+
* "OldValue": "HIGH",
|
|
127
|
+
* "UpdatedField": "Severity"
|
|
128
|
+
* }
|
|
129
|
+
* ]
|
|
130
|
+
* }
|
|
131
|
+
* ]
|
|
132
|
+
* }
|
|
133
|
+
* *\/
|
|
134
|
+
* // example id: to-get-finding-history-1680270012186
|
|
135
|
+
* ```
|
|
136
|
+
*
|
|
137
|
+
*/
|
|
138
|
+
export declare class GetFindingHistoryCommand extends $Command<GetFindingHistoryCommandInput, GetFindingHistoryCommandOutput, SecurityHubClientResolvedConfig> {
|
|
139
|
+
readonly input: GetFindingHistoryCommandInput;
|
|
140
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
141
|
+
/**
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
constructor(input: GetFindingHistoryCommandInput);
|
|
145
|
+
/**
|
|
146
|
+
* @internal
|
|
147
|
+
*/
|
|
148
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecurityHubClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetFindingHistoryCommandInput, GetFindingHistoryCommandOutput>;
|
|
149
|
+
/**
|
|
150
|
+
* @internal
|
|
151
|
+
*/
|
|
152
|
+
private serialize;
|
|
153
|
+
/**
|
|
154
|
+
* @internal
|
|
155
|
+
*/
|
|
156
|
+
private deserialize;
|
|
157
|
+
}
|
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@aws-sdk/smithy-client";
|
|
3
|
+
import {
|
|
4
|
+
Handler,
|
|
5
|
+
HttpHandlerOptions as __HttpHandlerOptions,
|
|
6
|
+
MetadataBearer as __MetadataBearer,
|
|
7
|
+
MiddlewareStack,
|
|
8
|
+
} from "@aws-sdk/types";
|
|
9
|
+
import {
|
|
10
|
+
GetFindingHistoryRequest,
|
|
11
|
+
GetFindingHistoryResponse,
|
|
12
|
+
} from "../models/models_2";
|
|
13
|
+
import {
|
|
14
|
+
SecurityHubClientResolvedConfig,
|
|
15
|
+
ServiceInputTypes,
|
|
16
|
+
ServiceOutputTypes,
|
|
17
|
+
} from "../SecurityHubClient";
|
|
18
|
+
export interface GetFindingHistoryCommandInput
|
|
19
|
+
extends GetFindingHistoryRequest {}
|
|
20
|
+
export interface GetFindingHistoryCommandOutput
|
|
21
|
+
extends GetFindingHistoryResponse,
|
|
22
|
+
__MetadataBearer {}
|
|
23
|
+
export declare class GetFindingHistoryCommand extends $Command<
|
|
24
|
+
GetFindingHistoryCommandInput,
|
|
25
|
+
GetFindingHistoryCommandOutput,
|
|
26
|
+
SecurityHubClientResolvedConfig
|
|
27
|
+
> {
|
|
28
|
+
readonly input: GetFindingHistoryCommandInput;
|
|
29
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
30
|
+
constructor(input: GetFindingHistoryCommandInput);
|
|
31
|
+
resolveMiddleware(
|
|
32
|
+
clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
|
|
33
|
+
configuration: SecurityHubClientResolvedConfig,
|
|
34
|
+
options?: __HttpHandlerOptions
|
|
35
|
+
): Handler<GetFindingHistoryCommandInput, GetFindingHistoryCommandOutput>;
|
|
36
|
+
private serialize;
|
|
37
|
+
private deserialize;
|
|
38
|
+
}
|