@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,191 @@
|
|
|
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 { GetConfigurationPolicyRequest, GetConfigurationPolicyResponse } 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 GetConfigurationPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetConfigurationPolicyCommandInput extends GetConfigurationPolicyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetConfigurationPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetConfigurationPolicyCommandOutput extends GetConfigurationPolicyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>
|
|
27
|
+
* Provides information about a configuration policy. Only the Security Hub delegated administrator can invoke
|
|
28
|
+
* 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, GetConfigurationPolicyCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
|
|
34
|
+
* // const { SecurityHubClient, GetConfigurationPolicyCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
|
|
35
|
+
* const client = new SecurityHubClient(config);
|
|
36
|
+
* const input = { // GetConfigurationPolicyRequest
|
|
37
|
+
* Identifier: "STRING_VALUE", // required
|
|
38
|
+
* };
|
|
39
|
+
* const command = new GetConfigurationPolicyCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // GetConfigurationPolicyResponse
|
|
42
|
+
* // Arn: "STRING_VALUE",
|
|
43
|
+
* // Id: "STRING_VALUE",
|
|
44
|
+
* // Name: "STRING_VALUE",
|
|
45
|
+
* // Description: "STRING_VALUE",
|
|
46
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
47
|
+
* // CreatedAt: new Date("TIMESTAMP"),
|
|
48
|
+
* // ConfigurationPolicy: { // Policy Union: only one key present
|
|
49
|
+
* // SecurityHub: { // SecurityHubPolicy
|
|
50
|
+
* // ServiceEnabled: true || false,
|
|
51
|
+
* // EnabledStandardIdentifiers: [ // EnabledStandardIdentifierList
|
|
52
|
+
* // "STRING_VALUE",
|
|
53
|
+
* // ],
|
|
54
|
+
* // SecurityControlsConfiguration: { // SecurityControlsConfiguration
|
|
55
|
+
* // EnabledSecurityControlIdentifiers: [ // EnabledSecurityControlIdentifierList
|
|
56
|
+
* // "STRING_VALUE",
|
|
57
|
+
* // ],
|
|
58
|
+
* // DisabledSecurityControlIdentifiers: [ // DisabledSecurityControlIdentifierList
|
|
59
|
+
* // "STRING_VALUE",
|
|
60
|
+
* // ],
|
|
61
|
+
* // SecurityControlCustomParameters: [ // SecurityControlCustomParametersList
|
|
62
|
+
* // { // SecurityControlCustomParameter
|
|
63
|
+
* // SecurityControlId: "STRING_VALUE",
|
|
64
|
+
* // Parameters: { // Parameters
|
|
65
|
+
* // "<keys>": { // ParameterConfiguration
|
|
66
|
+
* // ValueType: "DEFAULT" || "CUSTOM", // required
|
|
67
|
+
* // Value: { // ParameterValue Union: only one key present
|
|
68
|
+
* // Integer: Number("int"),
|
|
69
|
+
* // IntegerList: [ // IntegerList
|
|
70
|
+
* // Number("int"),
|
|
71
|
+
* // ],
|
|
72
|
+
* // Double: Number("double"),
|
|
73
|
+
* // String: "STRING_VALUE",
|
|
74
|
+
* // StringList: [ // StringList
|
|
75
|
+
* // "STRING_VALUE",
|
|
76
|
+
* // ],
|
|
77
|
+
* // Boolean: true || false,
|
|
78
|
+
* // Enum: "STRING_VALUE",
|
|
79
|
+
* // EnumList: [
|
|
80
|
+
* // "STRING_VALUE",
|
|
81
|
+
* // ],
|
|
82
|
+
* // },
|
|
83
|
+
* // },
|
|
84
|
+
* // },
|
|
85
|
+
* // },
|
|
86
|
+
* // ],
|
|
87
|
+
* // },
|
|
88
|
+
* // },
|
|
89
|
+
* // },
|
|
90
|
+
* // };
|
|
91
|
+
*
|
|
92
|
+
* ```
|
|
93
|
+
*
|
|
94
|
+
* @param GetConfigurationPolicyCommandInput - {@link GetConfigurationPolicyCommandInput}
|
|
95
|
+
* @returns {@link GetConfigurationPolicyCommandOutput}
|
|
96
|
+
* @see {@link GetConfigurationPolicyCommandInput} for command's `input` shape.
|
|
97
|
+
* @see {@link GetConfigurationPolicyCommandOutput} for command's `response` shape.
|
|
98
|
+
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
101
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link InternalException} (server fault)
|
|
104
|
+
* <p>Internal server error.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link InvalidAccessException} (client fault)
|
|
107
|
+
* <p>The account doesn't have permission to perform this action.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
110
|
+
* <p>The request was rejected because you supplied an invalid or out-of-range value for an
|
|
111
|
+
* input parameter.</p>
|
|
112
|
+
*
|
|
113
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
114
|
+
* <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
|
|
115
|
+
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
116
|
+
*
|
|
117
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
118
|
+
* <p>The request was rejected because we can't find the specified resource.</p>
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link SecurityHubServiceException}
|
|
121
|
+
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
122
|
+
*
|
|
123
|
+
* @example To get details about a configuration policy
|
|
124
|
+
* ```javascript
|
|
125
|
+
* // This operation provides details about the specified configuration policy.
|
|
126
|
+
* const input = {
|
|
127
|
+
* "Identifier": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
|
|
128
|
+
* };
|
|
129
|
+
* const command = new GetConfigurationPolicyCommand(input);
|
|
130
|
+
* const response = await client.send(command);
|
|
131
|
+
* /* response ==
|
|
132
|
+
* {
|
|
133
|
+
* "Arn": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
134
|
+
* "ConfigurationPolicy": {
|
|
135
|
+
* "SecurityHub": {
|
|
136
|
+
* "EnabledStandardIdentifiers": [
|
|
137
|
+
* "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
|
|
138
|
+
* "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
139
|
+
* ],
|
|
140
|
+
* "SecurityControlsConfiguration": {
|
|
141
|
+
* "DisabledSecurityControlIdentifiers": [
|
|
142
|
+
* "CloudWatch.1"
|
|
143
|
+
* ],
|
|
144
|
+
* "SecurityControlCustomParameters": [
|
|
145
|
+
* {
|
|
146
|
+
* "Parameters": {
|
|
147
|
+
* "daysToExpiration": {
|
|
148
|
+
* "Value": {
|
|
149
|
+
* "Integer": 14
|
|
150
|
+
* },
|
|
151
|
+
* "ValueType": "CUSTOM"
|
|
152
|
+
* }
|
|
153
|
+
* },
|
|
154
|
+
* "SecurityControlId": "ACM.1"
|
|
155
|
+
* }
|
|
156
|
+
* ]
|
|
157
|
+
* },
|
|
158
|
+
* "ServiceEnabled": true
|
|
159
|
+
* }
|
|
160
|
+
* },
|
|
161
|
+
* "CreatedAt": "2023-01-11T06:17:17.154Z",
|
|
162
|
+
* "Description": "Configuration policy for testing FSBP and CIS",
|
|
163
|
+
* "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
164
|
+
* "Name": "TestConfigurationPolicy",
|
|
165
|
+
* "UpdatedAt": "2023-01-11T06:17:17.154Z"
|
|
166
|
+
* }
|
|
167
|
+
* *\/
|
|
168
|
+
* // example id: to-get-details-about-a-configuration-policy-1695173701103
|
|
169
|
+
* ```
|
|
170
|
+
*
|
|
171
|
+
*/
|
|
172
|
+
export declare class GetConfigurationPolicyCommand extends $Command<GetConfigurationPolicyCommandInput, GetConfigurationPolicyCommandOutput, SecurityHubClientResolvedConfig> {
|
|
173
|
+
readonly input: GetConfigurationPolicyCommandInput;
|
|
174
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
175
|
+
/**
|
|
176
|
+
* @public
|
|
177
|
+
*/
|
|
178
|
+
constructor(input: GetConfigurationPolicyCommandInput);
|
|
179
|
+
/**
|
|
180
|
+
* @internal
|
|
181
|
+
*/
|
|
182
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecurityHubClientResolvedConfig, options?: __HttpHandlerOptions): Handler<GetConfigurationPolicyCommandInput, GetConfigurationPolicyCommandOutput>;
|
|
183
|
+
/**
|
|
184
|
+
* @internal
|
|
185
|
+
*/
|
|
186
|
+
private serialize;
|
|
187
|
+
/**
|
|
188
|
+
* @internal
|
|
189
|
+
*/
|
|
190
|
+
private deserialize;
|
|
191
|
+
}
|
|
@@ -296,6 +296,9 @@ export interface GetFindingsCommandOutput extends GetFindingsResponse, __Metadat
|
|
|
296
296
|
* VulnerabilitiesFixAvailable: "<StringFilterList>",
|
|
297
297
|
* ComplianceSecurityControlParametersName: "<StringFilterList>",
|
|
298
298
|
* ComplianceSecurityControlParametersValue: "<StringFilterList>",
|
|
299
|
+
* AwsAccountName: "<StringFilterList>",
|
|
300
|
+
* ResourceApplicationName: "<StringFilterList>",
|
|
301
|
+
* ResourceApplicationArn: "<StringFilterList>",
|
|
299
302
|
* },
|
|
300
303
|
* SortCriteria: [ // SortCriteria
|
|
301
304
|
* { // SortCriterion
|
|
@@ -4176,6 +4179,8 @@ export interface GetFindingsCommandOutput extends GetFindingsResponse, __Metadat
|
|
|
4176
4179
|
* // },
|
|
4177
4180
|
* // },
|
|
4178
4181
|
* // },
|
|
4182
|
+
* // ApplicationName: "STRING_VALUE",
|
|
4183
|
+
* // ApplicationArn: "STRING_VALUE",
|
|
4179
4184
|
* // },
|
|
4180
4185
|
* // ],
|
|
4181
4186
|
* // Compliance: { // Compliance
|
|
@@ -4419,6 +4424,8 @@ export interface GetFindingsCommandOutput extends GetFindingsResponse, __Metadat
|
|
|
4419
4424
|
* // Description: "STRING_VALUE",
|
|
4420
4425
|
* // Labels: "<TypeList>",
|
|
4421
4426
|
* // },
|
|
4427
|
+
* // ProcessedAt: "STRING_VALUE",
|
|
4428
|
+
* // AwsAccountName: "STRING_VALUE",
|
|
4422
4429
|
* // },
|
|
4423
4430
|
* // ],
|
|
4424
4431
|
* // NextToken: "STRING_VALUE",
|
|
@@ -308,6 +308,9 @@ export interface GetInsightsCommandOutput extends GetInsightsResponse, __Metadat
|
|
|
308
308
|
* // VulnerabilitiesFixAvailable: "<StringFilterList>",
|
|
309
309
|
* // ComplianceSecurityControlParametersName: "<StringFilterList>",
|
|
310
310
|
* // ComplianceSecurityControlParametersValue: "<StringFilterList>",
|
|
311
|
+
* // AwsAccountName: "<StringFilterList>",
|
|
312
|
+
* // ResourceApplicationName: "<StringFilterList>",
|
|
313
|
+
* // ResourceApplicationArn: "<StringFilterList>",
|
|
311
314
|
* // },
|
|
312
315
|
* // GroupByAttribute: "STRING_VALUE", // required
|
|
313
316
|
* // },
|
|
@@ -135,6 +135,41 @@ export interface GetSecurityControlDefinitionCommandOutput extends GetSecurityCo
|
|
|
135
135
|
* @throws {@link SecurityHubServiceException}
|
|
136
136
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
137
137
|
*
|
|
138
|
+
* @example To get the definition of a security control.
|
|
139
|
+
* ```javascript
|
|
140
|
+
* // The following example retrieves definition details for the specified security control.
|
|
141
|
+
* const input = {
|
|
142
|
+
* "SecurityControlId": "EC2.4"
|
|
143
|
+
* };
|
|
144
|
+
* const command = new GetSecurityControlDefinitionCommand(input);
|
|
145
|
+
* const response = await client.send(command);
|
|
146
|
+
* /* response ==
|
|
147
|
+
* {
|
|
148
|
+
* "SecurityControlDefinition": {
|
|
149
|
+
* "CurrentRegionAvailability": "AVAILABLE",
|
|
150
|
+
* "Description": "This control checks whether an Amazon EC2 instance has been stopped for longer than the allowed number of days. The control fails if an EC2 instance is stopped for longer than the maximum allowed time period. Unless you provide a custom parameter value for the maximum allowed time period, Security Hub uses a default value of 30 days.",
|
|
151
|
+
* "ParameterDefinitions": {
|
|
152
|
+
* "AllowedDays": {
|
|
153
|
+
* "ConfigurationOptions": {
|
|
154
|
+
* "Integer": {
|
|
155
|
+
* "DefaultValue": 30,
|
|
156
|
+
* "Max": 365,
|
|
157
|
+
* "Min": 1
|
|
158
|
+
* }
|
|
159
|
+
* },
|
|
160
|
+
* "Description": "Number of days the EC2 instance is allowed to be in a stopped state before generating a failed finding"
|
|
161
|
+
* }
|
|
162
|
+
* },
|
|
163
|
+
* "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/EC2.4/remediation",
|
|
164
|
+
* "SecurityControlId": "EC2.4",
|
|
165
|
+
* "SeverityRating": "MEDIUM",
|
|
166
|
+
* "Title": "Stopped Amazon EC2 instances should be removed after a specified time period"
|
|
167
|
+
* }
|
|
168
|
+
* }
|
|
169
|
+
* *\/
|
|
170
|
+
* // example id: to-get-the-definition-of-a-security-control-1699283789356
|
|
171
|
+
* ```
|
|
172
|
+
*
|
|
138
173
|
*/
|
|
139
174
|
export declare class GetSecurityControlDefinitionCommand extends $Command<GetSecurityControlDefinitionCommandInput, GetSecurityControlDefinitionCommandOutput, SecurityHubClientResolvedConfig> {
|
|
140
175
|
readonly input: GetSecurityControlDefinitionCommandInput;
|
|
@@ -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 { ListConfigurationPoliciesRequest, ListConfigurationPoliciesResponse } 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 ListConfigurationPoliciesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListConfigurationPoliciesCommandInput extends ListConfigurationPoliciesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListConfigurationPoliciesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListConfigurationPoliciesCommandOutput extends ListConfigurationPoliciesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>
|
|
27
|
+
* Lists the configuration policies that the Security Hub delegated administrator has created for your
|
|
28
|
+
* organization. Only the delegated administrator 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, ListConfigurationPoliciesCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
|
|
34
|
+
* // const { SecurityHubClient, ListConfigurationPoliciesCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
|
|
35
|
+
* const client = new SecurityHubClient(config);
|
|
36
|
+
* const input = { // ListConfigurationPoliciesRequest
|
|
37
|
+
* NextToken: "STRING_VALUE",
|
|
38
|
+
* MaxResults: Number("int"),
|
|
39
|
+
* };
|
|
40
|
+
* const command = new ListConfigurationPoliciesCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ListConfigurationPoliciesResponse
|
|
43
|
+
* // ConfigurationPolicySummaries: [ // ConfigurationPolicySummaryList
|
|
44
|
+
* // { // ConfigurationPolicySummary
|
|
45
|
+
* // Arn: "STRING_VALUE",
|
|
46
|
+
* // Id: "STRING_VALUE",
|
|
47
|
+
* // Name: "STRING_VALUE",
|
|
48
|
+
* // Description: "STRING_VALUE",
|
|
49
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
50
|
+
* // ServiceEnabled: true || false,
|
|
51
|
+
* // },
|
|
52
|
+
* // ],
|
|
53
|
+
* // NextToken: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param ListConfigurationPoliciesCommandInput - {@link ListConfigurationPoliciesCommandInput}
|
|
59
|
+
* @returns {@link ListConfigurationPoliciesCommandOutput}
|
|
60
|
+
* @see {@link ListConfigurationPoliciesCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link ListConfigurationPoliciesCommandOutput} 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 SecurityHubServiceException}
|
|
82
|
+
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
83
|
+
*
|
|
84
|
+
* @example To view a list of configuration policies
|
|
85
|
+
* ```javascript
|
|
86
|
+
* // This operation provides a list of your configuration policies, including metadata for each policy.
|
|
87
|
+
* const input = {
|
|
88
|
+
* "MaxResults": 1,
|
|
89
|
+
* "NextToken": "U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOhvw3o2JqjI86QDxdf"
|
|
90
|
+
* };
|
|
91
|
+
* const command = new ListConfigurationPoliciesCommand(input);
|
|
92
|
+
* const response = await client.send(command);
|
|
93
|
+
* /* response ==
|
|
94
|
+
* {
|
|
95
|
+
* "ConfigurationPolicySummaries": [
|
|
96
|
+
* {
|
|
97
|
+
* "Arn": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
98
|
+
* "Description": "Configuration policy for testing FSBP and CIS",
|
|
99
|
+
* "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
100
|
+
* "Name": "TestConfigurationPolicy",
|
|
101
|
+
* "ServiceEnabled": true,
|
|
102
|
+
* "UpdatedAt": "2023-01-11T06:17:17.154Z"
|
|
103
|
+
* }
|
|
104
|
+
* ],
|
|
105
|
+
* "NextToken": "U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOfvw3o2JqjI86QDxef"
|
|
106
|
+
* }
|
|
107
|
+
* *\/
|
|
108
|
+
* // example id: to-view-a-list-of-configuration-policies-1695173268602
|
|
109
|
+
* ```
|
|
110
|
+
*
|
|
111
|
+
*/
|
|
112
|
+
export declare class ListConfigurationPoliciesCommand extends $Command<ListConfigurationPoliciesCommandInput, ListConfigurationPoliciesCommandOutput, SecurityHubClientResolvedConfig> {
|
|
113
|
+
readonly input: ListConfigurationPoliciesCommandInput;
|
|
114
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
115
|
+
/**
|
|
116
|
+
* @public
|
|
117
|
+
*/
|
|
118
|
+
constructor(input: ListConfigurationPoliciesCommandInput);
|
|
119
|
+
/**
|
|
120
|
+
* @internal
|
|
121
|
+
*/
|
|
122
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecurityHubClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListConfigurationPoliciesCommandInput, ListConfigurationPoliciesCommandOutput>;
|
|
123
|
+
/**
|
|
124
|
+
* @internal
|
|
125
|
+
*/
|
|
126
|
+
private serialize;
|
|
127
|
+
/**
|
|
128
|
+
* @internal
|
|
129
|
+
*/
|
|
130
|
+
private deserialize;
|
|
131
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
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 { ListConfigurationPolicyAssociationsRequest, ListConfigurationPolicyAssociationsResponse } 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 ListConfigurationPolicyAssociationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListConfigurationPolicyAssociationsCommandInput extends ListConfigurationPolicyAssociationsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListConfigurationPolicyAssociationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListConfigurationPolicyAssociationsCommandOutput extends ListConfigurationPolicyAssociationsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>
|
|
27
|
+
* Provides information about the associations for your configuration policies and self-managed behavior. Only the
|
|
28
|
+
* Security Hub delegated administrator 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, ListConfigurationPolicyAssociationsCommand } from "@aws-sdk/client-securityhub"; // ES Modules import
|
|
34
|
+
* // const { SecurityHubClient, ListConfigurationPolicyAssociationsCommand } = require("@aws-sdk/client-securityhub"); // CommonJS import
|
|
35
|
+
* const client = new SecurityHubClient(config);
|
|
36
|
+
* const input = { // ListConfigurationPolicyAssociationsRequest
|
|
37
|
+
* NextToken: "STRING_VALUE",
|
|
38
|
+
* MaxResults: Number("int"),
|
|
39
|
+
* Filters: { // AssociationFilters
|
|
40
|
+
* ConfigurationPolicyId: "STRING_VALUE",
|
|
41
|
+
* AssociationType: "INHERITED" || "APPLIED",
|
|
42
|
+
* AssociationStatus: "PENDING" || "SUCCESS" || "FAILED",
|
|
43
|
+
* },
|
|
44
|
+
* };
|
|
45
|
+
* const command = new ListConfigurationPolicyAssociationsCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* // { // ListConfigurationPolicyAssociationsResponse
|
|
48
|
+
* // ConfigurationPolicyAssociationSummaries: [ // ConfigurationPolicyAssociationSummaryList
|
|
49
|
+
* // { // ConfigurationPolicyAssociationSummary
|
|
50
|
+
* // ConfigurationPolicyId: "STRING_VALUE",
|
|
51
|
+
* // TargetId: "STRING_VALUE",
|
|
52
|
+
* // TargetType: "ACCOUNT" || "ORGANIZATIONAL_UNIT",
|
|
53
|
+
* // AssociationType: "INHERITED" || "APPLIED",
|
|
54
|
+
* // UpdatedAt: new Date("TIMESTAMP"),
|
|
55
|
+
* // AssociationStatus: "PENDING" || "SUCCESS" || "FAILED",
|
|
56
|
+
* // AssociationStatusMessage: "STRING_VALUE",
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // NextToken: "STRING_VALUE",
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @param ListConfigurationPolicyAssociationsCommandInput - {@link ListConfigurationPolicyAssociationsCommandInput}
|
|
65
|
+
* @returns {@link ListConfigurationPolicyAssociationsCommandOutput}
|
|
66
|
+
* @see {@link ListConfigurationPolicyAssociationsCommandInput} for command's `input` shape.
|
|
67
|
+
* @see {@link ListConfigurationPolicyAssociationsCommandOutput} for command's `response` shape.
|
|
68
|
+
* @see {@link SecurityHubClientResolvedConfig | config} for SecurityHubClient's `config` shape.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link AccessDeniedException} (client fault)
|
|
71
|
+
* <p>You don't have permission to perform the action specified in the request.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link InternalException} (server fault)
|
|
74
|
+
* <p>Internal server error.</p>
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link InvalidAccessException} (client fault)
|
|
77
|
+
* <p>The account doesn't have permission to perform this action.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link InvalidInputException} (client fault)
|
|
80
|
+
* <p>The request was rejected because you supplied an invalid or out-of-range value for an
|
|
81
|
+
* input parameter.</p>
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link LimitExceededException} (client fault)
|
|
84
|
+
* <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services
|
|
85
|
+
* account or throttling limits. The error code describes the limit exceeded.</p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link SecurityHubServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
89
|
+
*
|
|
90
|
+
* @example To list configuration associations
|
|
91
|
+
* ```javascript
|
|
92
|
+
* // This operation lists all of the associations between targets and configuration policies or self-managed behavior. Targets can include accounts, organizational units, or the root.
|
|
93
|
+
* const input = {
|
|
94
|
+
* "Filters": {
|
|
95
|
+
* "AssociationType": "APPLIED"
|
|
96
|
+
* },
|
|
97
|
+
* "MaxResults": 1,
|
|
98
|
+
* "NextToken": "U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOhvw3o2JqjI86QDxdf"
|
|
99
|
+
* };
|
|
100
|
+
* const command = new ListConfigurationPolicyAssociationsCommand(input);
|
|
101
|
+
* const response = await client.send(command);
|
|
102
|
+
* /* response ==
|
|
103
|
+
* {
|
|
104
|
+
* "ConfigurationPolicyAssociationSummaries": [
|
|
105
|
+
* {
|
|
106
|
+
* "AssociationStatus": "PENDING",
|
|
107
|
+
* "AssociationType": "APPLIED",
|
|
108
|
+
* "ConfigurationPolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
109
|
+
* "TargetId": "123456789012",
|
|
110
|
+
* "TargetType": "ACCOUNT",
|
|
111
|
+
* "UpdatedAt": "2023-01-11T06:17:17.154Z"
|
|
112
|
+
* }
|
|
113
|
+
* ],
|
|
114
|
+
* "NextToken": "U1FsdGVkX19nBV2zoh+Gou9NgnulLJHWpn9xnG4hqSOfvw3o2JqjI86QDxef"
|
|
115
|
+
* }
|
|
116
|
+
* *\/
|
|
117
|
+
* // example id: to-list-configuration-associations-1695177309791
|
|
118
|
+
* ```
|
|
119
|
+
*
|
|
120
|
+
*/
|
|
121
|
+
export declare class ListConfigurationPolicyAssociationsCommand extends $Command<ListConfigurationPolicyAssociationsCommandInput, ListConfigurationPolicyAssociationsCommandOutput, SecurityHubClientResolvedConfig> {
|
|
122
|
+
readonly input: ListConfigurationPolicyAssociationsCommandInput;
|
|
123
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
124
|
+
/**
|
|
125
|
+
* @public
|
|
126
|
+
*/
|
|
127
|
+
constructor(input: ListConfigurationPolicyAssociationsCommandInput);
|
|
128
|
+
/**
|
|
129
|
+
* @internal
|
|
130
|
+
*/
|
|
131
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SecurityHubClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListConfigurationPolicyAssociationsCommandInput, ListConfigurationPolicyAssociationsCommandOutput>;
|
|
132
|
+
/**
|
|
133
|
+
* @internal
|
|
134
|
+
*/
|
|
135
|
+
private serialize;
|
|
136
|
+
/**
|
|
137
|
+
* @internal
|
|
138
|
+
*/
|
|
139
|
+
private deserialize;
|
|
140
|
+
}
|
|
@@ -153,6 +153,9 @@ export interface ListSecurityControlDefinitionsCommandOutput extends ListSecurit
|
|
|
153
153
|
* "SecurityControlDefinitions": [
|
|
154
154
|
* {
|
|
155
155
|
* "CurrentRegionAvailability": "AVAILABLE",
|
|
156
|
+
* "CustomizableProperties": [
|
|
157
|
+
* "Parameters"
|
|
158
|
+
* ],
|
|
156
159
|
* "Description": "This AWS control checks whether ACM Certificates in your account are marked for expiration within a specified time period. Certificates provided by ACM are automatically renewed. ACM does not automatically renew certificates that you import.",
|
|
157
160
|
* "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/ACM.1/remediation",
|
|
158
161
|
* "SecurityControlId": "ACM.1",
|
|
@@ -161,6 +164,9 @@ export interface ListSecurityControlDefinitionsCommandOutput extends ListSecurit
|
|
|
161
164
|
* },
|
|
162
165
|
* {
|
|
163
166
|
* "CurrentRegionAvailability": "AVAILABLE",
|
|
167
|
+
* "CustomizableProperties": [
|
|
168
|
+
* "Parameters"
|
|
169
|
+
* ],
|
|
164
170
|
* "Description": "This control checks whether all stages of Amazon API Gateway REST and WebSocket APIs have logging enabled. The control fails if logging is not enabled for all methods of a stage or if loggingLevel is neither ERROR nor INFO.",
|
|
165
171
|
* "RemediationUrl": "https://docs.aws.amazon.com/console/securityhub/APIGateway.1/remediation",
|
|
166
172
|
* "SecurityControlId": "APIGateway.1",
|