@aws-sdk/client-securityhub 3.775.0 → 3.777.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/dist-types/commands/AcceptAdministratorInvitationCommand.d.ts +8 -5
- package/dist-types/commands/AcceptInvitationCommand.d.ts +1 -0
- package/dist-types/commands/BatchDeleteAutomationRulesCommand.d.ts +9 -9
- package/dist-types/commands/BatchDisableStandardsCommand.d.ts +9 -9
- package/dist-types/commands/BatchEnableStandardsCommand.d.ts +10 -10
- package/dist-types/commands/BatchGetAutomationRulesCommand.d.ts +49 -49
- package/dist-types/commands/BatchGetConfigurationPolicyAssociationsCommand.d.ts +22 -22
- package/dist-types/commands/BatchGetSecurityControlsCommand.d.ts +33 -33
- package/dist-types/commands/BatchGetStandardsControlAssociationsCommand.d.ts +1 -50
- package/dist-types/commands/BatchImportFindingsCommand.d.ts +26 -26
- package/dist-types/commands/BatchUpdateAutomationRulesCommand.d.ts +10 -10
- package/dist-types/commands/BatchUpdateFindingsCommand.d.ts +30 -30
- package/dist-types/commands/BatchUpdateStandardsControlAssociationsCommand.d.ts +20 -20
- package/dist-types/commands/CreateActionTargetCommand.d.ts +7 -7
- package/dist-types/commands/CreateAutomationRuleCommand.d.ts +35 -35
- package/dist-types/commands/CreateConfigurationPolicyCommand.d.ts +37 -37
- package/dist-types/commands/CreateFindingAggregatorCommand.d.ts +9 -9
- package/dist-types/commands/CreateInsightCommand.d.ts +13 -13
- package/dist-types/commands/CreateMembersCommand.d.ts +7 -7
- package/dist-types/commands/DeclineInvitationsCommand.d.ts +5 -5
- package/dist-types/commands/DeleteActionTargetCommand.d.ts +5 -5
- package/dist-types/commands/DeleteConfigurationPolicyCommand.d.ts +7 -4
- package/dist-types/commands/DeleteFindingAggregatorCommand.d.ts +7 -4
- package/dist-types/commands/DeleteInsightCommand.d.ts +5 -5
- package/dist-types/commands/DeleteInvitationsCommand.d.ts +5 -5
- package/dist-types/commands/DeleteMembersCommand.d.ts +5 -5
- package/dist-types/commands/DescribeActionTargetsCommand.d.ts +8 -8
- package/dist-types/commands/DescribeHubCommand.d.ts +8 -8
- package/dist-types/commands/DescribeOrganizationConfigurationCommand.d.ts +10 -10
- package/dist-types/commands/DescribeProductsCommand.d.ts +17 -17
- package/dist-types/commands/DescribeStandardsCommand.d.ts +21 -21
- package/dist-types/commands/DescribeStandardsControlsCommand.d.ts +1 -46
- package/dist-types/commands/DisableImportFindingsForProductCommand.d.ts +7 -4
- package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts +7 -4
- package/dist-types/commands/DisableSecurityHubCommand.d.ts +7 -4
- package/dist-types/commands/DisassociateFromAdministratorAccountCommand.d.ts +7 -4
- package/dist-types/commands/DisassociateFromMasterAccountCommand.d.ts +1 -0
- package/dist-types/commands/DisassociateMembersCommand.d.ts +7 -4
- package/dist-types/commands/EnableImportFindingsForProductCommand.d.ts +5 -5
- package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts +7 -4
- package/dist-types/commands/EnableSecurityHubCommand.d.ts +9 -6
- package/dist-types/commands/GetAdministratorAccountCommand.d.ts +1 -19
- package/dist-types/commands/GetConfigurationPolicyAssociationCommand.d.ts +12 -12
- package/dist-types/commands/GetConfigurationPolicyCommand.d.ts +23 -23
- package/dist-types/commands/GetEnabledStandardsCommand.d.ts +9 -9
- package/dist-types/commands/GetFindingAggregatorCommand.d.ts +8 -8
- package/dist-types/commands/GetFindingHistoryCommand.d.ts +1 -42
- package/dist-types/commands/GetFindingsCommand.d.ts +63 -63
- package/dist-types/commands/GetInsightResultsCommand.d.ts +12 -12
- package/dist-types/commands/GetInsightsCommand.d.ts +15 -15
- package/dist-types/commands/GetInvitationsCountCommand.d.ts +7 -7
- package/dist-types/commands/GetMasterAccountCommand.d.ts +1 -0
- package/dist-types/commands/GetMembersCommand.d.ts +1 -37
- package/dist-types/commands/GetSecurityControlDefinitionCommand.d.ts +19 -19
- package/dist-types/commands/InviteMembersCommand.d.ts +5 -5
- package/dist-types/commands/ListAutomationRulesCommand.d.ts +23 -23
- package/dist-types/commands/ListConfigurationPoliciesCommand.d.ts +13 -13
- package/dist-types/commands/ListConfigurationPolicyAssociationsCommand.d.ts +15 -15
- package/dist-types/commands/ListEnabledProductsForImportCommand.d.ts +5 -5
- package/dist-types/commands/ListFindingAggregatorsCommand.d.ts +6 -6
- package/dist-types/commands/ListInvitationsCommand.d.ts +1 -21
- package/dist-types/commands/ListMembersCommand.d.ts +1 -31
- package/dist-types/commands/ListOrganizationAdminAccountsCommand.d.ts +7 -7
- package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +28 -28
- package/dist-types/commands/ListStandardsControlAssociationsCommand.d.ts +1 -44
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +7 -7
- package/dist-types/commands/StartConfigurationPolicyAssociationCommand.d.ts +13 -13
- package/dist-types/commands/StartConfigurationPolicyDisassociationCommand.d.ts +9 -6
- package/dist-types/commands/TagResourceCommand.d.ts +10 -7
- package/dist-types/commands/UntagResourceCommand.d.ts +8 -5
- package/dist-types/commands/UpdateActionTargetCommand.d.ts +9 -6
- package/dist-types/commands/UpdateConfigurationPolicyCommand.d.ts +39 -39
- package/dist-types/commands/UpdateFindingAggregatorCommand.d.ts +10 -10
- package/dist-types/commands/UpdateFindingsCommand.d.ts +1 -0
- package/dist-types/commands/UpdateInsightCommand.d.ts +15 -12
- package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +10 -7
- package/dist-types/commands/UpdateSecurityControlCommand.d.ts +13 -10
- package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts +8 -5
- package/dist-types/commands/UpdateStandardsControlCommand.d.ts +9 -6
- package/package.json +2 -2
|
@@ -74,23 +74,23 @@ declare const EnableImportFindingsForProductCommand_base: {
|
|
|
74
74
|
* @throws {@link SecurityHubServiceException}
|
|
75
75
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
76
76
|
*
|
|
77
|
-
*
|
|
77
|
+
*
|
|
78
78
|
* @example To activate an integration
|
|
79
79
|
* ```javascript
|
|
80
80
|
* // The following example activates an integration between Security Hub and a third party partner product that sends findings to Security Hub.
|
|
81
81
|
* const input = {
|
|
82
|
-
*
|
|
82
|
+
* ProductArn: "arn:aws:securityhub:us-east-1:517716713836:product/crowdstrike/crowdstrike-falcon"
|
|
83
83
|
* };
|
|
84
84
|
* const command = new EnableImportFindingsForProductCommand(input);
|
|
85
85
|
* const response = await client.send(command);
|
|
86
|
-
* /* response
|
|
86
|
+
* /* response is
|
|
87
87
|
* {
|
|
88
|
-
*
|
|
88
|
+
* ProductSubscriptionArn: "arn:aws:securityhub:us-east-1:517716713836:product-subscription/crowdstrike/crowdstrike-falcon"
|
|
89
89
|
* }
|
|
90
90
|
* *\/
|
|
91
|
-
* // example id: to-activate-an-integration-1676918918114
|
|
92
91
|
* ```
|
|
93
92
|
*
|
|
93
|
+
* @public
|
|
94
94
|
*/
|
|
95
95
|
export declare class EnableImportFindingsForProductCommand extends EnableImportFindingsForProductCommand_base {
|
|
96
96
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -70,18 +70,21 @@ declare const EnableOrganizationAdminAccountCommand_base: {
|
|
|
70
70
|
* @throws {@link SecurityHubServiceException}
|
|
71
71
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
72
72
|
*
|
|
73
|
-
*
|
|
73
|
+
*
|
|
74
74
|
* @example To designate a Security Hub administrator
|
|
75
75
|
* ```javascript
|
|
76
76
|
* // The following example designates the specified account as the Security Hub administrator account. The requesting account must be the organization management account.
|
|
77
77
|
* const input = {
|
|
78
|
-
*
|
|
78
|
+
* AdminAccountId: "123456789012"
|
|
79
79
|
* };
|
|
80
80
|
* const command = new EnableOrganizationAdminAccountCommand(input);
|
|
81
|
-
* await client.send(command);
|
|
82
|
-
*
|
|
81
|
+
* const response = await client.send(command);
|
|
82
|
+
* /* response is
|
|
83
|
+
* { /* metadata only *\/ }
|
|
84
|
+
* *\/
|
|
83
85
|
* ```
|
|
84
86
|
*
|
|
87
|
+
* @public
|
|
85
88
|
*/
|
|
86
89
|
export declare class EnableOrganizationAdminAccountCommand extends EnableOrganizationAdminAccountCommand_base {
|
|
87
90
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -91,21 +91,24 @@ declare const EnableSecurityHubCommand_base: {
|
|
|
91
91
|
* @throws {@link SecurityHubServiceException}
|
|
92
92
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
93
93
|
*
|
|
94
|
-
*
|
|
94
|
+
*
|
|
95
95
|
* @example To activate Security Hub
|
|
96
96
|
* ```javascript
|
|
97
97
|
* // The following example activates the Security Hub service in the requesting AWS account. The service is activated in the current AWS Region or the Region that you specify in the request. Some standards are automatically turned on in your account unless you opt out. To determine which standards are automatically turned on, see the Security Hub documentation.
|
|
98
98
|
* const input = {
|
|
99
|
-
*
|
|
100
|
-
*
|
|
101
|
-
*
|
|
99
|
+
* EnableDefaultStandards: true,
|
|
100
|
+
* Tags: {
|
|
101
|
+
* Department: "Security"
|
|
102
102
|
* }
|
|
103
103
|
* };
|
|
104
104
|
* const command = new EnableSecurityHubCommand(input);
|
|
105
|
-
* await client.send(command);
|
|
106
|
-
*
|
|
105
|
+
* const response = await client.send(command);
|
|
106
|
+
* /* response is
|
|
107
|
+
* { /* metadata only *\/ }
|
|
108
|
+
* *\/
|
|
107
109
|
* ```
|
|
108
110
|
*
|
|
111
|
+
* @public
|
|
109
112
|
*/
|
|
110
113
|
export declare class EnableSecurityHubCommand extends EnableSecurityHubCommand_base {
|
|
111
114
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -76,26 +76,8 @@ declare const GetAdministratorAccountCommand_base: {
|
|
|
76
76
|
* @throws {@link SecurityHubServiceException}
|
|
77
77
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
78
78
|
*
|
|
79
|
-
* @public
|
|
80
|
-
* @example To get details about the Security Hub administrator account
|
|
81
|
-
* ```javascript
|
|
82
|
-
* // The following example provides details about the Security Hub administrator account for the requesting member account.
|
|
83
|
-
* const input = {};
|
|
84
|
-
* const command = new GetAdministratorAccountCommand(input);
|
|
85
|
-
* const response = await client.send(command);
|
|
86
|
-
* /* response ==
|
|
87
|
-
* {
|
|
88
|
-
* "Administrator": {
|
|
89
|
-
* "AccountId": "123456789012",
|
|
90
|
-
* "InvitationId": "7ab938c5d52d7904ad09f9e7c20cc4eb",
|
|
91
|
-
* "InvitedAt": "2020-06-01T20:21:18.042000+00:00",
|
|
92
|
-
* "MemberStatus": "ASSOCIATED"
|
|
93
|
-
* }
|
|
94
|
-
* }
|
|
95
|
-
* *\/
|
|
96
|
-
* // example id: to-get-details-about-the-security-hub-administrator-account-1676998997182
|
|
97
|
-
* ```
|
|
98
79
|
*
|
|
80
|
+
* @public
|
|
99
81
|
*/
|
|
100
82
|
export declare class GetAdministratorAccountCommand extends GetAdministratorAccountCommand_base {
|
|
101
83
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -88,31 +88,31 @@ declare const GetConfigurationPolicyAssociationCommand_base: {
|
|
|
88
88
|
* @throws {@link SecurityHubServiceException}
|
|
89
89
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
90
90
|
*
|
|
91
|
-
*
|
|
91
|
+
*
|
|
92
92
|
* @example To get details about a configuration association
|
|
93
93
|
* ```javascript
|
|
94
94
|
* // This operation provides details about configuration associations for a specific target account, organizational unit, or the root.
|
|
95
95
|
* const input = {
|
|
96
|
-
*
|
|
97
|
-
*
|
|
96
|
+
* Target: {
|
|
97
|
+
* AccountId: "111122223333"
|
|
98
98
|
* }
|
|
99
99
|
* };
|
|
100
100
|
* const command = new GetConfigurationPolicyAssociationCommand(input);
|
|
101
101
|
* const response = await client.send(command);
|
|
102
|
-
* /* response
|
|
102
|
+
* /* response is
|
|
103
103
|
* {
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
104
|
+
* AssociationStatus: "FAILED",
|
|
105
|
+
* AssociationStatusMessage: "Configuration Policy a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 couldn’t be applied to account 111122223333 in us-east-1 Region. Retry your request.",
|
|
106
|
+
* AssociationType: "INHERITED",
|
|
107
|
+
* ConfigurationPolicyId: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
108
|
+
* TargetId: "111122223333",
|
|
109
|
+
* TargetType: "ACCOUNT",
|
|
110
|
+
* UpdatedAt: "2023-01-11T06:17:17.154Z"
|
|
111
111
|
* }
|
|
112
112
|
* *\/
|
|
113
|
-
* // example id: to-get-details-about-a-configuration-association-1695177816371
|
|
114
113
|
* ```
|
|
115
114
|
*
|
|
115
|
+
* @public
|
|
116
116
|
*/
|
|
117
117
|
export declare class GetConfigurationPolicyAssociationCommand extends GetConfigurationPolicyAssociationCommand_base {
|
|
118
118
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -124,55 +124,55 @@ declare const GetConfigurationPolicyCommand_base: {
|
|
|
124
124
|
* @throws {@link SecurityHubServiceException}
|
|
125
125
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
126
126
|
*
|
|
127
|
-
*
|
|
127
|
+
*
|
|
128
128
|
* @example To get details about a configuration policy
|
|
129
129
|
* ```javascript
|
|
130
130
|
* // This operation provides details about the specified configuration policy.
|
|
131
131
|
* const input = {
|
|
132
|
-
*
|
|
132
|
+
* Identifier: "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
133
133
|
* };
|
|
134
134
|
* const command = new GetConfigurationPolicyCommand(input);
|
|
135
135
|
* const response = await client.send(command);
|
|
136
|
-
* /* response
|
|
136
|
+
* /* response is
|
|
137
137
|
* {
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
*
|
|
138
|
+
* Arn: "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
139
|
+
* ConfigurationPolicy: {
|
|
140
|
+
* SecurityHub: {
|
|
141
|
+
* EnabledStandardIdentifiers: [
|
|
142
142
|
* "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
|
|
143
143
|
* "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
144
144
|
* ],
|
|
145
|
-
*
|
|
146
|
-
*
|
|
145
|
+
* SecurityControlsConfiguration: {
|
|
146
|
+
* DisabledSecurityControlIdentifiers: [
|
|
147
147
|
* "CloudWatch.1"
|
|
148
148
|
* ],
|
|
149
|
-
*
|
|
149
|
+
* SecurityControlCustomParameters: [
|
|
150
150
|
* {
|
|
151
|
-
*
|
|
152
|
-
*
|
|
153
|
-
*
|
|
154
|
-
*
|
|
151
|
+
* Parameters: {
|
|
152
|
+
* daysToExpiration: {
|
|
153
|
+
* Value: {
|
|
154
|
+
* Integer: 14
|
|
155
155
|
* },
|
|
156
|
-
*
|
|
156
|
+
* ValueType: "CUSTOM"
|
|
157
157
|
* }
|
|
158
158
|
* },
|
|
159
|
-
*
|
|
159
|
+
* SecurityControlId: "ACM.1"
|
|
160
160
|
* }
|
|
161
161
|
* ]
|
|
162
162
|
* },
|
|
163
|
-
*
|
|
163
|
+
* ServiceEnabled: true
|
|
164
164
|
* }
|
|
165
165
|
* },
|
|
166
|
-
*
|
|
167
|
-
*
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
*
|
|
166
|
+
* CreatedAt: "2023-01-11T06:17:17.154Z",
|
|
167
|
+
* Description: "Configuration policy for testing FSBP and CIS",
|
|
168
|
+
* Id: "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
169
|
+
* Name: "TestConfigurationPolicy",
|
|
170
|
+
* UpdatedAt: "2023-01-11T06:17:17.154Z"
|
|
171
171
|
* }
|
|
172
172
|
* *\/
|
|
173
|
-
* // example id: to-get-details-about-a-configuration-policy-1695173701103
|
|
174
173
|
* ```
|
|
175
174
|
*
|
|
175
|
+
* @public
|
|
176
176
|
*/
|
|
177
177
|
export declare class GetConfigurationPolicyCommand extends GetConfigurationPolicyCommand_base {
|
|
178
178
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -86,32 +86,32 @@ declare const GetEnabledStandardsCommand_base: {
|
|
|
86
86
|
* @throws {@link SecurityHubServiceException}
|
|
87
87
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
88
88
|
*
|
|
89
|
-
*
|
|
89
|
+
*
|
|
90
90
|
* @example To return a list of enabled standards
|
|
91
91
|
* ```javascript
|
|
92
92
|
* // The following example returns a list of Security Hub standards that are currently enabled in your account.
|
|
93
93
|
* const input = {
|
|
94
|
-
*
|
|
94
|
+
* StandardsSubscriptionArns: [
|
|
95
95
|
* "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"
|
|
96
96
|
* ]
|
|
97
97
|
* };
|
|
98
98
|
* const command = new GetEnabledStandardsCommand(input);
|
|
99
99
|
* const response = await client.send(command);
|
|
100
|
-
* /* response
|
|
100
|
+
* /* response is
|
|
101
101
|
* {
|
|
102
|
-
*
|
|
102
|
+
* StandardsSubscriptions: [
|
|
103
103
|
* {
|
|
104
|
-
*
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
104
|
+
* StandardsArn: "arn:aws:securityhub:us-west-1::standards/pci-dss/v/3.2.1",
|
|
105
|
+
* StandardsInput: { /* empty *\/ },
|
|
106
|
+
* StandardsStatus: "READY",
|
|
107
|
+
* StandardsSubscriptionArn: "arn:aws:securityhub:us-west-1:123456789012:subscription/pci-dss/v/3.2.1"
|
|
108
108
|
* }
|
|
109
109
|
* ]
|
|
110
110
|
* }
|
|
111
111
|
* *\/
|
|
112
|
-
* // example id: to-return-a-list-of-enabled-standards-1677090731129
|
|
113
112
|
* ```
|
|
114
113
|
*
|
|
114
|
+
* @public
|
|
115
115
|
*/
|
|
116
116
|
export declare class GetEnabledStandardsCommand extends GetEnabledStandardsCommand_base {
|
|
117
117
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -83,29 +83,29 @@ declare const GetFindingAggregatorCommand_base: {
|
|
|
83
83
|
* @throws {@link SecurityHubServiceException}
|
|
84
84
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
85
85
|
*
|
|
86
|
-
*
|
|
86
|
+
*
|
|
87
87
|
* @example To get cross-Region aggregation details
|
|
88
88
|
* ```javascript
|
|
89
89
|
* // The following example returns cross-Region aggregation details for the requesting account.
|
|
90
90
|
* const input = {
|
|
91
|
-
*
|
|
91
|
+
* FindingAggregatorArn: "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
92
92
|
* };
|
|
93
93
|
* const command = new GetFindingAggregatorCommand(input);
|
|
94
94
|
* const response = await client.send(command);
|
|
95
|
-
* /* response
|
|
95
|
+
* /* response is
|
|
96
96
|
* {
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
100
|
-
*
|
|
97
|
+
* FindingAggregationRegion: "us-east-1",
|
|
98
|
+
* FindingAggregatorArn: "arn:aws:securityhub:us-east-1:123456789012:finding-aggregator/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
99
|
+
* RegionLinkingMode: "SPECIFIED_REGIONS",
|
|
100
|
+
* Regions: [
|
|
101
101
|
* "us-west-1",
|
|
102
102
|
* "us-west-2"
|
|
103
103
|
* ]
|
|
104
104
|
* }
|
|
105
105
|
* *\/
|
|
106
|
-
* // example id: to-get-cross-region-aggregation-details-1677091474868
|
|
107
106
|
* ```
|
|
108
107
|
*
|
|
108
|
+
* @public
|
|
109
109
|
*/
|
|
110
110
|
export declare class GetFindingAggregatorCommand extends GetFindingAggregatorCommand_base {
|
|
111
111
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -100,49 +100,8 @@ declare const GetFindingHistoryCommand_base: {
|
|
|
100
100
|
* @throws {@link SecurityHubServiceException}
|
|
101
101
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
102
102
|
*
|
|
103
|
-
* @public
|
|
104
|
-
* @example To get finding history
|
|
105
|
-
* ```javascript
|
|
106
|
-
* // The following example retrieves the history of the specified finding during the specified time frame. If the time frame permits, Security Hub returns finding history for the last 90 days.
|
|
107
|
-
* const input = {
|
|
108
|
-
* "EndTime": "2021-09-31T15:53:35.573Z",
|
|
109
|
-
* "FindingIdentifier": {
|
|
110
|
-
* "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
111
|
-
* "ProductArn": "arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default"
|
|
112
|
-
* },
|
|
113
|
-
* "MaxResults": 2,
|
|
114
|
-
* "StartTime": "2021-09-30T15:53:35.573Z"
|
|
115
|
-
* };
|
|
116
|
-
* const command = new GetFindingHistoryCommand(input);
|
|
117
|
-
* const response = await client.send(command);
|
|
118
|
-
* /* response ==
|
|
119
|
-
* {
|
|
120
|
-
* "Records": [
|
|
121
|
-
* {
|
|
122
|
-
* "FindingCreated": false,
|
|
123
|
-
* "FindingIdentifier": {
|
|
124
|
-
* "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
125
|
-
* "ProductArn": "arn:aws:securityhub:us-west-2:123456789012:product/123456789012/default"
|
|
126
|
-
* },
|
|
127
|
-
* "UpdateSource": {
|
|
128
|
-
* "Identity": "arn:aws:iam::444455556666:role/Admin",
|
|
129
|
-
* "Type": "BATCH_UPDATE_FINDINGS"
|
|
130
|
-
* },
|
|
131
|
-
* "UpdateTime": "2021-09-31T15:52:25.573Z",
|
|
132
|
-
* "Updates": [
|
|
133
|
-
* {
|
|
134
|
-
* "NewValue": "MEDIUM",
|
|
135
|
-
* "OldValue": "HIGH",
|
|
136
|
-
* "UpdatedField": "Severity"
|
|
137
|
-
* }
|
|
138
|
-
* ]
|
|
139
|
-
* }
|
|
140
|
-
* ]
|
|
141
|
-
* }
|
|
142
|
-
* *\/
|
|
143
|
-
* // example id: to-get-finding-history-1680270012186
|
|
144
|
-
* ```
|
|
145
103
|
*
|
|
104
|
+
* @public
|
|
146
105
|
*/
|
|
147
106
|
export declare class GetFindingHistoryCommand extends GetFindingHistoryCommand_base {
|
|
148
107
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -4608,118 +4608,118 @@ declare const GetFindingsCommand_base: {
|
|
|
4608
4608
|
* @throws {@link SecurityHubServiceException}
|
|
4609
4609
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
4610
4610
|
*
|
|
4611
|
-
*
|
|
4611
|
+
*
|
|
4612
4612
|
* @example To get a list of findings
|
|
4613
4613
|
* ```javascript
|
|
4614
4614
|
* // The following example returns a filtered and sorted list of Security Hub findings.
|
|
4615
4615
|
* const input = {
|
|
4616
|
-
*
|
|
4617
|
-
*
|
|
4616
|
+
* Filters: {
|
|
4617
|
+
* AwsAccountId: [
|
|
4618
4618
|
* {
|
|
4619
|
-
*
|
|
4620
|
-
*
|
|
4619
|
+
* Comparison: "PREFIX",
|
|
4620
|
+
* Value: "123456789012"
|
|
4621
4621
|
* }
|
|
4622
4622
|
* ]
|
|
4623
4623
|
* },
|
|
4624
|
-
*
|
|
4624
|
+
* MaxResults: 1
|
|
4625
4625
|
* };
|
|
4626
4626
|
* const command = new GetFindingsCommand(input);
|
|
4627
4627
|
* const response = await client.send(command);
|
|
4628
|
-
* /* response
|
|
4628
|
+
* /* response is
|
|
4629
4629
|
* {
|
|
4630
|
-
*
|
|
4630
|
+
* Findings: [
|
|
4631
4631
|
* {
|
|
4632
|
-
*
|
|
4633
|
-
*
|
|
4634
|
-
*
|
|
4635
|
-
*
|
|
4632
|
+
* AwsAccountId: "123456789012",
|
|
4633
|
+
* CompanyName: "AWS",
|
|
4634
|
+
* Compliance: {
|
|
4635
|
+
* AssociatedStandards: [
|
|
4636
4636
|
* {
|
|
4637
|
-
*
|
|
4637
|
+
* StandardsId: "standards/aws-foundational-security-best-practices/v/1.0.0"
|
|
4638
4638
|
* },
|
|
4639
4639
|
* {
|
|
4640
|
-
*
|
|
4640
|
+
* StandardsId: "standards/pci-dss/v/3.2.1"
|
|
4641
4641
|
* },
|
|
4642
4642
|
* {
|
|
4643
|
-
*
|
|
4643
|
+
* StandardsId: "ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
4644
4644
|
* },
|
|
4645
4645
|
* {
|
|
4646
|
-
*
|
|
4646
|
+
* StandardsId: "standards/cis-aws-foundations-benchmark/v/1.4.0"
|
|
4647
4647
|
* },
|
|
4648
4648
|
* {
|
|
4649
|
-
*
|
|
4649
|
+
* StandardsId: "standards/service-managed-aws-control-tower/v/1.0.0"
|
|
4650
4650
|
* }
|
|
4651
4651
|
* ],
|
|
4652
|
-
*
|
|
4652
|
+
* RelatedRequirements: [
|
|
4653
4653
|
* "PCI DSS v3.2.1/3.4",
|
|
4654
4654
|
* "CIS AWS Foundations Benchmark v1.2.0/2.7",
|
|
4655
4655
|
* "CIS AWS Foundations Benchmark v1.4.0/3.7"
|
|
4656
4656
|
* ],
|
|
4657
|
-
*
|
|
4658
|
-
*
|
|
4657
|
+
* SecurityControlId: "CloudTrail.2",
|
|
4658
|
+
* Status: "FAILED"
|
|
4659
4659
|
* },
|
|
4660
|
-
*
|
|
4661
|
-
*
|
|
4662
|
-
*
|
|
4663
|
-
*
|
|
4664
|
-
*
|
|
4665
|
-
*
|
|
4660
|
+
* CreatedAt: "2022-10-06T02:18:23.076Z",
|
|
4661
|
+
* Description: "This AWS control checks whether AWS CloudTrail is configured to use the server side encryption (SSE) AWS Key Management Service (AWS KMS) customer master key (CMK) encryption. The check will pass if the KmsKeyId is defined.",
|
|
4662
|
+
* FindingProviderFields: {
|
|
4663
|
+
* Severity: {
|
|
4664
|
+
* Label: "MEDIUM",
|
|
4665
|
+
* Original: "MEDIUM"
|
|
4666
4666
|
* },
|
|
4667
|
-
*
|
|
4667
|
+
* Types: [
|
|
4668
4668
|
* "Software and Configuration Checks/Industry and Regulatory Standards"
|
|
4669
4669
|
* ]
|
|
4670
4670
|
* },
|
|
4671
|
-
*
|
|
4672
|
-
*
|
|
4673
|
-
*
|
|
4674
|
-
*
|
|
4675
|
-
*
|
|
4676
|
-
*
|
|
4677
|
-
*
|
|
4678
|
-
*
|
|
4679
|
-
*
|
|
4680
|
-
*
|
|
4681
|
-
*
|
|
4682
|
-
*
|
|
4671
|
+
* FirstObservedAt: "2022-10-06T02:18:23.076Z",
|
|
4672
|
+
* GeneratorId: "security-control/CloudTrail.2",
|
|
4673
|
+
* Id: "arn:aws:securityhub:us-east-2:123456789012:security-control/CloudTrail.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
4674
|
+
* LastObservedAt: "2022-10-28T16:10:06.956Z",
|
|
4675
|
+
* ProductArn: "arn:aws:securityhub:us-east-2::product/aws/securityhub",
|
|
4676
|
+
* ProductFields: {
|
|
4677
|
+
* RelatedAWSResources:0/name: "securityhub-cloud-trail-encryption-enabled-fe95bf3f",
|
|
4678
|
+
* RelatedAWSResources:0/type: "AWS::Config::ConfigRule",
|
|
4679
|
+
* Resources:0/Id: "arn:aws:cloudtrail:us-east-2:123456789012:trail/AWSMacieTrail-DO-NOT-EDIT",
|
|
4680
|
+
* aws/securityhub/CompanyName: "AWS",
|
|
4681
|
+
* aws/securityhub/FindingId: "arn:aws:securityhub:us-east-2::product/aws/securityhub/arn:aws:securityhub:us-east-2:123456789012:security-control/CloudTrail.2/finding/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
4682
|
+
* aws/securityhub/ProductName: "Security Hub"
|
|
4683
4683
|
* },
|
|
4684
|
-
*
|
|
4685
|
-
*
|
|
4686
|
-
*
|
|
4687
|
-
*
|
|
4688
|
-
*
|
|
4689
|
-
*
|
|
4690
|
-
*
|
|
4684
|
+
* ProductName: "Security Hub",
|
|
4685
|
+
* RecordState: "ACTIVE",
|
|
4686
|
+
* Region: "us-east-2",
|
|
4687
|
+
* Remediation: {
|
|
4688
|
+
* Recommendation: {
|
|
4689
|
+
* Text: "For directions on how to correct this issue, consult the AWS Security Hub controls documentation.",
|
|
4690
|
+
* Url: "https://docs.aws.amazon.com/console/securityhub/CloudTrail.2/remediation"
|
|
4691
4691
|
* }
|
|
4692
4692
|
* },
|
|
4693
|
-
*
|
|
4693
|
+
* Resources: [
|
|
4694
4694
|
* {
|
|
4695
|
-
*
|
|
4696
|
-
*
|
|
4697
|
-
*
|
|
4698
|
-
*
|
|
4695
|
+
* Id: "arn:aws:cloudtrail:us-east-2:123456789012:trail/AWSMacieTrail-DO-NOT-EDIT",
|
|
4696
|
+
* Partition: "aws",
|
|
4697
|
+
* Region: "us-east-2",
|
|
4698
|
+
* Type: "AwsCloudTrailTrail"
|
|
4699
4699
|
* }
|
|
4700
4700
|
* ],
|
|
4701
|
-
*
|
|
4702
|
-
*
|
|
4703
|
-
*
|
|
4704
|
-
*
|
|
4705
|
-
*
|
|
4701
|
+
* SchemaVersion: "2018-10-08",
|
|
4702
|
+
* Severity: {
|
|
4703
|
+
* Label: "MEDIUM",
|
|
4704
|
+
* Normalized: 40,
|
|
4705
|
+
* Original: "MEDIUM"
|
|
4706
4706
|
* },
|
|
4707
|
-
*
|
|
4708
|
-
*
|
|
4707
|
+
* Title: "CloudTrail should have encryption at-rest enabled",
|
|
4708
|
+
* Types: [
|
|
4709
4709
|
* "Software and Configuration Checks/Industry and Regulatory Standards"
|
|
4710
4710
|
* ],
|
|
4711
|
-
*
|
|
4712
|
-
*
|
|
4713
|
-
*
|
|
4711
|
+
* UpdatedAt: "2022-10-28T16:10:00.093Z",
|
|
4712
|
+
* Workflow: {
|
|
4713
|
+
* Status: "NEW"
|
|
4714
4714
|
* },
|
|
4715
|
-
*
|
|
4715
|
+
* WorkflowState: "NEW"
|
|
4716
4716
|
* }
|
|
4717
4717
|
* ]
|
|
4718
4718
|
* }
|
|
4719
4719
|
* *\/
|
|
4720
|
-
* // example id: to-get-a-list-of-findings-1677181069931
|
|
4721
4720
|
* ```
|
|
4722
4721
|
*
|
|
4722
|
+
* @public
|
|
4723
4723
|
*/
|
|
4724
4724
|
export declare class GetFindingsCommand extends GetFindingsCommand_base {
|
|
4725
4725
|
/** @internal type navigation helper, not in runtime. */
|
|
@@ -80,36 +80,36 @@ declare const GetInsightResultsCommand_base: {
|
|
|
80
80
|
* @throws {@link SecurityHubServiceException}
|
|
81
81
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
82
82
|
*
|
|
83
|
-
*
|
|
83
|
+
*
|
|
84
84
|
* @example To get the results of a Security Hub insight
|
|
85
85
|
* ```javascript
|
|
86
86
|
* // The following example returns the results of the Security Hub insight specified by the insight ARN.
|
|
87
87
|
* const input = {
|
|
88
|
-
*
|
|
88
|
+
* InsightArn: "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
89
89
|
* };
|
|
90
90
|
* const command = new GetInsightResultsCommand(input);
|
|
91
91
|
* const response = await client.send(command);
|
|
92
|
-
* /* response
|
|
92
|
+
* /* response is
|
|
93
93
|
* {
|
|
94
|
-
*
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
94
|
+
* InsightResults: {
|
|
95
|
+
* GroupByAttribute: "ResourceId",
|
|
96
|
+
* InsightArn: "arn:aws:securityhub:us-west-1:123456789012:insight/123456789012/custom/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
97
|
+
* ResultValues: [
|
|
98
98
|
* {
|
|
99
|
-
*
|
|
100
|
-
*
|
|
99
|
+
* Count: 10,
|
|
100
|
+
* GroupByAttributeValue: "AWS::::Account:111122223333"
|
|
101
101
|
* },
|
|
102
102
|
* {
|
|
103
|
-
*
|
|
104
|
-
*
|
|
103
|
+
* Count: 3,
|
|
104
|
+
* GroupByAttributeValue: "AWS::::Account:444455556666"
|
|
105
105
|
* }
|
|
106
106
|
* ]
|
|
107
107
|
* }
|
|
108
108
|
* }
|
|
109
109
|
* *\/
|
|
110
|
-
* // example id: to-get-the-results-of-a-security-hub-insight-1677182822019
|
|
111
110
|
* ```
|
|
112
111
|
*
|
|
112
|
+
* @public
|
|
113
113
|
*/
|
|
114
114
|
export declare class GetInsightResultsCommand extends GetInsightResultsCommand_base {
|
|
115
115
|
/** @internal type navigation helper, not in runtime. */
|