@aws-sdk/client-securityhub 3.830.0 → 3.831.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 +208 -0
- package/dist-cjs/index.js +1956 -51
- package/dist-es/SecurityHub.js +52 -0
- package/dist-es/commands/BatchUpdateFindingsV2Command.js +22 -0
- package/dist-es/commands/ConnectorRegistrationsV2Command.js +22 -0
- package/dist-es/commands/CreateAggregatorV2Command.js +22 -0
- package/dist-es/commands/CreateAutomationRuleV2Command.js +22 -0
- package/dist-es/commands/CreateConnectorV2Command.js +23 -0
- package/dist-es/commands/CreateTicketV2Command.js +22 -0
- package/dist-es/commands/DeleteAggregatorV2Command.js +22 -0
- package/dist-es/commands/DeleteAutomationRuleV2Command.js +22 -0
- package/dist-es/commands/DeleteConnectorV2Command.js +22 -0
- package/dist-es/commands/DescribeProductsV2Command.js +22 -0
- package/dist-es/commands/DescribeSecurityHubV2Command.js +22 -0
- package/dist-es/commands/DisableSecurityHubV2Command.js +22 -0
- package/dist-es/commands/EnableSecurityHubV2Command.js +22 -0
- package/dist-es/commands/GetAggregatorV2Command.js +22 -0
- package/dist-es/commands/GetAutomationRuleV2Command.js +22 -0
- package/dist-es/commands/GetConnectorV2Command.js +22 -0
- package/dist-es/commands/GetFindingStatisticsV2Command.js +22 -0
- package/dist-es/commands/GetFindingsV2Command.js +22 -0
- package/dist-es/commands/GetResourcesStatisticsV2Command.js +22 -0
- package/dist-es/commands/GetResourcesV2Command.js +22 -0
- package/dist-es/commands/ListAggregatorsV2Command.js +22 -0
- package/dist-es/commands/ListAutomationRulesV2Command.js +22 -0
- package/dist-es/commands/ListConnectorsV2Command.js +22 -0
- package/dist-es/commands/UpdateAggregatorV2Command.js +22 -0
- package/dist-es/commands/UpdateAutomationRuleV2Command.js +22 -0
- package/dist-es/commands/UpdateConnectorV2Command.js +23 -0
- package/dist-es/commands/index.js +26 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +13 -0
- package/dist-es/models/models_2.js +193 -19
- package/dist-es/models/models_3.js +101 -0
- package/dist-es/pagination/DescribeProductsV2Paginator.js +4 -0
- package/dist-es/pagination/GetFindingsV2Paginator.js +4 -0
- package/dist-es/pagination/GetResourcesV2Paginator.js +4 -0
- package/dist-es/pagination/ListAggregatorsV2Paginator.js +4 -0
- package/dist-es/pagination/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +1071 -32
- package/dist-types/SecurityHub.d.ts +192 -0
- package/dist-types/SecurityHubClient.d.ts +28 -2
- package/dist-types/commands/BatchGetAutomationRulesCommand.d.ts +5 -5
- package/dist-types/commands/BatchUpdateAutomationRulesCommand.d.ts +5 -5
- package/dist-types/commands/BatchUpdateFindingsCommand.d.ts +16 -12
- package/dist-types/commands/BatchUpdateFindingsV2Command.d.ts +129 -0
- package/dist-types/commands/ConnectorRegistrationsV2Command.d.ts +96 -0
- package/dist-types/commands/CreateAggregatorV2Command.d.ts +106 -0
- package/dist-types/commands/CreateAutomationRuleCommand.d.ts +5 -5
- package/dist-types/commands/CreateAutomationRuleV2Command.d.ts +174 -0
- package/dist-types/commands/CreateConnectorV2Command.d.ts +112 -0
- package/dist-types/commands/CreateInsightCommand.d.ts +5 -5
- package/dist-types/commands/CreateTicketV2Command.d.ts +97 -0
- package/dist-types/commands/DeleteAggregatorV2Command.d.ts +92 -0
- package/dist-types/commands/DeleteAutomationRuleV2Command.d.ts +92 -0
- package/dist-types/commands/DeleteConnectorV2Command.d.ts +92 -0
- package/dist-types/commands/DescribeProductsV2Command.d.ts +107 -0
- package/dist-types/commands/DescribeSecurityHubV2Command.d.ts +87 -0
- package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts +1 -0
- package/dist-types/commands/DisableSecurityHubV2Command.d.ts +84 -0
- package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts +6 -2
- package/dist-types/commands/EnableSecurityHubV2Command.d.ts +90 -0
- package/dist-types/commands/GetAggregatorV2Command.d.ts +99 -0
- package/dist-types/commands/GetAutomationRuleV2Command.d.ts +176 -0
- package/dist-types/commands/GetConnectorV2Command.d.ts +119 -0
- package/dist-types/commands/GetFindingHistoryCommand.d.ts +8 -2
- package/dist-types/commands/GetFindingStatisticsV2Command.d.ts +169 -0
- package/dist-types/commands/GetFindingsCommand.d.ts +7 -6
- package/dist-types/commands/GetFindingsV2Command.d.ts +163 -0
- package/dist-types/commands/GetInsightResultsCommand.d.ts +1 -1
- package/dist-types/commands/GetInsightsCommand.d.ts +6 -6
- package/dist-types/commands/GetInvitationsCountCommand.d.ts +1 -1
- package/dist-types/commands/GetMasterAccountCommand.d.ts +1 -1
- package/dist-types/commands/GetMembersCommand.d.ts +1 -1
- package/dist-types/commands/GetResourcesStatisticsV2Command.d.ts +162 -0
- package/dist-types/commands/GetResourcesV2Command.d.ts +190 -0
- package/dist-types/commands/GetSecurityControlDefinitionCommand.d.ts +1 -1
- package/dist-types/commands/InviteMembersCommand.d.ts +1 -1
- package/dist-types/commands/ListAggregatorsV2Command.d.ts +100 -0
- package/dist-types/commands/ListAutomationRulesCommand.d.ts +1 -1
- package/dist-types/commands/ListAutomationRulesV2Command.d.ts +109 -0
- package/dist-types/commands/ListConfigurationPoliciesCommand.d.ts +1 -1
- package/dist-types/commands/ListConfigurationPolicyAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListConnectorsV2Command.d.ts +110 -0
- package/dist-types/commands/ListEnabledProductsForImportCommand.d.ts +1 -1
- package/dist-types/commands/ListFindingAggregatorsCommand.d.ts +1 -1
- package/dist-types/commands/ListInvitationsCommand.d.ts +1 -1
- package/dist-types/commands/ListMembersCommand.d.ts +1 -1
- package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +3 -1
- package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +1 -1
- package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts +1 -1
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/commands/StartConfigurationPolicyAssociationCommand.d.ts +1 -1
- package/dist-types/commands/StartConfigurationPolicyDisassociationCommand.d.ts +1 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/commands/UpdateActionTargetCommand.d.ts +1 -1
- package/dist-types/commands/UpdateAggregatorV2Command.d.ts +103 -0
- package/dist-types/commands/UpdateAutomationRuleV2Command.d.ts +171 -0
- package/dist-types/commands/UpdateConfigurationPolicyCommand.d.ts +1 -1
- package/dist-types/commands/UpdateConnectorV2Command.d.ts +99 -0
- package/dist-types/commands/UpdateFindingAggregatorCommand.d.ts +1 -1
- package/dist-types/commands/UpdateFindingsCommand.d.ts +6 -6
- package/dist-types/commands/UpdateInsightCommand.d.ts +6 -6
- package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSecurityControlCommand.d.ts +1 -1
- package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/UpdateStandardsControlCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +26 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +166 -320
- package/dist-types/models/models_1.d.ts +319 -343
- package/dist-types/models/models_2.d.ts +2465 -2269
- package/dist-types/models/models_3.d.ts +2386 -0
- package/dist-types/pagination/DescribeProductsV2Paginator.d.ts +7 -0
- package/dist-types/pagination/GetFindingsV2Paginator.d.ts +7 -0
- package/dist-types/pagination/GetResourcesV2Paginator.d.ts +7 -0
- package/dist-types/pagination/ListAggregatorsV2Paginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +4 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +234 -0
- package/dist-types/ts3.4/SecurityHub.d.ts +452 -0
- package/dist-types/ts3.4/SecurityHubClient.d.ts +156 -0
- package/dist-types/ts3.4/commands/BatchUpdateFindingsV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/ConnectorRegistrationsV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateAggregatorV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateAutomationRuleV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateConnectorV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/CreateTicketV2Command.d.ts +50 -0
- package/dist-types/ts3.4/commands/DeleteAggregatorV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteAutomationRuleV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/DeleteConnectorV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeProductsV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/DescribeSecurityHubV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/DisableSecurityHubV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/EnableOrganizationAdminAccountCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/EnableSecurityHubV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetAggregatorV2Command.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetAutomationRuleV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetConnectorV2Command.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetFindingStatisticsV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetFindingsCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/GetFindingsV2Command.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetInsightResultsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInsightsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetInvitationsCountCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMasterAccountCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetMembersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/GetResourcesStatisticsV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/GetResourcesV2Command.d.ts +50 -0
- package/dist-types/ts3.4/commands/GetSecurityControlDefinitionCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/InviteMembersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAggregatorsV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListAutomationRulesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListAutomationRulesV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListConfigurationPoliciesCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListConfigurationPolicyAssociationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListConnectorsV2Command.d.ts +50 -0
- package/dist-types/ts3.4/commands/ListEnabledProductsForImportCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListFindingAggregatorsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListInvitationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListMembersCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListOrganizationAdminAccountsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListSecurityControlDefinitionsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListStandardsControlAssociationsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartConfigurationPolicyAssociationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/StartConfigurationPolicyDisassociationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateActionTargetCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateAggregatorV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateAutomationRuleV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateConfigurationPolicyCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateConnectorV2Command.d.ts +51 -0
- package/dist-types/ts3.4/commands/UpdateFindingAggregatorCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateFindingsCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateInsightCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateOrganizationConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSecurityControlCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateSecurityHubConfigurationCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/UpdateStandardsControlCommand.d.ts +1 -1
- package/dist-types/ts3.4/commands/index.d.ts +26 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +50 -57
- package/dist-types/ts3.4/models/models_1.d.ts +57 -66
- package/dist-types/ts3.4/models/models_2.d.ts +522 -310
- package/dist-types/ts3.4/models/models_3.d.ts +626 -0
- package/dist-types/ts3.4/pagination/DescribeProductsV2Paginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetFindingsV2Paginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/GetResourcesV2Paginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListAggregatorsV2Paginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +4 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +312 -0
- package/package.json +4 -2
|
@@ -0,0 +1,2386 @@
|
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
|
+
import { DocumentType as __DocumentType } from "@smithy/types";
|
|
3
|
+
import { AdminAccount, AggregatorV2, AllowedOperators, AssociationFilters, AssociationStatus, AssociationType, AutoEnableStandards, AutomationRulesActionV2, AutomationRulesMetadata, AutomationRulesMetadataV2, ConfigurationPolicyAssociationStatus, DateFilter, MapFilter, NoteUpdate, NumberFilter, RuleStatusV2, StringFilter } from "./models_0";
|
|
4
|
+
import { RecordState } from "./models_1";
|
|
5
|
+
import { AwsSecurityFinding, AwsSecurityFindingFilters, ConfigurationOptions, ConfigurationPolicyAssociationSummary, ConfigurationPolicySummary, ConnectorProviderName, ConnectorStatus, ConnectorSummary, ControlFindingGenerator, ControlStatus, Criteria, FindingAggregator, Invitation, OcsfFindingFilters, OrganizationConfiguration, ParameterConfiguration, Policy, Result, SecurityControlProperty, SecurityHubFeature, SeverityRating, SortCriterion, SortOrder, Target, TargetType } from "./models_2";
|
|
6
|
+
import { SecurityHubServiceException as __BaseException } from "./SecurityHubServiceException";
|
|
7
|
+
/**
|
|
8
|
+
* @public
|
|
9
|
+
*/
|
|
10
|
+
export interface GetFindingsResponse {
|
|
11
|
+
/**
|
|
12
|
+
* <p>The findings that matched the filters specified in the request.</p>
|
|
13
|
+
* @public
|
|
14
|
+
*/
|
|
15
|
+
Findings: AwsSecurityFinding[] | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* <p>The pagination token to use to request the next page of results.</p>
|
|
18
|
+
* @public
|
|
19
|
+
*/
|
|
20
|
+
NextToken?: string | undefined;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* @public
|
|
24
|
+
* @enum
|
|
25
|
+
*/
|
|
26
|
+
export declare const GroupByField: {
|
|
27
|
+
readonly ACTIVITY_NAME: "activity_name";
|
|
28
|
+
readonly CLASS_NAME: "class_name";
|
|
29
|
+
readonly CLOUD_ACCOUNT_UID: "cloud.account.uid";
|
|
30
|
+
readonly CLOUD_PROVIDER: "cloud.provider";
|
|
31
|
+
readonly CLOUD_REGION: "cloud.region";
|
|
32
|
+
readonly COMPLIANCE_ASSESSMENTS_NAME: "compliance.assessments.name";
|
|
33
|
+
readonly COMPLIANCE_CONTROL: "compliance.control";
|
|
34
|
+
readonly COMPLIANCE_STATUS: "compliance.status";
|
|
35
|
+
readonly FINDING_INFO_TITLE: "finding_info.title";
|
|
36
|
+
readonly FINDING_INFO_TYPES: "finding_info.types";
|
|
37
|
+
readonly METADATA_PRODUCT_NAME: "metadata.product.name";
|
|
38
|
+
readonly METADATA_PRODUCT_UID: "metadata.product.uid";
|
|
39
|
+
readonly RESOURCES_TYPE: "resources.type";
|
|
40
|
+
readonly RESOURCES_UID: "resources.uid";
|
|
41
|
+
readonly SEVERITY: "severity";
|
|
42
|
+
readonly STATUS: "status";
|
|
43
|
+
readonly VULNERABILITIES_FIX_COVERAGE: "vulnerabilities.fix_coverage";
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* @public
|
|
47
|
+
*/
|
|
48
|
+
export type GroupByField = (typeof GroupByField)[keyof typeof GroupByField];
|
|
49
|
+
/**
|
|
50
|
+
* <p>Defines the how the finding attribute should be grouped.</p>
|
|
51
|
+
* @public
|
|
52
|
+
*/
|
|
53
|
+
export interface GroupByRule {
|
|
54
|
+
/**
|
|
55
|
+
* <p>The criteria used to select which security findings should be included in the grouping operation.</p>
|
|
56
|
+
* @public
|
|
57
|
+
*/
|
|
58
|
+
Filters?: OcsfFindingFilters | undefined;
|
|
59
|
+
/**
|
|
60
|
+
* <p>The attribute by which filtered findings should be grouped.</p>
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
GroupByField: GroupByField | undefined;
|
|
64
|
+
}
|
|
65
|
+
/**
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
export interface GetFindingStatisticsV2Request {
|
|
69
|
+
/**
|
|
70
|
+
* <p>Specifies how security findings should be aggregated and organized in the statistical analysis.
|
|
71
|
+
* It can accept up to 5 <code>groupBy</code> fields in a single call.</p>
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
GroupByRules: GroupByRule[] | undefined;
|
|
75
|
+
/**
|
|
76
|
+
* <p>Orders the aggregation count in descending or ascending order.
|
|
77
|
+
* Descending order is the default.</p>
|
|
78
|
+
* @public
|
|
79
|
+
*/
|
|
80
|
+
SortOrder?: SortOrder | undefined;
|
|
81
|
+
/**
|
|
82
|
+
* <p>The maximum number of results to be returned.</p>
|
|
83
|
+
* @public
|
|
84
|
+
*/
|
|
85
|
+
MaxStatisticResults?: number | undefined;
|
|
86
|
+
}
|
|
87
|
+
/**
|
|
88
|
+
* <p>Represents individual aggregated results when grouping security findings for each <code>GroupByField</code>.</p>
|
|
89
|
+
* @public
|
|
90
|
+
*/
|
|
91
|
+
export interface GroupByValue {
|
|
92
|
+
/**
|
|
93
|
+
* <p>The value of the field by which findings are grouped.</p>
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
FieldValue?: string | undefined;
|
|
97
|
+
/**
|
|
98
|
+
* <p>The number of findings for a specific <code>FieldValue</code> and <code>GroupByField</code>.</p>
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
Count?: number | undefined;
|
|
102
|
+
}
|
|
103
|
+
/**
|
|
104
|
+
* <p>Represents finding statistics grouped by <code>GroupedByField</code>.</p>
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export interface GroupByResult {
|
|
108
|
+
/**
|
|
109
|
+
* <p>The attribute by which filtered security findings should be grouped.</p>
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
GroupByField?: string | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* <p>An array of grouped values and their respective counts for each <code>GroupByField</code>.</p>
|
|
115
|
+
* @public
|
|
116
|
+
*/
|
|
117
|
+
GroupByValues?: GroupByValue[] | undefined;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* @public
|
|
121
|
+
*/
|
|
122
|
+
export interface GetFindingStatisticsV2Response {
|
|
123
|
+
/**
|
|
124
|
+
* <p>Aggregated statistics about security findings based on specified grouping criteria.</p>
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
GroupByResults?: GroupByResult[] | undefined;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* @public
|
|
131
|
+
*/
|
|
132
|
+
export interface GetFindingsV2Request {
|
|
133
|
+
/**
|
|
134
|
+
* <p>The finding attributes used to define a condition to filter the returned OCSF findings.
|
|
135
|
+
* You can filter up to 10 composite filters.
|
|
136
|
+
* For each filter type inside of a composite filter, you can provide up to 20 filters.</p>
|
|
137
|
+
* @public
|
|
138
|
+
*/
|
|
139
|
+
Filters?: OcsfFindingFilters | undefined;
|
|
140
|
+
/**
|
|
141
|
+
* <p>The finding attributes used to sort the list of returned findings.</p>
|
|
142
|
+
* @public
|
|
143
|
+
*/
|
|
144
|
+
SortCriteria?: SortCriterion[] | undefined;
|
|
145
|
+
/**
|
|
146
|
+
* <p>
|
|
147
|
+
* The token required for pagination.
|
|
148
|
+
* On your first call, set the value of this parameter to <code>NULL</code>.
|
|
149
|
+
* For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.</p>
|
|
150
|
+
* @public
|
|
151
|
+
*/
|
|
152
|
+
NextToken?: string | undefined;
|
|
153
|
+
/**
|
|
154
|
+
* <p>The maximum number of results to return.</p>
|
|
155
|
+
* @public
|
|
156
|
+
*/
|
|
157
|
+
MaxResults?: number | undefined;
|
|
158
|
+
}
|
|
159
|
+
/**
|
|
160
|
+
* @public
|
|
161
|
+
*/
|
|
162
|
+
export interface GetFindingsV2Response {
|
|
163
|
+
/**
|
|
164
|
+
* <p>An array of security findings returned by the operation.</p>
|
|
165
|
+
* @public
|
|
166
|
+
*/
|
|
167
|
+
Findings?: __DocumentType[] | undefined;
|
|
168
|
+
/**
|
|
169
|
+
* <p>The pagination token to use to request the next page of results.
|
|
170
|
+
* Otherwise, this parameter is null.</p>
|
|
171
|
+
* @public
|
|
172
|
+
*/
|
|
173
|
+
NextToken?: string | undefined;
|
|
174
|
+
}
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
178
|
+
export interface GetInsightResultsRequest {
|
|
179
|
+
/**
|
|
180
|
+
* <p>The ARN of the insight for which to return results.</p>
|
|
181
|
+
* @public
|
|
182
|
+
*/
|
|
183
|
+
InsightArn: string | undefined;
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* <p>The insight result values returned by the <code>GetInsightResults</code>
|
|
187
|
+
* operation.</p>
|
|
188
|
+
* @public
|
|
189
|
+
*/
|
|
190
|
+
export interface InsightResultValue {
|
|
191
|
+
/**
|
|
192
|
+
* <p>The value of the attribute that the findings are grouped by for the insight whose
|
|
193
|
+
* results are returned by the <code>GetInsightResults</code> operation.</p>
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
196
|
+
GroupByAttributeValue: string | undefined;
|
|
197
|
+
/**
|
|
198
|
+
* <p>The number of findings returned for each <code>GroupByAttributeValue</code>.</p>
|
|
199
|
+
* @public
|
|
200
|
+
*/
|
|
201
|
+
Count: number | undefined;
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* <p>The insight results returned by the <code>GetInsightResults</code> operation.</p>
|
|
205
|
+
* @public
|
|
206
|
+
*/
|
|
207
|
+
export interface InsightResults {
|
|
208
|
+
/**
|
|
209
|
+
* <p>The ARN of the insight whose results are returned by the <code>GetInsightResults</code>
|
|
210
|
+
* operation.</p>
|
|
211
|
+
* @public
|
|
212
|
+
*/
|
|
213
|
+
InsightArn: string | undefined;
|
|
214
|
+
/**
|
|
215
|
+
* <p>The attribute that the findings are grouped by for the insight whose results are
|
|
216
|
+
* returned by the <code>GetInsightResults</code> operation.</p>
|
|
217
|
+
* @public
|
|
218
|
+
*/
|
|
219
|
+
GroupByAttribute: string | undefined;
|
|
220
|
+
/**
|
|
221
|
+
* <p>The list of insight result values returned by the <code>GetInsightResults</code>
|
|
222
|
+
* operation.</p>
|
|
223
|
+
* @public
|
|
224
|
+
*/
|
|
225
|
+
ResultValues: InsightResultValue[] | undefined;
|
|
226
|
+
}
|
|
227
|
+
/**
|
|
228
|
+
* @public
|
|
229
|
+
*/
|
|
230
|
+
export interface GetInsightResultsResponse {
|
|
231
|
+
/**
|
|
232
|
+
* <p>The insight results returned by the operation.</p>
|
|
233
|
+
* @public
|
|
234
|
+
*/
|
|
235
|
+
InsightResults: InsightResults | undefined;
|
|
236
|
+
}
|
|
237
|
+
/**
|
|
238
|
+
* @public
|
|
239
|
+
*/
|
|
240
|
+
export interface GetInsightsRequest {
|
|
241
|
+
/**
|
|
242
|
+
* <p>The ARNs of the insights to describe. If you don't provide any insight ARNs, then
|
|
243
|
+
* <code>GetInsights</code> returns all of your custom insights. It does not return any
|
|
244
|
+
* managed insights.</p>
|
|
245
|
+
* @public
|
|
246
|
+
*/
|
|
247
|
+
InsightArns?: string[] | undefined;
|
|
248
|
+
/**
|
|
249
|
+
* <p>The token that is required for pagination. On your first call to the
|
|
250
|
+
* <code>GetInsights</code> operation, set the value of this parameter to
|
|
251
|
+
* <code>NULL</code>.</p>
|
|
252
|
+
* <p>For subsequent calls to the operation, to continue listing data, set the value of this
|
|
253
|
+
* parameter to the value returned from the previous response.</p>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
NextToken?: string | undefined;
|
|
257
|
+
/**
|
|
258
|
+
* <p>The maximum number of items to return in the response.</p>
|
|
259
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
MaxResults?: number | undefined;
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* <p>Contains information about a Security Hub insight.</p>
|
|
265
|
+
* @public
|
|
266
|
+
*/
|
|
267
|
+
export interface Insight {
|
|
268
|
+
/**
|
|
269
|
+
* <p>The ARN of a Security Hub insight.</p>
|
|
270
|
+
* @public
|
|
271
|
+
*/
|
|
272
|
+
InsightArn: string | undefined;
|
|
273
|
+
/**
|
|
274
|
+
* <p>The name of a Security Hub insight.</p>
|
|
275
|
+
* @public
|
|
276
|
+
*/
|
|
277
|
+
Name: string | undefined;
|
|
278
|
+
/**
|
|
279
|
+
* <p>One or more attributes used to filter the findings included in the insight. You can filter by up to ten finding attributes. For each attribute, you can provide up to 20 filter values.
|
|
280
|
+
* The insight only includes findings that match the criteria defined in the filters.</p>
|
|
281
|
+
* @public
|
|
282
|
+
*/
|
|
283
|
+
Filters: AwsSecurityFindingFilters | undefined;
|
|
284
|
+
/**
|
|
285
|
+
* <p>The grouping attribute for the insight's findings. Indicates how to group the matching
|
|
286
|
+
* findings, and identifies the type of item that the insight applies to. For example, if an
|
|
287
|
+
* insight is grouped by resource identifier, then the insight produces a list of resource
|
|
288
|
+
* identifiers.</p>
|
|
289
|
+
* @public
|
|
290
|
+
*/
|
|
291
|
+
GroupByAttribute: string | undefined;
|
|
292
|
+
}
|
|
293
|
+
/**
|
|
294
|
+
* @public
|
|
295
|
+
*/
|
|
296
|
+
export interface GetInsightsResponse {
|
|
297
|
+
/**
|
|
298
|
+
* <p>The insights returned by the operation.</p>
|
|
299
|
+
* @public
|
|
300
|
+
*/
|
|
301
|
+
Insights: Insight[] | undefined;
|
|
302
|
+
/**
|
|
303
|
+
* <p>The pagination token to use to request the next page of results.</p>
|
|
304
|
+
* @public
|
|
305
|
+
*/
|
|
306
|
+
NextToken?: string | undefined;
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* @public
|
|
310
|
+
*/
|
|
311
|
+
export interface GetInvitationsCountRequest {
|
|
312
|
+
}
|
|
313
|
+
/**
|
|
314
|
+
* @public
|
|
315
|
+
*/
|
|
316
|
+
export interface GetInvitationsCountResponse {
|
|
317
|
+
/**
|
|
318
|
+
* <p>The number of all membership invitations sent to this Security Hub member account, not
|
|
319
|
+
* including the currently accepted invitation.</p>
|
|
320
|
+
* @public
|
|
321
|
+
*/
|
|
322
|
+
InvitationsCount?: number | undefined;
|
|
323
|
+
}
|
|
324
|
+
/**
|
|
325
|
+
* @public
|
|
326
|
+
*/
|
|
327
|
+
export interface GetMasterAccountRequest {
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* @public
|
|
331
|
+
*/
|
|
332
|
+
export interface GetMasterAccountResponse {
|
|
333
|
+
/**
|
|
334
|
+
* <p>A list of details about the Security Hub administrator account for the current member account.
|
|
335
|
+
* </p>
|
|
336
|
+
* @public
|
|
337
|
+
*/
|
|
338
|
+
Master?: Invitation | undefined;
|
|
339
|
+
}
|
|
340
|
+
/**
|
|
341
|
+
* @public
|
|
342
|
+
*/
|
|
343
|
+
export interface GetMembersRequest {
|
|
344
|
+
/**
|
|
345
|
+
* <p>The list of account IDs for the Security Hub member accounts to return the details for. </p>
|
|
346
|
+
* @public
|
|
347
|
+
*/
|
|
348
|
+
AccountIds: string[] | undefined;
|
|
349
|
+
}
|
|
350
|
+
/**
|
|
351
|
+
* <p>The details about a member account.</p>
|
|
352
|
+
* @public
|
|
353
|
+
*/
|
|
354
|
+
export interface Member {
|
|
355
|
+
/**
|
|
356
|
+
* <p>The Amazon Web Services account ID of the member account.</p>
|
|
357
|
+
* @public
|
|
358
|
+
*/
|
|
359
|
+
AccountId?: string | undefined;
|
|
360
|
+
/**
|
|
361
|
+
* <p>The email address of the member account.</p>
|
|
362
|
+
* @public
|
|
363
|
+
*/
|
|
364
|
+
Email?: string | undefined;
|
|
365
|
+
/**
|
|
366
|
+
* <p>This is replaced by <code>AdministratorID</code>.</p>
|
|
367
|
+
* <p>The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.</p>
|
|
368
|
+
*
|
|
369
|
+
* @deprecated
|
|
370
|
+
* @public
|
|
371
|
+
*/
|
|
372
|
+
MasterId?: string | undefined;
|
|
373
|
+
/**
|
|
374
|
+
* <p>The Amazon Web Services account ID of the Security Hub administrator account associated with this member account.</p>
|
|
375
|
+
* @public
|
|
376
|
+
*/
|
|
377
|
+
AdministratorId?: string | undefined;
|
|
378
|
+
/**
|
|
379
|
+
* <p>The status of the relationship between the member account and its administrator account.
|
|
380
|
+
* </p>
|
|
381
|
+
* <p>The status can have one of the following values:</p>
|
|
382
|
+
* <ul>
|
|
383
|
+
* <li>
|
|
384
|
+
* <p>
|
|
385
|
+
* <code>Created</code> - Indicates that the administrator account added the member account,
|
|
386
|
+
* but has not yet invited the member account.</p>
|
|
387
|
+
* </li>
|
|
388
|
+
* <li>
|
|
389
|
+
* <p>
|
|
390
|
+
* <code>Invited</code> - Indicates that the administrator account invited the member
|
|
391
|
+
* account. The member account has not yet responded to the invitation.</p>
|
|
392
|
+
* </li>
|
|
393
|
+
* <li>
|
|
394
|
+
* <p>
|
|
395
|
+
* <code>Enabled</code> - Indicates that the member account is currently active. For
|
|
396
|
+
* manually invited member accounts, indicates that the member account accepted the
|
|
397
|
+
* invitation.</p>
|
|
398
|
+
* </li>
|
|
399
|
+
* <li>
|
|
400
|
+
* <p>
|
|
401
|
+
* <code>Removed</code> - Indicates that the administrator account disassociated the member
|
|
402
|
+
* account.</p>
|
|
403
|
+
* </li>
|
|
404
|
+
* <li>
|
|
405
|
+
* <p>
|
|
406
|
+
* <code>Resigned</code> - Indicates that the member account disassociated themselves
|
|
407
|
+
* from the administrator account.</p>
|
|
408
|
+
* </li>
|
|
409
|
+
* <li>
|
|
410
|
+
* <p>
|
|
411
|
+
* <code>Deleted</code> - Indicates that the administrator account deleted the member
|
|
412
|
+
* account.</p>
|
|
413
|
+
* </li>
|
|
414
|
+
* <li>
|
|
415
|
+
* <p>
|
|
416
|
+
* <code>AccountSuspended</code> - Indicates that an organization account was suspended from Amazon Web Services at the same time that the administrator account tried to enable the organization account as a member account.</p>
|
|
417
|
+
* </li>
|
|
418
|
+
* </ul>
|
|
419
|
+
* @public
|
|
420
|
+
*/
|
|
421
|
+
MemberStatus?: string | undefined;
|
|
422
|
+
/**
|
|
423
|
+
* <p>A timestamp for the date and time when the invitation was sent to the member
|
|
424
|
+
* account.</p>
|
|
425
|
+
* @public
|
|
426
|
+
*/
|
|
427
|
+
InvitedAt?: Date | undefined;
|
|
428
|
+
/**
|
|
429
|
+
* <p>The timestamp for the date and time when the member account was updated.</p>
|
|
430
|
+
* @public
|
|
431
|
+
*/
|
|
432
|
+
UpdatedAt?: Date | undefined;
|
|
433
|
+
}
|
|
434
|
+
/**
|
|
435
|
+
* @public
|
|
436
|
+
*/
|
|
437
|
+
export interface GetMembersResponse {
|
|
438
|
+
/**
|
|
439
|
+
* <p>The list of details about the Security Hub member accounts.</p>
|
|
440
|
+
* @public
|
|
441
|
+
*/
|
|
442
|
+
Members?: Member[] | undefined;
|
|
443
|
+
/**
|
|
444
|
+
* <p>The list of Amazon Web Services accounts that could not be processed. For each account, the list
|
|
445
|
+
* includes the account ID and the email address.</p>
|
|
446
|
+
* @public
|
|
447
|
+
*/
|
|
448
|
+
UnprocessedAccounts?: Result[] | undefined;
|
|
449
|
+
}
|
|
450
|
+
/**
|
|
451
|
+
* @public
|
|
452
|
+
* @enum
|
|
453
|
+
*/
|
|
454
|
+
export declare const ResourcesDateField: {
|
|
455
|
+
readonly RESOURCE_CREATION_TIME_DT: "resource_creation_time_dt";
|
|
456
|
+
readonly RESOURCE_DETAIL_CAPTURE_TIME_DT: "resource_detail_capture_time_dt";
|
|
457
|
+
};
|
|
458
|
+
/**
|
|
459
|
+
* @public
|
|
460
|
+
*/
|
|
461
|
+
export type ResourcesDateField = (typeof ResourcesDateField)[keyof typeof ResourcesDateField];
|
|
462
|
+
/**
|
|
463
|
+
* <p>Enables the filtering of Amazon Web Services resources based on date and timestamp attributes.</p>
|
|
464
|
+
* @public
|
|
465
|
+
*/
|
|
466
|
+
export interface ResourcesDateFilter {
|
|
467
|
+
/**
|
|
468
|
+
* <p>The name of the field.</p>
|
|
469
|
+
* @public
|
|
470
|
+
*/
|
|
471
|
+
FieldName?: ResourcesDateField | undefined;
|
|
472
|
+
/**
|
|
473
|
+
* <p>A date filter for querying findings.</p>
|
|
474
|
+
* @public
|
|
475
|
+
*/
|
|
476
|
+
Filter?: DateFilter | undefined;
|
|
477
|
+
}
|
|
478
|
+
/**
|
|
479
|
+
* @public
|
|
480
|
+
* @enum
|
|
481
|
+
*/
|
|
482
|
+
export declare const ResourcesMapField: {
|
|
483
|
+
readonly TAG: "tags";
|
|
484
|
+
};
|
|
485
|
+
/**
|
|
486
|
+
* @public
|
|
487
|
+
*/
|
|
488
|
+
export type ResourcesMapField = (typeof ResourcesMapField)[keyof typeof ResourcesMapField];
|
|
489
|
+
/**
|
|
490
|
+
* <p>Enables filtering of Amazon Web Services resources based on key-value map attributes.</p>
|
|
491
|
+
* @public
|
|
492
|
+
*/
|
|
493
|
+
export interface ResourcesMapFilter {
|
|
494
|
+
/**
|
|
495
|
+
* <p>The name of the field.</p>
|
|
496
|
+
* @public
|
|
497
|
+
*/
|
|
498
|
+
FieldName?: ResourcesMapField | undefined;
|
|
499
|
+
/**
|
|
500
|
+
* <p>A map filter for filtering Security Hub findings. Each map filter provides the field to check for, the
|
|
501
|
+
* value to check for, and the comparison operator.</p>
|
|
502
|
+
* @public
|
|
503
|
+
*/
|
|
504
|
+
Filter?: MapFilter | undefined;
|
|
505
|
+
}
|
|
506
|
+
/**
|
|
507
|
+
* @public
|
|
508
|
+
* @enum
|
|
509
|
+
*/
|
|
510
|
+
export declare const ResourcesNumberField: {
|
|
511
|
+
readonly SEVERITY_CRITICAL: "findings_summary.severities.critical";
|
|
512
|
+
readonly SEVERITY_FATAL: "findings_summary.severities.fatal";
|
|
513
|
+
readonly SEVERITY_HIGH: "findings_summary.severities.high";
|
|
514
|
+
readonly SEVERITY_INFORMATIONAL: "findings_summary.severities.informational";
|
|
515
|
+
readonly SEVERITY_LOW: "findings_summary.severities.low";
|
|
516
|
+
readonly SEVERITY_MEDIUM: "findings_summary.severities.medium";
|
|
517
|
+
readonly SEVERITY_OTHER: "findings_summary.severities.other";
|
|
518
|
+
readonly SEVERITY_UNKNOWN: "findings_summary.severities.unknown";
|
|
519
|
+
readonly TOTAL_FINDINGS: "findings_summary.total_findings";
|
|
520
|
+
};
|
|
521
|
+
/**
|
|
522
|
+
* @public
|
|
523
|
+
*/
|
|
524
|
+
export type ResourcesNumberField = (typeof ResourcesNumberField)[keyof typeof ResourcesNumberField];
|
|
525
|
+
/**
|
|
526
|
+
* <p>Enables filtering of Amazon Web Services resources based on numerical values.</p>
|
|
527
|
+
* @public
|
|
528
|
+
*/
|
|
529
|
+
export interface ResourcesNumberFilter {
|
|
530
|
+
/**
|
|
531
|
+
* <p>The name of the field.</p>
|
|
532
|
+
* @public
|
|
533
|
+
*/
|
|
534
|
+
FieldName?: ResourcesNumberField | undefined;
|
|
535
|
+
/**
|
|
536
|
+
* <p>A number filter for querying findings.</p>
|
|
537
|
+
* @public
|
|
538
|
+
*/
|
|
539
|
+
Filter?: NumberFilter | undefined;
|
|
540
|
+
}
|
|
541
|
+
/**
|
|
542
|
+
* @public
|
|
543
|
+
* @enum
|
|
544
|
+
*/
|
|
545
|
+
export declare const ResourcesStringField: {
|
|
546
|
+
readonly ACCOUNT_ID: "account_id";
|
|
547
|
+
readonly FINDING_TYPE: "findings_summary.finding_type";
|
|
548
|
+
readonly PRODUCT_NAME: "findings_summary.product_name";
|
|
549
|
+
readonly REGION: "region";
|
|
550
|
+
readonly RESOURCE_ARN: "resource_arn";
|
|
551
|
+
readonly RESOURCE_CATEGORY: "resource_category";
|
|
552
|
+
readonly RESOURCE_ID: "resource_id";
|
|
553
|
+
readonly RESOURCE_NAME: "resource_name";
|
|
554
|
+
readonly RESOURCE_TYPE: "resource_type";
|
|
555
|
+
};
|
|
556
|
+
/**
|
|
557
|
+
* @public
|
|
558
|
+
*/
|
|
559
|
+
export type ResourcesStringField = (typeof ResourcesStringField)[keyof typeof ResourcesStringField];
|
|
560
|
+
/**
|
|
561
|
+
* <p>Enables filtering of Amazon Web Services resources based on string field values.</p>
|
|
562
|
+
* @public
|
|
563
|
+
*/
|
|
564
|
+
export interface ResourcesStringFilter {
|
|
565
|
+
/**
|
|
566
|
+
* <p>The name of the field.</p>
|
|
567
|
+
* @public
|
|
568
|
+
*/
|
|
569
|
+
FieldName?: ResourcesStringField | undefined;
|
|
570
|
+
/**
|
|
571
|
+
* <p>A string filter for filtering Security Hub findings.</p>
|
|
572
|
+
* @public
|
|
573
|
+
*/
|
|
574
|
+
Filter?: StringFilter | undefined;
|
|
575
|
+
}
|
|
576
|
+
/**
|
|
577
|
+
* <p>Enables the creation of criteria for Amazon Web Services resources in Security Hub.</p>
|
|
578
|
+
* @public
|
|
579
|
+
*/
|
|
580
|
+
export interface ResourcesCompositeFilter {
|
|
581
|
+
/**
|
|
582
|
+
* <p>Enables filtering based on string field values.</p>
|
|
583
|
+
* @public
|
|
584
|
+
*/
|
|
585
|
+
StringFilters?: ResourcesStringFilter[] | undefined;
|
|
586
|
+
/**
|
|
587
|
+
* <p>Enables filtering based on date and timestamp field values.</p>
|
|
588
|
+
* @public
|
|
589
|
+
*/
|
|
590
|
+
DateFilters?: ResourcesDateFilter[] | undefined;
|
|
591
|
+
/**
|
|
592
|
+
* <p>Enables filtering based on numerical field values.</p>
|
|
593
|
+
* @public
|
|
594
|
+
*/
|
|
595
|
+
NumberFilters?: ResourcesNumberFilter[] | undefined;
|
|
596
|
+
/**
|
|
597
|
+
* <p>Enables filtering based on map-based field values.</p>
|
|
598
|
+
* @public
|
|
599
|
+
*/
|
|
600
|
+
MapFilters?: ResourcesMapFilter[] | undefined;
|
|
601
|
+
/**
|
|
602
|
+
* <p>The logical operator used to combine multiple filter conditions.</p>
|
|
603
|
+
* @public
|
|
604
|
+
*/
|
|
605
|
+
Operator?: AllowedOperators | undefined;
|
|
606
|
+
}
|
|
607
|
+
/**
|
|
608
|
+
* <p>Enables filtering of Amazon Web Services resources based on data.</p>
|
|
609
|
+
* @public
|
|
610
|
+
*/
|
|
611
|
+
export interface ResourcesFilters {
|
|
612
|
+
/**
|
|
613
|
+
* <p>A collection of complex filtering conditions that can be applied to Amazon Web Services resources.</p>
|
|
614
|
+
* @public
|
|
615
|
+
*/
|
|
616
|
+
CompositeFilters?: ResourcesCompositeFilter[] | undefined;
|
|
617
|
+
/**
|
|
618
|
+
* <p>The logical operator used to combine multiple filter conditions in the structure.</p>
|
|
619
|
+
* @public
|
|
620
|
+
*/
|
|
621
|
+
CompositeOperator?: AllowedOperators | undefined;
|
|
622
|
+
}
|
|
623
|
+
/**
|
|
624
|
+
* @public
|
|
625
|
+
* @enum
|
|
626
|
+
*/
|
|
627
|
+
export declare const ResourceGroupByField: {
|
|
628
|
+
readonly ACCOUNT_ID: "account_id";
|
|
629
|
+
readonly FINDING_TYPE: "findings_summary.finding_type";
|
|
630
|
+
readonly REGION: "region";
|
|
631
|
+
readonly RESOURCE_CATEGORY: "resource_category";
|
|
632
|
+
readonly RESOURCE_NAME: "resource_name";
|
|
633
|
+
readonly RESOURCE_TYPE: "resource_type";
|
|
634
|
+
};
|
|
635
|
+
/**
|
|
636
|
+
* @public
|
|
637
|
+
*/
|
|
638
|
+
export type ResourceGroupByField = (typeof ResourceGroupByField)[keyof typeof ResourceGroupByField];
|
|
639
|
+
/**
|
|
640
|
+
* <p>Defines the configuration for organizing and categorizing Amazon Web Services resources based on associated security findings.</p>
|
|
641
|
+
* @public
|
|
642
|
+
*/
|
|
643
|
+
export interface ResourceGroupByRule {
|
|
644
|
+
/**
|
|
645
|
+
* <p>Specifies the attribute that resources should be grouped by.</p>
|
|
646
|
+
* @public
|
|
647
|
+
*/
|
|
648
|
+
GroupByField: ResourceGroupByField | undefined;
|
|
649
|
+
/**
|
|
650
|
+
* <p>The criteria used to select resources and associated security findings.</p>
|
|
651
|
+
* @public
|
|
652
|
+
*/
|
|
653
|
+
Filters?: ResourcesFilters | undefined;
|
|
654
|
+
}
|
|
655
|
+
/**
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
export interface GetResourcesStatisticsV2Request {
|
|
659
|
+
/**
|
|
660
|
+
* <p>How resource statistics should be aggregated and organized in the response.</p>
|
|
661
|
+
* @public
|
|
662
|
+
*/
|
|
663
|
+
GroupByRules: ResourceGroupByRule[] | undefined;
|
|
664
|
+
/**
|
|
665
|
+
* <p>Sorts aggregated statistics.</p>
|
|
666
|
+
* @public
|
|
667
|
+
*/
|
|
668
|
+
SortOrder?: SortOrder | undefined;
|
|
669
|
+
/**
|
|
670
|
+
* <p>The maximum number of results to be returned.</p>
|
|
671
|
+
* @public
|
|
672
|
+
*/
|
|
673
|
+
MaxStatisticResults?: number | undefined;
|
|
674
|
+
}
|
|
675
|
+
/**
|
|
676
|
+
* @public
|
|
677
|
+
*/
|
|
678
|
+
export interface GetResourcesStatisticsV2Response {
|
|
679
|
+
/**
|
|
680
|
+
* <p>The aggregated statistics about resources based on the specified grouping rule.</p>
|
|
681
|
+
* @public
|
|
682
|
+
*/
|
|
683
|
+
GroupByResults: GroupByResult[] | undefined;
|
|
684
|
+
}
|
|
685
|
+
/**
|
|
686
|
+
* @public
|
|
687
|
+
*/
|
|
688
|
+
export interface GetResourcesV2Request {
|
|
689
|
+
/**
|
|
690
|
+
* <p>Filters resources based on a set of criteria.</p>
|
|
691
|
+
* @public
|
|
692
|
+
*/
|
|
693
|
+
Filters?: ResourcesFilters | undefined;
|
|
694
|
+
/**
|
|
695
|
+
* <p>The finding attributes used to sort the list of returned findings.</p>
|
|
696
|
+
* @public
|
|
697
|
+
*/
|
|
698
|
+
SortCriteria?: SortCriterion[] | undefined;
|
|
699
|
+
/**
|
|
700
|
+
* <p>The token required for pagination.
|
|
701
|
+
* On your first call, set the value of this parameter to <code>NULL</code>.
|
|
702
|
+
* For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.</p>
|
|
703
|
+
* @public
|
|
704
|
+
*/
|
|
705
|
+
NextToken?: string | undefined;
|
|
706
|
+
/**
|
|
707
|
+
* <p>The maximum number of results to return.</p>
|
|
708
|
+
* @public
|
|
709
|
+
*/
|
|
710
|
+
MaxResults?: number | undefined;
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
* <p>A comprehensive distribution of security findings by severity level for Amazon Web Services resources.</p>
|
|
714
|
+
* @public
|
|
715
|
+
*/
|
|
716
|
+
export interface ResourceSeverityBreakdown {
|
|
717
|
+
/**
|
|
718
|
+
* <p>The number of findings not in any of the severity categories.</p>
|
|
719
|
+
* @public
|
|
720
|
+
*/
|
|
721
|
+
Other?: number | undefined;
|
|
722
|
+
/**
|
|
723
|
+
* <p>The number of findings with a severity level of fatal.</p>
|
|
724
|
+
* @public
|
|
725
|
+
*/
|
|
726
|
+
Fatal?: number | undefined;
|
|
727
|
+
/**
|
|
728
|
+
* <p>The number of findings with a severity level of critical.</p>
|
|
729
|
+
* @public
|
|
730
|
+
*/
|
|
731
|
+
Critical?: number | undefined;
|
|
732
|
+
/**
|
|
733
|
+
* <p>The number of findings with a severity level of high.</p>
|
|
734
|
+
* @public
|
|
735
|
+
*/
|
|
736
|
+
High?: number | undefined;
|
|
737
|
+
/**
|
|
738
|
+
* <p>The number of findings with a severity level of medium.</p>
|
|
739
|
+
* @public
|
|
740
|
+
*/
|
|
741
|
+
Medium?: number | undefined;
|
|
742
|
+
/**
|
|
743
|
+
* <p>The number of findings with a severity level of low.</p>
|
|
744
|
+
* @public
|
|
745
|
+
*/
|
|
746
|
+
Low?: number | undefined;
|
|
747
|
+
/**
|
|
748
|
+
* <p>The number of findings that provide security-related information.</p>
|
|
749
|
+
* @public
|
|
750
|
+
*/
|
|
751
|
+
Informational?: number | undefined;
|
|
752
|
+
/**
|
|
753
|
+
* <p>The number of findings with a severity level cannot be determined.</p>
|
|
754
|
+
* @public
|
|
755
|
+
*/
|
|
756
|
+
Unknown?: number | undefined;
|
|
757
|
+
}
|
|
758
|
+
/**
|
|
759
|
+
* <p>A list of summaries for all finding types on a resource.</p>
|
|
760
|
+
* @public
|
|
761
|
+
*/
|
|
762
|
+
export interface ResourceFindingsSummary {
|
|
763
|
+
/**
|
|
764
|
+
* <p>The category or classification of the security finding.</p>
|
|
765
|
+
* @public
|
|
766
|
+
*/
|
|
767
|
+
FindingType: string | undefined;
|
|
768
|
+
/**
|
|
769
|
+
* <p>The name of the product associated with the security finding.</p>
|
|
770
|
+
* @public
|
|
771
|
+
*/
|
|
772
|
+
ProductName: string | undefined;
|
|
773
|
+
/**
|
|
774
|
+
* <p>The total count of security findings.</p>
|
|
775
|
+
* @public
|
|
776
|
+
*/
|
|
777
|
+
TotalFindings: number | undefined;
|
|
778
|
+
/**
|
|
779
|
+
* <p>A breakdown of security findings by their severity levels.</p>
|
|
780
|
+
* @public
|
|
781
|
+
*/
|
|
782
|
+
Severities?: ResourceSeverityBreakdown | undefined;
|
|
783
|
+
}
|
|
784
|
+
/**
|
|
785
|
+
* @public
|
|
786
|
+
* @enum
|
|
787
|
+
*/
|
|
788
|
+
export declare const ResourceCategory: {
|
|
789
|
+
readonly AI_ML: "AI/ML";
|
|
790
|
+
readonly CODE: "Code";
|
|
791
|
+
readonly COMPUTE: "Compute";
|
|
792
|
+
readonly DATABASE: "Database";
|
|
793
|
+
readonly IDENTITY: "Identity";
|
|
794
|
+
readonly NETWORK: "Network";
|
|
795
|
+
readonly OTHER: "Other";
|
|
796
|
+
readonly STORAGE: "Storage";
|
|
797
|
+
};
|
|
798
|
+
/**
|
|
799
|
+
* @public
|
|
800
|
+
*/
|
|
801
|
+
export type ResourceCategory = (typeof ResourceCategory)[keyof typeof ResourceCategory];
|
|
802
|
+
/**
|
|
803
|
+
* <p>Represents tag information associated with Amazon Web Services resources.</p>
|
|
804
|
+
* @public
|
|
805
|
+
*/
|
|
806
|
+
export interface ResourceTag {
|
|
807
|
+
/**
|
|
808
|
+
* <p>The identifier or name of the tag.</p>
|
|
809
|
+
* @public
|
|
810
|
+
*/
|
|
811
|
+
Key: string | undefined;
|
|
812
|
+
/**
|
|
813
|
+
* <p>The data associated with the tag key.</p>
|
|
814
|
+
* @public
|
|
815
|
+
*/
|
|
816
|
+
Value: string | undefined;
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* <p>Provides comprehensive details about an Amazon Web Services resource and its associated security findings.</p>
|
|
820
|
+
* @public
|
|
821
|
+
*/
|
|
822
|
+
export interface ResourceResult {
|
|
823
|
+
/**
|
|
824
|
+
* <p>Specifies the ARN that uniquely identifies a resource.</p>
|
|
825
|
+
* @public
|
|
826
|
+
*/
|
|
827
|
+
ResourceArn?: string | undefined;
|
|
828
|
+
/**
|
|
829
|
+
* <p>The unique identifier for a resource.</p>
|
|
830
|
+
* @public
|
|
831
|
+
*/
|
|
832
|
+
ResourceId: string | undefined;
|
|
833
|
+
/**
|
|
834
|
+
* <p>The Amazon Web Services account that owns the resource.</p>
|
|
835
|
+
* @public
|
|
836
|
+
*/
|
|
837
|
+
AccountId: string | undefined;
|
|
838
|
+
/**
|
|
839
|
+
* <p>The Amazon Web Services Region where the resource is located.</p>
|
|
840
|
+
* @public
|
|
841
|
+
*/
|
|
842
|
+
Region: string | undefined;
|
|
843
|
+
/**
|
|
844
|
+
* <p>The grouping where the resource belongs.</p>
|
|
845
|
+
* @public
|
|
846
|
+
*/
|
|
847
|
+
ResourceCategory?: ResourceCategory | undefined;
|
|
848
|
+
/**
|
|
849
|
+
* <p>The type of resource.</p>
|
|
850
|
+
* @public
|
|
851
|
+
*/
|
|
852
|
+
ResourceType?: string | undefined;
|
|
853
|
+
/**
|
|
854
|
+
* <p>The name of the resource.</p>
|
|
855
|
+
* @public
|
|
856
|
+
*/
|
|
857
|
+
ResourceName?: string | undefined;
|
|
858
|
+
/**
|
|
859
|
+
* <p>The time when the resource was created.</p>
|
|
860
|
+
* @public
|
|
861
|
+
*/
|
|
862
|
+
ResourceCreationTimeDt?: string | undefined;
|
|
863
|
+
/**
|
|
864
|
+
* <p>The timestamp when information about the resource was captured.</p>
|
|
865
|
+
* @public
|
|
866
|
+
*/
|
|
867
|
+
ResourceDetailCaptureTimeDt: string | undefined;
|
|
868
|
+
/**
|
|
869
|
+
* <p>An aggregated view of security findings associated with a resource.</p>
|
|
870
|
+
* @public
|
|
871
|
+
*/
|
|
872
|
+
FindingsSummary?: ResourceFindingsSummary[] | undefined;
|
|
873
|
+
/**
|
|
874
|
+
* <p>The key-value pairs associated with a resource.</p>
|
|
875
|
+
* @public
|
|
876
|
+
*/
|
|
877
|
+
ResourceTags?: ResourceTag[] | undefined;
|
|
878
|
+
/**
|
|
879
|
+
* <p>The configuration details of a resource.</p>
|
|
880
|
+
* @public
|
|
881
|
+
*/
|
|
882
|
+
ResourceConfig: __DocumentType | undefined;
|
|
883
|
+
}
|
|
884
|
+
/**
|
|
885
|
+
* @public
|
|
886
|
+
*/
|
|
887
|
+
export interface GetResourcesV2Response {
|
|
888
|
+
/**
|
|
889
|
+
* <p>Filters resources based on a set of criteria.</p>
|
|
890
|
+
* @public
|
|
891
|
+
*/
|
|
892
|
+
Resources: ResourceResult[] | undefined;
|
|
893
|
+
/**
|
|
894
|
+
* <p>The pagination token to use to request the next page of results.
|
|
895
|
+
* Otherwise, this parameter is null.</p>
|
|
896
|
+
* @public
|
|
897
|
+
*/
|
|
898
|
+
NextToken?: string | undefined;
|
|
899
|
+
}
|
|
900
|
+
/**
|
|
901
|
+
* @public
|
|
902
|
+
*/
|
|
903
|
+
export interface GetSecurityControlDefinitionRequest {
|
|
904
|
+
/**
|
|
905
|
+
* <p>
|
|
906
|
+
* The ID of the security control to retrieve the definition for. This field doesn’t accept an Amazon Resource Name (ARN).
|
|
907
|
+
* </p>
|
|
908
|
+
* @public
|
|
909
|
+
*/
|
|
910
|
+
SecurityControlId: string | undefined;
|
|
911
|
+
}
|
|
912
|
+
/**
|
|
913
|
+
* @public
|
|
914
|
+
* @enum
|
|
915
|
+
*/
|
|
916
|
+
export declare const RegionAvailabilityStatus: {
|
|
917
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
918
|
+
readonly UNAVAILABLE: "UNAVAILABLE";
|
|
919
|
+
};
|
|
920
|
+
/**
|
|
921
|
+
* @public
|
|
922
|
+
*/
|
|
923
|
+
export type RegionAvailabilityStatus = (typeof RegionAvailabilityStatus)[keyof typeof RegionAvailabilityStatus];
|
|
924
|
+
/**
|
|
925
|
+
* <p>
|
|
926
|
+
* An object that describes a security control parameter and the options for customizing it.
|
|
927
|
+
* </p>
|
|
928
|
+
* @public
|
|
929
|
+
*/
|
|
930
|
+
export interface ParameterDefinition {
|
|
931
|
+
/**
|
|
932
|
+
* <p>
|
|
933
|
+
* Description of a control parameter.
|
|
934
|
+
* </p>
|
|
935
|
+
* @public
|
|
936
|
+
*/
|
|
937
|
+
Description: string | undefined;
|
|
938
|
+
/**
|
|
939
|
+
* <p>
|
|
940
|
+
* The options for customizing a control parameter. Customization options vary based on the data type of the parameter.
|
|
941
|
+
* </p>
|
|
942
|
+
* @public
|
|
943
|
+
*/
|
|
944
|
+
ConfigurationOptions: ConfigurationOptions | undefined;
|
|
945
|
+
}
|
|
946
|
+
/**
|
|
947
|
+
* <p>
|
|
948
|
+
* Provides metadata for a security control, including its unique standard-agnostic identifier, title, description,
|
|
949
|
+
* severity, availability in Amazon Web Services Regions, and a link to remediation steps.
|
|
950
|
+
* </p>
|
|
951
|
+
* @public
|
|
952
|
+
*/
|
|
953
|
+
export interface SecurityControlDefinition {
|
|
954
|
+
/**
|
|
955
|
+
* <p>
|
|
956
|
+
* The unique identifier of a security control across standards. Values for this field typically consist of an
|
|
957
|
+
* Amazon Web Services service name and a number (for example, APIGateway.3). This parameter differs from
|
|
958
|
+
* <code>SecurityControlArn</code>, which is a unique Amazon Resource Name (ARN) assigned to a control. The
|
|
959
|
+
* ARN references the security control ID (for example, arn:aws:securityhub:eu-central-1:123456789012:security-control/APIGateway.3).
|
|
960
|
+
* </p>
|
|
961
|
+
* @public
|
|
962
|
+
*/
|
|
963
|
+
SecurityControlId: string | undefined;
|
|
964
|
+
/**
|
|
965
|
+
* <p>
|
|
966
|
+
* The title of a security control.
|
|
967
|
+
* </p>
|
|
968
|
+
* @public
|
|
969
|
+
*/
|
|
970
|
+
Title: string | undefined;
|
|
971
|
+
/**
|
|
972
|
+
* <p> The description of a security control across standards. This typically summarizes how
|
|
973
|
+
* Security Hub evaluates the control and the conditions under which it produces a
|
|
974
|
+
* failed finding. This parameter doesn't reference a specific standard. </p>
|
|
975
|
+
* @public
|
|
976
|
+
*/
|
|
977
|
+
Description: string | undefined;
|
|
978
|
+
/**
|
|
979
|
+
* <p>
|
|
980
|
+
* A link to Security Hub documentation that explains how to remediate a failed finding for a security control.
|
|
981
|
+
* </p>
|
|
982
|
+
* @public
|
|
983
|
+
*/
|
|
984
|
+
RemediationUrl: string | undefined;
|
|
985
|
+
/**
|
|
986
|
+
* <p>
|
|
987
|
+
* The severity of a security control. For more information about how Security Hub determines control severity,
|
|
988
|
+
* see <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/controls-findings-create-update.html#control-findings-severity">Assigning severity to control findings</a> in the
|
|
989
|
+
* <i>Security Hub User Guide</i>.
|
|
990
|
+
* </p>
|
|
991
|
+
* @public
|
|
992
|
+
*/
|
|
993
|
+
SeverityRating: SeverityRating | undefined;
|
|
994
|
+
/**
|
|
995
|
+
* <p>
|
|
996
|
+
* Specifies whether a security control is available in the current Amazon Web Services Region.
|
|
997
|
+
* </p>
|
|
998
|
+
* @public
|
|
999
|
+
*/
|
|
1000
|
+
CurrentRegionAvailability: RegionAvailabilityStatus | undefined;
|
|
1001
|
+
/**
|
|
1002
|
+
* <p>
|
|
1003
|
+
* Security control properties that you can customize. Currently, only parameter customization is supported for select
|
|
1004
|
+
* controls. An empty array is returned for controls that don’t support custom properties.
|
|
1005
|
+
* </p>
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
CustomizableProperties?: SecurityControlProperty[] | undefined;
|
|
1009
|
+
/**
|
|
1010
|
+
* <p>
|
|
1011
|
+
* An object that provides a security control parameter name, description, and the options for customizing it. This
|
|
1012
|
+
* object is excluded for a control that doesn't support custom parameters.
|
|
1013
|
+
* </p>
|
|
1014
|
+
* @public
|
|
1015
|
+
*/
|
|
1016
|
+
ParameterDefinitions?: Record<string, ParameterDefinition> | undefined;
|
|
1017
|
+
}
|
|
1018
|
+
/**
|
|
1019
|
+
* @public
|
|
1020
|
+
*/
|
|
1021
|
+
export interface GetSecurityControlDefinitionResponse {
|
|
1022
|
+
/**
|
|
1023
|
+
* <p>
|
|
1024
|
+
* Provides metadata for a security control, including its unique standard-agnostic identifier, title, description,
|
|
1025
|
+
* severity, availability in Amazon Web Services Regions, and a link to remediation steps.
|
|
1026
|
+
* </p>
|
|
1027
|
+
* @public
|
|
1028
|
+
*/
|
|
1029
|
+
SecurityControlDefinition: SecurityControlDefinition | undefined;
|
|
1030
|
+
}
|
|
1031
|
+
/**
|
|
1032
|
+
* @public
|
|
1033
|
+
*/
|
|
1034
|
+
export interface InviteMembersRequest {
|
|
1035
|
+
/**
|
|
1036
|
+
* <p>The list of account IDs of the Amazon Web Services accounts to invite to Security Hub as members. </p>
|
|
1037
|
+
* @public
|
|
1038
|
+
*/
|
|
1039
|
+
AccountIds: string[] | undefined;
|
|
1040
|
+
}
|
|
1041
|
+
/**
|
|
1042
|
+
* @public
|
|
1043
|
+
*/
|
|
1044
|
+
export interface InviteMembersResponse {
|
|
1045
|
+
/**
|
|
1046
|
+
* <p>The list of Amazon Web Services accounts that could not be processed. For each account, the list
|
|
1047
|
+
* includes the account ID and the email address.</p>
|
|
1048
|
+
* @public
|
|
1049
|
+
*/
|
|
1050
|
+
UnprocessedAccounts?: Result[] | undefined;
|
|
1051
|
+
}
|
|
1052
|
+
/**
|
|
1053
|
+
* <p>The parameters used to modify an existing Jira Cloud integration.</p>
|
|
1054
|
+
* @public
|
|
1055
|
+
*/
|
|
1056
|
+
export interface JiraCloudUpdateConfiguration {
|
|
1057
|
+
/**
|
|
1058
|
+
* <p>The project key for a JiraCloud instance.</p>
|
|
1059
|
+
* @public
|
|
1060
|
+
*/
|
|
1061
|
+
ProjectKey: string | undefined;
|
|
1062
|
+
}
|
|
1063
|
+
/**
|
|
1064
|
+
* @public
|
|
1065
|
+
*/
|
|
1066
|
+
export interface ListAggregatorsV2Request {
|
|
1067
|
+
/**
|
|
1068
|
+
* <p>The token required for pagination.
|
|
1069
|
+
* On your first call, set the value of this parameter to <code>NULL</code>.
|
|
1070
|
+
* For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.</p>
|
|
1071
|
+
* @public
|
|
1072
|
+
*/
|
|
1073
|
+
NextToken?: string | undefined;
|
|
1074
|
+
/**
|
|
1075
|
+
* <p>The maximum number of results to return.</p>
|
|
1076
|
+
* @public
|
|
1077
|
+
*/
|
|
1078
|
+
MaxResults?: number | undefined;
|
|
1079
|
+
}
|
|
1080
|
+
/**
|
|
1081
|
+
* @public
|
|
1082
|
+
*/
|
|
1083
|
+
export interface ListAggregatorsV2Response {
|
|
1084
|
+
/**
|
|
1085
|
+
* <p>An array of aggregators.</p>
|
|
1086
|
+
* @public
|
|
1087
|
+
*/
|
|
1088
|
+
AggregatorsV2?: AggregatorV2[] | undefined;
|
|
1089
|
+
/**
|
|
1090
|
+
* <p>The pagination token to use to request the next page of results.
|
|
1091
|
+
* Otherwise, this parameter is null.</p>
|
|
1092
|
+
* @public
|
|
1093
|
+
*/
|
|
1094
|
+
NextToken?: string | undefined;
|
|
1095
|
+
}
|
|
1096
|
+
/**
|
|
1097
|
+
* @public
|
|
1098
|
+
*/
|
|
1099
|
+
export interface ListAutomationRulesRequest {
|
|
1100
|
+
/**
|
|
1101
|
+
* <p>
|
|
1102
|
+
* A token to specify where to start paginating the response. This is the <code>NextToken</code>
|
|
1103
|
+
* from a previously truncated response. On your first call to the <code>ListAutomationRules</code>
|
|
1104
|
+
* API, set the value of this parameter to <code>NULL</code>.
|
|
1105
|
+
* </p>
|
|
1106
|
+
* @public
|
|
1107
|
+
*/
|
|
1108
|
+
NextToken?: string | undefined;
|
|
1109
|
+
/**
|
|
1110
|
+
* <p> The maximum number of rules to return in the response. This currently ranges from 1 to
|
|
1111
|
+
* 100. </p>
|
|
1112
|
+
* @public
|
|
1113
|
+
*/
|
|
1114
|
+
MaxResults?: number | undefined;
|
|
1115
|
+
}
|
|
1116
|
+
/**
|
|
1117
|
+
* @public
|
|
1118
|
+
*/
|
|
1119
|
+
export interface ListAutomationRulesResponse {
|
|
1120
|
+
/**
|
|
1121
|
+
* <p>
|
|
1122
|
+
* Metadata for rules in the calling account. The response includes rules with a
|
|
1123
|
+
* <code>RuleStatus</code> of <code>ENABLED</code> and <code>DISABLED</code>.
|
|
1124
|
+
* </p>
|
|
1125
|
+
* @public
|
|
1126
|
+
*/
|
|
1127
|
+
AutomationRulesMetadata?: AutomationRulesMetadata[] | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* <p>
|
|
1130
|
+
* A pagination token for the response.
|
|
1131
|
+
* </p>
|
|
1132
|
+
* @public
|
|
1133
|
+
*/
|
|
1134
|
+
NextToken?: string | undefined;
|
|
1135
|
+
}
|
|
1136
|
+
/**
|
|
1137
|
+
* @public
|
|
1138
|
+
*/
|
|
1139
|
+
export interface ListAutomationRulesV2Request {
|
|
1140
|
+
/**
|
|
1141
|
+
* <p>The token required for pagination.
|
|
1142
|
+
* On your first call, set the value of this parameter to <code>NULL</code>.
|
|
1143
|
+
* For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.</p>
|
|
1144
|
+
* @public
|
|
1145
|
+
*/
|
|
1146
|
+
NextToken?: string | undefined;
|
|
1147
|
+
/**
|
|
1148
|
+
* <p>The maximum number of results to return.</p>
|
|
1149
|
+
* @public
|
|
1150
|
+
*/
|
|
1151
|
+
MaxResults?: number | undefined;
|
|
1152
|
+
}
|
|
1153
|
+
/**
|
|
1154
|
+
* @public
|
|
1155
|
+
*/
|
|
1156
|
+
export interface ListAutomationRulesV2Response {
|
|
1157
|
+
/**
|
|
1158
|
+
* <p>An array of automation rules.</p>
|
|
1159
|
+
* @public
|
|
1160
|
+
*/
|
|
1161
|
+
Rules?: AutomationRulesMetadataV2[] | undefined;
|
|
1162
|
+
/**
|
|
1163
|
+
* <p>The pagination token to use to request the next page of results.
|
|
1164
|
+
* Otherwise, this parameter is null.</p>
|
|
1165
|
+
* @public
|
|
1166
|
+
*/
|
|
1167
|
+
NextToken?: string | undefined;
|
|
1168
|
+
}
|
|
1169
|
+
/**
|
|
1170
|
+
* @public
|
|
1171
|
+
*/
|
|
1172
|
+
export interface ListConfigurationPoliciesRequest {
|
|
1173
|
+
/**
|
|
1174
|
+
* <p>
|
|
1175
|
+
* The NextToken value that's returned from a previous paginated <code>ListConfigurationPolicies</code> request where
|
|
1176
|
+
* <code>MaxResults</code> was used but the results exceeded the value of that parameter. Pagination continues from the
|
|
1177
|
+
* <code>MaxResults</code> was used but the results exceeded the value of that parameter. Pagination continues from the
|
|
1178
|
+
* end of the previous response that returned the <code>NextToken</code> value. This value is <code>null</code> when
|
|
1179
|
+
* there are no more results to return.
|
|
1180
|
+
* </p>
|
|
1181
|
+
* @public
|
|
1182
|
+
*/
|
|
1183
|
+
NextToken?: string | undefined;
|
|
1184
|
+
/**
|
|
1185
|
+
* <p>
|
|
1186
|
+
* The maximum number of results that's returned by <code>ListConfigurationPolicies</code> in each page of the response.
|
|
1187
|
+
* When this parameter is used, <code>ListConfigurationPolicies</code> returns the specified number of results in a
|
|
1188
|
+
* single page and a <code>NextToken</code> response element. You can see the remaining results of the initial request
|
|
1189
|
+
* by sending another <code>ListConfigurationPolicies</code> request with the returned <code>NextToken</code> value. A
|
|
1190
|
+
* valid range for <code>MaxResults</code> is between 1 and 100.
|
|
1191
|
+
* </p>
|
|
1192
|
+
* @public
|
|
1193
|
+
*/
|
|
1194
|
+
MaxResults?: number | undefined;
|
|
1195
|
+
}
|
|
1196
|
+
/**
|
|
1197
|
+
* @public
|
|
1198
|
+
*/
|
|
1199
|
+
export interface ListConfigurationPoliciesResponse {
|
|
1200
|
+
/**
|
|
1201
|
+
* <p>
|
|
1202
|
+
* Provides metadata for each of your configuration policies.
|
|
1203
|
+
* </p>
|
|
1204
|
+
* @public
|
|
1205
|
+
*/
|
|
1206
|
+
ConfigurationPolicySummaries?: ConfigurationPolicySummary[] | undefined;
|
|
1207
|
+
/**
|
|
1208
|
+
* <p>
|
|
1209
|
+
* The <code>NextToken</code> value to include in the next <code>ListConfigurationPolicies</code> request. When the
|
|
1210
|
+
* results of a <code>ListConfigurationPolicies</code> request exceed <code>MaxResults</code>, this value can be used to
|
|
1211
|
+
* retrieve the next page of results. This value is <code>null</code> when there are no more results to return.
|
|
1212
|
+
* </p>
|
|
1213
|
+
* @public
|
|
1214
|
+
*/
|
|
1215
|
+
NextToken?: string | undefined;
|
|
1216
|
+
}
|
|
1217
|
+
/**
|
|
1218
|
+
* @public
|
|
1219
|
+
*/
|
|
1220
|
+
export interface ListConfigurationPolicyAssociationsRequest {
|
|
1221
|
+
/**
|
|
1222
|
+
* <p>
|
|
1223
|
+
* The <code>NextToken</code> value that's returned from a previous paginated <code>ListConfigurationPolicyAssociations</code>
|
|
1224
|
+
* request where <code>MaxResults</code> was used but the results exceeded the value of that parameter. Pagination
|
|
1225
|
+
* continues from the end of the previous response that returned the <code>NextToken</code> value. This value is <code>null</code>
|
|
1226
|
+
* when there are no more results to return.
|
|
1227
|
+
* </p>
|
|
1228
|
+
* @public
|
|
1229
|
+
*/
|
|
1230
|
+
NextToken?: string | undefined;
|
|
1231
|
+
/**
|
|
1232
|
+
* <p>
|
|
1233
|
+
* The maximum number of results that's returned by <code>ListConfigurationPolicies</code> in each page of the response.
|
|
1234
|
+
* When this parameter is used, <code>ListConfigurationPolicyAssociations</code> returns the specified number of results
|
|
1235
|
+
* in a single page and a <code>NextToken</code> response element. You can see the remaining results of the initial
|
|
1236
|
+
* request by sending another <code>ListConfigurationPolicyAssociations</code> request with the returned <code>NextToken</code>
|
|
1237
|
+
* value. A valid range for <code>MaxResults</code> is between 1 and 100.
|
|
1238
|
+
* </p>
|
|
1239
|
+
* @public
|
|
1240
|
+
*/
|
|
1241
|
+
MaxResults?: number | undefined;
|
|
1242
|
+
/**
|
|
1243
|
+
* <p>
|
|
1244
|
+
* Options for filtering the <code>ListConfigurationPolicyAssociations</code> response. You can filter by the Amazon Resource Name (ARN) or
|
|
1245
|
+
* universally unique identifier (UUID) of a configuration, <code>AssociationType</code>, or <code>AssociationStatus</code>.
|
|
1246
|
+
* </p>
|
|
1247
|
+
* @public
|
|
1248
|
+
*/
|
|
1249
|
+
Filters?: AssociationFilters | undefined;
|
|
1250
|
+
}
|
|
1251
|
+
/**
|
|
1252
|
+
* @public
|
|
1253
|
+
*/
|
|
1254
|
+
export interface ListConfigurationPolicyAssociationsResponse {
|
|
1255
|
+
/**
|
|
1256
|
+
* <p>
|
|
1257
|
+
* An object that contains the details of each configuration policy association that’s returned in a
|
|
1258
|
+
* <code>ListConfigurationPolicyAssociations</code> request.
|
|
1259
|
+
* </p>
|
|
1260
|
+
* @public
|
|
1261
|
+
*/
|
|
1262
|
+
ConfigurationPolicyAssociationSummaries?: ConfigurationPolicyAssociationSummary[] | undefined;
|
|
1263
|
+
/**
|
|
1264
|
+
* <p>
|
|
1265
|
+
* The <code>NextToken</code> value to include in the next <code>ListConfigurationPolicyAssociations</code> request. When
|
|
1266
|
+
* the results of a <code>ListConfigurationPolicyAssociations</code> request exceed <code>MaxResults</code>, this value
|
|
1267
|
+
* can be used to retrieve the next page of results. This value is <code>null</code> when there are no more results to return.
|
|
1268
|
+
* </p>
|
|
1269
|
+
* @public
|
|
1270
|
+
*/
|
|
1271
|
+
NextToken?: string | undefined;
|
|
1272
|
+
}
|
|
1273
|
+
/**
|
|
1274
|
+
* @public
|
|
1275
|
+
*/
|
|
1276
|
+
export interface ListConnectorsV2Request {
|
|
1277
|
+
/**
|
|
1278
|
+
* <p>The pagination token per the Amazon Web Services Pagination standard</p>
|
|
1279
|
+
* @public
|
|
1280
|
+
*/
|
|
1281
|
+
NextToken?: string | undefined;
|
|
1282
|
+
/**
|
|
1283
|
+
* <p>The maximum number of results to be returned.</p>
|
|
1284
|
+
* @public
|
|
1285
|
+
*/
|
|
1286
|
+
MaxResults?: number | undefined;
|
|
1287
|
+
/**
|
|
1288
|
+
* <p>The name of the third-party provider.</p>
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1291
|
+
ProviderName?: ConnectorProviderName | undefined;
|
|
1292
|
+
/**
|
|
1293
|
+
* <p>The status for the connectorV2.</p>
|
|
1294
|
+
* @public
|
|
1295
|
+
*/
|
|
1296
|
+
ConnectorStatus?: ConnectorStatus | undefined;
|
|
1297
|
+
}
|
|
1298
|
+
/**
|
|
1299
|
+
* @public
|
|
1300
|
+
*/
|
|
1301
|
+
export interface ListConnectorsV2Response {
|
|
1302
|
+
/**
|
|
1303
|
+
* <p>The pagination token to use to request the next page of results.
|
|
1304
|
+
* Otherwise, this parameter is null.</p>
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
NextToken?: string | undefined;
|
|
1308
|
+
/**
|
|
1309
|
+
* <p>An array of connectorV2 summaries.</p>
|
|
1310
|
+
* @public
|
|
1311
|
+
*/
|
|
1312
|
+
Connectors: ConnectorSummary[] | undefined;
|
|
1313
|
+
}
|
|
1314
|
+
/**
|
|
1315
|
+
* @public
|
|
1316
|
+
*/
|
|
1317
|
+
export interface ListEnabledProductsForImportRequest {
|
|
1318
|
+
/**
|
|
1319
|
+
* <p>The token that is required for pagination. On your first call to the
|
|
1320
|
+
* <code>ListEnabledProductsForImport</code> operation, set the value of this parameter to
|
|
1321
|
+
* <code>NULL</code>.</p>
|
|
1322
|
+
* <p>For subsequent calls to the operation, to continue listing data, set the value of this
|
|
1323
|
+
* parameter to the value returned from the previous response.</p>
|
|
1324
|
+
* @public
|
|
1325
|
+
*/
|
|
1326
|
+
NextToken?: string | undefined;
|
|
1327
|
+
/**
|
|
1328
|
+
* <p>The maximum number of items to return in the response.</p>
|
|
1329
|
+
* @public
|
|
1330
|
+
*/
|
|
1331
|
+
MaxResults?: number | undefined;
|
|
1332
|
+
}
|
|
1333
|
+
/**
|
|
1334
|
+
* @public
|
|
1335
|
+
*/
|
|
1336
|
+
export interface ListEnabledProductsForImportResponse {
|
|
1337
|
+
/**
|
|
1338
|
+
* <p>The list of ARNs for the resources that represent your subscriptions to products. </p>
|
|
1339
|
+
* @public
|
|
1340
|
+
*/
|
|
1341
|
+
ProductSubscriptions?: string[] | undefined;
|
|
1342
|
+
/**
|
|
1343
|
+
* <p>The pagination token to use to request the next page of results.</p>
|
|
1344
|
+
* @public
|
|
1345
|
+
*/
|
|
1346
|
+
NextToken?: string | undefined;
|
|
1347
|
+
}
|
|
1348
|
+
/**
|
|
1349
|
+
* @public
|
|
1350
|
+
*/
|
|
1351
|
+
export interface ListFindingAggregatorsRequest {
|
|
1352
|
+
/**
|
|
1353
|
+
* <p>The token returned with the previous set of results. Identifies the next set of results to return.</p>
|
|
1354
|
+
* @public
|
|
1355
|
+
*/
|
|
1356
|
+
NextToken?: string | undefined;
|
|
1357
|
+
/**
|
|
1358
|
+
* <p>The maximum number of results to return. This operation currently only returns a single result.</p>
|
|
1359
|
+
* @public
|
|
1360
|
+
*/
|
|
1361
|
+
MaxResults?: number | undefined;
|
|
1362
|
+
}
|
|
1363
|
+
/**
|
|
1364
|
+
* @public
|
|
1365
|
+
*/
|
|
1366
|
+
export interface ListFindingAggregatorsResponse {
|
|
1367
|
+
/**
|
|
1368
|
+
* <p>The list of finding aggregators. This operation currently only returns a single result.</p>
|
|
1369
|
+
* @public
|
|
1370
|
+
*/
|
|
1371
|
+
FindingAggregators?: FindingAggregator[] | undefined;
|
|
1372
|
+
/**
|
|
1373
|
+
* <p>If there are more results, this is the token to provide in the next call to <code>ListFindingAggregators</code>.</p>
|
|
1374
|
+
* <p>This operation currently only returns a single result.
|
|
1375
|
+
* </p>
|
|
1376
|
+
* @public
|
|
1377
|
+
*/
|
|
1378
|
+
NextToken?: string | undefined;
|
|
1379
|
+
}
|
|
1380
|
+
/**
|
|
1381
|
+
* @public
|
|
1382
|
+
*/
|
|
1383
|
+
export interface ListInvitationsRequest {
|
|
1384
|
+
/**
|
|
1385
|
+
* <p>The maximum number of items to return in the response. </p>
|
|
1386
|
+
* @public
|
|
1387
|
+
*/
|
|
1388
|
+
MaxResults?: number | undefined;
|
|
1389
|
+
/**
|
|
1390
|
+
* <p>The token that is required for pagination. On your first call to the
|
|
1391
|
+
* <code>ListInvitations</code> operation, set the value of this parameter to
|
|
1392
|
+
* <code>NULL</code>.</p>
|
|
1393
|
+
* <p>For subsequent calls to the operation, to continue listing data, set the value of this
|
|
1394
|
+
* parameter to the value returned from the previous response.</p>
|
|
1395
|
+
* @public
|
|
1396
|
+
*/
|
|
1397
|
+
NextToken?: string | undefined;
|
|
1398
|
+
}
|
|
1399
|
+
/**
|
|
1400
|
+
* @public
|
|
1401
|
+
*/
|
|
1402
|
+
export interface ListInvitationsResponse {
|
|
1403
|
+
/**
|
|
1404
|
+
* <p>The details of the invitations returned by the operation.</p>
|
|
1405
|
+
* @public
|
|
1406
|
+
*/
|
|
1407
|
+
Invitations?: Invitation[] | undefined;
|
|
1408
|
+
/**
|
|
1409
|
+
* <p>The pagination token to use to request the next page of results.</p>
|
|
1410
|
+
* @public
|
|
1411
|
+
*/
|
|
1412
|
+
NextToken?: string | undefined;
|
|
1413
|
+
}
|
|
1414
|
+
/**
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
export interface ListMembersRequest {
|
|
1418
|
+
/**
|
|
1419
|
+
* <p>Specifies which member accounts to include in the response based on their relationship
|
|
1420
|
+
* status with the administrator account. The default value is <code>TRUE</code>.</p>
|
|
1421
|
+
* <p>If <code>OnlyAssociated</code> is set to <code>TRUE</code>, the response includes member
|
|
1422
|
+
* accounts whose relationship status with the administrator account is set to <code>ENABLED</code>.</p>
|
|
1423
|
+
* <p>If <code>OnlyAssociated</code> is set to <code>FALSE</code>, the response includes all
|
|
1424
|
+
* existing member accounts. </p>
|
|
1425
|
+
* @public
|
|
1426
|
+
*/
|
|
1427
|
+
OnlyAssociated?: boolean | undefined;
|
|
1428
|
+
/**
|
|
1429
|
+
* <p>The maximum number of items to return in the response. </p>
|
|
1430
|
+
* @public
|
|
1431
|
+
*/
|
|
1432
|
+
MaxResults?: number | undefined;
|
|
1433
|
+
/**
|
|
1434
|
+
* <p>The token that is required for pagination. On your first call to the
|
|
1435
|
+
* <code>ListMembers</code> operation, set the value of this parameter to
|
|
1436
|
+
* <code>NULL</code>.</p>
|
|
1437
|
+
* <p>For subsequent calls to the operation, to continue listing data, set the value of this
|
|
1438
|
+
* parameter to the value returned from the previous response.</p>
|
|
1439
|
+
* @public
|
|
1440
|
+
*/
|
|
1441
|
+
NextToken?: string | undefined;
|
|
1442
|
+
}
|
|
1443
|
+
/**
|
|
1444
|
+
* @public
|
|
1445
|
+
*/
|
|
1446
|
+
export interface ListMembersResponse {
|
|
1447
|
+
/**
|
|
1448
|
+
* <p>Member details returned by the operation.</p>
|
|
1449
|
+
* @public
|
|
1450
|
+
*/
|
|
1451
|
+
Members?: Member[] | undefined;
|
|
1452
|
+
/**
|
|
1453
|
+
* <p>The pagination token to use to request the next page of results.</p>
|
|
1454
|
+
* @public
|
|
1455
|
+
*/
|
|
1456
|
+
NextToken?: string | undefined;
|
|
1457
|
+
}
|
|
1458
|
+
/**
|
|
1459
|
+
* @public
|
|
1460
|
+
*/
|
|
1461
|
+
export interface ListOrganizationAdminAccountsRequest {
|
|
1462
|
+
/**
|
|
1463
|
+
* <p>The maximum number of items to return in the response.</p>
|
|
1464
|
+
* @public
|
|
1465
|
+
*/
|
|
1466
|
+
MaxResults?: number | undefined;
|
|
1467
|
+
/**
|
|
1468
|
+
* <p>The token that is required for pagination. On your first call to the
|
|
1469
|
+
* <code>ListOrganizationAdminAccounts</code> operation, set the value of this parameter to
|
|
1470
|
+
* <code>NULL</code>. For subsequent calls to the operation, to continue listing data, set
|
|
1471
|
+
* the value of this parameter to the value returned from the previous response. </p>
|
|
1472
|
+
* @public
|
|
1473
|
+
*/
|
|
1474
|
+
NextToken?: string | undefined;
|
|
1475
|
+
/**
|
|
1476
|
+
* <p>The feature where the delegated administrator account is listed.
|
|
1477
|
+
* Defaults to Security Hub if not specified.</p>
|
|
1478
|
+
* @public
|
|
1479
|
+
*/
|
|
1480
|
+
Feature?: SecurityHubFeature | undefined;
|
|
1481
|
+
}
|
|
1482
|
+
/**
|
|
1483
|
+
* @public
|
|
1484
|
+
*/
|
|
1485
|
+
export interface ListOrganizationAdminAccountsResponse {
|
|
1486
|
+
/**
|
|
1487
|
+
* <p>The list of Security Hub administrator accounts.</p>
|
|
1488
|
+
* @public
|
|
1489
|
+
*/
|
|
1490
|
+
AdminAccounts?: AdminAccount[] | undefined;
|
|
1491
|
+
/**
|
|
1492
|
+
* <p>The pagination token to use to request the next page of results.</p>
|
|
1493
|
+
* @public
|
|
1494
|
+
*/
|
|
1495
|
+
NextToken?: string | undefined;
|
|
1496
|
+
/**
|
|
1497
|
+
* <p>The feature where the delegated administrator account is listed.
|
|
1498
|
+
* Defaults to Security Hub CSPM if not specified.</p>
|
|
1499
|
+
* @public
|
|
1500
|
+
*/
|
|
1501
|
+
Feature?: SecurityHubFeature | undefined;
|
|
1502
|
+
}
|
|
1503
|
+
/**
|
|
1504
|
+
* @public
|
|
1505
|
+
*/
|
|
1506
|
+
export interface ListSecurityControlDefinitionsRequest {
|
|
1507
|
+
/**
|
|
1508
|
+
* <p>
|
|
1509
|
+
* The Amazon Resource Name (ARN) of the standard that you want to view controls for.
|
|
1510
|
+
* </p>
|
|
1511
|
+
* @public
|
|
1512
|
+
*/
|
|
1513
|
+
StandardsArn?: string | undefined;
|
|
1514
|
+
/**
|
|
1515
|
+
* <p>
|
|
1516
|
+
* Optional pagination parameter.
|
|
1517
|
+
* </p>
|
|
1518
|
+
* @public
|
|
1519
|
+
*/
|
|
1520
|
+
NextToken?: string | undefined;
|
|
1521
|
+
/**
|
|
1522
|
+
* <p> An optional parameter that limits the total results of the API response to the
|
|
1523
|
+
* specified number. If this parameter isn't provided in the request, the results include the
|
|
1524
|
+
* first 25 security controls that apply to the specified standard. The results also include a
|
|
1525
|
+
* <code>NextToken</code> parameter that you can use in a subsequent API call to get the
|
|
1526
|
+
* next 25 controls. This repeats until all controls for the standard are returned. </p>
|
|
1527
|
+
* @public
|
|
1528
|
+
*/
|
|
1529
|
+
MaxResults?: number | undefined;
|
|
1530
|
+
}
|
|
1531
|
+
/**
|
|
1532
|
+
* @public
|
|
1533
|
+
*/
|
|
1534
|
+
export interface ListSecurityControlDefinitionsResponse {
|
|
1535
|
+
/**
|
|
1536
|
+
* <p>
|
|
1537
|
+
* An array of controls that apply to the specified standard.
|
|
1538
|
+
* </p>
|
|
1539
|
+
* @public
|
|
1540
|
+
*/
|
|
1541
|
+
SecurityControlDefinitions: SecurityControlDefinition[] | undefined;
|
|
1542
|
+
/**
|
|
1543
|
+
* <p> A pagination parameter that's included in the response only if it was included in the
|
|
1544
|
+
* request. </p>
|
|
1545
|
+
* @public
|
|
1546
|
+
*/
|
|
1547
|
+
NextToken?: string | undefined;
|
|
1548
|
+
}
|
|
1549
|
+
/**
|
|
1550
|
+
* @public
|
|
1551
|
+
*/
|
|
1552
|
+
export interface ListStandardsControlAssociationsRequest {
|
|
1553
|
+
/**
|
|
1554
|
+
* <p>
|
|
1555
|
+
* The identifier of the control (identified with <code>SecurityControlId</code>, <code>SecurityControlArn</code>, or a mix of both parameters) that you
|
|
1556
|
+
* want to determine the enablement status of in each enabled standard.
|
|
1557
|
+
* </p>
|
|
1558
|
+
* @public
|
|
1559
|
+
*/
|
|
1560
|
+
SecurityControlId: string | undefined;
|
|
1561
|
+
/**
|
|
1562
|
+
* <p>
|
|
1563
|
+
* Optional pagination parameter.
|
|
1564
|
+
* </p>
|
|
1565
|
+
* @public
|
|
1566
|
+
*/
|
|
1567
|
+
NextToken?: string | undefined;
|
|
1568
|
+
/**
|
|
1569
|
+
* <p> An optional parameter that limits the total results of the API response to the
|
|
1570
|
+
* specified number. If this parameter isn't provided in the request, the results include the
|
|
1571
|
+
* first 25 standard and control associations. The results also include a
|
|
1572
|
+
* <code>NextToken</code> parameter that you can use in a subsequent API call to get the
|
|
1573
|
+
* next 25 associations. This repeats until all associations for the specified control are
|
|
1574
|
+
* returned. The number of results is limited by the number of supported Security Hub
|
|
1575
|
+
* standards that you've enabled in the calling account. </p>
|
|
1576
|
+
* @public
|
|
1577
|
+
*/
|
|
1578
|
+
MaxResults?: number | undefined;
|
|
1579
|
+
}
|
|
1580
|
+
/**
|
|
1581
|
+
* <p> An array that provides the enablement status and other details for each control that
|
|
1582
|
+
* applies to each enabled standard. </p>
|
|
1583
|
+
* @public
|
|
1584
|
+
*/
|
|
1585
|
+
export interface StandardsControlAssociationSummary {
|
|
1586
|
+
/**
|
|
1587
|
+
* <p>
|
|
1588
|
+
* The Amazon Resource Name (ARN) of a standard.
|
|
1589
|
+
* </p>
|
|
1590
|
+
* @public
|
|
1591
|
+
*/
|
|
1592
|
+
StandardsArn: string | undefined;
|
|
1593
|
+
/**
|
|
1594
|
+
* <p>
|
|
1595
|
+
* A unique standard-agnostic identifier for a control. Values for this field typically consist of an
|
|
1596
|
+
* Amazon Web Services service and a number, such as APIGateway.5. This field doesn't reference a specific standard.
|
|
1597
|
+
* </p>
|
|
1598
|
+
* @public
|
|
1599
|
+
*/
|
|
1600
|
+
SecurityControlId: string | undefined;
|
|
1601
|
+
/**
|
|
1602
|
+
* <p> The ARN of a control, such as
|
|
1603
|
+
* <code>arn:aws:securityhub:eu-central-1:123456789012:security-control/S3.1</code>. This
|
|
1604
|
+
* parameter doesn't mention a specific standard. </p>
|
|
1605
|
+
* @public
|
|
1606
|
+
*/
|
|
1607
|
+
SecurityControlArn: string | undefined;
|
|
1608
|
+
/**
|
|
1609
|
+
* <p>
|
|
1610
|
+
* The enablement status of a control in a specific standard.
|
|
1611
|
+
* </p>
|
|
1612
|
+
* @public
|
|
1613
|
+
*/
|
|
1614
|
+
AssociationStatus: AssociationStatus | undefined;
|
|
1615
|
+
/**
|
|
1616
|
+
* <p>
|
|
1617
|
+
* The requirement that underlies this control in the compliance framework related to the standard.
|
|
1618
|
+
* </p>
|
|
1619
|
+
* @public
|
|
1620
|
+
*/
|
|
1621
|
+
RelatedRequirements?: string[] | undefined;
|
|
1622
|
+
/**
|
|
1623
|
+
* <p>The last time that a control's enablement status in a specified standard was updated.</p>
|
|
1624
|
+
* @public
|
|
1625
|
+
*/
|
|
1626
|
+
UpdatedAt?: Date | undefined;
|
|
1627
|
+
/**
|
|
1628
|
+
* <p>The reason for updating a control's enablement status in a specified standard.</p>
|
|
1629
|
+
* @public
|
|
1630
|
+
*/
|
|
1631
|
+
UpdatedReason?: string | undefined;
|
|
1632
|
+
/**
|
|
1633
|
+
* <p>
|
|
1634
|
+
* The title of a control.
|
|
1635
|
+
* </p>
|
|
1636
|
+
* @public
|
|
1637
|
+
*/
|
|
1638
|
+
StandardsControlTitle?: string | undefined;
|
|
1639
|
+
/**
|
|
1640
|
+
* <p>
|
|
1641
|
+
* The description of a control. This typically summarizes how Security Hub evaluates the control and the
|
|
1642
|
+
* conditions under which it produces a failed finding. The parameter may reference a specific standard.
|
|
1643
|
+
* </p>
|
|
1644
|
+
* @public
|
|
1645
|
+
*/
|
|
1646
|
+
StandardsControlDescription?: string | undefined;
|
|
1647
|
+
}
|
|
1648
|
+
/**
|
|
1649
|
+
* @public
|
|
1650
|
+
*/
|
|
1651
|
+
export interface ListStandardsControlAssociationsResponse {
|
|
1652
|
+
/**
|
|
1653
|
+
* <p> An array that provides the enablement status and other details for each security
|
|
1654
|
+
* control that applies to each enabled standard. </p>
|
|
1655
|
+
* @public
|
|
1656
|
+
*/
|
|
1657
|
+
StandardsControlAssociationSummaries: StandardsControlAssociationSummary[] | undefined;
|
|
1658
|
+
/**
|
|
1659
|
+
* <p> A pagination parameter that's included in the response only if it was included in the
|
|
1660
|
+
* request. </p>
|
|
1661
|
+
* @public
|
|
1662
|
+
*/
|
|
1663
|
+
NextToken?: string | undefined;
|
|
1664
|
+
}
|
|
1665
|
+
/**
|
|
1666
|
+
* @public
|
|
1667
|
+
*/
|
|
1668
|
+
export interface ListTagsForResourceRequest {
|
|
1669
|
+
/**
|
|
1670
|
+
* <p>The ARN of the resource to retrieve tags for.</p>
|
|
1671
|
+
* @public
|
|
1672
|
+
*/
|
|
1673
|
+
ResourceArn: string | undefined;
|
|
1674
|
+
}
|
|
1675
|
+
/**
|
|
1676
|
+
* @public
|
|
1677
|
+
*/
|
|
1678
|
+
export interface ListTagsForResourceResponse {
|
|
1679
|
+
/**
|
|
1680
|
+
* <p>The tags associated with a resource.</p>
|
|
1681
|
+
* @public
|
|
1682
|
+
*/
|
|
1683
|
+
Tags?: Record<string, string> | undefined;
|
|
1684
|
+
}
|
|
1685
|
+
/**
|
|
1686
|
+
* <p>The parameters required to update the configuration of an integration provider.</p>
|
|
1687
|
+
* @public
|
|
1688
|
+
*/
|
|
1689
|
+
export type ProviderUpdateConfiguration = ProviderUpdateConfiguration.JiraCloudMember | ProviderUpdateConfiguration.$UnknownMember;
|
|
1690
|
+
/**
|
|
1691
|
+
* @public
|
|
1692
|
+
*/
|
|
1693
|
+
export declare namespace ProviderUpdateConfiguration {
|
|
1694
|
+
/**
|
|
1695
|
+
* <p>The parameters required to update the configuration for a Jira Cloud integration.</p>
|
|
1696
|
+
* @public
|
|
1697
|
+
*/
|
|
1698
|
+
interface JiraCloudMember {
|
|
1699
|
+
JiraCloud: JiraCloudUpdateConfiguration;
|
|
1700
|
+
$unknown?: never;
|
|
1701
|
+
}
|
|
1702
|
+
/**
|
|
1703
|
+
* @public
|
|
1704
|
+
*/
|
|
1705
|
+
interface $UnknownMember {
|
|
1706
|
+
JiraCloud?: never;
|
|
1707
|
+
$unknown: [string, any];
|
|
1708
|
+
}
|
|
1709
|
+
interface Visitor<T> {
|
|
1710
|
+
JiraCloud: (value: JiraCloudUpdateConfiguration) => T;
|
|
1711
|
+
_: (name: string, value: any) => T;
|
|
1712
|
+
}
|
|
1713
|
+
const visit: <T>(value: ProviderUpdateConfiguration, visitor: Visitor<T>) => T;
|
|
1714
|
+
}
|
|
1715
|
+
/**
|
|
1716
|
+
* <p>
|
|
1717
|
+
* The request was rejected because it conflicts with the resource's availability. For example, you tried
|
|
1718
|
+
* to update a security control that's currently in the <code>UPDATING</code> state.
|
|
1719
|
+
* </p>
|
|
1720
|
+
* @public
|
|
1721
|
+
*/
|
|
1722
|
+
export declare class ResourceInUseException extends __BaseException {
|
|
1723
|
+
readonly name: "ResourceInUseException";
|
|
1724
|
+
readonly $fault: "client";
|
|
1725
|
+
Message?: string | undefined;
|
|
1726
|
+
Code?: string | undefined;
|
|
1727
|
+
/**
|
|
1728
|
+
* @internal
|
|
1729
|
+
*/
|
|
1730
|
+
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
1731
|
+
}
|
|
1732
|
+
/**
|
|
1733
|
+
* @public
|
|
1734
|
+
*/
|
|
1735
|
+
export interface StartConfigurationPolicyAssociationRequest {
|
|
1736
|
+
/**
|
|
1737
|
+
* <p>
|
|
1738
|
+
* The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a
|
|
1739
|
+
* configuration policy, or a value of <code>SELF_MANAGED_SECURITY_HUB</code> for a self-managed configuration.
|
|
1740
|
+
* </p>
|
|
1741
|
+
* @public
|
|
1742
|
+
*/
|
|
1743
|
+
ConfigurationPolicyIdentifier: string | undefined;
|
|
1744
|
+
/**
|
|
1745
|
+
* <p>
|
|
1746
|
+
* The identifier of the target account, organizational unit, or the root to associate with the specified configuration.
|
|
1747
|
+
* </p>
|
|
1748
|
+
* @public
|
|
1749
|
+
*/
|
|
1750
|
+
Target: Target | undefined;
|
|
1751
|
+
}
|
|
1752
|
+
/**
|
|
1753
|
+
* @public
|
|
1754
|
+
*/
|
|
1755
|
+
export interface StartConfigurationPolicyAssociationResponse {
|
|
1756
|
+
/**
|
|
1757
|
+
* <p>
|
|
1758
|
+
* The UUID of the configuration policy.
|
|
1759
|
+
* </p>
|
|
1760
|
+
* @public
|
|
1761
|
+
*/
|
|
1762
|
+
ConfigurationPolicyId?: string | undefined;
|
|
1763
|
+
/**
|
|
1764
|
+
* <p>
|
|
1765
|
+
* The identifier of the target account, organizational unit, or the organization root with which the configuration is associated.
|
|
1766
|
+
* </p>
|
|
1767
|
+
* @public
|
|
1768
|
+
*/
|
|
1769
|
+
TargetId?: string | undefined;
|
|
1770
|
+
/**
|
|
1771
|
+
* <p>
|
|
1772
|
+
* Indicates whether the target is an Amazon Web Services account, organizational unit, or the organization root.
|
|
1773
|
+
* </p>
|
|
1774
|
+
* @public
|
|
1775
|
+
*/
|
|
1776
|
+
TargetType?: TargetType | undefined;
|
|
1777
|
+
/**
|
|
1778
|
+
* <p>
|
|
1779
|
+
* Indicates whether the association between the specified target and the configuration was directly applied by the
|
|
1780
|
+
* Security Hub delegated administrator or inherited from a parent.
|
|
1781
|
+
* </p>
|
|
1782
|
+
* @public
|
|
1783
|
+
*/
|
|
1784
|
+
AssociationType?: AssociationType | undefined;
|
|
1785
|
+
/**
|
|
1786
|
+
* <p>
|
|
1787
|
+
* The date and time, in UTC and ISO 8601 format, that the configuration policy association was last updated.
|
|
1788
|
+
* </p>
|
|
1789
|
+
* @public
|
|
1790
|
+
*/
|
|
1791
|
+
UpdatedAt?: Date | undefined;
|
|
1792
|
+
/**
|
|
1793
|
+
* <p>
|
|
1794
|
+
* The current status of the association between the specified target and the configuration.
|
|
1795
|
+
* </p>
|
|
1796
|
+
* @public
|
|
1797
|
+
*/
|
|
1798
|
+
AssociationStatus?: ConfigurationPolicyAssociationStatus | undefined;
|
|
1799
|
+
/**
|
|
1800
|
+
* <p>
|
|
1801
|
+
* An explanation for a <code>FAILED</code> value for <code>AssociationStatus</code>.
|
|
1802
|
+
* </p>
|
|
1803
|
+
* @public
|
|
1804
|
+
*/
|
|
1805
|
+
AssociationStatusMessage?: string | undefined;
|
|
1806
|
+
}
|
|
1807
|
+
/**
|
|
1808
|
+
* @public
|
|
1809
|
+
*/
|
|
1810
|
+
export interface StartConfigurationPolicyDisassociationRequest {
|
|
1811
|
+
/**
|
|
1812
|
+
* <p>
|
|
1813
|
+
* The identifier of the target account, organizational unit, or the root to disassociate from the specified configuration.
|
|
1814
|
+
* </p>
|
|
1815
|
+
* @public
|
|
1816
|
+
*/
|
|
1817
|
+
Target?: Target | undefined;
|
|
1818
|
+
/**
|
|
1819
|
+
* <p>
|
|
1820
|
+
* The Amazon Resource Name (ARN) of a configuration policy, the universally unique identifier (UUID) of a
|
|
1821
|
+
* configuration policy, or a value of <code>SELF_MANAGED_SECURITY_HUB</code> for a self-managed configuration.
|
|
1822
|
+
* </p>
|
|
1823
|
+
* @public
|
|
1824
|
+
*/
|
|
1825
|
+
ConfigurationPolicyIdentifier: string | undefined;
|
|
1826
|
+
}
|
|
1827
|
+
/**
|
|
1828
|
+
* @public
|
|
1829
|
+
*/
|
|
1830
|
+
export interface StartConfigurationPolicyDisassociationResponse {
|
|
1831
|
+
}
|
|
1832
|
+
/**
|
|
1833
|
+
* @public
|
|
1834
|
+
*/
|
|
1835
|
+
export interface TagResourceRequest {
|
|
1836
|
+
/**
|
|
1837
|
+
* <p>The ARN of the resource to apply the tags to.</p>
|
|
1838
|
+
* @public
|
|
1839
|
+
*/
|
|
1840
|
+
ResourceArn: string | undefined;
|
|
1841
|
+
/**
|
|
1842
|
+
* <p>The tags to add to the resource. You can add up to 50 tags at a time. The tag keys can be no longer than 128 characters. The tag values can be no longer than 256 characters.</p>
|
|
1843
|
+
* @public
|
|
1844
|
+
*/
|
|
1845
|
+
Tags: Record<string, string> | undefined;
|
|
1846
|
+
}
|
|
1847
|
+
/**
|
|
1848
|
+
* @public
|
|
1849
|
+
*/
|
|
1850
|
+
export interface TagResourceResponse {
|
|
1851
|
+
}
|
|
1852
|
+
/**
|
|
1853
|
+
* @public
|
|
1854
|
+
*/
|
|
1855
|
+
export interface UntagResourceRequest {
|
|
1856
|
+
/**
|
|
1857
|
+
* <p>The ARN of the resource to remove the tags from.</p>
|
|
1858
|
+
* @public
|
|
1859
|
+
*/
|
|
1860
|
+
ResourceArn: string | undefined;
|
|
1861
|
+
/**
|
|
1862
|
+
* <p>The tag keys associated with the tags to remove from the resource. You can remove up to 50 tags at a time.</p>
|
|
1863
|
+
* @public
|
|
1864
|
+
*/
|
|
1865
|
+
TagKeys: string[] | undefined;
|
|
1866
|
+
}
|
|
1867
|
+
/**
|
|
1868
|
+
* @public
|
|
1869
|
+
*/
|
|
1870
|
+
export interface UntagResourceResponse {
|
|
1871
|
+
}
|
|
1872
|
+
/**
|
|
1873
|
+
* @public
|
|
1874
|
+
*/
|
|
1875
|
+
export interface UpdateActionTargetRequest {
|
|
1876
|
+
/**
|
|
1877
|
+
* <p>The ARN of the custom action target to update.</p>
|
|
1878
|
+
* @public
|
|
1879
|
+
*/
|
|
1880
|
+
ActionTargetArn: string | undefined;
|
|
1881
|
+
/**
|
|
1882
|
+
* <p>The updated name of the custom action target.</p>
|
|
1883
|
+
* @public
|
|
1884
|
+
*/
|
|
1885
|
+
Name?: string | undefined;
|
|
1886
|
+
/**
|
|
1887
|
+
* <p>The updated description for the custom action target.</p>
|
|
1888
|
+
* @public
|
|
1889
|
+
*/
|
|
1890
|
+
Description?: string | undefined;
|
|
1891
|
+
}
|
|
1892
|
+
/**
|
|
1893
|
+
* @public
|
|
1894
|
+
*/
|
|
1895
|
+
export interface UpdateActionTargetResponse {
|
|
1896
|
+
}
|
|
1897
|
+
/**
|
|
1898
|
+
* @public
|
|
1899
|
+
*/
|
|
1900
|
+
export interface UpdateAggregatorV2Request {
|
|
1901
|
+
/**
|
|
1902
|
+
* <p>The ARN of the Aggregator V2.</p>
|
|
1903
|
+
* @public
|
|
1904
|
+
*/
|
|
1905
|
+
AggregatorV2Arn: string | undefined;
|
|
1906
|
+
/**
|
|
1907
|
+
* <p>Determines how Amazon Web Services Regions should be linked to the Aggregator V2.</p>
|
|
1908
|
+
* @public
|
|
1909
|
+
*/
|
|
1910
|
+
RegionLinkingMode: string | undefined;
|
|
1911
|
+
/**
|
|
1912
|
+
* <p>A list of Amazon Web Services Regions linked to the aggegation Region.</p>
|
|
1913
|
+
* @public
|
|
1914
|
+
*/
|
|
1915
|
+
LinkedRegions?: string[] | undefined;
|
|
1916
|
+
}
|
|
1917
|
+
/**
|
|
1918
|
+
* @public
|
|
1919
|
+
*/
|
|
1920
|
+
export interface UpdateAggregatorV2Response {
|
|
1921
|
+
/**
|
|
1922
|
+
* <p>The ARN of the Aggregator V2.</p>
|
|
1923
|
+
* @public
|
|
1924
|
+
*/
|
|
1925
|
+
AggregatorV2Arn?: string | undefined;
|
|
1926
|
+
/**
|
|
1927
|
+
* <p>The Amazon Web Services Region where data is aggregated.</p>
|
|
1928
|
+
* @public
|
|
1929
|
+
*/
|
|
1930
|
+
AggregationRegion?: string | undefined;
|
|
1931
|
+
/**
|
|
1932
|
+
* <p>Determines how Amazon Web Services Regions should be linked to the Aggregator V2.</p>
|
|
1933
|
+
* @public
|
|
1934
|
+
*/
|
|
1935
|
+
RegionLinkingMode?: string | undefined;
|
|
1936
|
+
/**
|
|
1937
|
+
* <p>A list of Amazon Web Services Regions linked to the aggegation Region.</p>
|
|
1938
|
+
* @public
|
|
1939
|
+
*/
|
|
1940
|
+
LinkedRegions?: string[] | undefined;
|
|
1941
|
+
}
|
|
1942
|
+
/**
|
|
1943
|
+
* @public
|
|
1944
|
+
*/
|
|
1945
|
+
export interface UpdateAutomationRuleV2Request {
|
|
1946
|
+
/**
|
|
1947
|
+
* <p>The ARN of the automation rule.</p>
|
|
1948
|
+
* @public
|
|
1949
|
+
*/
|
|
1950
|
+
Identifier: string | undefined;
|
|
1951
|
+
/**
|
|
1952
|
+
* <p>The status of the automation rule.</p>
|
|
1953
|
+
* @public
|
|
1954
|
+
*/
|
|
1955
|
+
RuleStatus?: RuleStatusV2 | undefined;
|
|
1956
|
+
/**
|
|
1957
|
+
* <p>Represents a value for the rule priority.</p>
|
|
1958
|
+
* @public
|
|
1959
|
+
*/
|
|
1960
|
+
RuleOrder?: number | undefined;
|
|
1961
|
+
/**
|
|
1962
|
+
* <p>A description of the automation rule.</p>
|
|
1963
|
+
* @public
|
|
1964
|
+
*/
|
|
1965
|
+
Description?: string | undefined;
|
|
1966
|
+
/**
|
|
1967
|
+
* <p>The name of the automation rule.</p>
|
|
1968
|
+
* @public
|
|
1969
|
+
*/
|
|
1970
|
+
RuleName?: string | undefined;
|
|
1971
|
+
/**
|
|
1972
|
+
* <p>The filtering type and configuration of the automation rule.</p>
|
|
1973
|
+
* @public
|
|
1974
|
+
*/
|
|
1975
|
+
Criteria?: Criteria | undefined;
|
|
1976
|
+
/**
|
|
1977
|
+
* <p>A list of actions to be performed when the rule criteria is met.</p>
|
|
1978
|
+
* @public
|
|
1979
|
+
*/
|
|
1980
|
+
Actions?: AutomationRulesActionV2[] | undefined;
|
|
1981
|
+
}
|
|
1982
|
+
/**
|
|
1983
|
+
* @public
|
|
1984
|
+
*/
|
|
1985
|
+
export interface UpdateAutomationRuleV2Response {
|
|
1986
|
+
}
|
|
1987
|
+
/**
|
|
1988
|
+
* @public
|
|
1989
|
+
*/
|
|
1990
|
+
export interface UpdateConfigurationPolicyRequest {
|
|
1991
|
+
/**
|
|
1992
|
+
* <p>
|
|
1993
|
+
* The Amazon Resource Name (ARN) or universally unique identifier (UUID) of the configuration policy.
|
|
1994
|
+
* </p>
|
|
1995
|
+
* @public
|
|
1996
|
+
*/
|
|
1997
|
+
Identifier: string | undefined;
|
|
1998
|
+
/**
|
|
1999
|
+
* <p>
|
|
2000
|
+
* The name of the configuration policy. Alphanumeric characters and the following ASCII characters are permitted:
|
|
2001
|
+
* <code>-, ., !, *, /</code>.
|
|
2002
|
+
* </p>
|
|
2003
|
+
* @public
|
|
2004
|
+
*/
|
|
2005
|
+
Name?: string | undefined;
|
|
2006
|
+
/**
|
|
2007
|
+
* <p>
|
|
2008
|
+
* The description of the configuration policy.
|
|
2009
|
+
* </p>
|
|
2010
|
+
* @public
|
|
2011
|
+
*/
|
|
2012
|
+
Description?: string | undefined;
|
|
2013
|
+
/**
|
|
2014
|
+
* <p>
|
|
2015
|
+
* The reason for updating the configuration policy.
|
|
2016
|
+
* </p>
|
|
2017
|
+
* @public
|
|
2018
|
+
*/
|
|
2019
|
+
UpdatedReason?: string | undefined;
|
|
2020
|
+
/**
|
|
2021
|
+
* <p>
|
|
2022
|
+
* An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or
|
|
2023
|
+
* disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls.
|
|
2024
|
+
* If you provide a list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including newly
|
|
2025
|
+
* released controls). If you provide a list of security controls that are disabled in the configuration policy, Security Hub
|
|
2026
|
+
* enables all other controls (including newly released controls).
|
|
2027
|
+
* </p>
|
|
2028
|
+
* <p>When updating a configuration policy, provide a complete list of standards that you want to enable and a complete list
|
|
2029
|
+
* of controls that you want to enable or disable. The updated configuration replaces the current configuration.</p>
|
|
2030
|
+
* @public
|
|
2031
|
+
*/
|
|
2032
|
+
ConfigurationPolicy?: Policy | undefined;
|
|
2033
|
+
}
|
|
2034
|
+
/**
|
|
2035
|
+
* @public
|
|
2036
|
+
*/
|
|
2037
|
+
export interface UpdateConfigurationPolicyResponse {
|
|
2038
|
+
/**
|
|
2039
|
+
* <p>
|
|
2040
|
+
* The ARN of the configuration policy.
|
|
2041
|
+
* </p>
|
|
2042
|
+
* @public
|
|
2043
|
+
*/
|
|
2044
|
+
Arn?: string | undefined;
|
|
2045
|
+
/**
|
|
2046
|
+
* <p>
|
|
2047
|
+
* The UUID of the configuration policy.
|
|
2048
|
+
* </p>
|
|
2049
|
+
* @public
|
|
2050
|
+
*/
|
|
2051
|
+
Id?: string | undefined;
|
|
2052
|
+
/**
|
|
2053
|
+
* <p>
|
|
2054
|
+
* The name of the configuration policy.
|
|
2055
|
+
* </p>
|
|
2056
|
+
* @public
|
|
2057
|
+
*/
|
|
2058
|
+
Name?: string | undefined;
|
|
2059
|
+
/**
|
|
2060
|
+
* <p>
|
|
2061
|
+
* The description of the configuration policy.
|
|
2062
|
+
* </p>
|
|
2063
|
+
* @public
|
|
2064
|
+
*/
|
|
2065
|
+
Description?: string | undefined;
|
|
2066
|
+
/**
|
|
2067
|
+
* <p>
|
|
2068
|
+
* The date and time, in UTC and ISO 8601 format, that the configuration policy was last updated.
|
|
2069
|
+
* </p>
|
|
2070
|
+
* @public
|
|
2071
|
+
*/
|
|
2072
|
+
UpdatedAt?: Date | undefined;
|
|
2073
|
+
/**
|
|
2074
|
+
* <p>
|
|
2075
|
+
* The date and time, in UTC and ISO 8601 format, that the configuration policy was created.
|
|
2076
|
+
* </p>
|
|
2077
|
+
* @public
|
|
2078
|
+
*/
|
|
2079
|
+
CreatedAt?: Date | undefined;
|
|
2080
|
+
/**
|
|
2081
|
+
* <p>
|
|
2082
|
+
* An object that defines how Security Hub is configured. It includes whether Security Hub is enabled or
|
|
2083
|
+
* disabled, a list of enabled security standards, a list of enabled or disabled security controls, and a list of custom parameter values for specified controls. If the request included a
|
|
2084
|
+
* list of security controls that are enabled in the configuration policy, Security Hub disables all other controls (including
|
|
2085
|
+
* newly released controls). If the request included a list of security controls that are disabled in the configuration policy,
|
|
2086
|
+
* Security Hub enables all other controls (including newly released controls).
|
|
2087
|
+
* </p>
|
|
2088
|
+
* @public
|
|
2089
|
+
*/
|
|
2090
|
+
ConfigurationPolicy?: Policy | undefined;
|
|
2091
|
+
}
|
|
2092
|
+
/**
|
|
2093
|
+
* @public
|
|
2094
|
+
*/
|
|
2095
|
+
export interface UpdateConnectorV2Request {
|
|
2096
|
+
/**
|
|
2097
|
+
* <p>The UUID of the connectorV2 to identify connectorV2 resource.</p>
|
|
2098
|
+
* @public
|
|
2099
|
+
*/
|
|
2100
|
+
ConnectorId: string | undefined;
|
|
2101
|
+
/**
|
|
2102
|
+
* <p>The clientSecret of ServiceNow.</p>
|
|
2103
|
+
* @public
|
|
2104
|
+
*/
|
|
2105
|
+
ClientSecret?: string | undefined;
|
|
2106
|
+
/**
|
|
2107
|
+
* <p>The description of the connectorV2.</p>
|
|
2108
|
+
* @public
|
|
2109
|
+
*/
|
|
2110
|
+
Description?: string | undefined;
|
|
2111
|
+
/**
|
|
2112
|
+
* <p>The third-party provider’s service configuration.</p>
|
|
2113
|
+
* @public
|
|
2114
|
+
*/
|
|
2115
|
+
Provider?: ProviderUpdateConfiguration | undefined;
|
|
2116
|
+
}
|
|
2117
|
+
/**
|
|
2118
|
+
* @public
|
|
2119
|
+
*/
|
|
2120
|
+
export interface UpdateConnectorV2Response {
|
|
2121
|
+
}
|
|
2122
|
+
/**
|
|
2123
|
+
* @public
|
|
2124
|
+
*/
|
|
2125
|
+
export interface UpdateFindingAggregatorRequest {
|
|
2126
|
+
/**
|
|
2127
|
+
* <p>The ARN of the finding aggregator. To obtain the ARN, use <code>ListFindingAggregators</code>.</p>
|
|
2128
|
+
* @public
|
|
2129
|
+
*/
|
|
2130
|
+
FindingAggregatorArn: string | undefined;
|
|
2131
|
+
/**
|
|
2132
|
+
* <p>Indicates whether to aggregate findings from all of the available Regions in the current partition. Also determines whether to automatically aggregate findings from new Regions as Security Hub supports them and you opt into them.</p>
|
|
2133
|
+
* <p>The selected option also determines how to use the Regions provided in the Regions list.</p>
|
|
2134
|
+
* <p>The options are as follows:</p>
|
|
2135
|
+
* <ul>
|
|
2136
|
+
* <li>
|
|
2137
|
+
* <p>
|
|
2138
|
+
* <code>ALL_REGIONS</code> - Aggregates findings from all of the Regions where Security Hub is enabled. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
|
|
2139
|
+
* </p>
|
|
2140
|
+
* </li>
|
|
2141
|
+
* <li>
|
|
2142
|
+
* <p>
|
|
2143
|
+
* <code>ALL_REGIONS_EXCEPT_SPECIFIED</code> - Aggregates findings from all of the Regions where Security Hub is enabled, except for the Regions listed in the <code>Regions</code> parameter. When you choose this option, Security Hub also automatically aggregates findings from new Regions as Security Hub supports them and you opt into them.
|
|
2144
|
+
* </p>
|
|
2145
|
+
* </li>
|
|
2146
|
+
* <li>
|
|
2147
|
+
* <p>
|
|
2148
|
+
* <code>SPECIFIED_REGIONS</code> - Aggregates findings only from the Regions listed in the <code>Regions</code> parameter. Security Hub does not automatically aggregate findings from new Regions.
|
|
2149
|
+
* </p>
|
|
2150
|
+
* </li>
|
|
2151
|
+
* <li>
|
|
2152
|
+
* <p>
|
|
2153
|
+
* <code>NO_REGIONS</code> - Aggregates no data because no Regions are selected as linked Regions.
|
|
2154
|
+
* </p>
|
|
2155
|
+
* </li>
|
|
2156
|
+
* </ul>
|
|
2157
|
+
* @public
|
|
2158
|
+
*/
|
|
2159
|
+
RegionLinkingMode: string | undefined;
|
|
2160
|
+
/**
|
|
2161
|
+
* <p>If <code>RegionLinkingMode</code> is <code>ALL_REGIONS_EXCEPT_SPECIFIED</code>, then this is a space-separated list of Regions that don't replicate and send findings to the home Region.</p>
|
|
2162
|
+
* <p>If <code>RegionLinkingMode</code> is <code>SPECIFIED_REGIONS</code>, then this is a space-separated list of Regions that do replicate and send findings to the home Region.</p>
|
|
2163
|
+
* <p>An <code>InvalidInputException</code> error results if you populate this field while <code>RegionLinkingMode</code> is
|
|
2164
|
+
* <code>NO_REGIONS</code>.</p>
|
|
2165
|
+
* @public
|
|
2166
|
+
*/
|
|
2167
|
+
Regions?: string[] | undefined;
|
|
2168
|
+
}
|
|
2169
|
+
/**
|
|
2170
|
+
* @public
|
|
2171
|
+
*/
|
|
2172
|
+
export interface UpdateFindingAggregatorResponse {
|
|
2173
|
+
/**
|
|
2174
|
+
* <p>The ARN of the finding aggregator.</p>
|
|
2175
|
+
* @public
|
|
2176
|
+
*/
|
|
2177
|
+
FindingAggregatorArn?: string | undefined;
|
|
2178
|
+
/**
|
|
2179
|
+
* <p>The home Region. Findings generated in linked Regions are replicated and sent to the home Region.</p>
|
|
2180
|
+
* @public
|
|
2181
|
+
*/
|
|
2182
|
+
FindingAggregationRegion?: string | undefined;
|
|
2183
|
+
/**
|
|
2184
|
+
* <p>Indicates whether to link all Regions, all Regions except for a list of excluded Regions, or a list of included Regions.</p>
|
|
2185
|
+
* @public
|
|
2186
|
+
*/
|
|
2187
|
+
RegionLinkingMode?: string | undefined;
|
|
2188
|
+
/**
|
|
2189
|
+
* <p>The list of excluded Regions or included Regions.</p>
|
|
2190
|
+
* @public
|
|
2191
|
+
*/
|
|
2192
|
+
Regions?: string[] | undefined;
|
|
2193
|
+
}
|
|
2194
|
+
/**
|
|
2195
|
+
* @public
|
|
2196
|
+
*/
|
|
2197
|
+
export interface UpdateFindingsRequest {
|
|
2198
|
+
/**
|
|
2199
|
+
* <p>A collection of attributes that specify which findings you want to update.</p>
|
|
2200
|
+
* @public
|
|
2201
|
+
*/
|
|
2202
|
+
Filters: AwsSecurityFindingFilters | undefined;
|
|
2203
|
+
/**
|
|
2204
|
+
* <p>The updated note for the finding.</p>
|
|
2205
|
+
* @public
|
|
2206
|
+
*/
|
|
2207
|
+
Note?: NoteUpdate | undefined;
|
|
2208
|
+
/**
|
|
2209
|
+
* <p>The updated record state for the finding.</p>
|
|
2210
|
+
* @public
|
|
2211
|
+
*/
|
|
2212
|
+
RecordState?: RecordState | undefined;
|
|
2213
|
+
}
|
|
2214
|
+
/**
|
|
2215
|
+
* @public
|
|
2216
|
+
*/
|
|
2217
|
+
export interface UpdateFindingsResponse {
|
|
2218
|
+
}
|
|
2219
|
+
/**
|
|
2220
|
+
* @public
|
|
2221
|
+
*/
|
|
2222
|
+
export interface UpdateInsightRequest {
|
|
2223
|
+
/**
|
|
2224
|
+
* <p>The ARN of the insight that you want to update.</p>
|
|
2225
|
+
* @public
|
|
2226
|
+
*/
|
|
2227
|
+
InsightArn: string | undefined;
|
|
2228
|
+
/**
|
|
2229
|
+
* <p>The updated name for the insight.</p>
|
|
2230
|
+
* @public
|
|
2231
|
+
*/
|
|
2232
|
+
Name?: string | undefined;
|
|
2233
|
+
/**
|
|
2234
|
+
* <p>The updated filters that define this insight.</p>
|
|
2235
|
+
* @public
|
|
2236
|
+
*/
|
|
2237
|
+
Filters?: AwsSecurityFindingFilters | undefined;
|
|
2238
|
+
/**
|
|
2239
|
+
* <p>The updated <code>GroupBy</code> attribute that defines this insight.</p>
|
|
2240
|
+
* @public
|
|
2241
|
+
*/
|
|
2242
|
+
GroupByAttribute?: string | undefined;
|
|
2243
|
+
}
|
|
2244
|
+
/**
|
|
2245
|
+
* @public
|
|
2246
|
+
*/
|
|
2247
|
+
export interface UpdateInsightResponse {
|
|
2248
|
+
}
|
|
2249
|
+
/**
|
|
2250
|
+
* @public
|
|
2251
|
+
*/
|
|
2252
|
+
export interface UpdateOrganizationConfigurationRequest {
|
|
2253
|
+
/**
|
|
2254
|
+
* <p>Whether to automatically enable Security Hub in new member accounts when they join the organization.</p>
|
|
2255
|
+
* <p>If set to <code>true</code>, then Security Hub is automatically enabled in new accounts. If set to <code>false</code>,
|
|
2256
|
+
* then Security Hub isn't enabled in new accounts automatically. The default value is <code>false</code>.</p>
|
|
2257
|
+
* <p>If the <code>ConfigurationType</code> of your organization is set to <code>CENTRAL</code>, then this field is set
|
|
2258
|
+
* to <code>false</code> and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration
|
|
2259
|
+
* policy in which Security Hub is enabled and associate the policy with new organization accounts.</p>
|
|
2260
|
+
* @public
|
|
2261
|
+
*/
|
|
2262
|
+
AutoEnable: boolean | undefined;
|
|
2263
|
+
/**
|
|
2264
|
+
* <p>Whether to automatically enable Security Hub <a href="https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-enable-disable.html">default standards</a>
|
|
2265
|
+
* in new member accounts when they join the organization.</p>
|
|
2266
|
+
* <p>The default value of this parameter is equal to <code>DEFAULT</code>.</p>
|
|
2267
|
+
* <p>If equal to <code>DEFAULT</code>, then Security Hub default standards are automatically enabled for new member
|
|
2268
|
+
* accounts. If equal to <code>NONE</code>, then default standards are not automatically enabled for new member
|
|
2269
|
+
* accounts.</p>
|
|
2270
|
+
* <p>If the <code>ConfigurationType</code> of your organization is set to <code>CENTRAL</code>, then this field is set
|
|
2271
|
+
* to <code>NONE</code> and can't be changed in the home Region and linked Regions. However, in that case, the delegated administrator can create a configuration
|
|
2272
|
+
* policy in which specific security standards are enabled and associate the policy with new organization accounts.</p>
|
|
2273
|
+
* @public
|
|
2274
|
+
*/
|
|
2275
|
+
AutoEnableStandards?: AutoEnableStandards | undefined;
|
|
2276
|
+
/**
|
|
2277
|
+
* <p>
|
|
2278
|
+
* Provides information about the way an organization is configured in Security Hub.
|
|
2279
|
+
* </p>
|
|
2280
|
+
* @public
|
|
2281
|
+
*/
|
|
2282
|
+
OrganizationConfiguration?: OrganizationConfiguration | undefined;
|
|
2283
|
+
}
|
|
2284
|
+
/**
|
|
2285
|
+
* @public
|
|
2286
|
+
*/
|
|
2287
|
+
export interface UpdateOrganizationConfigurationResponse {
|
|
2288
|
+
}
|
|
2289
|
+
/**
|
|
2290
|
+
* @public
|
|
2291
|
+
*/
|
|
2292
|
+
export interface UpdateSecurityControlRequest {
|
|
2293
|
+
/**
|
|
2294
|
+
* <p>
|
|
2295
|
+
* The Amazon Resource Name (ARN) or ID of the control to update.
|
|
2296
|
+
* </p>
|
|
2297
|
+
* @public
|
|
2298
|
+
*/
|
|
2299
|
+
SecurityControlId: string | undefined;
|
|
2300
|
+
/**
|
|
2301
|
+
* <p>
|
|
2302
|
+
* An object that specifies which security control parameters to update.
|
|
2303
|
+
* </p>
|
|
2304
|
+
* @public
|
|
2305
|
+
*/
|
|
2306
|
+
Parameters: Record<string, ParameterConfiguration> | undefined;
|
|
2307
|
+
/**
|
|
2308
|
+
* <p>
|
|
2309
|
+
* The most recent reason for updating the properties of the security control. This field accepts alphanumeric
|
|
2310
|
+
* characters in addition to white spaces, dashes, and underscores.
|
|
2311
|
+
* </p>
|
|
2312
|
+
* @public
|
|
2313
|
+
*/
|
|
2314
|
+
LastUpdateReason?: string | undefined;
|
|
2315
|
+
}
|
|
2316
|
+
/**
|
|
2317
|
+
* @public
|
|
2318
|
+
*/
|
|
2319
|
+
export interface UpdateSecurityControlResponse {
|
|
2320
|
+
}
|
|
2321
|
+
/**
|
|
2322
|
+
* @public
|
|
2323
|
+
*/
|
|
2324
|
+
export interface UpdateSecurityHubConfigurationRequest {
|
|
2325
|
+
/**
|
|
2326
|
+
* <p>Whether to automatically enable new controls when they are added to standards that are
|
|
2327
|
+
* enabled.</p>
|
|
2328
|
+
* <p>By default, this is set to <code>true</code>, and new controls are enabled
|
|
2329
|
+
* automatically. To not automatically enable new controls, set this to <code>false</code>.
|
|
2330
|
+
* </p>
|
|
2331
|
+
* <p>When you automatically enable new controls, you can interact with the controls in
|
|
2332
|
+
* the console and programmatically immediately after release. However, automatically enabled controls have a temporary default status of
|
|
2333
|
+
* <code>DISABLED</code>. It can take up to several days for Security Hub to process the control release and designate the
|
|
2334
|
+
* control as <code>ENABLED</code> in your account. During the processing period, you can manually enable or disable a
|
|
2335
|
+
* control, and Security Hub will maintain that designation regardless of whether you have <code>AutoEnableControls</code> set to
|
|
2336
|
+
* <code>true</code>.</p>
|
|
2337
|
+
* @public
|
|
2338
|
+
*/
|
|
2339
|
+
AutoEnableControls?: boolean | undefined;
|
|
2340
|
+
/**
|
|
2341
|
+
* <p>Updates whether the calling account has consolidated control findings turned on.
|
|
2342
|
+
* If the value for this field is set to
|
|
2343
|
+
* <code>SECURITY_CONTROL</code>, Security Hub generates a single finding for a control check even when the check
|
|
2344
|
+
* applies to multiple enabled standards.</p>
|
|
2345
|
+
* <p>If the value for this field is set to <code>STANDARD_CONTROL</code>, Security Hub generates separate findings
|
|
2346
|
+
* for a control check when the check applies to multiple enabled standards.</p>
|
|
2347
|
+
* <p>For accounts that are part of an organization, this value can only be updated in the administrator account.</p>
|
|
2348
|
+
* @public
|
|
2349
|
+
*/
|
|
2350
|
+
ControlFindingGenerator?: ControlFindingGenerator | undefined;
|
|
2351
|
+
}
|
|
2352
|
+
/**
|
|
2353
|
+
* @public
|
|
2354
|
+
*/
|
|
2355
|
+
export interface UpdateSecurityHubConfigurationResponse {
|
|
2356
|
+
}
|
|
2357
|
+
/**
|
|
2358
|
+
* @public
|
|
2359
|
+
*/
|
|
2360
|
+
export interface UpdateStandardsControlRequest {
|
|
2361
|
+
/**
|
|
2362
|
+
* <p>The ARN of the security standard control to enable or disable.</p>
|
|
2363
|
+
* @public
|
|
2364
|
+
*/
|
|
2365
|
+
StandardsControlArn: string | undefined;
|
|
2366
|
+
/**
|
|
2367
|
+
* <p>The updated status of the security standard control.</p>
|
|
2368
|
+
* @public
|
|
2369
|
+
*/
|
|
2370
|
+
ControlStatus?: ControlStatus | undefined;
|
|
2371
|
+
/**
|
|
2372
|
+
* <p>A description of the reason why you are disabling a security standard control. If you
|
|
2373
|
+
* are disabling a control, then this is required.</p>
|
|
2374
|
+
* @public
|
|
2375
|
+
*/
|
|
2376
|
+
DisabledReason?: string | undefined;
|
|
2377
|
+
}
|
|
2378
|
+
/**
|
|
2379
|
+
* @public
|
|
2380
|
+
*/
|
|
2381
|
+
export interface UpdateStandardsControlResponse {
|
|
2382
|
+
}
|
|
2383
|
+
/**
|
|
2384
|
+
* @internal
|
|
2385
|
+
*/
|
|
2386
|
+
export declare const UpdateConnectorV2RequestFilterSensitiveLog: (obj: UpdateConnectorV2Request) => any;
|