@aws-sdk/client-securityhub 3.459.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/dist-types/commands/BatchGetConfigurationPolicyAssociationsCommand.d.ts +48 -0
- package/dist-types/commands/CreateConfigurationPolicyCommand.d.ts +76 -0
- package/dist-types/commands/DeleteConfigurationPolicyCommand.d.ts +11 -0
- package/dist-types/commands/DescribeOrganizationConfigurationCommand.d.ts +20 -0
- package/dist-types/commands/GetConfigurationPolicyAssociationCommand.d.ts +24 -0
- package/dist-types/commands/GetConfigurationPolicyCommand.d.ts +48 -0
- package/dist-types/commands/ListConfigurationPoliciesCommand.d.ts +27 -0
- package/dist-types/commands/ListConfigurationPolicyAssociationsCommand.d.ts +30 -0
- package/dist-types/commands/StartConfigurationPolicyAssociationCommand.d.ts +25 -0
- package/dist-types/commands/StartConfigurationPolicyDisassociationCommand.d.ts +14 -0
- package/dist-types/commands/UpdateConfigurationPolicyCommand.d.ts +80 -0
- package/package.json +12 -12
|
@@ -105,6 +105,54 @@ export interface BatchGetConfigurationPolicyAssociationsCommandOutput extends Ba
|
|
|
105
105
|
* @throws {@link SecurityHubServiceException}
|
|
106
106
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
107
107
|
*
|
|
108
|
+
* @example To get configuration associations for a batch of targets
|
|
109
|
+
* ```javascript
|
|
110
|
+
* // This operation provides details about configuration associations for a batch of target accounts, organizational units, or the root.
|
|
111
|
+
* const input = {
|
|
112
|
+
* "ConfigurationPolicyAssociationIdentifiers": [
|
|
113
|
+
* {
|
|
114
|
+
* "Target": {
|
|
115
|
+
* "AccountId": "111122223333"
|
|
116
|
+
* }
|
|
117
|
+
* },
|
|
118
|
+
* {
|
|
119
|
+
* "Target": {
|
|
120
|
+
* "RootId": "r-f6g7h8i9j0example"
|
|
121
|
+
* }
|
|
122
|
+
* }
|
|
123
|
+
* ]
|
|
124
|
+
* };
|
|
125
|
+
* const command = new BatchGetConfigurationPolicyAssociationsCommand(input);
|
|
126
|
+
* const response = await client.send(command);
|
|
127
|
+
* /* response ==
|
|
128
|
+
* {
|
|
129
|
+
* "ConfigurationPolicyAssociations": [
|
|
130
|
+
* {
|
|
131
|
+
* "AssociationStatus": "SUCCESS",
|
|
132
|
+
* "AssociationStatusMessage": "This field is only populated for a failed association",
|
|
133
|
+
* "AssociationType": "INHERITED",
|
|
134
|
+
* "ConfigurationPolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
135
|
+
* "TargetId": "111122223333",
|
|
136
|
+
* "TargetType": "ACCOUNT",
|
|
137
|
+
* "UpdatedAt": "2023-01-11T06:17:17.154Z"
|
|
138
|
+
* }
|
|
139
|
+
* ],
|
|
140
|
+
* "UnprocessedConfigurationPolicyAssociations": [
|
|
141
|
+
* {
|
|
142
|
+
* "ConfigurationPolicyAssociationIdentifiers": {
|
|
143
|
+
* "Target": {
|
|
144
|
+
* "RootId": "r-f6g7h8i9j0example"
|
|
145
|
+
* }
|
|
146
|
+
* },
|
|
147
|
+
* "ErrorCode": "400",
|
|
148
|
+
* "ErrorReason": "You do not have sufficient access to perform this action."
|
|
149
|
+
* }
|
|
150
|
+
* ]
|
|
151
|
+
* }
|
|
152
|
+
* *\/
|
|
153
|
+
* // example id: to-get-configuration-associations-for-a-batch-of-targets-1695178953302
|
|
154
|
+
* ```
|
|
155
|
+
*
|
|
108
156
|
*/
|
|
109
157
|
export declare class BatchGetConfigurationPolicyAssociationsCommand extends $Command<BatchGetConfigurationPolicyAssociationsCommandInput, BatchGetConfigurationPolicyAssociationsCommandOutput, SecurityHubClientResolvedConfig> {
|
|
110
158
|
readonly input: BatchGetConfigurationPolicyAssociationsCommandInput;
|
|
@@ -166,6 +166,82 @@ export interface CreateConfigurationPolicyCommandOutput extends CreateConfigurat
|
|
|
166
166
|
* @throws {@link SecurityHubServiceException}
|
|
167
167
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
168
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
|
+
*
|
|
169
245
|
*/
|
|
170
246
|
export declare class CreateConfigurationPolicyCommand extends $Command<CreateConfigurationPolicyCommandInput, CreateConfigurationPolicyCommandOutput, SecurityHubClientResolvedConfig> {
|
|
171
247
|
readonly input: CreateConfigurationPolicyCommandInput;
|
|
@@ -75,6 +75,17 @@ export interface DeleteConfigurationPolicyCommandOutput extends DeleteConfigurat
|
|
|
75
75
|
* @throws {@link SecurityHubServiceException}
|
|
76
76
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
77
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
|
+
*
|
|
78
89
|
*/
|
|
79
90
|
export declare class DeleteConfigurationPolicyCommand extends $Command<DeleteConfigurationPolicyCommandInput, DeleteConfigurationPolicyCommandOutput, SecurityHubClientResolvedConfig> {
|
|
80
91
|
readonly input: DeleteConfigurationPolicyCommandInput;
|
|
@@ -86,6 +86,26 @@ export interface DescribeOrganizationConfigurationCommandOutput extends Describe
|
|
|
86
86
|
* // example id: to-get-information-about-organizations-configuration-1676059786304
|
|
87
87
|
* ```
|
|
88
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
|
+
*
|
|
89
109
|
*/
|
|
90
110
|
export declare class DescribeOrganizationConfigurationCommand extends $Command<DescribeOrganizationConfigurationCommandInput, DescribeOrganizationConfigurationCommandOutput, SecurityHubClientResolvedConfig> {
|
|
91
111
|
readonly input: DescribeOrganizationConfigurationCommandInput;
|
|
@@ -84,6 +84,30 @@ export interface GetConfigurationPolicyAssociationCommandOutput extends GetConfi
|
|
|
84
84
|
* @throws {@link SecurityHubServiceException}
|
|
85
85
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
86
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
|
+
*
|
|
87
111
|
*/
|
|
88
112
|
export declare class GetConfigurationPolicyAssociationCommand extends $Command<GetConfigurationPolicyAssociationCommandInput, GetConfigurationPolicyAssociationCommandOutput, SecurityHubClientResolvedConfig> {
|
|
89
113
|
readonly input: GetConfigurationPolicyAssociationCommandInput;
|
|
@@ -120,6 +120,54 @@ export interface GetConfigurationPolicyCommandOutput extends GetConfigurationPol
|
|
|
120
120
|
* @throws {@link SecurityHubServiceException}
|
|
121
121
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
122
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
|
+
*
|
|
123
171
|
*/
|
|
124
172
|
export declare class GetConfigurationPolicyCommand extends $Command<GetConfigurationPolicyCommandInput, GetConfigurationPolicyCommandOutput, SecurityHubClientResolvedConfig> {
|
|
125
173
|
readonly input: GetConfigurationPolicyCommandInput;
|
|
@@ -81,6 +81,33 @@ export interface ListConfigurationPoliciesCommandOutput extends ListConfiguratio
|
|
|
81
81
|
* @throws {@link SecurityHubServiceException}
|
|
82
82
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
83
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
|
+
*
|
|
84
111
|
*/
|
|
85
112
|
export declare class ListConfigurationPoliciesCommand extends $Command<ListConfigurationPoliciesCommandInput, ListConfigurationPoliciesCommandOutput, SecurityHubClientResolvedConfig> {
|
|
86
113
|
readonly input: ListConfigurationPoliciesCommandInput;
|
|
@@ -87,6 +87,36 @@ export interface ListConfigurationPolicyAssociationsCommandOutput extends ListCo
|
|
|
87
87
|
* @throws {@link SecurityHubServiceException}
|
|
88
88
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
89
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
|
+
*
|
|
90
120
|
*/
|
|
91
121
|
export declare class ListConfigurationPolicyAssociationsCommand extends $Command<ListConfigurationPolicyAssociationsCommandInput, ListConfigurationPolicyAssociationsCommandOutput, SecurityHubClientResolvedConfig> {
|
|
92
122
|
readonly input: ListConfigurationPolicyAssociationsCommandInput;
|
|
@@ -85,6 +85,31 @@ export interface StartConfigurationPolicyAssociationCommandOutput extends StartC
|
|
|
85
85
|
* @throws {@link SecurityHubServiceException}
|
|
86
86
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
87
87
|
*
|
|
88
|
+
* @example To associate a configuration with a target
|
|
89
|
+
* ```javascript
|
|
90
|
+
* // This operation associates a configuration policy or self-managed behavior with the target account, organizational unit, or the root.
|
|
91
|
+
* const input = {
|
|
92
|
+
* "ConfigurationPolicyIdentifier": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
93
|
+
* "Target": {
|
|
94
|
+
* "AccountId": "111122223333"
|
|
95
|
+
* }
|
|
96
|
+
* };
|
|
97
|
+
* const command = new StartConfigurationPolicyAssociationCommand(input);
|
|
98
|
+
* const response = await client.send(command);
|
|
99
|
+
* /* response ==
|
|
100
|
+
* {
|
|
101
|
+
* "AssociationStatus": "SUCCESS",
|
|
102
|
+
* "AssociationStatusMessage": "This field is populated only if the association fails",
|
|
103
|
+
* "AssociationType": "APPLIED",
|
|
104
|
+
* "ConfigurationPolicyId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
105
|
+
* "TargetId": "111122223333",
|
|
106
|
+
* "TargetType": "ACCOUNT",
|
|
107
|
+
* "UpdatedAt": "2023-01-11T06:17:17.154Z"
|
|
108
|
+
* }
|
|
109
|
+
* *\/
|
|
110
|
+
* // example id: to-associate-a-configuration-with-a-target-1695176455638
|
|
111
|
+
* ```
|
|
112
|
+
*
|
|
88
113
|
*/
|
|
89
114
|
export declare class StartConfigurationPolicyAssociationCommand extends $Command<StartConfigurationPolicyAssociationCommandInput, StartConfigurationPolicyAssociationCommandOutput, SecurityHubClientResolvedConfig> {
|
|
90
115
|
readonly input: StartConfigurationPolicyAssociationCommandInput;
|
|
@@ -79,6 +79,20 @@ export interface StartConfigurationPolicyDisassociationCommandOutput extends Sta
|
|
|
79
79
|
* @throws {@link SecurityHubServiceException}
|
|
80
80
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
81
81
|
*
|
|
82
|
+
* @example To disassociate a configuration from a target
|
|
83
|
+
* ```javascript
|
|
84
|
+
* // This operation disassociates a configuration policy or self-managed behavior from the target account, organizational unit, or the root.
|
|
85
|
+
* const input = {
|
|
86
|
+
* "ConfigurationPolicyIdentifier": "SELF_MANAGED_SECURITY_HUB",
|
|
87
|
+
* "Target": {
|
|
88
|
+
* "RootId": "r-f6g7h8i9j0example"
|
|
89
|
+
* }
|
|
90
|
+
* };
|
|
91
|
+
* const command = new StartConfigurationPolicyDisassociationCommand(input);
|
|
92
|
+
* await client.send(command);
|
|
93
|
+
* // example id: to-disassociate-a-configuration-from-a-target-1695177176748
|
|
94
|
+
* ```
|
|
95
|
+
*
|
|
82
96
|
*/
|
|
83
97
|
export declare class StartConfigurationPolicyDisassociationCommand extends $Command<StartConfigurationPolicyDisassociationCommandInput, StartConfigurationPolicyDisassociationCommandOutput, SecurityHubClientResolvedConfig> {
|
|
84
98
|
readonly input: StartConfigurationPolicyDisassociationCommandInput;
|
|
@@ -168,6 +168,86 @@ export interface UpdateConfigurationPolicyCommandOutput extends UpdateConfigurat
|
|
|
168
168
|
* @throws {@link SecurityHubServiceException}
|
|
169
169
|
* <p>Base exception class for all service exceptions from SecurityHub service.</p>
|
|
170
170
|
*
|
|
171
|
+
* @example To update a configuration policy
|
|
172
|
+
* ```javascript
|
|
173
|
+
* // This operation updates the specified configuration policy.
|
|
174
|
+
* const input = {
|
|
175
|
+
* "ConfigurationPolicy": {
|
|
176
|
+
* "SecurityHub": {
|
|
177
|
+
* "EnabledStandardIdentifiers": [
|
|
178
|
+
* "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
|
|
179
|
+
* "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
180
|
+
* ],
|
|
181
|
+
* "SecurityControlsConfiguration": {
|
|
182
|
+
* "DisabledSecurityControlIdentifiers": [
|
|
183
|
+
* "CloudWatch.1",
|
|
184
|
+
* "CloudWatch.2"
|
|
185
|
+
* ],
|
|
186
|
+
* "SecurityControlCustomParameters": [
|
|
187
|
+
* {
|
|
188
|
+
* "Parameters": {
|
|
189
|
+
* "daysToExpiration": {
|
|
190
|
+
* "Value": {
|
|
191
|
+
* "Integer": 21
|
|
192
|
+
* },
|
|
193
|
+
* "ValueType": "CUSTOM"
|
|
194
|
+
* }
|
|
195
|
+
* },
|
|
196
|
+
* "SecurityControlId": "ACM.1"
|
|
197
|
+
* }
|
|
198
|
+
* ]
|
|
199
|
+
* },
|
|
200
|
+
* "ServiceEnabled": true
|
|
201
|
+
* }
|
|
202
|
+
* },
|
|
203
|
+
* "Description": "Updated configuration policy for testing FSBP and CIS",
|
|
204
|
+
* "Identifier": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
205
|
+
* "Name": "TestConfigurationPolicy",
|
|
206
|
+
* "UpdatedReason": "Enabling ACM.2"
|
|
207
|
+
* };
|
|
208
|
+
* const command = new UpdateConfigurationPolicyCommand(input);
|
|
209
|
+
* const response = await client.send(command);
|
|
210
|
+
* /* response ==
|
|
211
|
+
* {
|
|
212
|
+
* "Arn": "arn:aws:securityhub:us-east-1:123456789012:configuration-policy/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
213
|
+
* "ConfigurationPolicy": {
|
|
214
|
+
* "SecurityHub": {
|
|
215
|
+
* "EnabledStandardIdentifiers": [
|
|
216
|
+
* "arn:aws:securityhub:us-east-1::standards/aws-foundational-security-best-practices/v/1.0.0",
|
|
217
|
+
* "arn:aws:securityhub:::ruleset/cis-aws-foundations-benchmark/v/1.2.0"
|
|
218
|
+
* ],
|
|
219
|
+
* "SecurityControlsConfiguration": {
|
|
220
|
+
* "DisabledSecurityControlIdentifiers": [
|
|
221
|
+
* "CloudWatch.1",
|
|
222
|
+
* "CloudWatch.2"
|
|
223
|
+
* ],
|
|
224
|
+
* "SecurityControlCustomParameters": [
|
|
225
|
+
* {
|
|
226
|
+
* "Parameters": {
|
|
227
|
+
* "daysToExpiration": {
|
|
228
|
+
* "Value": {
|
|
229
|
+
* "Integer": 21
|
|
230
|
+
* },
|
|
231
|
+
* "ValueType": "CUSTOM"
|
|
232
|
+
* }
|
|
233
|
+
* },
|
|
234
|
+
* "SecurityControlId": "ACM.1"
|
|
235
|
+
* }
|
|
236
|
+
* ]
|
|
237
|
+
* },
|
|
238
|
+
* "ServiceEnabled": true
|
|
239
|
+
* }
|
|
240
|
+
* },
|
|
241
|
+
* "CreatedAt": "2023-01-11T06:17:17.154Z",
|
|
242
|
+
* "Description": "Updated configuration policy for testing FSBP and CIS",
|
|
243
|
+
* "Id": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
|
|
244
|
+
* "Name": "TestConfigurationPolicy",
|
|
245
|
+
* "UpdatedAt": "2023-01-12T06:17:17.154Z"
|
|
246
|
+
* }
|
|
247
|
+
* *\/
|
|
248
|
+
* // example id: to-update-a-configuration-policy-1695174120555
|
|
249
|
+
* ```
|
|
250
|
+
*
|
|
171
251
|
*/
|
|
172
252
|
export declare class UpdateConfigurationPolicyCommand extends $Command<UpdateConfigurationPolicyCommandInput, UpdateConfigurationPolicyCommandOutput, SecurityHubClientResolvedConfig> {
|
|
173
253
|
readonly input: UpdateConfigurationPolicyCommandInput;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-securityhub",
|
|
3
3
|
"description": "AWS SDK for JavaScript Securityhub Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.460.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "tsc -p tsconfig.cjs.json",
|
|
@@ -21,19 +21,19 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
+
"@aws-sdk/client-sts": "3.460.0",
|
|
25
25
|
"@aws-sdk/core": "3.451.0",
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
27
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
28
|
-
"@aws-sdk/middleware-logger": "3.
|
|
29
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
30
|
-
"@aws-sdk/middleware-signing": "3.
|
|
31
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.460.0",
|
|
27
|
+
"@aws-sdk/middleware-host-header": "3.460.0",
|
|
28
|
+
"@aws-sdk/middleware-logger": "3.460.0",
|
|
29
|
+
"@aws-sdk/middleware-recursion-detection": "3.460.0",
|
|
30
|
+
"@aws-sdk/middleware-signing": "3.460.0",
|
|
31
|
+
"@aws-sdk/middleware-user-agent": "3.460.0",
|
|
32
32
|
"@aws-sdk/region-config-resolver": "3.451.0",
|
|
33
|
-
"@aws-sdk/types": "3.
|
|
34
|
-
"@aws-sdk/util-endpoints": "3.
|
|
35
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
36
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
33
|
+
"@aws-sdk/types": "3.460.0",
|
|
34
|
+
"@aws-sdk/util-endpoints": "3.460.0",
|
|
35
|
+
"@aws-sdk/util-user-agent-browser": "3.460.0",
|
|
36
|
+
"@aws-sdk/util-user-agent-node": "3.460.0",
|
|
37
37
|
"@smithy/config-resolver": "^2.0.18",
|
|
38
38
|
"@smithy/fetch-http-handler": "^2.2.6",
|
|
39
39
|
"@smithy/hash-node": "^2.0.15",
|