@aws-sdk/client-config-service 3.312.0 → 3.316.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-cjs/ConfigService.js +96 -1288
- package/dist-cjs/protocols/Aws_json1_1.js +996 -4061
- package/dist-es/ConfigService.js +96 -1288
- package/dist-es/protocols/Aws_json1_1.js +997 -4062
- package/dist-types/ConfigService.d.ts +120 -903
- package/dist-types/ts3.4/ConfigService.d.ts +4 -1
- package/package.json +6 -6
|
@@ -92,1366 +92,583 @@ import { StopConfigurationRecorderCommandInput, StopConfigurationRecorderCommand
|
|
|
92
92
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
|
|
93
93
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
|
|
94
94
|
import { ConfigServiceClient } from "./ConfigServiceClient";
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
* <p>Config provides a way to keep track of the configurations
|
|
99
|
-
* of all the Amazon Web Services resources associated with your Amazon Web Services account. You can
|
|
100
|
-
* use Config to get the current and historical configurations of
|
|
101
|
-
* each Amazon Web Services resource and also to get information about the relationship
|
|
102
|
-
* between the resources. An Amazon Web Services resource can be an Amazon Compute
|
|
103
|
-
* Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an
|
|
104
|
-
* elastic network Interface (ENI), or a security group. For a complete
|
|
105
|
-
* list of resources currently supported by Config, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Amazon Web Services resources</a>.</p>
|
|
106
|
-
* <p>You can access and manage Config through the Amazon Web Services Management
|
|
107
|
-
* Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config
|
|
108
|
-
* API, or the Amazon Web Services SDKs for Config. This reference guide contains
|
|
109
|
-
* documentation for the Config API and the Amazon Web Services CLI commands that
|
|
110
|
-
* you can use to manage Config. The Config API uses the
|
|
111
|
-
* Signature Version 4 protocol for signing requests. For more
|
|
112
|
-
* information about how to sign a request with this protocol, see
|
|
113
|
-
* <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature
|
|
114
|
-
* Version 4 Signing Process</a>. For detailed information
|
|
115
|
-
* about Config features and their associated actions or commands,
|
|
116
|
-
* as well as how to work with Amazon Web Services Management Console, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is Config</a> in the <i>Config Developer
|
|
117
|
-
* Guide</i>.</p>
|
|
118
|
-
*/
|
|
119
|
-
export declare class ConfigService extends ConfigServiceClient {
|
|
120
|
-
/**
|
|
121
|
-
* @public
|
|
122
|
-
* <p>Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request.
|
|
123
|
-
* If there are no unprocessed resources, the operation returns an empty <code>unprocessedResourceIdentifiers</code> list. </p>
|
|
124
|
-
* <note>
|
|
125
|
-
* <ul>
|
|
126
|
-
* <li>
|
|
127
|
-
* <p>The API does not return results for deleted resources.</p>
|
|
128
|
-
* </li>
|
|
129
|
-
* <li>
|
|
130
|
-
* <p> The API does not return tags and relationships.</p>
|
|
131
|
-
* </li>
|
|
132
|
-
* </ul>
|
|
133
|
-
* </note>
|
|
95
|
+
export interface ConfigService {
|
|
96
|
+
/**
|
|
97
|
+
* @see {@link BatchGetAggregateResourceConfigCommand}
|
|
134
98
|
*/
|
|
135
99
|
batchGetAggregateResourceConfig(args: BatchGetAggregateResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetAggregateResourceConfigCommandOutput>;
|
|
136
100
|
batchGetAggregateResourceConfig(args: BatchGetAggregateResourceConfigCommandInput, cb: (err: any, data?: BatchGetAggregateResourceConfigCommandOutput) => void): void;
|
|
137
101
|
batchGetAggregateResourceConfig(args: BatchGetAggregateResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetAggregateResourceConfigCommandOutput) => void): void;
|
|
138
102
|
/**
|
|
139
|
-
* @
|
|
140
|
-
* <p>Returns the <code>BaseConfigurationItem</code> for one or more requested resources.
|
|
141
|
-
* The operation also returns a list of resources that are
|
|
142
|
-
* not processed in the current request. If there are no unprocessed
|
|
143
|
-
* resources, the operation returns an empty unprocessedResourceKeys
|
|
144
|
-
* list. </p>
|
|
145
|
-
* <note>
|
|
146
|
-
* <ul>
|
|
147
|
-
* <li>
|
|
148
|
-
* <p>The API does not return results for deleted
|
|
149
|
-
* resources.</p>
|
|
150
|
-
* </li>
|
|
151
|
-
* <li>
|
|
152
|
-
* <p> The API does not return any tags for the requested
|
|
153
|
-
* resources. This information is filtered out of the
|
|
154
|
-
* supplementaryConfiguration section of the API
|
|
155
|
-
* response.</p>
|
|
156
|
-
* </li>
|
|
157
|
-
* </ul>
|
|
158
|
-
* </note>
|
|
103
|
+
* @see {@link BatchGetResourceConfigCommand}
|
|
159
104
|
*/
|
|
160
105
|
batchGetResourceConfig(args: BatchGetResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetResourceConfigCommandOutput>;
|
|
161
106
|
batchGetResourceConfig(args: BatchGetResourceConfigCommandInput, cb: (err: any, data?: BatchGetResourceConfigCommandOutput) => void): void;
|
|
162
107
|
batchGetResourceConfig(args: BatchGetResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetResourceConfigCommandOutput) => void): void;
|
|
163
108
|
/**
|
|
164
|
-
* @
|
|
165
|
-
* <p>Deletes the authorization granted to the specified
|
|
166
|
-
* configuration aggregator account in a specified region.</p>
|
|
109
|
+
* @see {@link DeleteAggregationAuthorizationCommand}
|
|
167
110
|
*/
|
|
168
111
|
deleteAggregationAuthorization(args: DeleteAggregationAuthorizationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAggregationAuthorizationCommandOutput>;
|
|
169
112
|
deleteAggregationAuthorization(args: DeleteAggregationAuthorizationCommandInput, cb: (err: any, data?: DeleteAggregationAuthorizationCommandOutput) => void): void;
|
|
170
113
|
deleteAggregationAuthorization(args: DeleteAggregationAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAggregationAuthorizationCommandOutput) => void): void;
|
|
171
114
|
/**
|
|
172
|
-
* @
|
|
173
|
-
* <p>Deletes the specified Config rule and all of its evaluation
|
|
174
|
-
* results.</p>
|
|
175
|
-
* <p>Config sets the state of a rule to <code>DELETING</code>
|
|
176
|
-
* until the deletion is complete. You cannot update a rule while it is
|
|
177
|
-
* in this state. If you make a <code>PutConfigRule</code> or
|
|
178
|
-
* <code>DeleteConfigRule</code> request for the rule, you will
|
|
179
|
-
* receive a <code>ResourceInUseException</code>.</p>
|
|
180
|
-
* <p>You can check the state of a rule by using the
|
|
181
|
-
* <code>DescribeConfigRules</code> request.</p>
|
|
115
|
+
* @see {@link DeleteConfigRuleCommand}
|
|
182
116
|
*/
|
|
183
117
|
deleteConfigRule(args: DeleteConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConfigRuleCommandOutput>;
|
|
184
118
|
deleteConfigRule(args: DeleteConfigRuleCommandInput, cb: (err: any, data?: DeleteConfigRuleCommandOutput) => void): void;
|
|
185
119
|
deleteConfigRule(args: DeleteConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigRuleCommandOutput) => void): void;
|
|
186
120
|
/**
|
|
187
|
-
* @
|
|
188
|
-
* <p>Deletes the specified configuration aggregator and the
|
|
189
|
-
* aggregated data associated with the aggregator.</p>
|
|
121
|
+
* @see {@link DeleteConfigurationAggregatorCommand}
|
|
190
122
|
*/
|
|
191
123
|
deleteConfigurationAggregator(args: DeleteConfigurationAggregatorCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConfigurationAggregatorCommandOutput>;
|
|
192
124
|
deleteConfigurationAggregator(args: DeleteConfigurationAggregatorCommandInput, cb: (err: any, data?: DeleteConfigurationAggregatorCommandOutput) => void): void;
|
|
193
125
|
deleteConfigurationAggregator(args: DeleteConfigurationAggregatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationAggregatorCommandOutput) => void): void;
|
|
194
126
|
/**
|
|
195
|
-
* @
|
|
196
|
-
* <p>Deletes the configuration recorder.</p>
|
|
197
|
-
* <p>After the configuration recorder is deleted, Config will
|
|
198
|
-
* not record resource configuration changes until you create a new
|
|
199
|
-
* configuration recorder.</p>
|
|
200
|
-
* <p>This action does not delete the configuration information that
|
|
201
|
-
* was previously recorded. You will be able to access the previously
|
|
202
|
-
* recorded information by using the
|
|
203
|
-
* <code>GetResourceConfigHistory</code> action, but you will not
|
|
204
|
-
* be able to access this information in the Config console until
|
|
205
|
-
* you create a new configuration recorder.</p>
|
|
127
|
+
* @see {@link DeleteConfigurationRecorderCommand}
|
|
206
128
|
*/
|
|
207
129
|
deleteConfigurationRecorder(args: DeleteConfigurationRecorderCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConfigurationRecorderCommandOutput>;
|
|
208
130
|
deleteConfigurationRecorder(args: DeleteConfigurationRecorderCommandInput, cb: (err: any, data?: DeleteConfigurationRecorderCommandOutput) => void): void;
|
|
209
131
|
deleteConfigurationRecorder(args: DeleteConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationRecorderCommandOutput) => void): void;
|
|
210
132
|
/**
|
|
211
|
-
* @
|
|
212
|
-
* <p>Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that
|
|
213
|
-
* conformance pack.</p>
|
|
214
|
-
* <p>Config sets the conformance pack to <code>DELETE_IN_PROGRESS</code> until the deletion is complete.
|
|
215
|
-
* You cannot update a conformance pack while it is in this state.</p>
|
|
133
|
+
* @see {@link DeleteConformancePackCommand}
|
|
216
134
|
*/
|
|
217
135
|
deleteConformancePack(args: DeleteConformancePackCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConformancePackCommandOutput>;
|
|
218
136
|
deleteConformancePack(args: DeleteConformancePackCommandInput, cb: (err: any, data?: DeleteConformancePackCommandOutput) => void): void;
|
|
219
137
|
deleteConformancePack(args: DeleteConformancePackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConformancePackCommandOutput) => void): void;
|
|
220
138
|
/**
|
|
221
|
-
* @
|
|
222
|
-
* <p>Deletes the delivery channel.</p>
|
|
223
|
-
* <p>Before you can delete the delivery channel, you must stop the
|
|
224
|
-
* configuration recorder by using the <a>StopConfigurationRecorder</a> action.</p>
|
|
139
|
+
* @see {@link DeleteDeliveryChannelCommand}
|
|
225
140
|
*/
|
|
226
141
|
deleteDeliveryChannel(args: DeleteDeliveryChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDeliveryChannelCommandOutput>;
|
|
227
142
|
deleteDeliveryChannel(args: DeleteDeliveryChannelCommandInput, cb: (err: any, data?: DeleteDeliveryChannelCommandOutput) => void): void;
|
|
228
143
|
deleteDeliveryChannel(args: DeleteDeliveryChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDeliveryChannelCommandOutput) => void): void;
|
|
229
144
|
/**
|
|
230
|
-
* @
|
|
231
|
-
* <p>Deletes the evaluation results for the specified Config
|
|
232
|
-
* rule. You can specify one Config rule per request. After you
|
|
233
|
-
* delete the evaluation results, you can call the <a>StartConfigRulesEvaluation</a> API to start evaluating
|
|
234
|
-
* your Amazon Web Services resources against the rule.</p>
|
|
145
|
+
* @see {@link DeleteEvaluationResultsCommand}
|
|
235
146
|
*/
|
|
236
147
|
deleteEvaluationResults(args: DeleteEvaluationResultsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteEvaluationResultsCommandOutput>;
|
|
237
148
|
deleteEvaluationResults(args: DeleteEvaluationResultsCommandInput, cb: (err: any, data?: DeleteEvaluationResultsCommandOutput) => void): void;
|
|
238
149
|
deleteEvaluationResults(args: DeleteEvaluationResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEvaluationResultsCommandOutput) => void): void;
|
|
239
150
|
/**
|
|
240
|
-
* @
|
|
241
|
-
* <p>Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization. </p>
|
|
242
|
-
* <p>Only a management account and a delegated administrator account can delete an organization Config rule.
|
|
243
|
-
* When calling this API with a delegated administrator, you must ensure Organizations
|
|
244
|
-
* <code>ListDelegatedAdministrator</code> permissions are added.</p>
|
|
245
|
-
* <p>Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete.
|
|
246
|
-
* You cannot update a rule while it is in this state.</p>
|
|
151
|
+
* @see {@link DeleteOrganizationConfigRuleCommand}
|
|
247
152
|
*/
|
|
248
153
|
deleteOrganizationConfigRule(args: DeleteOrganizationConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteOrganizationConfigRuleCommandOutput>;
|
|
249
154
|
deleteOrganizationConfigRule(args: DeleteOrganizationConfigRuleCommandInput, cb: (err: any, data?: DeleteOrganizationConfigRuleCommandOutput) => void): void;
|
|
250
155
|
deleteOrganizationConfigRule(args: DeleteOrganizationConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOrganizationConfigRuleCommandOutput) => void): void;
|
|
251
156
|
/**
|
|
252
|
-
* @
|
|
253
|
-
* <p>Deletes the specified organization conformance pack and all of the Config rules and remediation actions from
|
|
254
|
-
* all member accounts in that organization. </p>
|
|
255
|
-
* <p> Only a management account or a delegated administrator account can delete an organization conformance pack.
|
|
256
|
-
* When calling this API with a delegated administrator, you must ensure Organizations
|
|
257
|
-
* <code>ListDelegatedAdministrator</code> permissions are added.</p>
|
|
258
|
-
* <p>Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete.
|
|
259
|
-
* You cannot update a conformance pack while it is in this state. </p>
|
|
157
|
+
* @see {@link DeleteOrganizationConformancePackCommand}
|
|
260
158
|
*/
|
|
261
159
|
deleteOrganizationConformancePack(args: DeleteOrganizationConformancePackCommandInput, options?: __HttpHandlerOptions): Promise<DeleteOrganizationConformancePackCommandOutput>;
|
|
262
160
|
deleteOrganizationConformancePack(args: DeleteOrganizationConformancePackCommandInput, cb: (err: any, data?: DeleteOrganizationConformancePackCommandOutput) => void): void;
|
|
263
161
|
deleteOrganizationConformancePack(args: DeleteOrganizationConformancePackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteOrganizationConformancePackCommandOutput) => void): void;
|
|
264
162
|
/**
|
|
265
|
-
* @
|
|
266
|
-
* <p>Deletes pending authorization requests for a specified
|
|
267
|
-
* aggregator account in a specified region.</p>
|
|
163
|
+
* @see {@link DeletePendingAggregationRequestCommand}
|
|
268
164
|
*/
|
|
269
165
|
deletePendingAggregationRequest(args: DeletePendingAggregationRequestCommandInput, options?: __HttpHandlerOptions): Promise<DeletePendingAggregationRequestCommandOutput>;
|
|
270
166
|
deletePendingAggregationRequest(args: DeletePendingAggregationRequestCommandInput, cb: (err: any, data?: DeletePendingAggregationRequestCommandOutput) => void): void;
|
|
271
167
|
deletePendingAggregationRequest(args: DeletePendingAggregationRequestCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePendingAggregationRequestCommandOutput) => void): void;
|
|
272
168
|
/**
|
|
273
|
-
* @
|
|
274
|
-
* <p>Deletes the remediation configuration.</p>
|
|
169
|
+
* @see {@link DeleteRemediationConfigurationCommand}
|
|
275
170
|
*/
|
|
276
171
|
deleteRemediationConfiguration(args: DeleteRemediationConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRemediationConfigurationCommandOutput>;
|
|
277
172
|
deleteRemediationConfiguration(args: DeleteRemediationConfigurationCommandInput, cb: (err: any, data?: DeleteRemediationConfigurationCommandOutput) => void): void;
|
|
278
173
|
deleteRemediationConfiguration(args: DeleteRemediationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRemediationConfigurationCommandOutput) => void): void;
|
|
279
174
|
/**
|
|
280
|
-
* @
|
|
281
|
-
* <p>Deletes one or more remediation exceptions mentioned in the resource keys.</p>
|
|
282
|
-
* <note>
|
|
283
|
-
* <p>Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource.
|
|
284
|
-
* Remediation exceptions blocks auto-remediation until the exception is cleared.</p>
|
|
285
|
-
* </note>
|
|
175
|
+
* @see {@link DeleteRemediationExceptionsCommand}
|
|
286
176
|
*/
|
|
287
177
|
deleteRemediationExceptions(args: DeleteRemediationExceptionsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRemediationExceptionsCommandOutput>;
|
|
288
178
|
deleteRemediationExceptions(args: DeleteRemediationExceptionsCommandInput, cb: (err: any, data?: DeleteRemediationExceptionsCommandOutput) => void): void;
|
|
289
179
|
deleteRemediationExceptions(args: DeleteRemediationExceptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRemediationExceptionsCommandOutput) => void): void;
|
|
290
180
|
/**
|
|
291
|
-
* @
|
|
292
|
-
* <p>Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.
|
|
293
|
-
* </p>
|
|
181
|
+
* @see {@link DeleteResourceConfigCommand}
|
|
294
182
|
*/
|
|
295
183
|
deleteResourceConfig(args: DeleteResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<DeleteResourceConfigCommandOutput>;
|
|
296
184
|
deleteResourceConfig(args: DeleteResourceConfigCommandInput, cb: (err: any, data?: DeleteResourceConfigCommandOutput) => void): void;
|
|
297
185
|
deleteResourceConfig(args: DeleteResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteResourceConfigCommandOutput) => void): void;
|
|
298
186
|
/**
|
|
299
|
-
* @
|
|
300
|
-
* <p>Deletes the retention configuration.</p>
|
|
187
|
+
* @see {@link DeleteRetentionConfigurationCommand}
|
|
301
188
|
*/
|
|
302
189
|
deleteRetentionConfiguration(args: DeleteRetentionConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRetentionConfigurationCommandOutput>;
|
|
303
190
|
deleteRetentionConfiguration(args: DeleteRetentionConfigurationCommandInput, cb: (err: any, data?: DeleteRetentionConfigurationCommandOutput) => void): void;
|
|
304
191
|
deleteRetentionConfiguration(args: DeleteRetentionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRetentionConfigurationCommandOutput) => void): void;
|
|
305
192
|
/**
|
|
306
|
-
* @
|
|
307
|
-
* <p>Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.</p>
|
|
193
|
+
* @see {@link DeleteStoredQueryCommand}
|
|
308
194
|
*/
|
|
309
195
|
deleteStoredQuery(args: DeleteStoredQueryCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStoredQueryCommandOutput>;
|
|
310
196
|
deleteStoredQuery(args: DeleteStoredQueryCommandInput, cb: (err: any, data?: DeleteStoredQueryCommandOutput) => void): void;
|
|
311
197
|
deleteStoredQuery(args: DeleteStoredQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStoredQueryCommandOutput) => void): void;
|
|
312
198
|
/**
|
|
313
|
-
* @
|
|
314
|
-
* <p>Schedules delivery of a configuration snapshot to the Amazon S3
|
|
315
|
-
* bucket in the specified delivery channel. After the delivery has
|
|
316
|
-
* started, Config sends the following notifications using an
|
|
317
|
-
* Amazon SNS topic that you have specified.</p>
|
|
318
|
-
* <ul>
|
|
319
|
-
* <li>
|
|
320
|
-
* <p>Notification of the start of the delivery.</p>
|
|
321
|
-
* </li>
|
|
322
|
-
* <li>
|
|
323
|
-
* <p>Notification of the completion of the delivery, if the
|
|
324
|
-
* delivery was successfully completed.</p>
|
|
325
|
-
* </li>
|
|
326
|
-
* <li>
|
|
327
|
-
* <p>Notification of delivery failure, if the delivery
|
|
328
|
-
* failed.</p>
|
|
329
|
-
* </li>
|
|
330
|
-
* </ul>
|
|
199
|
+
* @see {@link DeliverConfigSnapshotCommand}
|
|
331
200
|
*/
|
|
332
201
|
deliverConfigSnapshot(args: DeliverConfigSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<DeliverConfigSnapshotCommandOutput>;
|
|
333
202
|
deliverConfigSnapshot(args: DeliverConfigSnapshotCommandInput, cb: (err: any, data?: DeliverConfigSnapshotCommandOutput) => void): void;
|
|
334
203
|
deliverConfigSnapshot(args: DeliverConfigSnapshotCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeliverConfigSnapshotCommandOutput) => void): void;
|
|
335
204
|
/**
|
|
336
|
-
* @
|
|
337
|
-
* <p>Returns a list of compliant and noncompliant rules with the
|
|
338
|
-
* number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
|
|
339
|
-
* </p>
|
|
340
|
-
* <note>
|
|
341
|
-
* <p>The results can return an empty result page, but if you
|
|
342
|
-
* have a <code>nextToken</code>, the results are displayed on the next
|
|
343
|
-
* page.</p>
|
|
344
|
-
* </note>
|
|
205
|
+
* @see {@link DescribeAggregateComplianceByConfigRulesCommand}
|
|
345
206
|
*/
|
|
346
207
|
describeAggregateComplianceByConfigRules(args: DescribeAggregateComplianceByConfigRulesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAggregateComplianceByConfigRulesCommandOutput>;
|
|
347
208
|
describeAggregateComplianceByConfigRules(args: DescribeAggregateComplianceByConfigRulesCommandInput, cb: (err: any, data?: DescribeAggregateComplianceByConfigRulesCommandOutput) => void): void;
|
|
348
209
|
describeAggregateComplianceByConfigRules(args: DescribeAggregateComplianceByConfigRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAggregateComplianceByConfigRulesCommandOutput) => void): void;
|
|
349
210
|
/**
|
|
350
|
-
* @
|
|
351
|
-
* <p>Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each
|
|
352
|
-
* conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.</p>
|
|
353
|
-
* <note>
|
|
354
|
-
* <p>The results can return an empty result page, but if you have a <code>nextToken</code>, the results are displayed on the next page.</p>
|
|
355
|
-
* </note>
|
|
211
|
+
* @see {@link DescribeAggregateComplianceByConformancePacksCommand}
|
|
356
212
|
*/
|
|
357
213
|
describeAggregateComplianceByConformancePacks(args: DescribeAggregateComplianceByConformancePacksCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAggregateComplianceByConformancePacksCommandOutput>;
|
|
358
214
|
describeAggregateComplianceByConformancePacks(args: DescribeAggregateComplianceByConformancePacksCommandInput, cb: (err: any, data?: DescribeAggregateComplianceByConformancePacksCommandOutput) => void): void;
|
|
359
215
|
describeAggregateComplianceByConformancePacks(args: DescribeAggregateComplianceByConformancePacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAggregateComplianceByConformancePacksCommandOutput) => void): void;
|
|
360
216
|
/**
|
|
361
|
-
* @
|
|
362
|
-
* <p>Returns a list of authorizations granted to various aggregator
|
|
363
|
-
* accounts and regions.</p>
|
|
217
|
+
* @see {@link DescribeAggregationAuthorizationsCommand}
|
|
364
218
|
*/
|
|
365
219
|
describeAggregationAuthorizations(args: DescribeAggregationAuthorizationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAggregationAuthorizationsCommandOutput>;
|
|
366
220
|
describeAggregationAuthorizations(args: DescribeAggregationAuthorizationsCommandInput, cb: (err: any, data?: DescribeAggregationAuthorizationsCommandOutput) => void): void;
|
|
367
221
|
describeAggregationAuthorizations(args: DescribeAggregationAuthorizationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAggregationAuthorizationsCommandOutput) => void): void;
|
|
368
222
|
/**
|
|
369
|
-
* @
|
|
370
|
-
* <p>Indicates whether the specified Config rules are compliant.
|
|
371
|
-
* If a rule is noncompliant, this action returns the number of Amazon Web Services
|
|
372
|
-
* resources that do not comply with the rule.</p>
|
|
373
|
-
* <p>A rule is compliant if all of the evaluated resources comply
|
|
374
|
-
* with it. It is noncompliant if any of these resources do not
|
|
375
|
-
* comply.</p>
|
|
376
|
-
* <p>If Config has no current evaluation results for the rule,
|
|
377
|
-
* it returns <code>INSUFFICIENT_DATA</code>. This result might
|
|
378
|
-
* indicate one of the following conditions:</p>
|
|
379
|
-
* <ul>
|
|
380
|
-
* <li>
|
|
381
|
-
* <p>Config has never invoked an evaluation for the
|
|
382
|
-
* rule. To check whether it has, use the
|
|
383
|
-
* <code>DescribeConfigRuleEvaluationStatus</code> action
|
|
384
|
-
* to get the <code>LastSuccessfulInvocationTime</code> and
|
|
385
|
-
* <code>LastFailedInvocationTime</code>.</p>
|
|
386
|
-
* </li>
|
|
387
|
-
* <li>
|
|
388
|
-
* <p>The rule's Lambda function is failing to send
|
|
389
|
-
* evaluation results to Config. Verify that the role you
|
|
390
|
-
* assigned to your configuration recorder includes the
|
|
391
|
-
* <code>config:PutEvaluations</code> permission. If the
|
|
392
|
-
* rule is a custom rule, verify that the Lambda execution
|
|
393
|
-
* role includes the <code>config:PutEvaluations</code>
|
|
394
|
-
* permission.</p>
|
|
395
|
-
* </li>
|
|
396
|
-
* <li>
|
|
397
|
-
* <p>The rule's Lambda function has returned
|
|
398
|
-
* <code>NOT_APPLICABLE</code> for all evaluation results.
|
|
399
|
-
* This can occur if the resources were deleted or removed from
|
|
400
|
-
* the rule's scope.</p>
|
|
401
|
-
* </li>
|
|
402
|
-
* </ul>
|
|
223
|
+
* @see {@link DescribeComplianceByConfigRuleCommand}
|
|
403
224
|
*/
|
|
404
225
|
describeComplianceByConfigRule(args: DescribeComplianceByConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<DescribeComplianceByConfigRuleCommandOutput>;
|
|
405
226
|
describeComplianceByConfigRule(args: DescribeComplianceByConfigRuleCommandInput, cb: (err: any, data?: DescribeComplianceByConfigRuleCommandOutput) => void): void;
|
|
406
227
|
describeComplianceByConfigRule(args: DescribeComplianceByConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComplianceByConfigRuleCommandOutput) => void): void;
|
|
407
228
|
/**
|
|
408
|
-
* @
|
|
409
|
-
* <p>Indicates whether the specified Amazon Web Services resources are compliant. If
|
|
410
|
-
* a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.</p>
|
|
411
|
-
* <p>A resource is compliant if it complies with all the Config
|
|
412
|
-
* rules that evaluate it. It is noncompliant if it does not comply
|
|
413
|
-
* with one or more of these rules.</p>
|
|
414
|
-
* <p>If Config has no current evaluation results for the
|
|
415
|
-
* resource, it returns <code>INSUFFICIENT_DATA</code>. This result
|
|
416
|
-
* might indicate one of the following conditions about the rules that
|
|
417
|
-
* evaluate the resource:</p>
|
|
418
|
-
* <ul>
|
|
419
|
-
* <li>
|
|
420
|
-
* <p>Config has never invoked an evaluation for the
|
|
421
|
-
* rule. To check whether it has, use the
|
|
422
|
-
* <code>DescribeConfigRuleEvaluationStatus</code> action
|
|
423
|
-
* to get the <code>LastSuccessfulInvocationTime</code> and
|
|
424
|
-
* <code>LastFailedInvocationTime</code>.</p>
|
|
425
|
-
* </li>
|
|
426
|
-
* <li>
|
|
427
|
-
* <p>The rule's Lambda function is failing to send
|
|
428
|
-
* evaluation results to Config. Verify that the role that
|
|
429
|
-
* you assigned to your configuration recorder includes the
|
|
430
|
-
* <code>config:PutEvaluations</code> permission. If the
|
|
431
|
-
* rule is a custom rule, verify that the Lambda execution
|
|
432
|
-
* role includes the <code>config:PutEvaluations</code>
|
|
433
|
-
* permission.</p>
|
|
434
|
-
* </li>
|
|
435
|
-
* <li>
|
|
436
|
-
* <p>The rule's Lambda function has returned
|
|
437
|
-
* <code>NOT_APPLICABLE</code> for all evaluation results.
|
|
438
|
-
* This can occur if the resources were deleted or removed from
|
|
439
|
-
* the rule's scope.</p>
|
|
440
|
-
* </li>
|
|
441
|
-
* </ul>
|
|
229
|
+
* @see {@link DescribeComplianceByResourceCommand}
|
|
442
230
|
*/
|
|
443
231
|
describeComplianceByResource(args: DescribeComplianceByResourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeComplianceByResourceCommandOutput>;
|
|
444
232
|
describeComplianceByResource(args: DescribeComplianceByResourceCommandInput, cb: (err: any, data?: DescribeComplianceByResourceCommandOutput) => void): void;
|
|
445
233
|
describeComplianceByResource(args: DescribeComplianceByResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComplianceByResourceCommandOutput) => void): void;
|
|
446
234
|
/**
|
|
447
|
-
* @
|
|
448
|
-
* <p>Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke
|
|
449
|
-
* the rule, and the related error for the last failure.</p>
|
|
235
|
+
* @see {@link DescribeConfigRuleEvaluationStatusCommand}
|
|
450
236
|
*/
|
|
451
237
|
describeConfigRuleEvaluationStatus(args: DescribeConfigRuleEvaluationStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConfigRuleEvaluationStatusCommandOutput>;
|
|
452
238
|
describeConfigRuleEvaluationStatus(args: DescribeConfigRuleEvaluationStatusCommandInput, cb: (err: any, data?: DescribeConfigRuleEvaluationStatusCommandOutput) => void): void;
|
|
453
239
|
describeConfigRuleEvaluationStatus(args: DescribeConfigRuleEvaluationStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigRuleEvaluationStatusCommandOutput) => void): void;
|
|
454
240
|
/**
|
|
455
|
-
* @
|
|
456
|
-
* <p>Returns details about your Config rules.</p>
|
|
241
|
+
* @see {@link DescribeConfigRulesCommand}
|
|
457
242
|
*/
|
|
458
243
|
describeConfigRules(args: DescribeConfigRulesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConfigRulesCommandOutput>;
|
|
459
244
|
describeConfigRules(args: DescribeConfigRulesCommandInput, cb: (err: any, data?: DescribeConfigRulesCommandOutput) => void): void;
|
|
460
245
|
describeConfigRules(args: DescribeConfigRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigRulesCommandOutput) => void): void;
|
|
461
246
|
/**
|
|
462
|
-
* @
|
|
463
|
-
* <p>Returns the details of one or more configuration aggregators.
|
|
464
|
-
* If the configuration aggregator is not specified, this action
|
|
465
|
-
* returns the details for all the configuration aggregators associated
|
|
466
|
-
* with the account. </p>
|
|
247
|
+
* @see {@link DescribeConfigurationAggregatorsCommand}
|
|
467
248
|
*/
|
|
468
249
|
describeConfigurationAggregators(args: DescribeConfigurationAggregatorsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConfigurationAggregatorsCommandOutput>;
|
|
469
250
|
describeConfigurationAggregators(args: DescribeConfigurationAggregatorsCommandInput, cb: (err: any, data?: DescribeConfigurationAggregatorsCommandOutput) => void): void;
|
|
470
251
|
describeConfigurationAggregators(args: DescribeConfigurationAggregatorsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationAggregatorsCommandOutput) => void): void;
|
|
471
252
|
/**
|
|
472
|
-
* @
|
|
473
|
-
* <p>Returns status information for sources within an aggregator.
|
|
474
|
-
* The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message. </p>
|
|
253
|
+
* @see {@link DescribeConfigurationAggregatorSourcesStatusCommand}
|
|
475
254
|
*/
|
|
476
255
|
describeConfigurationAggregatorSourcesStatus(args: DescribeConfigurationAggregatorSourcesStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConfigurationAggregatorSourcesStatusCommandOutput>;
|
|
477
256
|
describeConfigurationAggregatorSourcesStatus(args: DescribeConfigurationAggregatorSourcesStatusCommandInput, cb: (err: any, data?: DescribeConfigurationAggregatorSourcesStatusCommandOutput) => void): void;
|
|
478
257
|
describeConfigurationAggregatorSourcesStatus(args: DescribeConfigurationAggregatorSourcesStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationAggregatorSourcesStatusCommandOutput) => void): void;
|
|
479
258
|
/**
|
|
480
|
-
* @
|
|
481
|
-
* <p>Returns the details for the specified configuration recorders.
|
|
482
|
-
* If the configuration recorder is not specified, this action returns
|
|
483
|
-
* the details for all configuration recorders associated with the
|
|
484
|
-
* account.</p>
|
|
485
|
-
* <note>
|
|
486
|
-
* <p>Currently, you can specify only one configuration recorder
|
|
487
|
-
* per region in your account.</p>
|
|
488
|
-
* </note>
|
|
259
|
+
* @see {@link DescribeConfigurationRecordersCommand}
|
|
489
260
|
*/
|
|
490
261
|
describeConfigurationRecorders(args: DescribeConfigurationRecordersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConfigurationRecordersCommandOutput>;
|
|
491
262
|
describeConfigurationRecorders(args: DescribeConfigurationRecordersCommandInput, cb: (err: any, data?: DescribeConfigurationRecordersCommandOutput) => void): void;
|
|
492
263
|
describeConfigurationRecorders(args: DescribeConfigurationRecordersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationRecordersCommandOutput) => void): void;
|
|
493
264
|
/**
|
|
494
|
-
* @
|
|
495
|
-
* <p>Returns the current status of the specified configuration
|
|
496
|
-
* recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action
|
|
497
|
-
* returns the status of all configuration recorders associated with
|
|
498
|
-
* the account.</p>
|
|
499
|
-
* <note>
|
|
500
|
-
* <p>Currently, you can specify only one configuration recorder
|
|
501
|
-
* per region in your account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.</p>
|
|
502
|
-
* </note>
|
|
265
|
+
* @see {@link DescribeConfigurationRecorderStatusCommand}
|
|
503
266
|
*/
|
|
504
267
|
describeConfigurationRecorderStatus(args: DescribeConfigurationRecorderStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConfigurationRecorderStatusCommandOutput>;
|
|
505
268
|
describeConfigurationRecorderStatus(args: DescribeConfigurationRecorderStatusCommandInput, cb: (err: any, data?: DescribeConfigurationRecorderStatusCommandOutput) => void): void;
|
|
506
269
|
describeConfigurationRecorderStatus(args: DescribeConfigurationRecorderStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationRecorderStatusCommandOutput) => void): void;
|
|
507
270
|
/**
|
|
508
|
-
* @
|
|
509
|
-
* <p>Returns compliance details for each rule in that conformance pack.</p>
|
|
510
|
-
* <note>
|
|
511
|
-
* <p>You must provide exact rule names.</p>
|
|
512
|
-
* </note>
|
|
271
|
+
* @see {@link DescribeConformancePackComplianceCommand}
|
|
513
272
|
*/
|
|
514
273
|
describeConformancePackCompliance(args: DescribeConformancePackComplianceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConformancePackComplianceCommandOutput>;
|
|
515
274
|
describeConformancePackCompliance(args: DescribeConformancePackComplianceCommandInput, cb: (err: any, data?: DescribeConformancePackComplianceCommandOutput) => void): void;
|
|
516
275
|
describeConformancePackCompliance(args: DescribeConformancePackComplianceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConformancePackComplianceCommandOutput) => void): void;
|
|
517
276
|
/**
|
|
518
|
-
* @
|
|
519
|
-
* <p>Returns a list of one or more conformance packs.</p>
|
|
277
|
+
* @see {@link DescribeConformancePacksCommand}
|
|
520
278
|
*/
|
|
521
279
|
describeConformancePacks(args: DescribeConformancePacksCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConformancePacksCommandOutput>;
|
|
522
280
|
describeConformancePacks(args: DescribeConformancePacksCommandInput, cb: (err: any, data?: DescribeConformancePacksCommandOutput) => void): void;
|
|
523
281
|
describeConformancePacks(args: DescribeConformancePacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConformancePacksCommandOutput) => void): void;
|
|
524
282
|
/**
|
|
525
|
-
* @
|
|
526
|
-
* <p>Provides one or more conformance packs deployment status.</p>
|
|
527
|
-
* <note>
|
|
528
|
-
* <p>If there are no conformance packs then you will see an empty result.</p>
|
|
529
|
-
* </note>
|
|
283
|
+
* @see {@link DescribeConformancePackStatusCommand}
|
|
530
284
|
*/
|
|
531
285
|
describeConformancePackStatus(args: DescribeConformancePackStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConformancePackStatusCommandOutput>;
|
|
532
286
|
describeConformancePackStatus(args: DescribeConformancePackStatusCommandInput, cb: (err: any, data?: DescribeConformancePackStatusCommandOutput) => void): void;
|
|
533
287
|
describeConformancePackStatus(args: DescribeConformancePackStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConformancePackStatusCommandOutput) => void): void;
|
|
534
288
|
/**
|
|
535
|
-
* @
|
|
536
|
-
* <p>Returns details about the specified delivery channel. If a
|
|
537
|
-
* delivery channel is not specified, this action returns the details
|
|
538
|
-
* of all delivery channels associated with the account.</p>
|
|
539
|
-
* <note>
|
|
540
|
-
* <p>Currently, you can specify only one delivery channel per
|
|
541
|
-
* region in your account.</p>
|
|
542
|
-
* </note>
|
|
289
|
+
* @see {@link DescribeDeliveryChannelsCommand}
|
|
543
290
|
*/
|
|
544
291
|
describeDeliveryChannels(args: DescribeDeliveryChannelsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDeliveryChannelsCommandOutput>;
|
|
545
292
|
describeDeliveryChannels(args: DescribeDeliveryChannelsCommandInput, cb: (err: any, data?: DescribeDeliveryChannelsCommandOutput) => void): void;
|
|
546
293
|
describeDeliveryChannels(args: DescribeDeliveryChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeliveryChannelsCommandOutput) => void): void;
|
|
547
294
|
/**
|
|
548
|
-
* @
|
|
549
|
-
* <p>Returns the current status of the specified delivery channel.
|
|
550
|
-
* If a delivery channel is not specified, this action returns the
|
|
551
|
-
* current status of all delivery channels associated with the
|
|
552
|
-
* account.</p>
|
|
553
|
-
* <note>
|
|
554
|
-
* <p>Currently, you can specify only one delivery channel per
|
|
555
|
-
* region in your account.</p>
|
|
556
|
-
* </note>
|
|
295
|
+
* @see {@link DescribeDeliveryChannelStatusCommand}
|
|
557
296
|
*/
|
|
558
297
|
describeDeliveryChannelStatus(args: DescribeDeliveryChannelStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDeliveryChannelStatusCommandOutput>;
|
|
559
298
|
describeDeliveryChannelStatus(args: DescribeDeliveryChannelStatusCommandInput, cb: (err: any, data?: DescribeDeliveryChannelStatusCommandOutput) => void): void;
|
|
560
299
|
describeDeliveryChannelStatus(args: DescribeDeliveryChannelStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeliveryChannelStatusCommandOutput) => void): void;
|
|
561
300
|
/**
|
|
562
|
-
* @
|
|
563
|
-
* <p>Returns a list of organization Config rules. </p>
|
|
564
|
-
* <note>
|
|
565
|
-
* <p>When you specify the limit and the next token, you receive a paginated response.</p>
|
|
566
|
-
* <p>Limit and next token are not applicable if you specify organization Config rule names.
|
|
567
|
-
* It is only applicable, when you request all the organization Config rules.</p>
|
|
568
|
-
* <p>
|
|
569
|
-
* <i>For accounts within an organzation</i>
|
|
570
|
-
* </p>
|
|
571
|
-
* <p>If you deploy an organizational rule or conformance pack in an organization
|
|
572
|
-
* administrator account, and then establish a delegated administrator and deploy an
|
|
573
|
-
* organizational rule or conformance pack in the delegated administrator account, you
|
|
574
|
-
* won't be able to see the organizational rule or conformance pack in the organization
|
|
575
|
-
* administrator account from the delegated administrator account or see the organizational
|
|
576
|
-
* rule or conformance pack in the delegated administrator account from organization
|
|
577
|
-
* administrator account. The <code>DescribeOrganizationConfigRules</code> and
|
|
578
|
-
* <code>DescribeOrganizationConformancePacks</code> APIs can only see and interact with
|
|
579
|
-
* the organization-related resource that were deployed from within the account calling
|
|
580
|
-
* those APIs.</p>
|
|
581
|
-
* </note>
|
|
301
|
+
* @see {@link DescribeOrganizationConfigRulesCommand}
|
|
582
302
|
*/
|
|
583
303
|
describeOrganizationConfigRules(args: DescribeOrganizationConfigRulesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrganizationConfigRulesCommandOutput>;
|
|
584
304
|
describeOrganizationConfigRules(args: DescribeOrganizationConfigRulesCommandInput, cb: (err: any, data?: DescribeOrganizationConfigRulesCommandOutput) => void): void;
|
|
585
305
|
describeOrganizationConfigRules(args: DescribeOrganizationConfigRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigRulesCommandOutput) => void): void;
|
|
586
306
|
/**
|
|
587
|
-
* @
|
|
588
|
-
* <p>Provides organization Config rule deployment status for an organization.</p>
|
|
589
|
-
* <note>
|
|
590
|
-
* <p>The status is not considered successful until organization Config rule is successfully deployed in all the member
|
|
591
|
-
* accounts with an exception of excluded accounts.</p>
|
|
592
|
-
* <p>When you specify the limit and the next token, you receive a paginated response.
|
|
593
|
-
* Limit and next token are not applicable if you specify organization Config rule names.
|
|
594
|
-
* It is only applicable, when you request all the organization Config rules.</p>
|
|
595
|
-
* </note>
|
|
307
|
+
* @see {@link DescribeOrganizationConfigRuleStatusesCommand}
|
|
596
308
|
*/
|
|
597
309
|
describeOrganizationConfigRuleStatuses(args: DescribeOrganizationConfigRuleStatusesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrganizationConfigRuleStatusesCommandOutput>;
|
|
598
310
|
describeOrganizationConfigRuleStatuses(args: DescribeOrganizationConfigRuleStatusesCommandInput, cb: (err: any, data?: DescribeOrganizationConfigRuleStatusesCommandOutput) => void): void;
|
|
599
311
|
describeOrganizationConfigRuleStatuses(args: DescribeOrganizationConfigRuleStatusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigRuleStatusesCommandOutput) => void): void;
|
|
600
312
|
/**
|
|
601
|
-
* @
|
|
602
|
-
* <p>Returns a list of organization conformance packs. </p>
|
|
603
|
-
* <note>
|
|
604
|
-
* <p>When you specify the limit and the next token, you receive a paginated response. </p>
|
|
605
|
-
* <p>Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable,
|
|
606
|
-
* when you request all the organization conformance packs. </p>
|
|
607
|
-
* <p>
|
|
608
|
-
* <i>For accounts within an organzation</i>
|
|
609
|
-
* </p>
|
|
610
|
-
* <p>If you deploy an organizational rule or conformance pack in an organization
|
|
611
|
-
* administrator account, and then establish a delegated administrator and deploy an
|
|
612
|
-
* organizational rule or conformance pack in the delegated administrator account, you
|
|
613
|
-
* won't be able to see the organizational rule or conformance pack in the organization
|
|
614
|
-
* administrator account from the delegated administrator account or see the organizational
|
|
615
|
-
* rule or conformance pack in the delegated administrator account from organization
|
|
616
|
-
* administrator account. The <code>DescribeOrganizationConfigRules</code> and
|
|
617
|
-
* <code>DescribeOrganizationConformancePacks</code> APIs can only see and interact with
|
|
618
|
-
* the organization-related resource that were deployed from within the account calling
|
|
619
|
-
* those APIs.</p>
|
|
620
|
-
* </note>
|
|
313
|
+
* @see {@link DescribeOrganizationConformancePacksCommand}
|
|
621
314
|
*/
|
|
622
315
|
describeOrganizationConformancePacks(args: DescribeOrganizationConformancePacksCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrganizationConformancePacksCommandOutput>;
|
|
623
316
|
describeOrganizationConformancePacks(args: DescribeOrganizationConformancePacksCommandInput, cb: (err: any, data?: DescribeOrganizationConformancePacksCommandOutput) => void): void;
|
|
624
317
|
describeOrganizationConformancePacks(args: DescribeOrganizationConformancePacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConformancePacksCommandOutput) => void): void;
|
|
625
318
|
/**
|
|
626
|
-
* @
|
|
627
|
-
* <p>Provides organization conformance pack deployment status for an organization. </p>
|
|
628
|
-
* <note>
|
|
629
|
-
* <p>The status is not considered successful until organization conformance pack is successfully
|
|
630
|
-
* deployed in all the member accounts with an exception of excluded accounts.</p>
|
|
631
|
-
* <p>When you specify the limit and the next token, you receive a paginated response.
|
|
632
|
-
* Limit and next token are not applicable if you specify organization conformance pack names.
|
|
633
|
-
* They are only applicable, when you request all the organization conformance packs.</p>
|
|
634
|
-
* </note>
|
|
319
|
+
* @see {@link DescribeOrganizationConformancePackStatusesCommand}
|
|
635
320
|
*/
|
|
636
321
|
describeOrganizationConformancePackStatuses(args: DescribeOrganizationConformancePackStatusesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrganizationConformancePackStatusesCommandOutput>;
|
|
637
322
|
describeOrganizationConformancePackStatuses(args: DescribeOrganizationConformancePackStatusesCommandInput, cb: (err: any, data?: DescribeOrganizationConformancePackStatusesCommandOutput) => void): void;
|
|
638
323
|
describeOrganizationConformancePackStatuses(args: DescribeOrganizationConformancePackStatusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConformancePackStatusesCommandOutput) => void): void;
|
|
639
324
|
/**
|
|
640
|
-
* @
|
|
641
|
-
* <p>Returns a list of all pending aggregation requests.</p>
|
|
325
|
+
* @see {@link DescribePendingAggregationRequestsCommand}
|
|
642
326
|
*/
|
|
643
327
|
describePendingAggregationRequests(args: DescribePendingAggregationRequestsCommandInput, options?: __HttpHandlerOptions): Promise<DescribePendingAggregationRequestsCommandOutput>;
|
|
644
328
|
describePendingAggregationRequests(args: DescribePendingAggregationRequestsCommandInput, cb: (err: any, data?: DescribePendingAggregationRequestsCommandOutput) => void): void;
|
|
645
329
|
describePendingAggregationRequests(args: DescribePendingAggregationRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePendingAggregationRequestsCommandOutput) => void): void;
|
|
646
330
|
/**
|
|
647
|
-
* @
|
|
648
|
-
* <p>Returns the details of one or more remediation configurations.</p>
|
|
331
|
+
* @see {@link DescribeRemediationConfigurationsCommand}
|
|
649
332
|
*/
|
|
650
333
|
describeRemediationConfigurations(args: DescribeRemediationConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRemediationConfigurationsCommandOutput>;
|
|
651
334
|
describeRemediationConfigurations(args: DescribeRemediationConfigurationsCommandInput, cb: (err: any, data?: DescribeRemediationConfigurationsCommandOutput) => void): void;
|
|
652
335
|
describeRemediationConfigurations(args: DescribeRemediationConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRemediationConfigurationsCommandOutput) => void): void;
|
|
653
336
|
/**
|
|
654
|
-
* @
|
|
655
|
-
* <p>Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted.
|
|
656
|
-
* When you specify the limit and the next token, you receive a paginated response. </p>
|
|
657
|
-
* <note>
|
|
658
|
-
* <p>Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource.
|
|
659
|
-
* Remediation exceptions blocks auto-remediation until the exception is cleared.</p>
|
|
660
|
-
* <p>When you specify the limit and the next token, you receive a paginated response. </p>
|
|
661
|
-
* <p>Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.</p>
|
|
662
|
-
* </note>
|
|
337
|
+
* @see {@link DescribeRemediationExceptionsCommand}
|
|
663
338
|
*/
|
|
664
339
|
describeRemediationExceptions(args: DescribeRemediationExceptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRemediationExceptionsCommandOutput>;
|
|
665
340
|
describeRemediationExceptions(args: DescribeRemediationExceptionsCommandInput, cb: (err: any, data?: DescribeRemediationExceptionsCommandOutput) => void): void;
|
|
666
341
|
describeRemediationExceptions(args: DescribeRemediationExceptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRemediationExceptionsCommandOutput) => void): void;
|
|
667
342
|
/**
|
|
668
|
-
* @
|
|
669
|
-
* <p>Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed.
|
|
670
|
-
* When you specify the limit and the next token, you receive a paginated response.</p>
|
|
343
|
+
* @see {@link DescribeRemediationExecutionStatusCommand}
|
|
671
344
|
*/
|
|
672
345
|
describeRemediationExecutionStatus(args: DescribeRemediationExecutionStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRemediationExecutionStatusCommandOutput>;
|
|
673
346
|
describeRemediationExecutionStatus(args: DescribeRemediationExecutionStatusCommandInput, cb: (err: any, data?: DescribeRemediationExecutionStatusCommandOutput) => void): void;
|
|
674
347
|
describeRemediationExecutionStatus(args: DescribeRemediationExecutionStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRemediationExecutionStatusCommandOutput) => void): void;
|
|
675
348
|
/**
|
|
676
|
-
* @
|
|
677
|
-
* <p>Returns the details of one or more retention configurations. If
|
|
678
|
-
* the retention configuration name is not specified, this action
|
|
679
|
-
* returns the details for all the retention configurations for that
|
|
680
|
-
* account.</p>
|
|
681
|
-
* <note>
|
|
682
|
-
* <p>Currently, Config supports only one retention
|
|
683
|
-
* configuration per region in your account.</p>
|
|
684
|
-
* </note>
|
|
349
|
+
* @see {@link DescribeRetentionConfigurationsCommand}
|
|
685
350
|
*/
|
|
686
351
|
describeRetentionConfigurations(args: DescribeRetentionConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRetentionConfigurationsCommandOutput>;
|
|
687
352
|
describeRetentionConfigurations(args: DescribeRetentionConfigurationsCommandInput, cb: (err: any, data?: DescribeRetentionConfigurationsCommandOutput) => void): void;
|
|
688
353
|
describeRetentionConfigurations(args: DescribeRetentionConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRetentionConfigurationsCommandOutput) => void): void;
|
|
689
354
|
/**
|
|
690
|
-
* @
|
|
691
|
-
* <p>Returns the evaluation results for the specified Config
|
|
692
|
-
* rule for a specific resource in a rule. The results indicate which
|
|
693
|
-
* Amazon Web Services resources were evaluated by the rule, when each resource was
|
|
694
|
-
* last evaluated, and whether each resource complies with the rule. </p>
|
|
695
|
-
* <note>
|
|
696
|
-
* <p>The results can return an empty result page. But if you
|
|
697
|
-
* have a <code>nextToken</code>, the results are displayed on the next
|
|
698
|
-
* page.</p>
|
|
699
|
-
* </note>
|
|
355
|
+
* @see {@link GetAggregateComplianceDetailsByConfigRuleCommand}
|
|
700
356
|
*/
|
|
701
357
|
getAggregateComplianceDetailsByConfigRule(args: GetAggregateComplianceDetailsByConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<GetAggregateComplianceDetailsByConfigRuleCommandOutput>;
|
|
702
358
|
getAggregateComplianceDetailsByConfigRule(args: GetAggregateComplianceDetailsByConfigRuleCommandInput, cb: (err: any, data?: GetAggregateComplianceDetailsByConfigRuleCommandOutput) => void): void;
|
|
703
359
|
getAggregateComplianceDetailsByConfigRule(args: GetAggregateComplianceDetailsByConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateComplianceDetailsByConfigRuleCommandOutput) => void): void;
|
|
704
360
|
/**
|
|
705
|
-
* @
|
|
706
|
-
* <p>Returns the number of compliant and noncompliant rules for one
|
|
707
|
-
* or more accounts and regions in an aggregator.</p>
|
|
708
|
-
* <note>
|
|
709
|
-
* <p>The results can return an empty result page, but if you
|
|
710
|
-
* have a nextToken, the results are displayed on the next
|
|
711
|
-
* page.</p>
|
|
712
|
-
* </note>
|
|
361
|
+
* @see {@link GetAggregateConfigRuleComplianceSummaryCommand}
|
|
713
362
|
*/
|
|
714
363
|
getAggregateConfigRuleComplianceSummary(args: GetAggregateConfigRuleComplianceSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetAggregateConfigRuleComplianceSummaryCommandOutput>;
|
|
715
364
|
getAggregateConfigRuleComplianceSummary(args: GetAggregateConfigRuleComplianceSummaryCommandInput, cb: (err: any, data?: GetAggregateConfigRuleComplianceSummaryCommandOutput) => void): void;
|
|
716
365
|
getAggregateConfigRuleComplianceSummary(args: GetAggregateConfigRuleComplianceSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateConfigRuleComplianceSummaryCommandOutput) => void): void;
|
|
717
366
|
/**
|
|
718
|
-
* @
|
|
719
|
-
* <p>Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.</p>
|
|
720
|
-
* <note>
|
|
721
|
-
* <p>The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.</p>
|
|
722
|
-
* </note>
|
|
367
|
+
* @see {@link GetAggregateConformancePackComplianceSummaryCommand}
|
|
723
368
|
*/
|
|
724
369
|
getAggregateConformancePackComplianceSummary(args: GetAggregateConformancePackComplianceSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetAggregateConformancePackComplianceSummaryCommandOutput>;
|
|
725
370
|
getAggregateConformancePackComplianceSummary(args: GetAggregateConformancePackComplianceSummaryCommandInput, cb: (err: any, data?: GetAggregateConformancePackComplianceSummaryCommandOutput) => void): void;
|
|
726
371
|
getAggregateConformancePackComplianceSummary(args: GetAggregateConformancePackComplianceSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateConformancePackComplianceSummaryCommandOutput) => void): void;
|
|
727
372
|
/**
|
|
728
|
-
* @
|
|
729
|
-
* <p>Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.</p>
|
|
730
|
-
* <p>For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1.
|
|
731
|
-
* If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.</p>
|
|
373
|
+
* @see {@link GetAggregateDiscoveredResourceCountsCommand}
|
|
732
374
|
*/
|
|
733
375
|
getAggregateDiscoveredResourceCounts(args: GetAggregateDiscoveredResourceCountsCommandInput, options?: __HttpHandlerOptions): Promise<GetAggregateDiscoveredResourceCountsCommandOutput>;
|
|
734
376
|
getAggregateDiscoveredResourceCounts(args: GetAggregateDiscoveredResourceCountsCommandInput, cb: (err: any, data?: GetAggregateDiscoveredResourceCountsCommandOutput) => void): void;
|
|
735
377
|
getAggregateDiscoveredResourceCounts(args: GetAggregateDiscoveredResourceCountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateDiscoveredResourceCountsCommandOutput) => void): void;
|
|
736
378
|
/**
|
|
737
|
-
* @
|
|
738
|
-
* <p>Returns configuration item that is aggregated for your specific resource in a specific source account and region.</p>
|
|
379
|
+
* @see {@link GetAggregateResourceConfigCommand}
|
|
739
380
|
*/
|
|
740
381
|
getAggregateResourceConfig(args: GetAggregateResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<GetAggregateResourceConfigCommandOutput>;
|
|
741
382
|
getAggregateResourceConfig(args: GetAggregateResourceConfigCommandInput, cb: (err: any, data?: GetAggregateResourceConfigCommandOutput) => void): void;
|
|
742
383
|
getAggregateResourceConfig(args: GetAggregateResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateResourceConfigCommandOutput) => void): void;
|
|
743
384
|
/**
|
|
744
|
-
* @
|
|
745
|
-
* <p>Returns the evaluation results for the specified Config
|
|
746
|
-
* rule. The results indicate which Amazon Web Services resources were evaluated by the
|
|
747
|
-
* rule, when each resource was last evaluated, and whether each
|
|
748
|
-
* resource complies with the rule.</p>
|
|
385
|
+
* @see {@link GetComplianceDetailsByConfigRuleCommand}
|
|
749
386
|
*/
|
|
750
387
|
getComplianceDetailsByConfigRule(args: GetComplianceDetailsByConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<GetComplianceDetailsByConfigRuleCommandOutput>;
|
|
751
388
|
getComplianceDetailsByConfigRule(args: GetComplianceDetailsByConfigRuleCommandInput, cb: (err: any, data?: GetComplianceDetailsByConfigRuleCommandOutput) => void): void;
|
|
752
389
|
getComplianceDetailsByConfigRule(args: GetComplianceDetailsByConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceDetailsByConfigRuleCommandOutput) => void): void;
|
|
753
390
|
/**
|
|
754
|
-
* @
|
|
755
|
-
* <p>Returns the evaluation results for the specified Amazon Web Services resource.
|
|
756
|
-
* The results indicate which Config rules were used to evaluate
|
|
757
|
-
* the resource, when each rule was last invoked, and whether the resource
|
|
758
|
-
* complies with each rule.</p>
|
|
391
|
+
* @see {@link GetComplianceDetailsByResourceCommand}
|
|
759
392
|
*/
|
|
760
393
|
getComplianceDetailsByResource(args: GetComplianceDetailsByResourceCommandInput, options?: __HttpHandlerOptions): Promise<GetComplianceDetailsByResourceCommandOutput>;
|
|
761
394
|
getComplianceDetailsByResource(args: GetComplianceDetailsByResourceCommandInput, cb: (err: any, data?: GetComplianceDetailsByResourceCommandOutput) => void): void;
|
|
762
395
|
getComplianceDetailsByResource(args: GetComplianceDetailsByResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceDetailsByResourceCommandOutput) => void): void;
|
|
763
396
|
/**
|
|
764
|
-
* @
|
|
765
|
-
* <p>Returns the number of Config rules that are compliant and
|
|
766
|
-
* noncompliant, up to a maximum of 25 for each.</p>
|
|
397
|
+
* @see {@link GetComplianceSummaryByConfigRuleCommand}
|
|
767
398
|
*/
|
|
768
399
|
getComplianceSummaryByConfigRule(args: GetComplianceSummaryByConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<GetComplianceSummaryByConfigRuleCommandOutput>;
|
|
769
400
|
getComplianceSummaryByConfigRule(args: GetComplianceSummaryByConfigRuleCommandInput, cb: (err: any, data?: GetComplianceSummaryByConfigRuleCommandOutput) => void): void;
|
|
770
401
|
getComplianceSummaryByConfigRule(args: GetComplianceSummaryByConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceSummaryByConfigRuleCommandOutput) => void): void;
|
|
771
402
|
/**
|
|
772
|
-
* @
|
|
773
|
-
* <p>Returns the number of resources that are compliant and the
|
|
774
|
-
* number that are noncompliant. You can specify one or more resource
|
|
775
|
-
* types to get these numbers for each resource type. The maximum
|
|
776
|
-
* number returned is 100.</p>
|
|
403
|
+
* @see {@link GetComplianceSummaryByResourceTypeCommand}
|
|
777
404
|
*/
|
|
778
405
|
getComplianceSummaryByResourceType(args: GetComplianceSummaryByResourceTypeCommandInput, options?: __HttpHandlerOptions): Promise<GetComplianceSummaryByResourceTypeCommandOutput>;
|
|
779
406
|
getComplianceSummaryByResourceType(args: GetComplianceSummaryByResourceTypeCommandInput, cb: (err: any, data?: GetComplianceSummaryByResourceTypeCommandOutput) => void): void;
|
|
780
407
|
getComplianceSummaryByResourceType(args: GetComplianceSummaryByResourceTypeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceSummaryByResourceTypeCommandOutput) => void): void;
|
|
781
408
|
/**
|
|
782
|
-
* @
|
|
783
|
-
* <p>Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.</p>
|
|
409
|
+
* @see {@link GetConformancePackComplianceDetailsCommand}
|
|
784
410
|
*/
|
|
785
411
|
getConformancePackComplianceDetails(args: GetConformancePackComplianceDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetConformancePackComplianceDetailsCommandOutput>;
|
|
786
412
|
getConformancePackComplianceDetails(args: GetConformancePackComplianceDetailsCommandInput, cb: (err: any, data?: GetConformancePackComplianceDetailsCommandOutput) => void): void;
|
|
787
413
|
getConformancePackComplianceDetails(args: GetConformancePackComplianceDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConformancePackComplianceDetailsCommandOutput) => void): void;
|
|
788
414
|
/**
|
|
789
|
-
* @
|
|
790
|
-
* <p>Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.</p>
|
|
415
|
+
* @see {@link GetConformancePackComplianceSummaryCommand}
|
|
791
416
|
*/
|
|
792
417
|
getConformancePackComplianceSummary(args: GetConformancePackComplianceSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetConformancePackComplianceSummaryCommandOutput>;
|
|
793
418
|
getConformancePackComplianceSummary(args: GetConformancePackComplianceSummaryCommandInput, cb: (err: any, data?: GetConformancePackComplianceSummaryCommandOutput) => void): void;
|
|
794
419
|
getConformancePackComplianceSummary(args: GetConformancePackComplianceSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetConformancePackComplianceSummaryCommandOutput) => void): void;
|
|
795
420
|
/**
|
|
796
|
-
* @
|
|
797
|
-
* <p>Returns the policy definition containing the logic for your Config Custom Policy rule.</p>
|
|
421
|
+
* @see {@link GetCustomRulePolicyCommand}
|
|
798
422
|
*/
|
|
799
423
|
getCustomRulePolicy(args: GetCustomRulePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetCustomRulePolicyCommandOutput>;
|
|
800
424
|
getCustomRulePolicy(args: GetCustomRulePolicyCommandInput, cb: (err: any, data?: GetCustomRulePolicyCommandOutput) => void): void;
|
|
801
425
|
getCustomRulePolicy(args: GetCustomRulePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetCustomRulePolicyCommandOutput) => void): void;
|
|
802
426
|
/**
|
|
803
|
-
* @
|
|
804
|
-
* <p>Returns the resource types, the number of each resource type,
|
|
805
|
-
* and the total number of resources that Config is recording in
|
|
806
|
-
* this region for your Amazon Web Services account. </p>
|
|
807
|
-
* <p class="title">
|
|
808
|
-
* <b>Example</b>
|
|
809
|
-
* </p>
|
|
810
|
-
* <ol>
|
|
811
|
-
* <li>
|
|
812
|
-
* <p>Config is recording three resource types in the US
|
|
813
|
-
* East (Ohio) Region for your account: 25 EC2 instances, 20
|
|
814
|
-
* IAM users, and 15 S3 buckets.</p>
|
|
815
|
-
* </li>
|
|
816
|
-
* <li>
|
|
817
|
-
* <p>You make a call to the
|
|
818
|
-
* <code>GetDiscoveredResourceCounts</code> action and
|
|
819
|
-
* specify that you want all resource types. </p>
|
|
820
|
-
* </li>
|
|
821
|
-
* <li>
|
|
822
|
-
* <p>Config returns the following:</p>
|
|
823
|
-
* <ul>
|
|
824
|
-
* <li>
|
|
825
|
-
* <p>The resource types (EC2 instances, IAM users,
|
|
826
|
-
* and S3 buckets).</p>
|
|
827
|
-
* </li>
|
|
828
|
-
* <li>
|
|
829
|
-
* <p>The number of each resource type (25, 20, and
|
|
830
|
-
* 15).</p>
|
|
831
|
-
* </li>
|
|
832
|
-
* <li>
|
|
833
|
-
* <p>The total number of all resources
|
|
834
|
-
* (60).</p>
|
|
835
|
-
* </li>
|
|
836
|
-
* </ul>
|
|
837
|
-
* </li>
|
|
838
|
-
* </ol>
|
|
839
|
-
* <p>The response is paginated. By default, Config lists 100
|
|
840
|
-
* <a>ResourceCount</a> objects on each page. You can
|
|
841
|
-
* customize this number with the <code>limit</code> parameter. The
|
|
842
|
-
* response includes a <code>nextToken</code> string. To get the next
|
|
843
|
-
* page of results, run the request again and specify the string for
|
|
844
|
-
* the <code>nextToken</code> parameter.</p>
|
|
845
|
-
* <note>
|
|
846
|
-
* <p>If you make a call to the <a>GetDiscoveredResourceCounts</a> action, you might
|
|
847
|
-
* not immediately receive resource counts in the following
|
|
848
|
-
* situations:</p>
|
|
849
|
-
* <ul>
|
|
850
|
-
* <li>
|
|
851
|
-
* <p>You are a new Config customer.</p>
|
|
852
|
-
* </li>
|
|
853
|
-
* <li>
|
|
854
|
-
* <p>You just enabled resource recording.</p>
|
|
855
|
-
* </li>
|
|
856
|
-
* </ul>
|
|
857
|
-
* <p>It might take a few minutes for Config to record and
|
|
858
|
-
* count your resources. Wait a few minutes and then retry the
|
|
859
|
-
* <a>GetDiscoveredResourceCounts</a> action.
|
|
860
|
-
* </p>
|
|
861
|
-
* </note>
|
|
427
|
+
* @see {@link GetDiscoveredResourceCountsCommand}
|
|
862
428
|
*/
|
|
863
429
|
getDiscoveredResourceCounts(args: GetDiscoveredResourceCountsCommandInput, options?: __HttpHandlerOptions): Promise<GetDiscoveredResourceCountsCommandOutput>;
|
|
864
430
|
getDiscoveredResourceCounts(args: GetDiscoveredResourceCountsCommandInput, cb: (err: any, data?: GetDiscoveredResourceCountsCommandOutput) => void): void;
|
|
865
431
|
getDiscoveredResourceCounts(args: GetDiscoveredResourceCountsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDiscoveredResourceCountsCommandOutput) => void): void;
|
|
866
432
|
/**
|
|
867
|
-
* @
|
|
868
|
-
* <p>Returns detailed status for each member account within an organization for a given organization Config rule.</p>
|
|
433
|
+
* @see {@link GetOrganizationConfigRuleDetailedStatusCommand}
|
|
869
434
|
*/
|
|
870
435
|
getOrganizationConfigRuleDetailedStatus(args: GetOrganizationConfigRuleDetailedStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetOrganizationConfigRuleDetailedStatusCommandOutput>;
|
|
871
436
|
getOrganizationConfigRuleDetailedStatus(args: GetOrganizationConfigRuleDetailedStatusCommandInput, cb: (err: any, data?: GetOrganizationConfigRuleDetailedStatusCommandOutput) => void): void;
|
|
872
437
|
getOrganizationConfigRuleDetailedStatus(args: GetOrganizationConfigRuleDetailedStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrganizationConfigRuleDetailedStatusCommandOutput) => void): void;
|
|
873
438
|
/**
|
|
874
|
-
* @
|
|
875
|
-
* <p>Returns detailed status for each member account within an organization for a given organization conformance pack.</p>
|
|
439
|
+
* @see {@link GetOrganizationConformancePackDetailedStatusCommand}
|
|
876
440
|
*/
|
|
877
441
|
getOrganizationConformancePackDetailedStatus(args: GetOrganizationConformancePackDetailedStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetOrganizationConformancePackDetailedStatusCommandOutput>;
|
|
878
442
|
getOrganizationConformancePackDetailedStatus(args: GetOrganizationConformancePackDetailedStatusCommandInput, cb: (err: any, data?: GetOrganizationConformancePackDetailedStatusCommandOutput) => void): void;
|
|
879
443
|
getOrganizationConformancePackDetailedStatus(args: GetOrganizationConformancePackDetailedStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrganizationConformancePackDetailedStatusCommandOutput) => void): void;
|
|
880
444
|
/**
|
|
881
|
-
* @
|
|
882
|
-
* <p>Returns the policy definition containing the logic for your organization Config Custom Policy rule.</p>
|
|
445
|
+
* @see {@link GetOrganizationCustomRulePolicyCommand}
|
|
883
446
|
*/
|
|
884
447
|
getOrganizationCustomRulePolicy(args: GetOrganizationCustomRulePolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetOrganizationCustomRulePolicyCommandOutput>;
|
|
885
448
|
getOrganizationCustomRulePolicy(args: GetOrganizationCustomRulePolicyCommandInput, cb: (err: any, data?: GetOrganizationCustomRulePolicyCommandOutput) => void): void;
|
|
886
449
|
getOrganizationCustomRulePolicy(args: GetOrganizationCustomRulePolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetOrganizationCustomRulePolicyCommandOutput) => void): void;
|
|
887
450
|
/**
|
|
888
|
-
* @
|
|
889
|
-
* <p>Returns a list of <code>ConfigurationItems</code> for the specified resource.
|
|
890
|
-
* The list contains details about each state of the resource
|
|
891
|
-
* during the specified time interval. If you specified a retention
|
|
892
|
-
* period to retain your <code>ConfigurationItems</code> between a
|
|
893
|
-
* minimum of 30 days and a maximum of 7 years (2557 days), Config
|
|
894
|
-
* returns the <code>ConfigurationItems</code> for the specified
|
|
895
|
-
* retention period. </p>
|
|
896
|
-
* <p>The response is paginated. By default, Config returns a
|
|
897
|
-
* limit of 10 configuration items per page. You can customize this
|
|
898
|
-
* number with the <code>limit</code> parameter. The response includes
|
|
899
|
-
* a <code>nextToken</code> string. To get the next page of results,
|
|
900
|
-
* run the request again and specify the string for the
|
|
901
|
-
* <code>nextToken</code> parameter.</p>
|
|
902
|
-
* <note>
|
|
903
|
-
* <p>Each call to the API is limited to span a duration of seven
|
|
904
|
-
* days. It is likely that the number of records returned is
|
|
905
|
-
* smaller than the specified <code>limit</code>. In such cases,
|
|
906
|
-
* you can make another call, using the
|
|
907
|
-
* <code>nextToken</code>.</p>
|
|
908
|
-
* </note>
|
|
451
|
+
* @see {@link GetResourceConfigHistoryCommand}
|
|
909
452
|
*/
|
|
910
453
|
getResourceConfigHistory(args: GetResourceConfigHistoryCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceConfigHistoryCommandOutput>;
|
|
911
454
|
getResourceConfigHistory(args: GetResourceConfigHistoryCommandInput, cb: (err: any, data?: GetResourceConfigHistoryCommandOutput) => void): void;
|
|
912
455
|
getResourceConfigHistory(args: GetResourceConfigHistoryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceConfigHistoryCommandOutput) => void): void;
|
|
913
456
|
/**
|
|
914
|
-
* @
|
|
915
|
-
* <p>Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run.
|
|
916
|
-
* The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated,
|
|
917
|
-
* the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules. </p>
|
|
918
|
-
* <note>
|
|
919
|
-
* <p>To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_GetComplianceDetailsByResource.html">GetComplianceDetailsByResource</a> API.
|
|
920
|
-
* For more information, see the <a href="https://docs.aws.amazon.com/config/latest/APIReference/API_GetResourceEvaluationSummary.html#API_GetResourceEvaluationSummary_Examples">Examples</a> section.</p>
|
|
921
|
-
* </note>
|
|
457
|
+
* @see {@link GetResourceEvaluationSummaryCommand}
|
|
922
458
|
*/
|
|
923
459
|
getResourceEvaluationSummary(args: GetResourceEvaluationSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceEvaluationSummaryCommandOutput>;
|
|
924
460
|
getResourceEvaluationSummary(args: GetResourceEvaluationSummaryCommandInput, cb: (err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void): void;
|
|
925
461
|
getResourceEvaluationSummary(args: GetResourceEvaluationSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void): void;
|
|
926
462
|
/**
|
|
927
|
-
* @
|
|
928
|
-
* <p>Returns the details of a specific stored query.</p>
|
|
463
|
+
* @see {@link GetStoredQueryCommand}
|
|
929
464
|
*/
|
|
930
465
|
getStoredQuery(args: GetStoredQueryCommandInput, options?: __HttpHandlerOptions): Promise<GetStoredQueryCommandOutput>;
|
|
931
466
|
getStoredQuery(args: GetStoredQueryCommandInput, cb: (err: any, data?: GetStoredQueryCommandOutput) => void): void;
|
|
932
467
|
getStoredQuery(args: GetStoredQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStoredQueryCommandOutput) => void): void;
|
|
933
468
|
/**
|
|
934
|
-
* @
|
|
935
|
-
* <p>Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.
|
|
936
|
-
* A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region.
|
|
937
|
-
* You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.</p>
|
|
938
|
-
* <p>For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type <code>AWS::EC2::Instance</code> then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.</p>
|
|
469
|
+
* @see {@link ListAggregateDiscoveredResourcesCommand}
|
|
939
470
|
*/
|
|
940
471
|
listAggregateDiscoveredResources(args: ListAggregateDiscoveredResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListAggregateDiscoveredResourcesCommandOutput>;
|
|
941
472
|
listAggregateDiscoveredResources(args: ListAggregateDiscoveredResourcesCommandInput, cb: (err: any, data?: ListAggregateDiscoveredResourcesCommandOutput) => void): void;
|
|
942
473
|
listAggregateDiscoveredResources(args: ListAggregateDiscoveredResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAggregateDiscoveredResourcesCommandOutput) => void): void;
|
|
943
474
|
/**
|
|
944
|
-
* @
|
|
945
|
-
* <p>Returns a list of conformance pack compliance scores.
|
|
946
|
-
* A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack.
|
|
947
|
-
* This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand
|
|
948
|
-
* the level of compliance in your conformance packs.</p>
|
|
949
|
-
* <note>
|
|
950
|
-
* <p>Conformance packs with no evaluation results will have a compliance score of <code>INSUFFICIENT_DATA</code>.</p>
|
|
951
|
-
* </note>
|
|
475
|
+
* @see {@link ListConformancePackComplianceScoresCommand}
|
|
952
476
|
*/
|
|
953
477
|
listConformancePackComplianceScores(args: ListConformancePackComplianceScoresCommandInput, options?: __HttpHandlerOptions): Promise<ListConformancePackComplianceScoresCommandOutput>;
|
|
954
478
|
listConformancePackComplianceScores(args: ListConformancePackComplianceScoresCommandInput, cb: (err: any, data?: ListConformancePackComplianceScoresCommandOutput) => void): void;
|
|
955
479
|
listConformancePackComplianceScores(args: ListConformancePackComplianceScoresCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListConformancePackComplianceScoresCommandOutput) => void): void;
|
|
956
480
|
/**
|
|
957
|
-
* @
|
|
958
|
-
* <p>Accepts a resource type and returns a list of resource
|
|
959
|
-
* identifiers for the resources of that type. A resource identifier
|
|
960
|
-
* includes the resource type, ID, and (if available) the custom
|
|
961
|
-
* resource name. The results consist of resources that Config has
|
|
962
|
-
* discovered, including those that Config is not currently
|
|
963
|
-
* recording. You can narrow the results to include only resources that
|
|
964
|
-
* have specific resource IDs or a resource name.</p>
|
|
965
|
-
* <note>
|
|
966
|
-
* <p>You can specify either resource IDs or a resource name, but
|
|
967
|
-
* not both, in the same request.</p>
|
|
968
|
-
* </note>
|
|
969
|
-
* <p>The response is paginated. By default, Config lists 100
|
|
970
|
-
* resource identifiers on each page. You can customize this number
|
|
971
|
-
* with the <code>limit</code> parameter. The response includes a
|
|
972
|
-
* <code>nextToken</code> string. To get the next page of results,
|
|
973
|
-
* run the request again and specify the string for the
|
|
974
|
-
* <code>nextToken</code> parameter.</p>
|
|
481
|
+
* @see {@link ListDiscoveredResourcesCommand}
|
|
975
482
|
*/
|
|
976
483
|
listDiscoveredResources(args: ListDiscoveredResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListDiscoveredResourcesCommandOutput>;
|
|
977
484
|
listDiscoveredResources(args: ListDiscoveredResourcesCommandInput, cb: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void): void;
|
|
978
485
|
listDiscoveredResources(args: ListDiscoveredResourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDiscoveredResourcesCommandOutput) => void): void;
|
|
979
486
|
/**
|
|
980
|
-
* @
|
|
981
|
-
* <p>Returns a list of proactive resource evaluations.</p>
|
|
487
|
+
* @see {@link ListResourceEvaluationsCommand}
|
|
982
488
|
*/
|
|
983
489
|
listResourceEvaluations(args: ListResourceEvaluationsCommandInput, options?: __HttpHandlerOptions): Promise<ListResourceEvaluationsCommandOutput>;
|
|
984
490
|
listResourceEvaluations(args: ListResourceEvaluationsCommandInput, cb: (err: any, data?: ListResourceEvaluationsCommandOutput) => void): void;
|
|
985
491
|
listResourceEvaluations(args: ListResourceEvaluationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourceEvaluationsCommandOutput) => void): void;
|
|
986
492
|
/**
|
|
987
|
-
* @
|
|
988
|
-
* <p>Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100. </p>
|
|
493
|
+
* @see {@link ListStoredQueriesCommand}
|
|
989
494
|
*/
|
|
990
495
|
listStoredQueries(args: ListStoredQueriesCommandInput, options?: __HttpHandlerOptions): Promise<ListStoredQueriesCommandOutput>;
|
|
991
496
|
listStoredQueries(args: ListStoredQueriesCommandInput, cb: (err: any, data?: ListStoredQueriesCommandOutput) => void): void;
|
|
992
497
|
listStoredQueries(args: ListStoredQueriesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStoredQueriesCommandOutput) => void): void;
|
|
993
498
|
/**
|
|
994
|
-
* @
|
|
995
|
-
* <p>List the tags for Config resource.</p>
|
|
499
|
+
* @see {@link ListTagsForResourceCommand}
|
|
996
500
|
*/
|
|
997
501
|
listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
|
|
998
502
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
999
503
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
1000
504
|
/**
|
|
1001
|
-
* @
|
|
1002
|
-
* <p>Authorizes the aggregator account and region to collect data
|
|
1003
|
-
* from the source account and region. </p>
|
|
1004
|
-
* <note>
|
|
1005
|
-
* <p>
|
|
1006
|
-
* <code>PutAggregationAuthorization</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different <code>tags</code> values,
|
|
1007
|
-
* Config will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>tags</code> will not be updated, even if they are different.</p>
|
|
1008
|
-
* </note>
|
|
505
|
+
* @see {@link PutAggregationAuthorizationCommand}
|
|
1009
506
|
*/
|
|
1010
507
|
putAggregationAuthorization(args: PutAggregationAuthorizationCommandInput, options?: __HttpHandlerOptions): Promise<PutAggregationAuthorizationCommandOutput>;
|
|
1011
508
|
putAggregationAuthorization(args: PutAggregationAuthorizationCommandInput, cb: (err: any, data?: PutAggregationAuthorizationCommandOutput) => void): void;
|
|
1012
509
|
putAggregationAuthorization(args: PutAggregationAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAggregationAuthorizationCommandOutput) => void): void;
|
|
1013
510
|
/**
|
|
1014
|
-
* @
|
|
1015
|
-
* <p>Adds or updates an Config rule to evaluate if your
|
|
1016
|
-
* Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account,
|
|
1017
|
-
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
1018
|
-
* <b>Service Limits</b>
|
|
1019
|
-
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
1020
|
-
* <p>There are two types of rules: <i>Config Managed Rules</i> and <i>Config Custom Rules</i>.
|
|
1021
|
-
* You can use <code>PutConfigRule</code> to create both Config Managed Rules and Config Custom Rules.</p>
|
|
1022
|
-
* <p>Config Managed Rules are predefined,
|
|
1023
|
-
* customizable rules created by Config. For a list of managed rules, see
|
|
1024
|
-
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
|
|
1025
|
-
* Managed Rules</a>. If you are adding an Config managed rule, you must specify the
|
|
1026
|
-
* rule's identifier for the <code>SourceIdentifier</code> key.</p>
|
|
1027
|
-
* <p>Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions
|
|
1028
|
-
* (<a href="https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function"> Lambda Developer Guide</a>) and with Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
|
|
1029
|
-
* Repository</a>), a policy-as-code language.
|
|
1030
|
-
*
|
|
1031
|
-
* Config custom rules created with Lambda
|
|
1032
|
-
* are called <i>Config Custom Lambda Rules</i> and Config custom rules created with
|
|
1033
|
-
* Guard are called <i>Config Custom Policy Rules</i>.</p>
|
|
1034
|
-
* <p>If you are adding a new Config Custom Lambda rule,
|
|
1035
|
-
* you first need to create an Lambda function that the rule invokes to evaluate
|
|
1036
|
-
* your resources. When you use <code>PutConfigRule</code> to add a Custom Lambda rule to Config, you must specify the Amazon Resource
|
|
1037
|
-
* Name (ARN) that Lambda assigns to the function. You specify the ARN
|
|
1038
|
-
* in the <code>SourceIdentifier</code> key. This key is part of the
|
|
1039
|
-
* <code>Source</code> object, which is part of the
|
|
1040
|
-
* <code>ConfigRule</code> object. </p>
|
|
1041
|
-
* <p>For any new Config rule that you add, specify the
|
|
1042
|
-
* <code>ConfigRuleName</code> in the <code>ConfigRule</code>
|
|
1043
|
-
* object. Do not specify the <code>ConfigRuleArn</code> or the
|
|
1044
|
-
* <code>ConfigRuleId</code>. These values are generated by Config for new rules.</p>
|
|
1045
|
-
* <p>If you are updating a rule that you added previously, you can
|
|
1046
|
-
* specify the rule by <code>ConfigRuleName</code>,
|
|
1047
|
-
* <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the
|
|
1048
|
-
* <code>ConfigRule</code> data type that you use in this
|
|
1049
|
-
* request.</p>
|
|
1050
|
-
* <p>For more information about developing and using Config
|
|
1051
|
-
* rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating Resources with Config Rules</a>
|
|
1052
|
-
* in the <i>Config Developer Guide</i>.</p>
|
|
1053
|
-
* <note>
|
|
1054
|
-
* <p>
|
|
1055
|
-
* <code>PutConfigRule</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different <code>tags</code> values,
|
|
1056
|
-
* Config will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>tags</code> will not be updated, even if they are different.</p>
|
|
1057
|
-
* </note>
|
|
511
|
+
* @see {@link PutConfigRuleCommand}
|
|
1058
512
|
*/
|
|
1059
513
|
putConfigRule(args: PutConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<PutConfigRuleCommandOutput>;
|
|
1060
514
|
putConfigRule(args: PutConfigRuleCommandInput, cb: (err: any, data?: PutConfigRuleCommandOutput) => void): void;
|
|
1061
515
|
putConfigRule(args: PutConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigRuleCommandOutput) => void): void;
|
|
1062
516
|
/**
|
|
1063
|
-
* @
|
|
1064
|
-
* <p>Creates and updates the configuration aggregator with the
|
|
1065
|
-
* selected source accounts and regions. The source account can be
|
|
1066
|
-
* individual account(s) or an organization.</p>
|
|
1067
|
-
* <p>
|
|
1068
|
-
* <code>accountIds</code> that are passed will be replaced with existing accounts.
|
|
1069
|
-
* If you want to add additional accounts into the aggregator, call <code>DescribeConfigurationAggregators</code> to get the previous accounts and then append new ones.</p>
|
|
1070
|
-
* <note>
|
|
1071
|
-
* <p>Config should be enabled in source accounts and regions
|
|
1072
|
-
* you want to aggregate.</p>
|
|
1073
|
-
* <p>If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization.
|
|
1074
|
-
* If the caller is a management account, Config calls <code>EnableAwsServiceAccess</code> API to enable integration between Config and Organizations.
|
|
1075
|
-
* If the caller is a registered delegated administrator, Config calls <code>ListDelegatedAdministrators</code> API to verify whether the caller is a valid delegated administrator.</p>
|
|
1076
|
-
* <p>To register a delegated administrator, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli">Register a Delegated Administrator</a> in the <i>Config developer guide</i>. </p>
|
|
1077
|
-
* </note>
|
|
1078
|
-
* <note>
|
|
1079
|
-
* <p>
|
|
1080
|
-
* <code>PutConfigurationAggregator</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different <code>tags</code> values,
|
|
1081
|
-
* Config will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>tags</code> will not be updated, even if they are different.</p>
|
|
1082
|
-
* </note>
|
|
517
|
+
* @see {@link PutConfigurationAggregatorCommand}
|
|
1083
518
|
*/
|
|
1084
519
|
putConfigurationAggregator(args: PutConfigurationAggregatorCommandInput, options?: __HttpHandlerOptions): Promise<PutConfigurationAggregatorCommandOutput>;
|
|
1085
520
|
putConfigurationAggregator(args: PutConfigurationAggregatorCommandInput, cb: (err: any, data?: PutConfigurationAggregatorCommandOutput) => void): void;
|
|
1086
521
|
putConfigurationAggregator(args: PutConfigurationAggregatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationAggregatorCommandOutput) => void): void;
|
|
1087
522
|
/**
|
|
1088
|
-
* @
|
|
1089
|
-
* <p>Creates a new configuration recorder to record the selected
|
|
1090
|
-
* resource configurations.</p>
|
|
1091
|
-
* <p>You can use this action to change the role <code>roleARN</code>
|
|
1092
|
-
* or the <code>recordingGroup</code> of an existing recorder. To
|
|
1093
|
-
* change the role, call the action on the existing configuration
|
|
1094
|
-
* recorder and specify a role.</p>
|
|
1095
|
-
* <note>
|
|
1096
|
-
* <p>Currently, you can specify only one configuration recorder
|
|
1097
|
-
* per region in your account.</p>
|
|
1098
|
-
* <p>If <code>ConfigurationRecorder</code> does not have the
|
|
1099
|
-
* <b>recordingGroup</b> parameter
|
|
1100
|
-
* specified, the default is to record all supported resource
|
|
1101
|
-
* types.</p>
|
|
1102
|
-
* </note>
|
|
523
|
+
* @see {@link PutConfigurationRecorderCommand}
|
|
1103
524
|
*/
|
|
1104
525
|
putConfigurationRecorder(args: PutConfigurationRecorderCommandInput, options?: __HttpHandlerOptions): Promise<PutConfigurationRecorderCommandOutput>;
|
|
1105
526
|
putConfigurationRecorder(args: PutConfigurationRecorderCommandInput, cb: (err: any, data?: PutConfigurationRecorderCommandOutput) => void): void;
|
|
1106
527
|
putConfigurationRecorder(args: PutConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConfigurationRecorderCommandOutput) => void): void;
|
|
1107
528
|
/**
|
|
1108
|
-
* @
|
|
1109
|
-
* <p>Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization.
|
|
1110
|
-
* For information on how many conformance packs you can have per account,
|
|
1111
|
-
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
1112
|
-
* <b>Service Limits</b>
|
|
1113
|
-
* </a> in the Config Developer Guide.</p>
|
|
1114
|
-
* <p>This API creates a service-linked role <code>AWSServiceRoleForConfigConforms</code> in your account.
|
|
1115
|
-
* The service-linked role is created only when the role does not exist in your account. </p>
|
|
1116
|
-
* <note>
|
|
1117
|
-
* <p>You must specify only one of the follow parameters: <code>TemplateS3Uri</code>, <code>TemplateBody</code> or <code>TemplateSSMDocumentDetails</code>.</p>
|
|
1118
|
-
* </note>
|
|
529
|
+
* @see {@link PutConformancePackCommand}
|
|
1119
530
|
*/
|
|
1120
531
|
putConformancePack(args: PutConformancePackCommandInput, options?: __HttpHandlerOptions): Promise<PutConformancePackCommandOutput>;
|
|
1121
532
|
putConformancePack(args: PutConformancePackCommandInput, cb: (err: any, data?: PutConformancePackCommandOutput) => void): void;
|
|
1122
533
|
putConformancePack(args: PutConformancePackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutConformancePackCommandOutput) => void): void;
|
|
1123
534
|
/**
|
|
1124
|
-
* @
|
|
1125
|
-
* <p>Creates a delivery channel object to deliver configuration
|
|
1126
|
-
* information to an Amazon S3 bucket and Amazon SNS topic.</p>
|
|
1127
|
-
* <p>Before you can create a delivery channel, you must create a
|
|
1128
|
-
* configuration recorder.</p>
|
|
1129
|
-
* <p>You can use this action to change the Amazon S3 bucket or an
|
|
1130
|
-
* Amazon SNS topic of the existing delivery channel. To change the
|
|
1131
|
-
* Amazon S3 bucket or an Amazon SNS topic, call this action and
|
|
1132
|
-
* specify the changed values for the S3 bucket and the SNS topic. If
|
|
1133
|
-
* you specify a different value for either the S3 bucket or the SNS
|
|
1134
|
-
* topic, this action will keep the existing value for the parameter
|
|
1135
|
-
* that is not changed.</p>
|
|
1136
|
-
* <note>
|
|
1137
|
-
* <p>You can have only one delivery channel per region in your
|
|
1138
|
-
* account.</p>
|
|
1139
|
-
* </note>
|
|
535
|
+
* @see {@link PutDeliveryChannelCommand}
|
|
1140
536
|
*/
|
|
1141
537
|
putDeliveryChannel(args: PutDeliveryChannelCommandInput, options?: __HttpHandlerOptions): Promise<PutDeliveryChannelCommandOutput>;
|
|
1142
538
|
putDeliveryChannel(args: PutDeliveryChannelCommandInput, cb: (err: any, data?: PutDeliveryChannelCommandOutput) => void): void;
|
|
1143
539
|
putDeliveryChannel(args: PutDeliveryChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutDeliveryChannelCommandOutput) => void): void;
|
|
1144
540
|
/**
|
|
1145
|
-
* @
|
|
1146
|
-
* <p>Used by an Lambda function to deliver evaluation results to
|
|
1147
|
-
* Config. This action is required in every Lambda function
|
|
1148
|
-
* that is invoked by an Config rule.</p>
|
|
541
|
+
* @see {@link PutEvaluationsCommand}
|
|
1149
542
|
*/
|
|
1150
543
|
putEvaluations(args: PutEvaluationsCommandInput, options?: __HttpHandlerOptions): Promise<PutEvaluationsCommandOutput>;
|
|
1151
544
|
putEvaluations(args: PutEvaluationsCommandInput, cb: (err: any, data?: PutEvaluationsCommandOutput) => void): void;
|
|
1152
545
|
putEvaluations(args: PutEvaluationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutEvaluationsCommandOutput) => void): void;
|
|
1153
546
|
/**
|
|
1154
|
-
* @
|
|
1155
|
-
* <p>Add or updates the evaluations for process checks.
|
|
1156
|
-
* This API checks if the rule is a process check when the name of the Config rule is provided.</p>
|
|
547
|
+
* @see {@link PutExternalEvaluationCommand}
|
|
1157
548
|
*/
|
|
1158
549
|
putExternalEvaluation(args: PutExternalEvaluationCommandInput, options?: __HttpHandlerOptions): Promise<PutExternalEvaluationCommandOutput>;
|
|
1159
550
|
putExternalEvaluation(args: PutExternalEvaluationCommandInput, cb: (err: any, data?: PutExternalEvaluationCommandOutput) => void): void;
|
|
1160
551
|
putExternalEvaluation(args: PutExternalEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutExternalEvaluationCommandOutput) => void): void;
|
|
1161
552
|
/**
|
|
1162
|
-
* @
|
|
1163
|
-
* <p>Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your
|
|
1164
|
-
* desired configurations. For information on how many organization Config rules you can have per account,
|
|
1165
|
-
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
1166
|
-
* <b>Service Limits</b>
|
|
1167
|
-
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
1168
|
-
* <p> Only a management account and a delegated administrator can create or update an organization Config rule.
|
|
1169
|
-
* When calling this API with a delegated administrator, you must ensure Organizations
|
|
1170
|
-
* <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
|
|
1171
|
-
* <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service-linked
|
|
1172
|
-
* role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the management or delegated administrator account of your organization.
|
|
1173
|
-
* The service-linked role is created only when the role does not exist in the caller account.
|
|
1174
|
-
* Config verifies the existence of role with <code>GetRole</code> action.</p>
|
|
1175
|
-
* <p>To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
|
|
1176
|
-
* <code>register-delegated-administrator</code> for <code>config-multiaccountsetup.amazonaws.com</code>. </p>
|
|
1177
|
-
* <p>There are two types of rules: <i>Config Managed Rules</i> and <i>Config Custom Rules</i>.
|
|
1178
|
-
* You can use <code>PutOrganizationConfigRule</code> to create both Config Managed Rules and Config Custom Rules.</p>
|
|
1179
|
-
* <p>Config Managed Rules are predefined,
|
|
1180
|
-
* customizable rules created by Config. For a list of managed rules, see
|
|
1181
|
-
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
|
|
1182
|
-
* Managed Rules</a>. If you are adding an Config managed rule, you must specify the rule's identifier for the <code>RuleIdentifier</code> key.</p>
|
|
1183
|
-
* <p>Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions
|
|
1184
|
-
* (<a href="https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function"> Lambda Developer Guide</a>) and with Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
|
|
1185
|
-
* Repository</a>), a policy-as-code language.
|
|
1186
|
-
*
|
|
1187
|
-
* Config custom rules created with Lambda
|
|
1188
|
-
* are called <i>Config Custom Lambda Rules</i> and Config custom rules created with
|
|
1189
|
-
* Guard are called <i>Config Custom Policy Rules</i>.</p>
|
|
1190
|
-
* <p>If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function in the management account or a delegated
|
|
1191
|
-
* administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function.
|
|
1192
|
-
* When you use <code>PutOrganizationConfigRule</code> to add a Custom Lambda rule to Config, you must
|
|
1193
|
-
* specify the Amazon Resource Name (ARN) that Lambda assigns to the function.</p>
|
|
1194
|
-
* <note>
|
|
1195
|
-
* <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p>
|
|
1196
|
-
* <p>Make sure to specify one of either <code>OrganizationCustomPolicyRuleMetadata</code> for Custom Policy rules, <code>OrganizationCustomRuleMetadata</code> for Custom Lambda rules, or <code>OrganizationManagedRuleMetadata</code> for managed rules.</p>
|
|
1197
|
-
* </note>
|
|
553
|
+
* @see {@link PutOrganizationConfigRuleCommand}
|
|
1198
554
|
*/
|
|
1199
555
|
putOrganizationConfigRule(args: PutOrganizationConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<PutOrganizationConfigRuleCommandOutput>;
|
|
1200
556
|
putOrganizationConfigRule(args: PutOrganizationConfigRuleCommandInput, cb: (err: any, data?: PutOrganizationConfigRuleCommandOutput) => void): void;
|
|
1201
557
|
putOrganizationConfigRule(args: PutOrganizationConfigRuleCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutOrganizationConfigRuleCommandOutput) => void): void;
|
|
1202
558
|
/**
|
|
1203
|
-
* @
|
|
1204
|
-
* <p>Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account,
|
|
1205
|
-
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
1206
|
-
* <b>Service Limits</b>
|
|
1207
|
-
* </a> in the Config Developer Guide.</p>
|
|
1208
|
-
* <p>Only a management account and a delegated administrator can call this API.
|
|
1209
|
-
* When calling this API with a delegated administrator, you must ensure Organizations
|
|
1210
|
-
* <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
|
|
1211
|
-
* <p>This API enables organization service access for <code>config-multiaccountsetup.amazonaws.com</code>
|
|
1212
|
-
* through the <code>EnableAWSServiceAccess</code> action and creates a
|
|
1213
|
-
* service-linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the management or delegated administrator account of your organization.
|
|
1214
|
-
* The service-linked role is created only when the role does not exist in the caller account.
|
|
1215
|
-
* To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
|
|
1216
|
-
* <code>register-delegate-admin</code> for <code>config-multiaccountsetup.amazonaws.com</code>.</p>
|
|
1217
|
-
* <note>
|
|
1218
|
-
* <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p>
|
|
1219
|
-
* <p>You must specify either the <code>TemplateS3Uri</code> or the <code>TemplateBody</code> parameter, but not both.
|
|
1220
|
-
* If you provide both Config uses the <code>TemplateS3Uri</code> parameter and ignores the <code>TemplateBody</code> parameter.</p>
|
|
1221
|
-
* <p>Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated.
|
|
1222
|
-
* You cannot update a conformance pack while it is in this state.</p>
|
|
1223
|
-
* </note>
|
|
559
|
+
* @see {@link PutOrganizationConformancePackCommand}
|
|
1224
560
|
*/
|
|
1225
561
|
putOrganizationConformancePack(args: PutOrganizationConformancePackCommandInput, options?: __HttpHandlerOptions): Promise<PutOrganizationConformancePackCommandOutput>;
|
|
1226
562
|
putOrganizationConformancePack(args: PutOrganizationConformancePackCommandInput, cb: (err: any, data?: PutOrganizationConformancePackCommandOutput) => void): void;
|
|
1227
563
|
putOrganizationConformancePack(args: PutOrganizationConformancePackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutOrganizationConformancePackCommandOutput) => void): void;
|
|
1228
564
|
/**
|
|
1229
|
-
* @
|
|
1230
|
-
* <p>Adds or updates the remediation configuration with a specific Config rule with the
|
|
1231
|
-
* selected target or action.
|
|
1232
|
-
* The API creates the <code>RemediationConfiguration</code> object for the Config rule.
|
|
1233
|
-
* The Config rule must already exist for you to add a remediation configuration.
|
|
1234
|
-
* The target (SSM document) must exist and have permissions to use the target. </p>
|
|
1235
|
-
* <note>
|
|
1236
|
-
* <p>If you make backward incompatible changes to the SSM document,
|
|
1237
|
-
* you must call this again to ensure the remediations can run.</p>
|
|
1238
|
-
* <p>This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules,
|
|
1239
|
-
* the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.</p>
|
|
1240
|
-
* </note>
|
|
1241
|
-
* <note>
|
|
1242
|
-
* <p>For manual remediation configuration, you need to provide a value for <code>automationAssumeRole</code> or use a value in the <code>assumeRole</code>field to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.</p>
|
|
1243
|
-
* <p>However, for automatic remediation configuration, the only valid <code>assumeRole</code> field value is <code>AutomationAssumeRole</code> and you need to provide a value for <code>AutomationAssumeRole</code> to remediate your resources.</p>
|
|
1244
|
-
* </note>
|
|
565
|
+
* @see {@link PutRemediationConfigurationsCommand}
|
|
1245
566
|
*/
|
|
1246
567
|
putRemediationConfigurations(args: PutRemediationConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<PutRemediationConfigurationsCommandOutput>;
|
|
1247
568
|
putRemediationConfigurations(args: PutRemediationConfigurationsCommandInput, cb: (err: any, data?: PutRemediationConfigurationsCommandOutput) => void): void;
|
|
1248
569
|
putRemediationConfigurations(args: PutRemediationConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRemediationConfigurationsCommandOutput) => void): void;
|
|
1249
570
|
/**
|
|
1250
|
-
* @
|
|
1251
|
-
* <p>A remediation exception is when a specified resource is no longer considered for auto-remediation.
|
|
1252
|
-
* This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule. </p>
|
|
1253
|
-
* <note>
|
|
1254
|
-
* <p>Config generates a remediation exception when a problem occurs running a remediation action for a specified resource.
|
|
1255
|
-
* Remediation exceptions blocks auto-remediation until the exception is cleared.</p>
|
|
1256
|
-
* </note>
|
|
1257
|
-
* <note>
|
|
1258
|
-
* <p>When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until
|
|
1259
|
-
* the given Config rule for the specified resource evaluates the resource as <code>NON_COMPLIANT</code>.
|
|
1260
|
-
* Once the resource has been evaluated as <code>NON_COMPLIANT</code>, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation.
|
|
1261
|
-
* Otherwise, using auto-remediation before a <code>NON_COMPLIANT</code> evaluation result can delete resources before the exception is applied.</p>
|
|
1262
|
-
* </note>
|
|
1263
|
-
* <note>
|
|
1264
|
-
* <p>Placing an exception can only be performed on resources that are <code>NON_COMPLIANT</code>.
|
|
1265
|
-
* If you use this API for <code>COMPLIANT</code> resources or resources that are <code>NOT_APPLICABLE</code>, a remediation exception will not be generated.
|
|
1266
|
-
* For more information on the conditions that initiate the possible Config evaluation results,
|
|
1267
|
-
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#aws-config-rules">Concepts | Config Rules</a> in the Config Developer Guide.</p>
|
|
1268
|
-
* </note>
|
|
571
|
+
* @see {@link PutRemediationExceptionsCommand}
|
|
1269
572
|
*/
|
|
1270
573
|
putRemediationExceptions(args: PutRemediationExceptionsCommandInput, options?: __HttpHandlerOptions): Promise<PutRemediationExceptionsCommandOutput>;
|
|
1271
574
|
putRemediationExceptions(args: PutRemediationExceptionsCommandInput, cb: (err: any, data?: PutRemediationExceptionsCommandOutput) => void): void;
|
|
1272
575
|
putRemediationExceptions(args: PutRemediationExceptionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRemediationExceptionsCommandOutput) => void): void;
|
|
1273
576
|
/**
|
|
1274
|
-
* @
|
|
1275
|
-
* <p>Records the configuration state for the resource provided in the request.
|
|
1276
|
-
*
|
|
1277
|
-
* The configuration state of a resource is represented in Config as Configuration Items.
|
|
1278
|
-
* Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs. </p>
|
|
1279
|
-
* <note>
|
|
1280
|
-
* <p>The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.</p>
|
|
1281
|
-
* <p>When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
|
|
1282
|
-
* </p>
|
|
1283
|
-
* <p>Write-only schema properites are not recorded as part of the published configuration item.</p>
|
|
1284
|
-
* </note>
|
|
577
|
+
* @see {@link PutResourceConfigCommand}
|
|
1285
578
|
*/
|
|
1286
579
|
putResourceConfig(args: PutResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<PutResourceConfigCommandOutput>;
|
|
1287
580
|
putResourceConfig(args: PutResourceConfigCommandInput, cb: (err: any, data?: PutResourceConfigCommandOutput) => void): void;
|
|
1288
581
|
putResourceConfig(args: PutResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutResourceConfigCommandOutput) => void): void;
|
|
1289
582
|
/**
|
|
1290
|
-
* @
|
|
1291
|
-
* <p>Creates and updates the retention configuration with details
|
|
1292
|
-
* about retention period (number of days) that Config stores your
|
|
1293
|
-
* historical information. The API creates the
|
|
1294
|
-
* <code>RetentionConfiguration</code> object and names the object
|
|
1295
|
-
* as <b>default</b>. When you have a
|
|
1296
|
-
* <code>RetentionConfiguration</code> object named <b>default</b>, calling the API modifies the
|
|
1297
|
-
* default object. </p>
|
|
1298
|
-
* <note>
|
|
1299
|
-
* <p>Currently, Config supports only one retention
|
|
1300
|
-
* configuration per region in your account.</p>
|
|
1301
|
-
* </note>
|
|
583
|
+
* @see {@link PutRetentionConfigurationCommand}
|
|
1302
584
|
*/
|
|
1303
585
|
putRetentionConfiguration(args: PutRetentionConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutRetentionConfigurationCommandOutput>;
|
|
1304
586
|
putRetentionConfiguration(args: PutRetentionConfigurationCommandInput, cb: (err: any, data?: PutRetentionConfigurationCommandOutput) => void): void;
|
|
1305
587
|
putRetentionConfiguration(args: PutRetentionConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRetentionConfigurationCommandOutput) => void): void;
|
|
1306
588
|
/**
|
|
1307
|
-
* @
|
|
1308
|
-
* <p>Saves a new query or updates an existing saved query. The <code>QueryName</code> must be unique for a single Amazon Web Services account and a single Amazon Web Services Region.
|
|
1309
|
-
* You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.</p>
|
|
1310
|
-
* <note>
|
|
1311
|
-
* <p>
|
|
1312
|
-
* <code>PutStoredQuery</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different <code>tags</code> values,
|
|
1313
|
-
* Config will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>tags</code> will not be updated, even if they are different.</p>
|
|
1314
|
-
* </note>
|
|
589
|
+
* @see {@link PutStoredQueryCommand}
|
|
1315
590
|
*/
|
|
1316
591
|
putStoredQuery(args: PutStoredQueryCommandInput, options?: __HttpHandlerOptions): Promise<PutStoredQueryCommandOutput>;
|
|
1317
592
|
putStoredQuery(args: PutStoredQueryCommandInput, cb: (err: any, data?: PutStoredQueryCommandOutput) => void): void;
|
|
1318
593
|
putStoredQuery(args: PutStoredQueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutStoredQueryCommandOutput) => void): void;
|
|
1319
594
|
/**
|
|
1320
|
-
* @
|
|
1321
|
-
* <p>Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions,
|
|
1322
|
-
* performs the corresponding search, and returns resource configurations matching the properties.</p>
|
|
1323
|
-
* <p>For more information about query components, see the
|
|
1324
|
-
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html">
|
|
1325
|
-
* <b>Query Components</b>
|
|
1326
|
-
* </a> section in the Config Developer Guide.</p>
|
|
1327
|
-
* <note>
|
|
1328
|
-
* <p>If you run an aggregation query (i.e., using <code>GROUP BY</code> or using aggregate functions such as <code>COUNT</code>; e.g., <code>SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId</code>)
|
|
1329
|
-
* and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 500.</p>
|
|
1330
|
-
* <p>If you run a non-aggregation query (i.e., not using <code>GROUP BY</code> or aggregate function; e.g., <code>SELECT * WHERE resourceType = 'AWS::IAM::Role'</code>)
|
|
1331
|
-
* and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 25.</p>
|
|
1332
|
-
* </note>
|
|
595
|
+
* @see {@link SelectAggregateResourceConfigCommand}
|
|
1333
596
|
*/
|
|
1334
597
|
selectAggregateResourceConfig(args: SelectAggregateResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<SelectAggregateResourceConfigCommandOutput>;
|
|
1335
598
|
selectAggregateResourceConfig(args: SelectAggregateResourceConfigCommandInput, cb: (err: any, data?: SelectAggregateResourceConfigCommandOutput) => void): void;
|
|
1336
599
|
selectAggregateResourceConfig(args: SelectAggregateResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SelectAggregateResourceConfigCommandOutput) => void): void;
|
|
1337
600
|
/**
|
|
1338
|
-
* @
|
|
1339
|
-
* <p>Accepts a structured query language (SQL) <code>SELECT</code> command, performs the corresponding search, and returns resource configurations matching the properties.</p>
|
|
1340
|
-
* <p>For more information about query components, see the
|
|
1341
|
-
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html">
|
|
1342
|
-
* <b>Query Components</b>
|
|
1343
|
-
* </a> section in the <i>Config Developer Guide</i>.</p>
|
|
601
|
+
* @see {@link SelectResourceConfigCommand}
|
|
1344
602
|
*/
|
|
1345
603
|
selectResourceConfig(args: SelectResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<SelectResourceConfigCommandOutput>;
|
|
1346
604
|
selectResourceConfig(args: SelectResourceConfigCommandInput, cb: (err: any, data?: SelectResourceConfigCommandOutput) => void): void;
|
|
1347
605
|
selectResourceConfig(args: SelectResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SelectResourceConfigCommandOutput) => void): void;
|
|
1348
606
|
/**
|
|
1349
|
-
* @
|
|
1350
|
-
* <p>Runs an on-demand evaluation for the specified Config rules
|
|
1351
|
-
* against the last known configuration state of the resources. Use
|
|
1352
|
-
* <code>StartConfigRulesEvaluation</code> when you want to test
|
|
1353
|
-
* that a rule you updated is working as expected.
|
|
1354
|
-
* <code>StartConfigRulesEvaluation</code> does not re-record the
|
|
1355
|
-
* latest configuration state for your resources. It re-runs an
|
|
1356
|
-
* evaluation against the last known state of your resources. </p>
|
|
1357
|
-
* <p>You can specify up to 25 Config rules per request. </p>
|
|
1358
|
-
* <p>An existing <code>StartConfigRulesEvaluation</code> call for
|
|
1359
|
-
* the specified rules must complete before you can call the API again.
|
|
1360
|
-
* If you chose to have Config stream to an Amazon SNS topic, you
|
|
1361
|
-
* will receive a <code>ConfigRuleEvaluationStarted</code> notification
|
|
1362
|
-
* when the evaluation starts.</p>
|
|
1363
|
-
* <note>
|
|
1364
|
-
* <p>You don't need to call the
|
|
1365
|
-
* <code>StartConfigRulesEvaluation</code> API to run an
|
|
1366
|
-
* evaluation for a new rule. When you create a rule, Config
|
|
1367
|
-
* evaluates your resources against the rule automatically.
|
|
1368
|
-
* </p>
|
|
1369
|
-
* </note>
|
|
1370
|
-
* <p>The <code>StartConfigRulesEvaluation</code> API is useful if
|
|
1371
|
-
* you want to run on-demand evaluations, such as the following
|
|
1372
|
-
* example:</p>
|
|
1373
|
-
* <ol>
|
|
1374
|
-
* <li>
|
|
1375
|
-
* <p>You have a custom rule that evaluates your IAM
|
|
1376
|
-
* resources every 24 hours.</p>
|
|
1377
|
-
* </li>
|
|
1378
|
-
* <li>
|
|
1379
|
-
* <p>You update your Lambda function to add additional
|
|
1380
|
-
* conditions to your rule.</p>
|
|
1381
|
-
* </li>
|
|
1382
|
-
* <li>
|
|
1383
|
-
* <p>Instead of waiting for the next periodic evaluation,
|
|
1384
|
-
* you call the <code>StartConfigRulesEvaluation</code>
|
|
1385
|
-
* API.</p>
|
|
1386
|
-
* </li>
|
|
1387
|
-
* <li>
|
|
1388
|
-
* <p>Config invokes your Lambda function and evaluates
|
|
1389
|
-
* your IAM resources.</p>
|
|
1390
|
-
* </li>
|
|
1391
|
-
* <li>
|
|
1392
|
-
* <p>Your custom rule will still run periodic evaluations
|
|
1393
|
-
* every 24 hours.</p>
|
|
1394
|
-
* </li>
|
|
1395
|
-
* </ol>
|
|
607
|
+
* @see {@link StartConfigRulesEvaluationCommand}
|
|
1396
608
|
*/
|
|
1397
609
|
startConfigRulesEvaluation(args: StartConfigRulesEvaluationCommandInput, options?: __HttpHandlerOptions): Promise<StartConfigRulesEvaluationCommandOutput>;
|
|
1398
610
|
startConfigRulesEvaluation(args: StartConfigRulesEvaluationCommandInput, cb: (err: any, data?: StartConfigRulesEvaluationCommandOutput) => void): void;
|
|
1399
611
|
startConfigRulesEvaluation(args: StartConfigRulesEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartConfigRulesEvaluationCommandOutput) => void): void;
|
|
1400
612
|
/**
|
|
1401
|
-
* @
|
|
1402
|
-
* <p>Starts recording configurations of the Amazon Web Services resources you have
|
|
1403
|
-
* selected to record in your Amazon Web Services account.</p>
|
|
1404
|
-
* <p>You must have created at least one delivery channel to
|
|
1405
|
-
* successfully start the configuration recorder.</p>
|
|
613
|
+
* @see {@link StartConfigurationRecorderCommand}
|
|
1406
614
|
*/
|
|
1407
615
|
startConfigurationRecorder(args: StartConfigurationRecorderCommandInput, options?: __HttpHandlerOptions): Promise<StartConfigurationRecorderCommandOutput>;
|
|
1408
616
|
startConfigurationRecorder(args: StartConfigurationRecorderCommandInput, cb: (err: any, data?: StartConfigurationRecorderCommandOutput) => void): void;
|
|
1409
617
|
startConfigurationRecorder(args: StartConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartConfigurationRecorderCommandOutput) => void): void;
|
|
1410
618
|
/**
|
|
1411
|
-
* @
|
|
1412
|
-
* <p>Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.</p>
|
|
1413
|
-
* <p>You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.</p>
|
|
619
|
+
* @see {@link StartRemediationExecutionCommand}
|
|
1414
620
|
*/
|
|
1415
621
|
startRemediationExecution(args: StartRemediationExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartRemediationExecutionCommandOutput>;
|
|
1416
622
|
startRemediationExecution(args: StartRemediationExecutionCommandInput, cb: (err: any, data?: StartRemediationExecutionCommandOutput) => void): void;
|
|
1417
623
|
startRemediationExecution(args: StartRemediationExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartRemediationExecutionCommandOutput) => void): void;
|
|
1418
624
|
/**
|
|
1419
|
-
* @
|
|
1420
|
-
* <p>Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules.
|
|
1421
|
-
* You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all
|
|
1422
|
-
* of the Config rules in your account that match with the specified proactive mode and resource type.</p>
|
|
1423
|
-
* <note>
|
|
1424
|
-
* <p>Ensure you have the <code>cloudformation:DescribeType</code> role setup to validate the resource type schema.</p>
|
|
1425
|
-
* <p>You can find the
|
|
1426
|
-
* <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html">Resource type schema</a> in "<i>Amazon Web Services public extensions</i>" within the CloudFormation registry or with the following CLI commmand:
|
|
1427
|
-
* <code>aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE</code>.</p>
|
|
1428
|
-
* <p>For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view">Managing extensions through the CloudFormation registry</a>
|
|
1429
|
-
* and <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html">Amazon Web Services resource and property types reference</a> in the CloudFormation User Guide.</p>
|
|
1430
|
-
* </note>
|
|
625
|
+
* @see {@link StartResourceEvaluationCommand}
|
|
1431
626
|
*/
|
|
1432
627
|
startResourceEvaluation(args: StartResourceEvaluationCommandInput, options?: __HttpHandlerOptions): Promise<StartResourceEvaluationCommandOutput>;
|
|
1433
628
|
startResourceEvaluation(args: StartResourceEvaluationCommandInput, cb: (err: any, data?: StartResourceEvaluationCommandOutput) => void): void;
|
|
1434
629
|
startResourceEvaluation(args: StartResourceEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartResourceEvaluationCommandOutput) => void): void;
|
|
1435
630
|
/**
|
|
1436
|
-
* @
|
|
1437
|
-
* <p>Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.</p>
|
|
631
|
+
* @see {@link StopConfigurationRecorderCommand}
|
|
1438
632
|
*/
|
|
1439
633
|
stopConfigurationRecorder(args: StopConfigurationRecorderCommandInput, options?: __HttpHandlerOptions): Promise<StopConfigurationRecorderCommandOutput>;
|
|
1440
634
|
stopConfigurationRecorder(args: StopConfigurationRecorderCommandInput, cb: (err: any, data?: StopConfigurationRecorderCommandOutput) => void): void;
|
|
1441
635
|
stopConfigurationRecorder(args: StopConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopConfigurationRecorderCommandOutput) => void): void;
|
|
1442
636
|
/**
|
|
1443
|
-
* @
|
|
1444
|
-
* <p>Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed.
|
|
1445
|
-
* If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.</p>
|
|
637
|
+
* @see {@link TagResourceCommand}
|
|
1446
638
|
*/
|
|
1447
639
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1448
640
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1449
641
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
1450
642
|
/**
|
|
1451
|
-
* @
|
|
1452
|
-
* <p>Deletes specified tags from a resource.</p>
|
|
643
|
+
* @see {@link UntagResourceCommand}
|
|
1453
644
|
*/
|
|
1454
645
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
1455
646
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1456
647
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
1457
648
|
}
|
|
649
|
+
/**
|
|
650
|
+
* @public
|
|
651
|
+
* <fullname>Config</fullname>
|
|
652
|
+
* <p>Config provides a way to keep track of the configurations
|
|
653
|
+
* of all the Amazon Web Services resources associated with your Amazon Web Services account. You can
|
|
654
|
+
* use Config to get the current and historical configurations of
|
|
655
|
+
* each Amazon Web Services resource and also to get information about the relationship
|
|
656
|
+
* between the resources. An Amazon Web Services resource can be an Amazon Compute
|
|
657
|
+
* Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an
|
|
658
|
+
* elastic network Interface (ENI), or a security group. For a complete
|
|
659
|
+
* list of resources currently supported by Config, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources">Supported Amazon Web Services resources</a>.</p>
|
|
660
|
+
* <p>You can access and manage Config through the Amazon Web Services Management
|
|
661
|
+
* Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config
|
|
662
|
+
* API, or the Amazon Web Services SDKs for Config. This reference guide contains
|
|
663
|
+
* documentation for the Config API and the Amazon Web Services CLI commands that
|
|
664
|
+
* you can use to manage Config. The Config API uses the
|
|
665
|
+
* Signature Version 4 protocol for signing requests. For more
|
|
666
|
+
* information about how to sign a request with this protocol, see
|
|
667
|
+
* <a href="https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html">Signature
|
|
668
|
+
* Version 4 Signing Process</a>. For detailed information
|
|
669
|
+
* about Config features and their associated actions or commands,
|
|
670
|
+
* as well as how to work with Amazon Web Services Management Console, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html">What Is Config</a> in the <i>Config Developer
|
|
671
|
+
* Guide</i>.</p>
|
|
672
|
+
*/
|
|
673
|
+
export declare class ConfigService extends ConfigServiceClient implements ConfigService {
|
|
674
|
+
}
|