@aws-sdk/client-securityhub 3.458.0 → 3.460.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 +80 -0
- package/dist-cjs/SecurityHub.js +20 -0
- package/dist-cjs/commands/BatchGetConfigurationPolicyAssociationsCommand.js +51 -0
- package/dist-cjs/commands/CreateConfigurationPolicyCommand.js +51 -0
- package/dist-cjs/commands/DeleteConfigurationPolicyCommand.js +51 -0
- package/dist-cjs/commands/GetConfigurationPolicyAssociationCommand.js +51 -0
- package/dist-cjs/commands/GetConfigurationPolicyCommand.js +51 -0
- package/dist-cjs/commands/ListConfigurationPoliciesCommand.js +51 -0
- package/dist-cjs/commands/ListConfigurationPolicyAssociationsCommand.js +51 -0
- package/dist-cjs/commands/StartConfigurationPolicyAssociationCommand.js +51 -0
- package/dist-cjs/commands/StartConfigurationPolicyDisassociationCommand.js +51 -0
- package/dist-cjs/commands/UpdateConfigurationPolicyCommand.js +51 -0
- package/dist-cjs/commands/index.js +10 -0
- package/dist-cjs/models/models_0.js +10 -1
- package/dist-cjs/models/models_2.js +34 -1
- package/dist-cjs/pagination/ListConfigurationPoliciesPaginator.js +29 -0
- package/dist-cjs/pagination/ListConfigurationPolicyAssociationsPaginator.js +29 -0
- package/dist-cjs/pagination/index.js +2 -0
- package/dist-cjs/protocols/Aws_restJson1.js +943 -35
- package/dist-es/SecurityHub.js +20 -0
- package/dist-es/commands/BatchGetConfigurationPolicyAssociationsCommand.js +47 -0
- package/dist-es/commands/CreateConfigurationPolicyCommand.js +47 -0
- package/dist-es/commands/DeleteConfigurationPolicyCommand.js +47 -0
- package/dist-es/commands/GetConfigurationPolicyAssociationCommand.js +47 -0
- package/dist-es/commands/GetConfigurationPolicyCommand.js +47 -0
- package/dist-es/commands/ListConfigurationPoliciesCommand.js +47 -0
- package/dist-es/commands/ListConfigurationPolicyAssociationsCommand.js +47 -0
- package/dist-es/commands/StartConfigurationPolicyAssociationCommand.js +47 -0
- package/dist-es/commands/StartConfigurationPolicyDisassociationCommand.js +47 -0
- package/dist-es/commands/UpdateConfigurationPolicyCommand.js +47 -0
- package/dist-es/commands/index.js +10 -0
- package/dist-es/models/models_0.js +9 -0
- package/dist-es/models/models_2.js +33 -0
- package/dist-es/pagination/ListConfigurationPoliciesPaginator.js +25 -0
- package/dist-es/pagination/ListConfigurationPolicyAssociationsPaginator.js +25 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_restJson1.js +920 -33
- package/dist-types/SecurityHub.d.ts +70 -0
- package/dist-types/SecurityHubClient.d.ts +12 -2
- package/dist-types/commands/BatchDisableStandardsCommand.d.ts +3 -0
- package/dist-types/commands/BatchEnableStandardsCommand.d.ts +3 -0
- package/dist-types/commands/BatchGetAutomationRulesCommand.d.ts +3 -0
- package/dist-types/commands/BatchGetConfigurationPolicyAssociationsCommand.d.ts +176 -0
- package/dist-types/commands/BatchGetSecurityControlsCommand.d.ts +22 -2
- package/dist-types/commands/BatchImportFindingsCommand.d.ts +4 -0
- package/dist-types/commands/BatchUpdateAutomationRulesCommand.d.ts +3 -0
- package/dist-types/commands/BatchUpdateStandardsControlAssociationsCommand.d.ts +3 -0
- package/dist-types/commands/CreateAutomationRuleCommand.d.ts +3 -0
- package/dist-types/commands/CreateConfigurationPolicyCommand.d.ts +265 -0
- package/dist-types/commands/CreateInsightCommand.d.ts +3 -0
- package/dist-types/commands/CreateMembersCommand.d.ts +3 -0
- package/dist-types/commands/DeleteConfigurationPolicyCommand.d.ts +109 -0
- package/dist-types/commands/DescribeOrganizationConfigurationCommand.d.ts +27 -2
- package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts +3 -0
- package/dist-types/commands/DisableSecurityHubCommand.d.ts +3 -0
- package/dist-types/commands/DisassociateMembersCommand.d.ts +3 -0
- package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts +3 -0
- package/dist-types/commands/GetConfigurationPolicyAssociationCommand.d.ts +131 -0
- package/dist-types/commands/GetConfigurationPolicyCommand.d.ts +191 -0
- package/dist-types/commands/GetFindingsCommand.d.ts +7 -0
- package/dist-types/commands/GetInsightsCommand.d.ts +3 -0
- package/dist-types/commands/GetSecurityControlDefinitionCommand.d.ts +35 -0
- package/dist-types/commands/ListConfigurationPoliciesCommand.d.ts +131 -0
- package/dist-types/commands/ListConfigurationPolicyAssociationsCommand.d.ts +140 -0
- package/dist-types/commands/ListSecurityControlDefinitionsCommand.d.ts +6 -0
- package/dist-types/commands/StartConfigurationPolicyAssociationCommand.d.ts +133 -0
- package/dist-types/commands/StartConfigurationPolicyDisassociationCommand.d.ts +116 -0
- package/dist-types/commands/UpdateConfigurationPolicyCommand.d.ts +271 -0
- package/dist-types/commands/UpdateFindingsCommand.d.ts +3 -0
- package/dist-types/commands/UpdateInsightCommand.d.ts +3 -0
- package/dist-types/commands/UpdateOrganizationConfigurationCommand.d.ts +16 -2
- package/dist-types/commands/UpdateSecurityControlCommand.d.ts +23 -0
- package/dist-types/commands/UpdateSecurityHubConfigurationCommand.d.ts +3 -0
- package/dist-types/commands/UpdateStandardsControlCommand.d.ts +3 -0
- package/dist-types/commands/index.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +86 -192
- package/dist-types/models/models_1.d.ts +192 -49
- package/dist-types/models/models_2.d.ts +1180 -37
- package/dist-types/pagination/ListConfigurationPoliciesPaginator.d.ts +7 -0
- package/dist-types/pagination/ListConfigurationPolicyAssociationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +90 -0
- package/dist-types/ts3.4/SecurityHub.d.ts +200 -0
- package/dist-types/ts3.4/SecurityHubClient.d.ts +60 -0
- package/dist-types/ts3.4/commands/BatchGetConfigurationPolicyAssociationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/CreateConfigurationPolicyCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/DeleteConfigurationPolicyCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetConfigurationPolicyAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/GetConfigurationPolicyCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListConfigurationPoliciesCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/ListConfigurationPolicyAssociationsCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartConfigurationPolicyAssociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/StartConfigurationPolicyDisassociationCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/UpdateConfigurationPolicyCommand.d.ts +42 -0
- package/dist-types/ts3.4/commands/index.d.ts +10 -0
- package/dist-types/ts3.4/models/models_0.d.ts +21 -26
- package/dist-types/ts3.4/models/models_1.d.ts +32 -9
- package/dist-types/ts3.4/models/models_2.d.ts +243 -4
- package/dist-types/ts3.4/pagination/ListConfigurationPoliciesPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListConfigurationPolicyAssociationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +120 -0
- package/package.json +12 -12
|
@@ -0,0 +1,265 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { CreateConfigurationPolicyRequest, CreateConfigurationPolicyResponse } from "../models/models_2";
|
|
5
|
+
import { SecurityHubClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecurityHubClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link CreateConfigurationPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateConfigurationPolicyCommandInput extends CreateConfigurationPolicyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateConfigurationPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateConfigurationPolicyCommandOutput extends CreateConfigurationPolicyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>
|
|
27
|
+
* Creates a configuration policy with the defined configuration. Only the Security Hub delegated administrator
|
|
28
|
+
* can invoke this operation from the home Region.
|
|
29
|
+
* </p>
|
|
30
|
+
* @example
|
|
31
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
32
|
+
* ```javascript
|
|
33
|
+
* import { SecurityHubClient, CreateConfigurationPolicyCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
|
|
34
|
+
* // const { SecurityHubClient, CreateConfigurationPolicyCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
|
|
35
|
+
* const client = new SecurityHubClient(config);
|
|
36
|
+
* const input = { // CreateConfigurationPolicyRequest
|
|
37
|
+
* Name: "STRING_VALUE", // required
|
|
38
|
+
* Description: "STRING_VALUE",
|
|
39
|
+
* ConfigurationPolicy: { // Policy Union: only one key present
|
|
40
|
+
* SecurityHub: { // SecurityHubPolicy
|
|
41
|
+
* ServiceEnabled: true || false,
|
|
42
|
+
* EnabledStandardIdentifiers: [ // EnabledStandardIdentifierList
|
|
43
|
+
* "STRING_VALUE",
|
|
44
|
+
* ],
|
|
45
|
+
* SecurityControlsConfiguration: { // SecurityControlsConfiguration
|
|
46
|
+
* EnabledSecurityControlIdentifiers: [ // EnabledSecurityControlIdentifierList
|
|
47
|
+
* "STRING_VALUE",
|
|
48
|
+
* ],
|
|
49
|
+
* DisabledSecurityControlIdentifiers: [ // DisabledSecurityControlIdentifierList
|
|
50
|
+
* "STRING_VALUE",
|
|
51
|
+
* ],
|
|
52
|
+
* SecurityControlCustomParameters: [ // SecurityControlCustomParametersList
|
|
53
|
+
* { // SecurityControlCustomParameter
|
|
54
|
+
* SecurityControlId: "STRING_VALUE",
|
|
55
|
+
* Parameters: { // Parameters
|
|
56
|
+
* "<keys>": { // ParameterConfiguration
|
|
57
|
+
* ValueType: "DEFAULT" || "CUSTOM", // required
|
|
58
|
+
* Value: { // ParameterValue Union: only one key present
|
|
59
|
+
* Integer: Number("int"),
|
|
60
|
+
* IntegerList: [ // IntegerList
|
|
61
|
+
* Number("int"),
|
|
62
|
+
* ],
|
|
63
|
+
* Double: Number("double"),
|
|
64
|
+
* String: "STRING_VALUE",
|
|
65
|
+
* StringList: [ // StringList
|
|
66
|
+
* "STRING_VALUE",
|
|
67
|
+
* ],
|
|
68
|
+
* Boolean: true || false,
|
|
69
|
+
* Enum: "STRING_VALUE",
|
|
70
|
+
* EnumList: [
|
|
71
|
+
* "STRING_VALUE",
|
|
72
|
+
* ],
|
|
73
|
+
* },
|
|
74
|
+
* },
|
|
75
|
+
* },
|
|
76
|
+
* },
|
|
77
|
+
* ],
|
|
78
|
+
* },
|
|
79
|
+
* },
|
|
80
|
+
* },
|
|
81
|
+
* Tags: { // TagMap
|
|
82
|
+
* "<keys>": "STRING_VALUE",
|
|
83
|
+
* },
|
|
84
|
+
* };
|
|
85
|
+
* const command = new CreateConfigurationPolicyCommand(input);
|
|
86
|
+
* const response = await client.send(command);
|
|
87
|
+
* // { // CreateConfigurationPolicyResponse
|
|
88
|
+
* // Arn: "STRING_VALUE",
|
|
89
|
+
* // Id: "STRING_VALUE",
|
|
90
|
+
* // Name: "STRING_VALUE",
|
|
91
|
+
* // Description: "STRING_VALUE",
|
|
92
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
93
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
94
|
+
* // ConfigurationPolicy: { // Policy Union: only one key present
|
|
95
|
+
* // SecurityHub: { // SecurityHubPolicy
|
|
96
|
+
* // ServiceEnabled: true || false,
|
|
97
|
+
* // EnabledStandardIdentifiers: [ // EnabledStandardIdentifierList
|
|
98
|
+
* // "STRING_VALUE",
|
|
99
|
+
* // ],
|
|
100
|
+
* // SecurityControlsConfiguration: { // SecurityControlsConfiguration
|
|
101
|
+
* // EnabledSecurityControlIdentifiers: [ // EnabledSecurityControlIdentifierList
|
|
102
|
+
* // "STRING_VALUE",
|
|
103
|
+
* // ],
|
|
104
|
+
* // DisabledSecurityControlIdentifiers: [ // DisabledSecurityControlIdentifierList
|
|
105
|
+
* // "STRING_VALUE",
|
|
106
|
+
* // ],
|
|
107
|
+
* // SecurityControlCustomParameters: [ // SecurityControlCustomParametersList
|
|
108
|
+
* // { // SecurityControlCustomParameter
|
|
109
|
+
* // SecurityControlId: "STRING_VALUE",
|
|
110
|
+
* // Parameters: { // Parameters
|
|
111
|
+
* // "<keys>": { // ParameterConfiguration
|
|
112
|
+
* // ValueType: "DEFAULT" || "CUSTOM", // required
|
|
113
|
+
* // Value: { // ParameterValue Union: only one key present
|
|
114
|
+
* // Integer: Number("int"),
|
|
115
|
+
* // IntegerList: [ // IntegerList
|
|
116
|
+
* // Number("int"),
|
|
117
|
+
* // ],
|
|
118
|
+
* // Double: Number("double"),
|
|
119
|
+
* // String: "STRING_VALUE",
|
|
120
|
+
* // StringList: [ // StringList
|
|
121
|
+
* // "STRING_VALUE",
|
|
122
|
+
* // ],
|
|
123
|
+
* // Boolean: true || false,
|
|
124
|
+
* // Enum: "STRING_VALUE",
|
|
125
|
+
* // EnumList: [
|
|
126
|
+
* // "STRING_VALUE",
|
|
127
|
+
* // ],
|
|
128
|
+
* // },
|
|
129
|
+
* // },
|
|
130
|
+
* // },
|
|
131
|
+
* // },
|
|
132
|
+
* // ],
|
|
133
|
+
* // },
|
|
134
|
+
* // },
|
|
135
|
+
* // },
|
|
136
|
+
* // };
|
|
137
|
+
*
|
|
138
|
+
* ```
|
|
139
|
+
*
|
|
140
|
+
* @param CreateConfigurationPolicyCommandInput - {@link CreateConfigurationPolicyCommandInput}
|
|
141
|
+
* @returns {@link CreateConfigurationPolicyCommandOutput}
|
|
142
|
+
* @see {@link CreateConfigurationPolicyCommandInput} for command's `input` shape.
|
|
143
|
+
* @see {@link CreateConfigurationPolicyCommandOutput} for command's `response` shape.
|
|
144
|
+
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
145
|
+
*
|
|
146
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
147
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
148
|
+
*
|
|
149
|
+
* @throws {@link InternalException} (server fault)
|
|
150
|
+
* <p>Internal server error.</p>
|
|
151
|
+
*
|
|
152
|
+
* @throws {@link InvalidAccessException} (client fault)
|
|
153
|
+
* <p>The account doesn't have permission to perform this action.</p>
|
|
154
|
+
*
|
|
155
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
156
|
+
* <p>The request was rejected because you supplied an invalid or out-of-range value for an
|
|
157
|
+
* input parameter.</p>
|
|
158
|
+
*
|
|
159
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
160
|
+
* <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
|
|
161
|
+
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
162
|
+
*
|
|
163
|
+
* @throws {@link ResourceConflictException} (client fault)
|
|
164
|
+
* <p>The resource specified in the request conflicts with an existing resource.</p>
|
|
165
|
+
*
|
|
166
|
+
* @throws {@link SecurityHubServiceException}
|
|
167
|
+
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
168
|
+
*
|
|
169
|
+
* @example To create a configuration policy
|
|
170
|
+
* ```javascript
|
|
171
|
+
* // This operation creates a configuration policy in Security Hub.
|
|
172
|
+
* const input = {
|
|
173
|
+
* "ConfigurationPolicy": {
|
|
174
|
+
* "SecurityHub": {
|
|
175
|
+
* "EnabledStandardIdentifiers": [
|
|
176
|
+
* "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
|
|
177
|
+
* "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
178
|
+
* ],
|
|
179
|
+
* "SecurityControlsConfiguration": {
|
|
180
|
+
* "DisabledSecurityControlIdentifiers": [
|
|
181
|
+
* "CloudWatch.1"
|
|
182
|
+
* ],
|
|
183
|
+
* "SecurityControlCustomParameters": [
|
|
184
|
+
* {
|
|
185
|
+
* "Parameters": {
|
|
186
|
+
* "daysToExpiration": {
|
|
187
|
+
* "Value": {
|
|
188
|
+
* "Integer": 14
|
|
189
|
+
* },
|
|
190
|
+
* "ValueType": "CUSTOM"
|
|
191
|
+
* }
|
|
192
|
+
* },
|
|
193
|
+
* "SecurityControlId": "ACM.1"
|
|
194
|
+
* }
|
|
195
|
+
* ]
|
|
196
|
+
* },
|
|
197
|
+
* "ServiceEnabled": true
|
|
198
|
+
* }
|
|
199
|
+
* },
|
|
200
|
+
* "Description": "Configuration policy for testing FSBP and CIS",
|
|
201
|
+
* "Name": "TestConfigurationPolicy"
|
|
202
|
+
* };
|
|
203
|
+
* const command = new CreateConfigurationPolicyCommand(input);
|
|
204
|
+
* const response = await client.send(command);
|
|
205
|
+
* /* response ==
|
|
206
|
+
* {
|
|
207
|
+
* "Arn": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
208
|
+
* "ConfigurationPolicy": {
|
|
209
|
+
* "SecurityHub": {
|
|
210
|
+
* "EnabledStandardIdentifiers": [
|
|
211
|
+
* "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
|
|
212
|
+
* "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
213
|
+
* ],
|
|
214
|
+
* "SecurityControlsConfiguration": {
|
|
215
|
+
* "DisabledSecurityControlIdentifiers": [
|
|
216
|
+
* "CloudWatch.1"
|
|
217
|
+
* ],
|
|
218
|
+
* "SecurityControlCustomParameters": [
|
|
219
|
+
* {
|
|
220
|
+
* "Parameters": {
|
|
221
|
+
* "daysToExpiration": {
|
|
222
|
+
* "Value": {
|
|
223
|
+
* "Integer": 14
|
|
224
|
+
* },
|
|
225
|
+
* "ValueType": "CUSTOM"
|
|
226
|
+
* }
|
|
227
|
+
* },
|
|
228
|
+
* "SecurityControlId": "ACM.1"
|
|
229
|
+
* }
|
|
230
|
+
* ]
|
|
231
|
+
* },
|
|
232
|
+
* "ServiceEnabled": true
|
|
233
|
+
* }
|
|
234
|
+
* },
|
|
235
|
+
* "CreatedAt": "2023-01-11T06:17:17.154Z",
|
|
236
|
+
* "Description": "Configuration policy for testing FSBP and CIS",
|
|
237
|
+
* "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
238
|
+
* "Name": "TestConfigurationPolicy",
|
|
239
|
+
* "UpdatedAt": "2023-01-11T06:17:17.154Z"
|
|
240
|
+
* }
|
|
241
|
+
* *\/
|
|
242
|
+
* // example id: to-create-a-configuration-policy-1695172470099
|
|
243
|
+
* ```
|
|
244
|
+
*
|
|
245
|
+
*/
|
|
246
|
+
export declare class CreateConfigurationPolicyCommand extends $Command<CreateConfigurationPolicyCommandInput, CreateConfigurationPolicyCommandOutput, SecurityHubClientResolvedConfig> {
|
|
247
|
+
readonly input: CreateConfigurationPolicyCommandInput;
|
|
248
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
249
|
+
/**
|
|
250
|
+
* @public
|
|
251
|
+
*/
|
|
252
|
+
constructor(input: CreateConfigurationPolicyCommandInput);
|
|
253
|
+
/**
|
|
254
|
+
* @internal
|
|
255
|
+
*/
|
|
256
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecurityHubClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateConfigurationPolicyCommandInput, CreateConfigurationPolicyCommandOutput>;
|
|
257
|
+
/**
|
|
258
|
+
* @internal
|
|
259
|
+
*/
|
|
260
|
+
private serialize;
|
|
261
|
+
/**
|
|
262
|
+
* @internal
|
|
263
|
+
*/
|
|
264
|
+
private deserialize;
|
|
265
|
+
}
|
|
@@ -299,6 +299,9 @@ export interface CreateInsightCommandOutput extends CreateInsightResponse, __Met
|
|
|
299
299
|
* VulnerabilitiesFixAvailable: "<StringFilterList>",
|
|
300
300
|
* ComplianceSecurityControlParametersName: "<StringFilterList>",
|
|
301
301
|
* ComplianceSecurityControlParametersValue: "<StringFilterList>",
|
|
302
|
+
* AwsAccountName: "<StringFilterList>",
|
|
303
|
+
* ResourceApplicationName: "<StringFilterList>",
|
|
304
|
+
* ResourceApplicationArn: "<StringFilterList>",
|
|
302
305
|
* },
|
|
303
306
|
* GroupByAttribute: "STRING_VALUE", // required
|
|
304
307
|
* };
|
|
@@ -91,6 +91,9 @@ export interface CreateMembersCommandOutput extends CreateMembersResponse, __Met
|
|
|
91
91
|
* @see {@link CreateMembersCommandOutput} for command's `response` shape.
|
|
92
92
|
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
93
93
|
*
|
|
94
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
95
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
96
|
+
*
|
|
94
97
|
* @throws {@link InternalException} (server fault)
|
|
95
98
|
* <p>Internal server error.</p>
|
|
96
99
|
*
|
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { DeleteConfigurationPolicyRequest, DeleteConfigurationPolicyResponse } from "../models/models_2";
|
|
5
|
+
import { SecurityHubClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecurityHubClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link DeleteConfigurationPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteConfigurationPolicyCommandInput extends DeleteConfigurationPolicyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteConfigurationPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteConfigurationPolicyCommandOutput extends DeleteConfigurationPolicyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>
|
|
27
|
+
* Deletes a configuration policy. Only the Security Hub delegated administrator can invoke this operation
|
|
28
|
+
* from the home Region. For the deletion to succeed, you must first disassociate a configuration policy from target accounts,
|
|
29
|
+
* organizational units, or the root by invoking the <code>StartConfigurationPolicyDisassociation</code> operation.
|
|
30
|
+
* </p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { SecurityHubClient, DeleteConfigurationPolicyCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
|
|
35
|
+
* // const { SecurityHubClient, DeleteConfigurationPolicyCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
|
|
36
|
+
* const client = new SecurityHubClient(config);
|
|
37
|
+
* const input = { // DeleteConfigurationPolicyRequest
|
|
38
|
+
* Identifier: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteConfigurationPolicyCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // {};
|
|
43
|
+
*
|
|
44
|
+
* ```
|
|
45
|
+
*
|
|
46
|
+
* @param DeleteConfigurationPolicyCommandInput - {@link DeleteConfigurationPolicyCommandInput}
|
|
47
|
+
* @returns {@link DeleteConfigurationPolicyCommandOutput}
|
|
48
|
+
* @see {@link DeleteConfigurationPolicyCommandInput} for command's `input` shape.
|
|
49
|
+
* @see {@link DeleteConfigurationPolicyCommandOutput} for command's `response` shape.
|
|
50
|
+
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link InternalException} (server fault)
|
|
56
|
+
* <p>Internal server error.</p>
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InvalidAccessException} (client fault)
|
|
59
|
+
* <p>The account doesn't have permission to perform this action.</p>
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
62
|
+
* <p>The request was rejected because you supplied an invalid or out-of-range value for an
|
|
63
|
+
* input parameter.</p>
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
66
|
+
* <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
|
|
67
|
+
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link ResourceConflictException} (client fault)
|
|
70
|
+
* <p>The resource specified in the request conflicts with an existing resource.</p>
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
73
|
+
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link SecurityHubServiceException}
|
|
76
|
+
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
77
|
+
*
|
|
78
|
+
* @example To delete a configuration policy
|
|
79
|
+
* ```javascript
|
|
80
|
+
* // This operation deletes the specified configuration policy.
|
|
81
|
+
* const input = {
|
|
82
|
+
* "Identifier": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
83
|
+
* };
|
|
84
|
+
* const command = new DeleteConfigurationPolicyCommand(input);
|
|
85
|
+
* await client.send(command);
|
|
86
|
+
* // example id: to-delete-a-configuration-policy-1695174614062
|
|
87
|
+
* ```
|
|
88
|
+
*
|
|
89
|
+
*/
|
|
90
|
+
export declare class DeleteConfigurationPolicyCommand extends $Command<DeleteConfigurationPolicyCommandInput, DeleteConfigurationPolicyCommandOutput, SecurityHubClientResolvedConfig> {
|
|
91
|
+
readonly input: DeleteConfigurationPolicyCommandInput;
|
|
92
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
93
|
+
/**
|
|
94
|
+
* @public
|
|
95
|
+
*/
|
|
96
|
+
constructor(input: DeleteConfigurationPolicyCommandInput);
|
|
97
|
+
/**
|
|
98
|
+
* @internal
|
|
99
|
+
*/
|
|
100
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecurityHubClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteConfigurationPolicyCommandInput, DeleteConfigurationPolicyCommandOutput>;
|
|
101
|
+
/**
|
|
102
|
+
* @internal
|
|
103
|
+
*/
|
|
104
|
+
private serialize;
|
|
105
|
+
/**
|
|
106
|
+
* @internal
|
|
107
|
+
*/
|
|
108
|
+
private deserialize;
|
|
109
|
+
}
|
|
@@ -23,8 +23,8 @@ export interface DescribeOrganizationConfigurationCommandOutput extends Describe
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Returns information about the
|
|
27
|
-
*
|
|
26
|
+
* <p>Returns information about the way your organization is configured in Security Hub. Only the
|
|
27
|
+
* Security Hub administrator account can invoke this operation.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -38,6 +38,11 @@ export interface DescribeOrganizationConfigurationCommandOutput extends Describe
|
|
|
38
38
|
* // AutoEnable: true || false,
|
|
39
39
|
* // MemberAccountLimitReached: true || false,
|
|
40
40
|
* // AutoEnableStandards: "NONE" || "DEFAULT",
|
|
41
|
+
* // OrganizationConfiguration: { // OrganizationConfiguration
|
|
42
|
+
* // ConfigurationType: "CENTRAL" || "LOCAL",
|
|
43
|
+
* // Status: "PENDING" || "ENABLED" || "FAILED",
|
|
44
|
+
* // StatusMessage: "STRING_VALUE",
|
|
45
|
+
* // },
|
|
41
46
|
* // };
|
|
42
47
|
*
|
|
43
48
|
* ```
|
|
@@ -81,6 +86,26 @@ export interface DescribeOrganizationConfigurationCommandOutput extends Describe
|
|
|
81
86
|
* // example id: to-get-information-about-organizations-configuration-1676059786304
|
|
82
87
|
* ```
|
|
83
88
|
*
|
|
89
|
+
* @example To get information about organization configuration
|
|
90
|
+
* ```javascript
|
|
91
|
+
* // This operation provides information about the way your organization is configured in Security Hub. Only a Security Hub administrator account can invoke this operation.
|
|
92
|
+
* const input = {};
|
|
93
|
+
* const command = new DescribeOrganizationConfigurationCommand(input);
|
|
94
|
+
* const response = await client.send(command);
|
|
95
|
+
* /* response ==
|
|
96
|
+
* {
|
|
97
|
+
* "AutoEnable": false,
|
|
98
|
+
* "AutoEnableStandards": "NONE",
|
|
99
|
+
* "MemberAccountLimitReached": false,
|
|
100
|
+
* "OrganizationConfiguration": {
|
|
101
|
+
* "ConfigurationType": "CENTRAL",
|
|
102
|
+
* "Status": "ENABLED"
|
|
103
|
+
* }
|
|
104
|
+
* }
|
|
105
|
+
* *\/
|
|
106
|
+
* // example id: to-get-information-about-organization-configuration-1676059786304
|
|
107
|
+
* ```
|
|
108
|
+
*
|
|
84
109
|
*/
|
|
85
110
|
export declare class DescribeOrganizationConfigurationCommand extends $Command<DescribeOrganizationConfigurationCommandInput, DescribeOrganizationConfigurationCommandOutput, SecurityHubClientResolvedConfig> {
|
|
86
111
|
readonly input: DescribeOrganizationConfigurationCommandInput;
|
|
@@ -46,6 +46,9 @@ export interface DisableOrganizationAdminAccountCommandOutput extends DisableOrg
|
|
|
46
46
|
* @see {@link DisableOrganizationAdminAccountCommandOutput} for command's `response` shape.
|
|
47
47
|
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
48
48
|
*
|
|
49
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
50
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
51
|
+
*
|
|
49
52
|
* @throws {@link InternalException} (server fault)
|
|
50
53
|
* <p>Internal server error.</p>
|
|
51
54
|
*
|
|
@@ -50,6 +50,9 @@ export interface DisableSecurityHubCommandOutput extends DisableSecurityHubRespo
|
|
|
50
50
|
* @see {@link DisableSecurityHubCommandOutput} for command's `response` shape.
|
|
51
51
|
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
52
52
|
*
|
|
53
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
54
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
55
|
+
*
|
|
53
56
|
* @throws {@link InternalException} (server fault)
|
|
54
57
|
* <p>Internal server error.</p>
|
|
55
58
|
*
|
|
@@ -49,6 +49,9 @@ export interface DisassociateMembersCommandOutput extends DisassociateMembersRes
|
|
|
49
49
|
* @see {@link DisassociateMembersCommandOutput} for command's `response` shape.
|
|
50
50
|
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
51
51
|
*
|
|
52
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
53
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
54
|
+
*
|
|
52
55
|
* @throws {@link InternalException} (server fault)
|
|
53
56
|
* <p>Internal server error.</p>
|
|
54
57
|
*
|
|
@@ -46,6 +46,9 @@ export interface EnableOrganizationAdminAccountCommandOutput extends EnableOrgan
|
|
|
46
46
|
* @see {@link EnableOrganizationAdminAccountCommandOutput} for command's `response` shape.
|
|
47
47
|
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
48
48
|
*
|
|
49
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
50
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
51
|
+
*
|
|
49
52
|
* @throws {@link InternalException} (server fault)
|
|
50
53
|
* <p>Internal server error.</p>
|
|
51
54
|
*
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { GetConfigurationPolicyAssociationRequest, GetConfigurationPolicyAssociationResponse } from "../models/models_2";
|
|
5
|
+
import { SecurityHubClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../SecurityHubClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link GetConfigurationPolicyAssociationCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetConfigurationPolicyAssociationCommandInput extends GetConfigurationPolicyAssociationRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetConfigurationPolicyAssociationCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetConfigurationPolicyAssociationCommandOutput extends GetConfigurationPolicyAssociationResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>
|
|
27
|
+
* Returns the association between a configuration and a target account, organizational unit, or the root. The
|
|
28
|
+
* configuration can be a configuration policy or self-managed behavior. Only the Security Hub delegated administrator can
|
|
29
|
+
* invoke this operation from the home Region.
|
|
30
|
+
* </p>
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { SecurityHubClient, GetConfigurationPolicyAssociationCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
|
|
35
|
+
* // const { SecurityHubClient, GetConfigurationPolicyAssociationCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
|
|
36
|
+
* const client = new SecurityHubClient(config);
|
|
37
|
+
* const input = { // GetConfigurationPolicyAssociationRequest
|
|
38
|
+
* Target: { // Target Union: only one key present
|
|
39
|
+
* AccountId: "STRING_VALUE",
|
|
40
|
+
* OrganizationalUnitId: "STRING_VALUE",
|
|
41
|
+
* RootId: "STRING_VALUE",
|
|
42
|
+
* },
|
|
43
|
+
* };
|
|
44
|
+
* const command = new GetConfigurationPolicyAssociationCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // GetConfigurationPolicyAssociationResponse
|
|
47
|
+
* // ConfigurationPolicyId: "STRING_VALUE",
|
|
48
|
+
* // TargetId: "STRING_VALUE",
|
|
49
|
+
* // TargetType: "ACCOUNT" || "ORGANIZATIONAL_UNIT",
|
|
50
|
+
* // AssociationType: "INHERITED" || "APPLIED",
|
|
51
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
52
|
+
* // AssociationStatus: "PENDING" || "SUCCESS" || "FAILED",
|
|
53
|
+
* // AssociationStatusMessage: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param GetConfigurationPolicyAssociationCommandInput - {@link GetConfigurationPolicyAssociationCommandInput}
|
|
59
|
+
* @returns {@link GetConfigurationPolicyAssociationCommandOutput}
|
|
60
|
+
* @see {@link GetConfigurationPolicyAssociationCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link GetConfigurationPolicyAssociationCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
65
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalException} (server fault)
|
|
68
|
+
* <p>Internal server error.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InvalidAccessException} (client fault)
|
|
71
|
+
* <p>The account doesn't have permission to perform this action.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
74
|
+
* <p>The request was rejected because you supplied an invalid or out-of-range value for an
|
|
75
|
+
* input parameter.</p>
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
78
|
+
* <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
|
|
79
|
+
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
82
|
+
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link SecurityHubServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
86
|
+
*
|
|
87
|
+
* @example To get details about a configuration association
|
|
88
|
+
* ```javascript
|
|
89
|
+
* // This operation provides details about configuration associations for a specific target account, organizational unit, or the root.
|
|
90
|
+
* const input = {
|
|
91
|
+
* "Target": {
|
|
92
|
+
* "AccountId": "111122223333"
|
|
93
|
+
* }
|
|
94
|
+
* };
|
|
95
|
+
* const command = new GetConfigurationPolicyAssociationCommand(input);
|
|
96
|
+
* const response = await client.send(command);
|
|
97
|
+
* /* response ==
|
|
98
|
+
* {
|
|
99
|
+
* "AssociationStatus": "FAILED",
|
|
100
|
+
* "AssociationStatusMessage": "Configuration Policy a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 couldn’t be applied to account 111122223333 in us-east-1 Region. Retry your request.",
|
|
101
|
+
* "AssociationType": "INHERITED",
|
|
102
|
+
* "ConfigurationPolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
103
|
+
* "TargetId": "111122223333",
|
|
104
|
+
* "TargetType": "ACCOUNT",
|
|
105
|
+
* "UpdatedAt": "2023-01-11T06:17:17.154Z"
|
|
106
|
+
* }
|
|
107
|
+
* *\/
|
|
108
|
+
* // example id: to-get-details-about-a-configuration-association-1695177816371
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
*/
|
|
112
|
+
export declare class GetConfigurationPolicyAssociationCommand extends $Command<GetConfigurationPolicyAssociationCommandInput, GetConfigurationPolicyAssociationCommandOutput, SecurityHubClientResolvedConfig> {
|
|
113
|
+
readonly input: GetConfigurationPolicyAssociationCommandInput;
|
|
114
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
constructor(input: GetConfigurationPolicyAssociationCommandInput);
|
|
119
|
+
/**
|
|
120
|
+
* @internal
|
|
121
|
+
*/
|
|
122
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecurityHubClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConfigurationPolicyAssociationCommandInput, GetConfigurationPolicyAssociationCommandOutput>;
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
private serialize;
|
|
127
|
+
/**
|
|
128
|
+
* @internal
|
|
129
|
+
*/
|
|
130
|
+
private deserialize;
|
|
131
|
+
}
|