@aws-sdk/client-config-service 3.292.0 → 3.294.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -1
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +87 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +87 -0
- package/dist-types/ConfigService.d.ts +273 -267
- package/dist-types/ConfigServiceClient.d.ts +2 -4
- package/dist-types/commands/BatchGetAggregateResourceConfigCommand.d.ts +4 -5
- package/dist-types/commands/BatchGetResourceConfigCommand.d.ts +10 -10
- package/dist-types/commands/DeleteAggregationAuthorizationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteConfigRuleCommand.d.ts +4 -4
- package/dist-types/commands/DeleteConfigurationRecorderCommand.d.ts +2 -2
- package/dist-types/commands/DeleteConformancePackCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDeliveryChannelCommand.d.ts +1 -1
- package/dist-types/commands/DeleteEvaluationResultsCommand.d.ts +2 -2
- package/dist-types/commands/DeleteOrganizationConfigRuleCommand.d.ts +6 -6
- package/dist-types/commands/DeleteOrganizationConformancePackCommand.d.ts +5 -5
- package/dist-types/commands/DeletePendingAggregationRequestCommand.d.ts +1 -1
- package/dist-types/commands/DeleteRemediationConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/DeleteRemediationExceptionsCommand.d.ts +1 -1
- package/dist-types/commands/DeleteResourceConfigCommand.d.ts +3 -3
- package/dist-types/commands/DeleteRetentionConfigurationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteStoredQueryCommand.d.ts +3 -3
- package/dist-types/commands/DeliverConfigSnapshotCommand.d.ts +7 -7
- package/dist-types/commands/DescribeAggregateComplianceByConfigRulesCommand.d.ts +7 -7
- package/dist-types/commands/DescribeAggregateComplianceByConformancePacksCommand.d.ts +5 -5
- package/dist-types/commands/DescribeAggregationAuthorizationsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeComplianceByConfigRuleCommand.d.ts +12 -12
- package/dist-types/commands/DescribeComplianceByResourceCommand.d.ts +11 -11
- package/dist-types/commands/DescribeConfigRuleEvaluationStatusCommand.d.ts +3 -3
- package/dist-types/commands/DescribeConfigRulesCommand.d.ts +3 -3
- package/dist-types/commands/DescribeConfigurationAggregatorSourcesStatusCommand.d.ts +2 -2
- package/dist-types/commands/DescribeConfigurationAggregatorsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeConfigurationRecorderStatusCommand.d.ts +5 -5
- package/dist-types/commands/DescribeConfigurationRecordersCommand.d.ts +3 -3
- package/dist-types/commands/DescribeConformancePackComplianceCommand.d.ts +3 -3
- package/dist-types/commands/DescribeConformancePackStatusCommand.d.ts +3 -3
- package/dist-types/commands/DescribeConformancePacksCommand.d.ts +2 -2
- package/dist-types/commands/DescribeDeliveryChannelStatusCommand.d.ts +3 -3
- package/dist-types/commands/DescribeDeliveryChannelsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeOrganizationConfigRuleStatusesCommand.d.ts +7 -8
- package/dist-types/commands/DescribeOrganizationConfigRulesCommand.d.ts +9 -12
- package/dist-types/commands/DescribeOrganizationConformancePackStatusesCommand.d.ts +7 -7
- package/dist-types/commands/DescribeOrganizationConformancePacksCommand.d.ts +9 -11
- package/dist-types/commands/DescribePendingAggregationRequestsCommand.d.ts +2 -2
- package/dist-types/commands/DescribeRemediationExceptionsCommand.d.ts +5 -5
- package/dist-types/commands/DescribeRemediationExecutionStatusCommand.d.ts +2 -2
- package/dist-types/commands/DescribeRetentionConfigurationsCommand.d.ts +5 -5
- package/dist-types/commands/GetAggregateComplianceDetailsByConfigRuleCommand.d.ts +7 -7
- package/dist-types/commands/GetAggregateConfigRuleComplianceSummaryCommand.d.ts +7 -7
- package/dist-types/commands/GetAggregateConformancePackComplianceSummaryCommand.d.ts +5 -5
- package/dist-types/commands/GetAggregateDiscoveredResourceCountsCommand.d.ts +5 -5
- package/dist-types/commands/GetAggregateResourceConfigCommand.d.ts +3 -3
- package/dist-types/commands/GetComplianceDetailsByConfigRuleCommand.d.ts +3 -3
- package/dist-types/commands/GetComplianceDetailsByResourceCommand.d.ts +1 -1
- package/dist-types/commands/GetComplianceSummaryByResourceTypeCommand.d.ts +1 -1
- package/dist-types/commands/GetConformancePackComplianceDetailsCommand.d.ts +2 -2
- package/dist-types/commands/GetConformancePackComplianceSummaryCommand.d.ts +1 -1
- package/dist-types/commands/GetCustomRulePolicyCommand.d.ts +1 -1
- package/dist-types/commands/GetDiscoveredResourceCountsCommand.d.ts +28 -34
- package/dist-types/commands/GetOrganizationConfigRuleDetailedStatusCommand.d.ts +4 -4
- package/dist-types/commands/GetOrganizationConformancePackDetailedStatusCommand.d.ts +4 -4
- package/dist-types/commands/GetOrganizationCustomRulePolicyCommand.d.ts +3 -3
- package/dist-types/commands/GetResourceConfigHistoryCommand.d.ts +9 -9
- package/dist-types/commands/GetResourceEvaluationSummaryCommand.d.ts +4 -0
- package/dist-types/commands/GetStoredQueryCommand.d.ts +3 -3
- package/dist-types/commands/ListAggregateDiscoveredResourcesCommand.d.ts +5 -5
- package/dist-types/commands/ListConformancePackComplianceScoresCommand.d.ts +3 -3
- package/dist-types/commands/ListDiscoveredResourcesCommand.d.ts +8 -8
- package/dist-types/commands/ListResourceEvaluationsCommand.d.ts +3 -3
- package/dist-types/commands/ListStoredQueriesCommand.d.ts +4 -4
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +4 -4
- package/dist-types/commands/PutAggregationAuthorizationCommand.d.ts +6 -1
- package/dist-types/commands/PutConfigRuleCommand.d.ts +28 -25
- package/dist-types/commands/PutConfigurationAggregatorCommand.d.ts +15 -12
- package/dist-types/commands/PutConfigurationRecorderCommand.d.ts +6 -6
- package/dist-types/commands/PutConformancePackCommand.d.ts +8 -8
- package/dist-types/commands/PutDeliveryChannelCommand.d.ts +8 -10
- package/dist-types/commands/PutEvaluationsCommand.d.ts +3 -3
- package/dist-types/commands/PutExternalEvaluationCommand.d.ts +2 -2
- package/dist-types/commands/PutOrganizationConfigRuleCommand.d.ts +30 -32
- package/dist-types/commands/PutOrganizationConformancePackCommand.d.ts +16 -19
- package/dist-types/commands/PutRemediationConfigurationsCommand.d.ts +9 -9
- package/dist-types/commands/PutRemediationExceptionsCommand.d.ts +19 -10
- package/dist-types/commands/PutResourceConfigCommand.d.ts +9 -9
- package/dist-types/commands/PutRetentionConfigurationCommand.d.ts +4 -4
- package/dist-types/commands/PutStoredQueryCommand.d.ts +8 -3
- package/dist-types/commands/SelectAggregateResourceConfigCommand.d.ts +6 -8
- package/dist-types/commands/SelectResourceConfigCommand.d.ts +2 -2
- package/dist-types/commands/StartConfigRulesEvaluationCommand.d.ts +21 -23
- package/dist-types/commands/StartConfigurationRecorderCommand.d.ts +1 -1
- package/dist-types/commands/StartRemediationExecutionCommand.d.ts +5 -5
- package/dist-types/commands/StartResourceEvaluationCommand.d.ts +8 -5
- package/dist-types/commands/TagResourceCommand.d.ts +4 -4
- package/dist-types/commands/UntagResourceCommand.d.ts +3 -3
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +329 -277
- package/dist-types/models/models_1.d.ts +21 -23
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +87 -0
- package/package.json +7 -7
|
@@ -94,8 +94,7 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
|
|
|
94
94
|
import { ConfigServiceClient } from "./ConfigServiceClient";
|
|
95
95
|
/**
|
|
96
96
|
* <fullname>Config</fullname>
|
|
97
|
-
*
|
|
98
|
-
* <p>Config provides a way to keep track of the configurations
|
|
97
|
+
* <p>Config provides a way to keep track of the configurations
|
|
99
98
|
* of all the Amazon Web Services resources associated with your Amazon Web Services account. You can
|
|
100
99
|
* use Config to get the current and historical configurations of
|
|
101
100
|
* each Amazon Web Services resource and also to get information about the relationship
|
|
@@ -103,8 +102,7 @@ import { ConfigServiceClient } from "./ConfigServiceClient";
|
|
|
103
102
|
* Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an
|
|
104
103
|
* elastic network Interface (ENI), or a security group. For a complete
|
|
105
104
|
* 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
|
-
*
|
|
107
|
-
* <p>You can access and manage Config through the Amazon Web Services Management
|
|
105
|
+
* <p>You can access and manage Config through the Amazon Web Services Management
|
|
108
106
|
* Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config
|
|
109
107
|
* API, or the Amazon Web Services SDKs for Config. This reference guide contains
|
|
110
108
|
* documentation for the Config API and the Amazon Web Services CLI commands that
|
|
@@ -121,8 +119,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
121
119
|
/**
|
|
122
120
|
* <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
121
|
* If there are no unprocessed resources, the operation returns an empty <code>unprocessedResourceIdentifiers</code> list. </p>
|
|
124
|
-
*
|
|
125
|
-
* <note>
|
|
122
|
+
* <note>
|
|
126
123
|
* <ul>
|
|
127
124
|
* <li>
|
|
128
125
|
* <p>The API does not return results for deleted resources.</p>
|
|
@@ -142,20 +139,20 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
142
139
|
* not processed in the current request. If there are no unprocessed
|
|
143
140
|
* resources, the operation returns an empty unprocessedResourceKeys
|
|
144
141
|
* list. </p>
|
|
145
|
-
*
|
|
146
|
-
*
|
|
142
|
+
* <note>
|
|
143
|
+
* <ul>
|
|
147
144
|
* <li>
|
|
148
|
-
*
|
|
145
|
+
* <p>The API does not return results for deleted
|
|
149
146
|
* resources.</p>
|
|
150
|
-
*
|
|
147
|
+
* </li>
|
|
151
148
|
* <li>
|
|
152
|
-
*
|
|
149
|
+
* <p> The API does not return any tags for the requested
|
|
153
150
|
* resources. This information is filtered out of the
|
|
154
151
|
* supplementaryConfiguration section of the API
|
|
155
152
|
* response.</p>
|
|
156
|
-
*
|
|
153
|
+
* </li>
|
|
157
154
|
* </ul>
|
|
158
|
-
*
|
|
155
|
+
* </note>
|
|
159
156
|
*/
|
|
160
157
|
batchGetResourceConfig(args: BatchGetResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetResourceConfigCommandOutput>;
|
|
161
158
|
batchGetResourceConfig(args: BatchGetResourceConfigCommandInput, cb: (err: any, data?: BatchGetResourceConfigCommandOutput) => void): void;
|
|
@@ -170,12 +167,12 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
170
167
|
/**
|
|
171
168
|
* <p>Deletes the specified Config rule and all of its evaluation
|
|
172
169
|
* results.</p>
|
|
173
|
-
*
|
|
170
|
+
* <p>Config sets the state of a rule to <code>DELETING</code>
|
|
174
171
|
* until the deletion is complete. You cannot update a rule while it is
|
|
175
172
|
* in this state. If you make a <code>PutConfigRule</code> or
|
|
176
173
|
* <code>DeleteConfigRule</code> request for the rule, you will
|
|
177
174
|
* receive a <code>ResourceInUseException</code>.</p>
|
|
178
|
-
*
|
|
175
|
+
* <p>You can check the state of a rule by using the
|
|
179
176
|
* <code>DescribeConfigRules</code> request.</p>
|
|
180
177
|
*/
|
|
181
178
|
deleteConfigRule(args: DeleteConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConfigRuleCommandOutput>;
|
|
@@ -190,10 +187,10 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
190
187
|
deleteConfigurationAggregator(args: DeleteConfigurationAggregatorCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConfigurationAggregatorCommandOutput) => void): void;
|
|
191
188
|
/**
|
|
192
189
|
* <p>Deletes the configuration recorder.</p>
|
|
193
|
-
*
|
|
190
|
+
* <p>After the configuration recorder is deleted, Config will
|
|
194
191
|
* not record resource configuration changes until you create a new
|
|
195
192
|
* configuration recorder.</p>
|
|
196
|
-
*
|
|
193
|
+
* <p>This action does not delete the configuration information that
|
|
197
194
|
* was previously recorded. You will be able to access the previously
|
|
198
195
|
* recorded information by using the
|
|
199
196
|
* <code>GetResourceConfigHistory</code> action, but you will not
|
|
@@ -206,7 +203,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
206
203
|
/**
|
|
207
204
|
* <p>Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that
|
|
208
205
|
* conformance pack.</p>
|
|
209
|
-
*
|
|
206
|
+
* <p>Config sets the conformance pack to <code>DELETE_IN_PROGRESS</code> until the deletion is complete.
|
|
210
207
|
* You cannot update a conformance pack while it is in this state.</p>
|
|
211
208
|
*/
|
|
212
209
|
deleteConformancePack(args: DeleteConformancePackCommandInput, options?: __HttpHandlerOptions): Promise<DeleteConformancePackCommandOutput>;
|
|
@@ -214,7 +211,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
214
211
|
deleteConformancePack(args: DeleteConformancePackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteConformancePackCommandOutput) => void): void;
|
|
215
212
|
/**
|
|
216
213
|
* <p>Deletes the delivery channel.</p>
|
|
217
|
-
*
|
|
214
|
+
* <p>Before you can delete the delivery channel, you must stop the
|
|
218
215
|
* configuration recorder by using the <a>StopConfigurationRecorder</a> action.</p>
|
|
219
216
|
*/
|
|
220
217
|
deleteDeliveryChannel(args: DeleteDeliveryChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDeliveryChannelCommandOutput>;
|
|
@@ -231,10 +228,10 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
231
228
|
deleteEvaluationResults(args: DeleteEvaluationResultsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteEvaluationResultsCommandOutput) => void): void;
|
|
232
229
|
/**
|
|
233
230
|
* <p>Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization. </p>
|
|
234
|
-
*
|
|
231
|
+
* <p>Only a management account and a delegated administrator account can delete an organization Config rule.
|
|
235
232
|
* When calling this API with a delegated administrator, you must ensure Organizations
|
|
236
233
|
* <code>ListDelegatedAdministrator</code> permissions are added.</p>
|
|
237
|
-
*
|
|
234
|
+
* <p>Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete.
|
|
238
235
|
* You cannot update a rule while it is in this state.</p>
|
|
239
236
|
*/
|
|
240
237
|
deleteOrganizationConfigRule(args: DeleteOrganizationConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<DeleteOrganizationConfigRuleCommandOutput>;
|
|
@@ -246,7 +243,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
246
243
|
* <p> Only a management account or a delegated administrator account can delete an organization conformance pack.
|
|
247
244
|
* When calling this API with a delegated administrator, you must ensure Organizations
|
|
248
245
|
* <code>ListDelegatedAdministrator</code> permissions are added.</p>
|
|
249
|
-
*
|
|
246
|
+
* <p>Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete.
|
|
250
247
|
* You cannot update a conformance pack while it is in this state. </p>
|
|
251
248
|
*/
|
|
252
249
|
deleteOrganizationConformancePack(args: DeleteOrganizationConformancePackCommandInput, options?: __HttpHandlerOptions): Promise<DeleteOrganizationConformancePackCommandOutput>;
|
|
@@ -267,7 +264,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
267
264
|
deleteRemediationConfiguration(args: DeleteRemediationConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRemediationConfigurationCommandOutput) => void): void;
|
|
268
265
|
/**
|
|
269
266
|
* <p>Deletes one or more remediation exceptions mentioned in the resource keys.</p>
|
|
270
|
-
*
|
|
267
|
+
* <note>
|
|
271
268
|
* <p>Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource.
|
|
272
269
|
* Remediation exceptions blocks auto-remediation until the exception is cleared.</p>
|
|
273
270
|
* </note>
|
|
@@ -299,18 +296,18 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
299
296
|
* bucket in the specified delivery channel. After the delivery has
|
|
300
297
|
* started, Config sends the following notifications using an
|
|
301
298
|
* Amazon SNS topic that you have specified.</p>
|
|
302
|
-
*
|
|
299
|
+
* <ul>
|
|
303
300
|
* <li>
|
|
304
|
-
*
|
|
305
|
-
*
|
|
301
|
+
* <p>Notification of the start of the delivery.</p>
|
|
302
|
+
* </li>
|
|
306
303
|
* <li>
|
|
307
|
-
*
|
|
304
|
+
* <p>Notification of the completion of the delivery, if the
|
|
308
305
|
* delivery was successfully completed.</p>
|
|
309
|
-
*
|
|
306
|
+
* </li>
|
|
310
307
|
* <li>
|
|
311
|
-
*
|
|
308
|
+
* <p>Notification of delivery failure, if the delivery
|
|
312
309
|
* failed.</p>
|
|
313
|
-
*
|
|
310
|
+
* </li>
|
|
314
311
|
* </ul>
|
|
315
312
|
*/
|
|
316
313
|
deliverConfigSnapshot(args: DeliverConfigSnapshotCommandInput, options?: __HttpHandlerOptions): Promise<DeliverConfigSnapshotCommandOutput>;
|
|
@@ -320,11 +317,11 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
320
317
|
* <p>Returns a list of compliant and noncompliant rules with the
|
|
321
318
|
* number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
|
|
322
319
|
* </p>
|
|
323
|
-
*
|
|
324
|
-
*
|
|
320
|
+
* <note>
|
|
321
|
+
* <p>The results can return an empty result page, but if you
|
|
325
322
|
* have a <code>nextToken</code>, the results are displayed on the next
|
|
326
323
|
* page.</p>
|
|
327
|
-
*
|
|
324
|
+
* </note>
|
|
328
325
|
*/
|
|
329
326
|
describeAggregateComplianceByConfigRules(args: DescribeAggregateComplianceByConfigRulesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAggregateComplianceByConfigRulesCommandOutput>;
|
|
330
327
|
describeAggregateComplianceByConfigRules(args: DescribeAggregateComplianceByConfigRulesCommandInput, cb: (err: any, data?: DescribeAggregateComplianceByConfigRulesCommandOutput) => void): void;
|
|
@@ -332,7 +329,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
332
329
|
/**
|
|
333
330
|
* <p>Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each
|
|
334
331
|
* 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>
|
|
335
|
-
*
|
|
332
|
+
* <note>
|
|
336
333
|
* <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>
|
|
337
334
|
* </note>
|
|
338
335
|
*/
|
|
@@ -350,35 +347,35 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
350
347
|
* <p>Indicates whether the specified Config rules are compliant.
|
|
351
348
|
* If a rule is noncompliant, this action returns the number of Amazon Web Services
|
|
352
349
|
* resources that do not comply with the rule.</p>
|
|
353
|
-
*
|
|
350
|
+
* <p>A rule is compliant if all of the evaluated resources comply
|
|
354
351
|
* with it. It is noncompliant if any of these resources do not
|
|
355
352
|
* comply.</p>
|
|
356
|
-
*
|
|
353
|
+
* <p>If Config has no current evaluation results for the rule,
|
|
357
354
|
* it returns <code>INSUFFICIENT_DATA</code>. This result might
|
|
358
355
|
* indicate one of the following conditions:</p>
|
|
359
|
-
*
|
|
356
|
+
* <ul>
|
|
360
357
|
* <li>
|
|
361
|
-
*
|
|
358
|
+
* <p>Config has never invoked an evaluation for the
|
|
362
359
|
* rule. To check whether it has, use the
|
|
363
360
|
* <code>DescribeConfigRuleEvaluationStatus</code> action
|
|
364
361
|
* to get the <code>LastSuccessfulInvocationTime</code> and
|
|
365
362
|
* <code>LastFailedInvocationTime</code>.</p>
|
|
366
|
-
*
|
|
363
|
+
* </li>
|
|
367
364
|
* <li>
|
|
368
|
-
*
|
|
365
|
+
* <p>The rule's Lambda function is failing to send
|
|
369
366
|
* evaluation results to Config. Verify that the role you
|
|
370
367
|
* assigned to your configuration recorder includes the
|
|
371
368
|
* <code>config:PutEvaluations</code> permission. If the
|
|
372
369
|
* rule is a custom rule, verify that the Lambda execution
|
|
373
370
|
* role includes the <code>config:PutEvaluations</code>
|
|
374
371
|
* permission.</p>
|
|
375
|
-
*
|
|
372
|
+
* </li>
|
|
376
373
|
* <li>
|
|
377
|
-
*
|
|
374
|
+
* <p>The rule's Lambda function has returned
|
|
378
375
|
* <code>NOT_APPLICABLE</code> for all evaluation results.
|
|
379
376
|
* This can occur if the resources were deleted or removed from
|
|
380
377
|
* the rule's scope.</p>
|
|
381
|
-
*
|
|
378
|
+
* </li>
|
|
382
379
|
* </ul>
|
|
383
380
|
*/
|
|
384
381
|
describeComplianceByConfigRule(args: DescribeComplianceByConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<DescribeComplianceByConfigRuleCommandOutput>;
|
|
@@ -387,36 +384,36 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
387
384
|
/**
|
|
388
385
|
* <p>Indicates whether the specified Amazon Web Services resources are compliant. If
|
|
389
386
|
* a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.</p>
|
|
390
|
-
*
|
|
387
|
+
* <p>A resource is compliant if it complies with all the Config
|
|
391
388
|
* rules that evaluate it. It is noncompliant if it does not comply
|
|
392
389
|
* with one or more of these rules.</p>
|
|
393
|
-
*
|
|
390
|
+
* <p>If Config has no current evaluation results for the
|
|
394
391
|
* resource, it returns <code>INSUFFICIENT_DATA</code>. This result
|
|
395
392
|
* might indicate one of the following conditions about the rules that
|
|
396
393
|
* evaluate the resource:</p>
|
|
397
|
-
*
|
|
394
|
+
* <ul>
|
|
398
395
|
* <li>
|
|
399
|
-
*
|
|
396
|
+
* <p>Config has never invoked an evaluation for the
|
|
400
397
|
* rule. To check whether it has, use the
|
|
401
398
|
* <code>DescribeConfigRuleEvaluationStatus</code> action
|
|
402
399
|
* to get the <code>LastSuccessfulInvocationTime</code> and
|
|
403
400
|
* <code>LastFailedInvocationTime</code>.</p>
|
|
404
|
-
*
|
|
401
|
+
* </li>
|
|
405
402
|
* <li>
|
|
406
|
-
*
|
|
403
|
+
* <p>The rule's Lambda function is failing to send
|
|
407
404
|
* evaluation results to Config. Verify that the role that
|
|
408
405
|
* you assigned to your configuration recorder includes the
|
|
409
406
|
* <code>config:PutEvaluations</code> permission. If the
|
|
410
407
|
* rule is a custom rule, verify that the Lambda execution
|
|
411
408
|
* role includes the <code>config:PutEvaluations</code>
|
|
412
409
|
* permission.</p>
|
|
413
|
-
*
|
|
410
|
+
* </li>
|
|
414
411
|
* <li>
|
|
415
|
-
*
|
|
412
|
+
* <p>The rule's Lambda function has returned
|
|
416
413
|
* <code>NOT_APPLICABLE</code> for all evaluation results.
|
|
417
414
|
* This can occur if the resources were deleted or removed from
|
|
418
415
|
* the rule's scope.</p>
|
|
419
|
-
*
|
|
416
|
+
* </li>
|
|
420
417
|
* </ul>
|
|
421
418
|
*/
|
|
422
419
|
describeComplianceByResource(args: DescribeComplianceByResourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeComplianceByResourceCommandOutput>;
|
|
@@ -456,30 +453,30 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
456
453
|
* If the configuration recorder is not specified, this action returns
|
|
457
454
|
* the details for all configuration recorders associated with the
|
|
458
455
|
* account.</p>
|
|
459
|
-
*
|
|
460
|
-
*
|
|
456
|
+
* <note>
|
|
457
|
+
* <p>Currently, you can specify only one configuration recorder
|
|
461
458
|
* per region in your account.</p>
|
|
462
|
-
*
|
|
459
|
+
* </note>
|
|
463
460
|
*/
|
|
464
461
|
describeConfigurationRecorders(args: DescribeConfigurationRecordersCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConfigurationRecordersCommandOutput>;
|
|
465
462
|
describeConfigurationRecorders(args: DescribeConfigurationRecordersCommandInput, cb: (err: any, data?: DescribeConfigurationRecordersCommandOutput) => void): void;
|
|
466
463
|
describeConfigurationRecorders(args: DescribeConfigurationRecordersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationRecordersCommandOutput) => void): void;
|
|
467
464
|
/**
|
|
468
465
|
* <p>Returns the current status of the specified configuration
|
|
469
|
-
* recorder. If a configuration recorder is not specified, this action
|
|
466
|
+
* recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action
|
|
470
467
|
* returns the status of all configuration recorders associated with
|
|
471
468
|
* the account.</p>
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
* per region in your account.</p>
|
|
475
|
-
*
|
|
469
|
+
* <note>
|
|
470
|
+
* <p>Currently, you can specify only one configuration recorder
|
|
471
|
+
* 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>
|
|
472
|
+
* </note>
|
|
476
473
|
*/
|
|
477
474
|
describeConfigurationRecorderStatus(args: DescribeConfigurationRecorderStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeConfigurationRecorderStatusCommandOutput>;
|
|
478
475
|
describeConfigurationRecorderStatus(args: DescribeConfigurationRecorderStatusCommandInput, cb: (err: any, data?: DescribeConfigurationRecorderStatusCommandOutput) => void): void;
|
|
479
476
|
describeConfigurationRecorderStatus(args: DescribeConfigurationRecorderStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConfigurationRecorderStatusCommandOutput) => void): void;
|
|
480
477
|
/**
|
|
481
478
|
* <p>Returns compliance details for each rule in that conformance pack.</p>
|
|
482
|
-
*
|
|
479
|
+
* <note>
|
|
483
480
|
* <p>You must provide exact rule names.</p>
|
|
484
481
|
* </note>
|
|
485
482
|
*/
|
|
@@ -494,7 +491,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
494
491
|
describeConformancePacks(args: DescribeConformancePacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeConformancePacksCommandOutput) => void): void;
|
|
495
492
|
/**
|
|
496
493
|
* <p>Provides one or more conformance packs deployment status.</p>
|
|
497
|
-
*
|
|
494
|
+
* <note>
|
|
498
495
|
* <p>If there are no conformance packs then you will see an empty result.</p>
|
|
499
496
|
* </note>
|
|
500
497
|
*/
|
|
@@ -505,10 +502,10 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
505
502
|
* <p>Returns details about the specified delivery channel. If a
|
|
506
503
|
* delivery channel is not specified, this action returns the details
|
|
507
504
|
* of all delivery channels associated with the account.</p>
|
|
508
|
-
*
|
|
509
|
-
*
|
|
505
|
+
* <note>
|
|
506
|
+
* <p>Currently, you can specify only one delivery channel per
|
|
510
507
|
* region in your account.</p>
|
|
511
|
-
*
|
|
508
|
+
* </note>
|
|
512
509
|
*/
|
|
513
510
|
describeDeliveryChannels(args: DescribeDeliveryChannelsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDeliveryChannelsCommandOutput>;
|
|
514
511
|
describeDeliveryChannels(args: DescribeDeliveryChannelsCommandInput, cb: (err: any, data?: DescribeDeliveryChannelsCommandOutput) => void): void;
|
|
@@ -518,27 +515,24 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
518
515
|
* If a delivery channel is not specified, this action returns the
|
|
519
516
|
* current status of all delivery channels associated with the
|
|
520
517
|
* account.</p>
|
|
521
|
-
*
|
|
522
|
-
*
|
|
518
|
+
* <note>
|
|
519
|
+
* <p>Currently, you can specify only one delivery channel per
|
|
523
520
|
* region in your account.</p>
|
|
524
|
-
*
|
|
521
|
+
* </note>
|
|
525
522
|
*/
|
|
526
523
|
describeDeliveryChannelStatus(args: DescribeDeliveryChannelStatusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDeliveryChannelStatusCommandOutput>;
|
|
527
524
|
describeDeliveryChannelStatus(args: DescribeDeliveryChannelStatusCommandInput, cb: (err: any, data?: DescribeDeliveryChannelStatusCommandOutput) => void): void;
|
|
528
525
|
describeDeliveryChannelStatus(args: DescribeDeliveryChannelStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDeliveryChannelStatusCommandOutput) => void): void;
|
|
529
526
|
/**
|
|
530
527
|
* <p>Returns a list of organization Config rules. </p>
|
|
531
|
-
*
|
|
532
|
-
* <note>
|
|
528
|
+
* <note>
|
|
533
529
|
* <p>When you specify the limit and the next token, you receive a paginated response.</p>
|
|
534
|
-
*
|
|
530
|
+
* <p>Limit and next token are not applicable if you specify organization Config rule names.
|
|
535
531
|
* It is only applicable, when you request all the organization Config rules.</p>
|
|
536
|
-
*
|
|
537
|
-
* <p>
|
|
532
|
+
* <p>
|
|
538
533
|
* <i>For accounts within an organzation</i>
|
|
539
534
|
* </p>
|
|
540
|
-
*
|
|
541
|
-
* <p>If you deploy an organizational rule or conformance pack in an organization
|
|
535
|
+
* <p>If you deploy an organizational rule or conformance pack in an organization
|
|
542
536
|
* administrator account, and then establish a delegated administrator and deploy an
|
|
543
537
|
* organizational rule or conformance pack in the delegated administrator account, you
|
|
544
538
|
* won't be able to see the organizational rule or conformance pack in the organization
|
|
@@ -548,37 +542,34 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
548
542
|
* <code>DescribeOrganizationConformancePacks</code> APIs can only see and interact with
|
|
549
543
|
* the organization-related resource that were deployed from within the account calling
|
|
550
544
|
* those APIs.</p>
|
|
551
|
-
*
|
|
545
|
+
* </note>
|
|
552
546
|
*/
|
|
553
547
|
describeOrganizationConfigRules(args: DescribeOrganizationConfigRulesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrganizationConfigRulesCommandOutput>;
|
|
554
548
|
describeOrganizationConfigRules(args: DescribeOrganizationConfigRulesCommandInput, cb: (err: any, data?: DescribeOrganizationConfigRulesCommandOutput) => void): void;
|
|
555
549
|
describeOrganizationConfigRules(args: DescribeOrganizationConfigRulesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigRulesCommandOutput) => void): void;
|
|
556
550
|
/**
|
|
557
551
|
* <p>Provides organization Config rule deployment status for an organization.</p>
|
|
558
|
-
*
|
|
559
|
-
* <note>
|
|
552
|
+
* <note>
|
|
560
553
|
* <p>The status is not considered successful until organization Config rule is successfully deployed in all the member
|
|
561
554
|
* accounts with an exception of excluded accounts.</p>
|
|
562
|
-
*
|
|
555
|
+
* <p>When you specify the limit and the next token, you receive a paginated response.
|
|
563
556
|
* Limit and next token are not applicable if you specify organization Config rule names.
|
|
564
557
|
* It is only applicable, when you request all the organization Config rules.</p>
|
|
565
|
-
*
|
|
558
|
+
* </note>
|
|
566
559
|
*/
|
|
567
560
|
describeOrganizationConfigRuleStatuses(args: DescribeOrganizationConfigRuleStatusesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrganizationConfigRuleStatusesCommandOutput>;
|
|
568
561
|
describeOrganizationConfigRuleStatuses(args: DescribeOrganizationConfigRuleStatusesCommandInput, cb: (err: any, data?: DescribeOrganizationConfigRuleStatusesCommandOutput) => void): void;
|
|
569
562
|
describeOrganizationConfigRuleStatuses(args: DescribeOrganizationConfigRuleStatusesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConfigRuleStatusesCommandOutput) => void): void;
|
|
570
563
|
/**
|
|
571
564
|
* <p>Returns a list of organization conformance packs. </p>
|
|
572
|
-
*
|
|
565
|
+
* <note>
|
|
573
566
|
* <p>When you specify the limit and the next token, you receive a paginated response. </p>
|
|
574
|
-
*
|
|
567
|
+
* <p>Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable,
|
|
575
568
|
* when you request all the organization conformance packs. </p>
|
|
576
|
-
*
|
|
577
|
-
* <p>
|
|
569
|
+
* <p>
|
|
578
570
|
* <i>For accounts within an organzation</i>
|
|
579
571
|
* </p>
|
|
580
|
-
*
|
|
581
|
-
* <p>If you deploy an organizational rule or conformance pack in an organization
|
|
572
|
+
* <p>If you deploy an organizational rule or conformance pack in an organization
|
|
582
573
|
* administrator account, and then establish a delegated administrator and deploy an
|
|
583
574
|
* organizational rule or conformance pack in the delegated administrator account, you
|
|
584
575
|
* won't be able to see the organizational rule or conformance pack in the organization
|
|
@@ -588,17 +579,17 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
588
579
|
* <code>DescribeOrganizationConformancePacks</code> APIs can only see and interact with
|
|
589
580
|
* the organization-related resource that were deployed from within the account calling
|
|
590
581
|
* those APIs.</p>
|
|
591
|
-
*
|
|
582
|
+
* </note>
|
|
592
583
|
*/
|
|
593
584
|
describeOrganizationConformancePacks(args: DescribeOrganizationConformancePacksCommandInput, options?: __HttpHandlerOptions): Promise<DescribeOrganizationConformancePacksCommandOutput>;
|
|
594
585
|
describeOrganizationConformancePacks(args: DescribeOrganizationConformancePacksCommandInput, cb: (err: any, data?: DescribeOrganizationConformancePacksCommandOutput) => void): void;
|
|
595
586
|
describeOrganizationConformancePacks(args: DescribeOrganizationConformancePacksCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeOrganizationConformancePacksCommandOutput) => void): void;
|
|
596
587
|
/**
|
|
597
588
|
* <p>Provides organization conformance pack deployment status for an organization. </p>
|
|
598
|
-
*
|
|
599
|
-
*
|
|
589
|
+
* <note>
|
|
590
|
+
* <p>The status is not considered successful until organization conformance pack is successfully
|
|
600
591
|
* deployed in all the member accounts with an exception of excluded accounts.</p>
|
|
601
|
-
*
|
|
592
|
+
* <p>When you specify the limit and the next token, you receive a paginated response.
|
|
602
593
|
* Limit and next token are not applicable if you specify organization conformance pack names.
|
|
603
594
|
* They are only applicable, when you request all the organization conformance packs.</p>
|
|
604
595
|
* </note>
|
|
@@ -621,11 +612,11 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
621
612
|
/**
|
|
622
613
|
* <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.
|
|
623
614
|
* When you specify the limit and the next token, you receive a paginated response. </p>
|
|
624
|
-
*
|
|
615
|
+
* <note>
|
|
625
616
|
* <p>Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource.
|
|
626
617
|
* Remediation exceptions blocks auto-remediation until the exception is cleared.</p>
|
|
627
|
-
*
|
|
628
|
-
*
|
|
618
|
+
* <p>When you specify the limit and the next token, you receive a paginated response. </p>
|
|
619
|
+
* <p>Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.</p>
|
|
629
620
|
* </note>
|
|
630
621
|
*/
|
|
631
622
|
describeRemediationExceptions(args: DescribeRemediationExceptionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRemediationExceptionsCommandOutput>;
|
|
@@ -643,10 +634,10 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
643
634
|
* the retention configuration name is not specified, this action
|
|
644
635
|
* returns the details for all the retention configurations for that
|
|
645
636
|
* account.</p>
|
|
646
|
-
*
|
|
647
|
-
*
|
|
637
|
+
* <note>
|
|
638
|
+
* <p>Currently, Config supports only one retention
|
|
648
639
|
* configuration per region in your account.</p>
|
|
649
|
-
*
|
|
640
|
+
* </note>
|
|
650
641
|
*/
|
|
651
642
|
describeRetentionConfigurations(args: DescribeRetentionConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRetentionConfigurationsCommandOutput>;
|
|
652
643
|
describeRetentionConfigurations(args: DescribeRetentionConfigurationsCommandInput, cb: (err: any, data?: DescribeRetentionConfigurationsCommandOutput) => void): void;
|
|
@@ -656,11 +647,11 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
656
647
|
* rule for a specific resource in a rule. The results indicate which
|
|
657
648
|
* Amazon Web Services resources were evaluated by the rule, when each resource was
|
|
658
649
|
* last evaluated, and whether each resource complies with the rule. </p>
|
|
659
|
-
*
|
|
660
|
-
*
|
|
650
|
+
* <note>
|
|
651
|
+
* <p>The results can return an empty result page. But if you
|
|
661
652
|
* have a <code>nextToken</code>, the results are displayed on the next
|
|
662
653
|
* page.</p>
|
|
663
|
-
*
|
|
654
|
+
* </note>
|
|
664
655
|
*/
|
|
665
656
|
getAggregateComplianceDetailsByConfigRule(args: GetAggregateComplianceDetailsByConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<GetAggregateComplianceDetailsByConfigRuleCommandOutput>;
|
|
666
657
|
getAggregateComplianceDetailsByConfigRule(args: GetAggregateComplianceDetailsByConfigRuleCommandInput, cb: (err: any, data?: GetAggregateComplianceDetailsByConfigRuleCommandOutput) => void): void;
|
|
@@ -668,18 +659,18 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
668
659
|
/**
|
|
669
660
|
* <p>Returns the number of compliant and noncompliant rules for one
|
|
670
661
|
* or more accounts and regions in an aggregator.</p>
|
|
671
|
-
*
|
|
672
|
-
*
|
|
662
|
+
* <note>
|
|
663
|
+
* <p>The results can return an empty result page, but if you
|
|
673
664
|
* have a nextToken, the results are displayed on the next
|
|
674
665
|
* page.</p>
|
|
675
|
-
*
|
|
666
|
+
* </note>
|
|
676
667
|
*/
|
|
677
668
|
getAggregateConfigRuleComplianceSummary(args: GetAggregateConfigRuleComplianceSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetAggregateConfigRuleComplianceSummaryCommandOutput>;
|
|
678
669
|
getAggregateConfigRuleComplianceSummary(args: GetAggregateConfigRuleComplianceSummaryCommandInput, cb: (err: any, data?: GetAggregateConfigRuleComplianceSummaryCommandOutput) => void): void;
|
|
679
670
|
getAggregateConfigRuleComplianceSummary(args: GetAggregateConfigRuleComplianceSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateConfigRuleComplianceSummaryCommandOutput) => void): void;
|
|
680
671
|
/**
|
|
681
672
|
* <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>
|
|
682
|
-
*
|
|
673
|
+
* <note>
|
|
683
674
|
* <p>The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.</p>
|
|
684
675
|
* </note>
|
|
685
676
|
*/
|
|
@@ -688,7 +679,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
688
679
|
getAggregateConformancePackComplianceSummary(args: GetAggregateConformancePackComplianceSummaryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAggregateConformancePackComplianceSummaryCommandOutput) => void): void;
|
|
689
680
|
/**
|
|
690
681
|
* <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>
|
|
691
|
-
*
|
|
682
|
+
* <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.
|
|
692
683
|
* 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>
|
|
693
684
|
*/
|
|
694
685
|
getAggregateDiscoveredResourceCounts(args: GetAggregateDiscoveredResourceCountsCommandInput, options?: __HttpHandlerOptions): Promise<GetAggregateDiscoveredResourceCountsCommandOutput>;
|
|
@@ -756,67 +747,61 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
756
747
|
* <p>Returns the resource types, the number of each resource type,
|
|
757
748
|
* and the total number of resources that Config is recording in
|
|
758
749
|
* this region for your Amazon Web Services account. </p>
|
|
759
|
-
*
|
|
750
|
+
* <p class="title">
|
|
760
751
|
* <b>Example</b>
|
|
761
752
|
* </p>
|
|
762
753
|
* <ol>
|
|
763
754
|
* <li>
|
|
764
|
-
*
|
|
755
|
+
* <p>Config is recording three resource types in the US
|
|
765
756
|
* East (Ohio) Region for your account: 25 EC2 instances, 20
|
|
766
757
|
* IAM users, and 15 S3 buckets.</p>
|
|
767
|
-
*
|
|
758
|
+
* </li>
|
|
768
759
|
* <li>
|
|
769
|
-
*
|
|
760
|
+
* <p>You make a call to the
|
|
770
761
|
* <code>GetDiscoveredResourceCounts</code> action and
|
|
771
762
|
* specify that you want all resource types. </p>
|
|
772
|
-
*
|
|
763
|
+
* </li>
|
|
773
764
|
* <li>
|
|
774
|
-
*
|
|
775
|
-
*
|
|
776
|
-
* <ul>
|
|
765
|
+
* <p>Config returns the following:</p>
|
|
766
|
+
* <ul>
|
|
777
767
|
* <li>
|
|
778
|
-
*
|
|
768
|
+
* <p>The resource types (EC2 instances, IAM users,
|
|
779
769
|
* and S3 buckets).</p>
|
|
780
|
-
*
|
|
770
|
+
* </li>
|
|
781
771
|
* <li>
|
|
782
|
-
*
|
|
772
|
+
* <p>The number of each resource type (25, 20, and
|
|
783
773
|
* 15).</p>
|
|
784
|
-
*
|
|
774
|
+
* </li>
|
|
785
775
|
* <li>
|
|
786
|
-
*
|
|
776
|
+
* <p>The total number of all resources
|
|
787
777
|
* (60).</p>
|
|
788
|
-
*
|
|
778
|
+
* </li>
|
|
789
779
|
* </ul>
|
|
790
|
-
*
|
|
791
|
-
* </li>
|
|
780
|
+
* </li>
|
|
792
781
|
* </ol>
|
|
793
|
-
*
|
|
794
|
-
* <p>The response is paginated. By default, Config lists 100
|
|
782
|
+
* <p>The response is paginated. By default, Config lists 100
|
|
795
783
|
* <a>ResourceCount</a> objects on each page. You can
|
|
796
784
|
* customize this number with the <code>limit</code> parameter. The
|
|
797
785
|
* response includes a <code>nextToken</code> string. To get the next
|
|
798
786
|
* page of results, run the request again and specify the string for
|
|
799
787
|
* the <code>nextToken</code> parameter.</p>
|
|
800
|
-
*
|
|
801
|
-
*
|
|
802
|
-
* <p>If you make a call to the <a>GetDiscoveredResourceCounts</a> action, you might
|
|
788
|
+
* <note>
|
|
789
|
+
* <p>If you make a call to the <a>GetDiscoveredResourceCounts</a> action, you might
|
|
803
790
|
* not immediately receive resource counts in the following
|
|
804
791
|
* situations:</p>
|
|
805
|
-
*
|
|
806
|
-
* <ul>
|
|
792
|
+
* <ul>
|
|
807
793
|
* <li>
|
|
808
|
-
*
|
|
809
|
-
*
|
|
794
|
+
* <p>You are a new Config customer.</p>
|
|
795
|
+
* </li>
|
|
810
796
|
* <li>
|
|
811
|
-
*
|
|
812
|
-
*
|
|
797
|
+
* <p>You just enabled resource recording.</p>
|
|
798
|
+
* </li>
|
|
813
799
|
* </ul>
|
|
814
|
-
*
|
|
815
|
-
* <p>It might take a few minutes for Config to record and
|
|
800
|
+
* <p>It might take a few minutes for Config to record and
|
|
816
801
|
* count your resources. Wait a few minutes and then retry the
|
|
817
802
|
* <a>GetDiscoveredResourceCounts</a> action.
|
|
818
803
|
* </p>
|
|
819
|
-
*
|
|
804
|
+
* </note>
|
|
820
805
|
*/
|
|
821
806
|
getDiscoveredResourceCounts(args: GetDiscoveredResourceCountsCommandInput, options?: __HttpHandlerOptions): Promise<GetDiscoveredResourceCountsCommandOutput>;
|
|
822
807
|
getDiscoveredResourceCounts(args: GetDiscoveredResourceCountsCommandInput, cb: (err: any, data?: GetDiscoveredResourceCountsCommandOutput) => void): void;
|
|
@@ -847,19 +832,19 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
847
832
|
* minimum of 30 days and a maximum of 7 years (2557 days), Config
|
|
848
833
|
* returns the <code>ConfigurationItems</code> for the specified
|
|
849
834
|
* retention period. </p>
|
|
850
|
-
*
|
|
835
|
+
* <p>The response is paginated. By default, Config returns a
|
|
851
836
|
* limit of 10 configuration items per page. You can customize this
|
|
852
837
|
* number with the <code>limit</code> parameter. The response includes
|
|
853
838
|
* a <code>nextToken</code> string. To get the next page of results,
|
|
854
839
|
* run the request again and specify the string for the
|
|
855
840
|
* <code>nextToken</code> parameter.</p>
|
|
856
|
-
*
|
|
857
|
-
*
|
|
841
|
+
* <note>
|
|
842
|
+
* <p>Each call to the API is limited to span a duration of seven
|
|
858
843
|
* days. It is likely that the number of records returned is
|
|
859
844
|
* smaller than the specified <code>limit</code>. In such cases,
|
|
860
845
|
* you can make another call, using the
|
|
861
846
|
* <code>nextToken</code>.</p>
|
|
862
|
-
*
|
|
847
|
+
* </note>
|
|
863
848
|
*/
|
|
864
849
|
getResourceConfigHistory(args: GetResourceConfigHistoryCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceConfigHistoryCommandOutput>;
|
|
865
850
|
getResourceConfigHistory(args: GetResourceConfigHistoryCommandInput, cb: (err: any, data?: GetResourceConfigHistoryCommandOutput) => void): void;
|
|
@@ -868,6 +853,10 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
868
853
|
* <p>Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run.
|
|
869
854
|
* The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated,
|
|
870
855
|
* the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules. </p>
|
|
856
|
+
* <note>
|
|
857
|
+
* <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.
|
|
858
|
+
* 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>
|
|
859
|
+
* </note>
|
|
871
860
|
*/
|
|
872
861
|
getResourceEvaluationSummary(args: GetResourceEvaluationSummaryCommandInput, options?: __HttpHandlerOptions): Promise<GetResourceEvaluationSummaryCommandOutput>;
|
|
873
862
|
getResourceEvaluationSummary(args: GetResourceEvaluationSummaryCommandInput, cb: (err: any, data?: GetResourceEvaluationSummaryCommandOutput) => void): void;
|
|
@@ -882,7 +871,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
882
871
|
* <p>Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.
|
|
883
872
|
* A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region.
|
|
884
873
|
* 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>
|
|
885
|
-
*
|
|
874
|
+
* <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>
|
|
886
875
|
*/
|
|
887
876
|
listAggregateDiscoveredResources(args: ListAggregateDiscoveredResourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListAggregateDiscoveredResourcesCommandOutput>;
|
|
888
877
|
listAggregateDiscoveredResources(args: ListAggregateDiscoveredResourcesCommandInput, cb: (err: any, data?: ListAggregateDiscoveredResourcesCommandOutput) => void): void;
|
|
@@ -892,7 +881,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
892
881
|
* 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.
|
|
893
882
|
* 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
|
|
894
883
|
* the level of compliance in your conformance packs.</p>
|
|
895
|
-
*
|
|
884
|
+
* <note>
|
|
896
885
|
* <p>Conformance packs with no evaluation results will have a compliance score of <code>INSUFFICIENT_DATA</code>.</p>
|
|
897
886
|
* </note>
|
|
898
887
|
*/
|
|
@@ -907,11 +896,11 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
907
896
|
* discovered, including those that Config is not currently
|
|
908
897
|
* recording. You can narrow the results to include only resources that
|
|
909
898
|
* have specific resource IDs or a resource name.</p>
|
|
910
|
-
*
|
|
911
|
-
*
|
|
899
|
+
* <note>
|
|
900
|
+
* <p>You can specify either resource IDs or a resource name, but
|
|
912
901
|
* not both, in the same request.</p>
|
|
913
|
-
*
|
|
914
|
-
*
|
|
902
|
+
* </note>
|
|
903
|
+
* <p>The response is paginated. By default, Config lists 100
|
|
915
904
|
* resource identifiers on each page. You can customize this number
|
|
916
905
|
* with the <code>limit</code> parameter. The response includes a
|
|
917
906
|
* <code>nextToken</code> string. To get the next page of results,
|
|
@@ -942,6 +931,11 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
942
931
|
/**
|
|
943
932
|
* <p>Authorizes the aggregator account and region to collect data
|
|
944
933
|
* from the source account and region. </p>
|
|
934
|
+
* <note>
|
|
935
|
+
* <p>
|
|
936
|
+
* <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,
|
|
937
|
+
* 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>
|
|
938
|
+
* </note>
|
|
945
939
|
*/
|
|
946
940
|
putAggregationAuthorization(args: PutAggregationAuthorizationCommandInput, options?: __HttpHandlerOptions): Promise<PutAggregationAuthorizationCommandOutput>;
|
|
947
941
|
putAggregationAuthorization(args: PutAggregationAuthorizationCommandInput, cb: (err: any, data?: PutAggregationAuthorizationCommandOutput) => void): void;
|
|
@@ -952,41 +946,44 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
952
946
|
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
953
947
|
* <b>Service Limits</b>
|
|
954
948
|
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
949
|
+
* <p>There are two types of rules: <i>Config Managed Rules</i> and <i>Config Custom Rules</i>.
|
|
950
|
+
* You can use <code>PutConfigRule</code> to create both Config Managed Rules and Config Custom Rules.</p>
|
|
951
|
+
* <p>Config Managed Rules are predefined,
|
|
952
|
+
* customizable rules created by Config. For a list of managed rules, see
|
|
953
|
+
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
|
|
954
|
+
* Managed Rules</a>. If you are adding an Config managed rule, you must specify the
|
|
955
|
+
* rule's identifier for the <code>SourceIdentifier</code> key.</p>
|
|
956
|
+
* <p>Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions
|
|
957
|
+
* (<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
|
|
958
|
+
* Repository</a>), a policy-as-code language.
|
|
955
959
|
*
|
|
956
|
-
*
|
|
957
|
-
*
|
|
958
|
-
*
|
|
959
|
-
*
|
|
960
|
-
* Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
|
|
961
|
-
* Repository</a>) is a policy-as-code language that allows you to write policies that
|
|
962
|
-
* are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to
|
|
963
|
-
* evaluate a custom rule. If you are adding a new Custom Lambda rule,
|
|
960
|
+
* Config custom rules created with Lambda
|
|
961
|
+
* are called <i>Config Custom Lambda Rules</i> and Config custom rules created with
|
|
962
|
+
* Guard are called <i>Config Custom Policy Rules</i>.</p>
|
|
963
|
+
* <p>If you are adding a new Config Custom Lambda rule,
|
|
964
964
|
* you first need to create an Lambda function that the rule invokes to evaluate
|
|
965
965
|
* your resources. When you use <code>PutConfigRule</code> to add a Custom Lambda rule to Config, you must specify the Amazon Resource
|
|
966
966
|
* Name (ARN) that Lambda assigns to the function. You specify the ARN
|
|
967
967
|
* in the <code>SourceIdentifier</code> key. This key is part of the
|
|
968
968
|
* <code>Source</code> object, which is part of the
|
|
969
969
|
* <code>ConfigRule</code> object. </p>
|
|
970
|
-
*
|
|
971
|
-
* <p>Managed rules are predefined,
|
|
972
|
-
* customizable rules created by Config. For a list of managed rules, see
|
|
973
|
-
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
|
|
974
|
-
* Managed Rules</a>. If you are adding an Config managed rule, you must specify the
|
|
975
|
-
* rule's identifier for the <code>SourceIdentifier</code> key.</p>
|
|
976
|
-
*
|
|
977
|
-
* <p>For any new rule that you add, specify the
|
|
970
|
+
* <p>For any new Config rule that you add, specify the
|
|
978
971
|
* <code>ConfigRuleName</code> in the <code>ConfigRule</code>
|
|
979
972
|
* object. Do not specify the <code>ConfigRuleArn</code> or the
|
|
980
973
|
* <code>ConfigRuleId</code>. These values are generated by Config for new rules.</p>
|
|
981
|
-
*
|
|
974
|
+
* <p>If you are updating a rule that you added previously, you can
|
|
982
975
|
* specify the rule by <code>ConfigRuleName</code>,
|
|
983
976
|
* <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the
|
|
984
977
|
* <code>ConfigRule</code> data type that you use in this
|
|
985
978
|
* request.</p>
|
|
986
|
-
*
|
|
987
|
-
*
|
|
988
|
-
* rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating Amazon Web Services resource Configurations with Config</a>
|
|
979
|
+
* <p>For more information about developing and using Config
|
|
980
|
+
* rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating Resources with Config Rules</a>
|
|
989
981
|
* in the <i>Config Developer Guide</i>.</p>
|
|
982
|
+
* <note>
|
|
983
|
+
* <p>
|
|
984
|
+
* <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,
|
|
985
|
+
* 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>
|
|
986
|
+
* </note>
|
|
990
987
|
*/
|
|
991
988
|
putConfigRule(args: PutConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<PutConfigRuleCommandOutput>;
|
|
992
989
|
putConfigRule(args: PutConfigRuleCommandInput, cb: (err: any, data?: PutConfigRuleCommandOutput) => void): void;
|
|
@@ -995,19 +992,22 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
995
992
|
* <p>Creates and updates the configuration aggregator with the
|
|
996
993
|
* selected source accounts and regions. The source account can be
|
|
997
994
|
* individual account(s) or an organization.</p>
|
|
998
|
-
*
|
|
999
|
-
* <p>
|
|
995
|
+
* <p>
|
|
1000
996
|
* <code>accountIds</code> that are passed will be replaced with existing accounts.
|
|
1001
997
|
* 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>
|
|
1002
|
-
*
|
|
1003
|
-
*
|
|
998
|
+
* <note>
|
|
999
|
+
* <p>Config should be enabled in source accounts and regions
|
|
1004
1000
|
* you want to aggregate.</p>
|
|
1005
|
-
*
|
|
1006
|
-
* <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.
|
|
1001
|
+
* <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.
|
|
1007
1002
|
* If the caller is a management account, Config calls <code>EnableAwsServiceAccess</code> API to enable integration between Config and Organizations.
|
|
1008
1003
|
* 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>
|
|
1009
|
-
*
|
|
1010
|
-
*
|
|
1004
|
+
* <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>
|
|
1005
|
+
* </note>
|
|
1006
|
+
* <note>
|
|
1007
|
+
* <p>
|
|
1008
|
+
* <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,
|
|
1009
|
+
* 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>
|
|
1010
|
+
* </note>
|
|
1011
1011
|
*/
|
|
1012
1012
|
putConfigurationAggregator(args: PutConfigurationAggregatorCommandInput, options?: __HttpHandlerOptions): Promise<PutConfigurationAggregatorCommandOutput>;
|
|
1013
1013
|
putConfigurationAggregator(args: PutConfigurationAggregatorCommandInput, cb: (err: any, data?: PutConfigurationAggregatorCommandOutput) => void): void;
|
|
@@ -1015,18 +1015,18 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1015
1015
|
/**
|
|
1016
1016
|
* <p>Creates a new configuration recorder to record the selected
|
|
1017
1017
|
* resource configurations.</p>
|
|
1018
|
-
*
|
|
1018
|
+
* <p>You can use this action to change the role <code>roleARN</code>
|
|
1019
1019
|
* or the <code>recordingGroup</code> of an existing recorder. To
|
|
1020
1020
|
* change the role, call the action on the existing configuration
|
|
1021
1021
|
* recorder and specify a role.</p>
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
1022
|
+
* <note>
|
|
1023
|
+
* <p>Currently, you can specify only one configuration recorder
|
|
1024
1024
|
* per region in your account.</p>
|
|
1025
|
-
*
|
|
1025
|
+
* <p>If <code>ConfigurationRecorder</code> does not have the
|
|
1026
1026
|
* <b>recordingGroup</b> parameter
|
|
1027
1027
|
* specified, the default is to record all supported resource
|
|
1028
1028
|
* types.</p>
|
|
1029
|
-
*
|
|
1029
|
+
* </note>
|
|
1030
1030
|
*/
|
|
1031
1031
|
putConfigurationRecorder(args: PutConfigurationRecorderCommandInput, options?: __HttpHandlerOptions): Promise<PutConfigurationRecorderCommandOutput>;
|
|
1032
1032
|
putConfigurationRecorder(args: PutConfigurationRecorderCommandInput, cb: (err: any, data?: PutConfigurationRecorderCommandOutput) => void): void;
|
|
@@ -1037,9 +1037,9 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1037
1037
|
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
1038
1038
|
* <b>Service Limits</b>
|
|
1039
1039
|
* </a> in the Config Developer Guide.</p>
|
|
1040
|
-
*
|
|
1040
|
+
* <p>This API creates a service-linked role <code>AWSServiceRoleForConfigConforms</code> in your account.
|
|
1041
1041
|
* The service-linked role is created only when the role does not exist in your account. </p>
|
|
1042
|
-
*
|
|
1042
|
+
* <note>
|
|
1043
1043
|
* <p>You must specify only one of the follow parameters: <code>TemplateS3Uri</code>, <code>TemplateBody</code> or <code>TemplateSSMDocumentDetails</code>.</p>
|
|
1044
1044
|
* </note>
|
|
1045
1045
|
*/
|
|
@@ -1049,21 +1049,19 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1049
1049
|
/**
|
|
1050
1050
|
* <p>Creates a delivery channel object to deliver configuration
|
|
1051
1051
|
* information to an Amazon S3 bucket and Amazon SNS topic.</p>
|
|
1052
|
-
*
|
|
1052
|
+
* <p>Before you can create a delivery channel, you must create a
|
|
1053
1053
|
* configuration recorder.</p>
|
|
1054
|
-
*
|
|
1054
|
+
* <p>You can use this action to change the Amazon S3 bucket or an
|
|
1055
1055
|
* Amazon SNS topic of the existing delivery channel. To change the
|
|
1056
1056
|
* Amazon S3 bucket or an Amazon SNS topic, call this action and
|
|
1057
1057
|
* specify the changed values for the S3 bucket and the SNS topic. If
|
|
1058
1058
|
* you specify a different value for either the S3 bucket or the SNS
|
|
1059
1059
|
* topic, this action will keep the existing value for the parameter
|
|
1060
1060
|
* that is not changed.</p>
|
|
1061
|
-
*
|
|
1062
|
-
*
|
|
1061
|
+
* <note>
|
|
1062
|
+
* <p>You can have only one delivery channel per region in your
|
|
1063
1063
|
* account.</p>
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1066
|
-
* </note>
|
|
1064
|
+
* </note>
|
|
1067
1065
|
*/
|
|
1068
1066
|
putDeliveryChannel(args: PutDeliveryChannelCommandInput, options?: __HttpHandlerOptions): Promise<PutDeliveryChannelCommandOutput>;
|
|
1069
1067
|
putDeliveryChannel(args: PutDeliveryChannelCommandInput, cb: (err: any, data?: PutDeliveryChannelCommandOutput) => void): void;
|
|
@@ -1089,38 +1087,36 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1089
1087
|
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
1090
1088
|
* <b>Service Limits</b>
|
|
1091
1089
|
* </a> in the <i>Config Developer Guide</i>.</p>
|
|
1092
|
-
*
|
|
1090
|
+
* <p> Only a management account and a delegated administrator can create or update an organization Config rule.
|
|
1093
1091
|
* When calling this API with a delegated administrator, you must ensure Organizations
|
|
1094
1092
|
* <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
|
|
1095
|
-
*
|
|
1093
|
+
* <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service-linked
|
|
1096
1094
|
* role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the management or delegated administrator account of your organization.
|
|
1097
1095
|
* The service-linked role is created only when the role does not exist in the caller account.
|
|
1098
1096
|
* Config verifies the existence of role with <code>GetRole</code> action.</p>
|
|
1099
|
-
*
|
|
1097
|
+
* <p>To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
|
|
1100
1098
|
* <code>register-delegated-administrator</code> for <code>config-multiaccountsetup.amazonaws.com</code>. </p>
|
|
1101
|
-
*
|
|
1102
|
-
*
|
|
1103
|
-
*
|
|
1104
|
-
*
|
|
1105
|
-
* <p>Custom rules are rules that you can create using either Guard or Lambda functions.
|
|
1106
|
-
* Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
|
|
1107
|
-
* Repository</a>) is a policy-as-code language that allows you to write policies that
|
|
1108
|
-
* are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to
|
|
1109
|
-
* evaluate a custom rule. If you are adding a new Custom Lambda rule, you first need to create an Lambda function in the management account or a delegated
|
|
1110
|
-
* 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.
|
|
1111
|
-
* When you use <code>PutOrganizationConfigRule</code> to add a Custom Lambda rule to Config, you must
|
|
1112
|
-
* specify the Amazon Resource Name (ARN) that Lambda assigns to the function.</p>
|
|
1113
|
-
*
|
|
1114
|
-
* <p>Managed rules are predefined,
|
|
1099
|
+
* <p>There are two types of rules: <i>Config Managed Rules</i> and <i>Config Custom Rules</i>.
|
|
1100
|
+
* You can use <code>PutOrganizationConfigRule</code> to create both Config Managed Rules and Config Custom Rules.</p>
|
|
1101
|
+
* <p>Config Managed Rules are predefined,
|
|
1115
1102
|
* customizable rules created by Config. For a list of managed rules, see
|
|
1116
1103
|
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
|
|
1117
1104
|
* 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>
|
|
1105
|
+
* <p>Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions
|
|
1106
|
+
* (<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
|
|
1107
|
+
* Repository</a>), a policy-as-code language.
|
|
1118
1108
|
*
|
|
1119
|
-
*
|
|
1120
|
-
*
|
|
1109
|
+
* Config custom rules created with Lambda
|
|
1110
|
+
* are called <i>Config Custom Lambda Rules</i> and Config custom rules created with
|
|
1111
|
+
* Guard are called <i>Config Custom Policy Rules</i>.</p>
|
|
1112
|
+
* <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
|
|
1113
|
+
* 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.
|
|
1114
|
+
* When you use <code>PutOrganizationConfigRule</code> to add a Custom Lambda rule to Config, you must
|
|
1115
|
+
* specify the Amazon Resource Name (ARN) that Lambda assigns to the function.</p>
|
|
1116
|
+
* <note>
|
|
1121
1117
|
* <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p>
|
|
1122
|
-
*
|
|
1123
|
-
*
|
|
1118
|
+
* <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>
|
|
1119
|
+
* </note>
|
|
1124
1120
|
*/
|
|
1125
1121
|
putOrganizationConfigRule(args: PutOrganizationConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<PutOrganizationConfigRuleCommandOutput>;
|
|
1126
1122
|
putOrganizationConfigRule(args: PutOrganizationConfigRuleCommandInput, cb: (err: any, data?: PutOrganizationConfigRuleCommandOutput) => void): void;
|
|
@@ -1130,23 +1126,20 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1130
1126
|
* see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
|
|
1131
1127
|
* <b>Service Limits</b>
|
|
1132
1128
|
* </a> in the Config Developer Guide.</p>
|
|
1133
|
-
*
|
|
1129
|
+
* <p>Only a management account and a delegated administrator can call this API.
|
|
1134
1130
|
* When calling this API with a delegated administrator, you must ensure Organizations
|
|
1135
1131
|
* <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
|
|
1136
|
-
*
|
|
1132
|
+
* <p>This API enables organization service access for <code>config-multiaccountsetup.amazonaws.com</code>
|
|
1137
1133
|
* through the <code>EnableAWSServiceAccess</code> action and creates a
|
|
1138
1134
|
* service-linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the management or delegated administrator account of your organization.
|
|
1139
1135
|
* The service-linked role is created only when the role does not exist in the caller account.
|
|
1140
1136
|
* To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
|
|
1141
1137
|
* <code>register-delegate-admin</code> for <code>config-multiaccountsetup.amazonaws.com</code>.</p>
|
|
1142
|
-
*
|
|
1143
|
-
*
|
|
1144
|
-
*
|
|
1145
|
-
* <note>
|
|
1146
|
-
* <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p>
|
|
1147
|
-
* <p>You must specify either the <code>TemplateS3Uri</code> or the <code>TemplateBody</code> parameter, but not both.
|
|
1138
|
+
* <note>
|
|
1139
|
+
* <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p>
|
|
1140
|
+
* <p>You must specify either the <code>TemplateS3Uri</code> or the <code>TemplateBody</code> parameter, but not both.
|
|
1148
1141
|
* If you provide both Config uses the <code>TemplateS3Uri</code> parameter and ignores the <code>TemplateBody</code> parameter.</p>
|
|
1149
|
-
*
|
|
1142
|
+
* <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.
|
|
1150
1143
|
* You cannot update a conformance pack while it is in this state.</p>
|
|
1151
1144
|
* </note>
|
|
1152
1145
|
*/
|
|
@@ -1159,29 +1152,38 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1159
1152
|
* The API creates the <code>RemediationConfiguration</code> object for the Config rule.
|
|
1160
1153
|
* The Config rule must already exist for you to add a remediation configuration.
|
|
1161
1154
|
* The target (SSM document) must exist and have permissions to use the target. </p>
|
|
1162
|
-
*
|
|
1155
|
+
* <note>
|
|
1163
1156
|
* <p>If you make backward incompatible changes to the SSM document,
|
|
1164
1157
|
* you must call this again to ensure the remediations can run.</p>
|
|
1165
|
-
*
|
|
1158
|
+
* <p>This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules,
|
|
1166
1159
|
* the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.</p>
|
|
1167
1160
|
* </note>
|
|
1168
|
-
*
|
|
1161
|
+
* <note>
|
|
1169
1162
|
* <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>
|
|
1170
|
-
*
|
|
1171
|
-
*
|
|
1163
|
+
* <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>
|
|
1164
|
+
* </note>
|
|
1172
1165
|
*/
|
|
1173
1166
|
putRemediationConfigurations(args: PutRemediationConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<PutRemediationConfigurationsCommandOutput>;
|
|
1174
1167
|
putRemediationConfigurations(args: PutRemediationConfigurationsCommandInput, cb: (err: any, data?: PutRemediationConfigurationsCommandOutput) => void): void;
|
|
1175
1168
|
putRemediationConfigurations(args: PutRemediationConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutRemediationConfigurationsCommandOutput) => void): void;
|
|
1176
1169
|
/**
|
|
1177
|
-
* <p>A remediation exception is when a
|
|
1178
|
-
* This API adds a new exception or updates an existing exception for a
|
|
1179
|
-
*
|
|
1180
|
-
* <p>Config generates a remediation exception when a problem occurs
|
|
1170
|
+
* <p>A remediation exception is when a specified resource is no longer considered for auto-remediation.
|
|
1171
|
+
* This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule. </p>
|
|
1172
|
+
* <note>
|
|
1173
|
+
* <p>Config generates a remediation exception when a problem occurs running a remediation action for a specified resource.
|
|
1181
1174
|
* Remediation exceptions blocks auto-remediation until the exception is cleared.</p>
|
|
1182
1175
|
* </note>
|
|
1183
|
-
*
|
|
1184
|
-
* <p>
|
|
1176
|
+
* <note>
|
|
1177
|
+
* <p>When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until
|
|
1178
|
+
* the given Config rule for the specified resource evaluates the resource as <code>NON_COMPLIANT</code>.
|
|
1179
|
+
* 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.
|
|
1180
|
+
* Otherwise, using auto-remediation before a <code>NON_COMPLIANT</code> evaluation result can delete resources before the exception is applied.</p>
|
|
1181
|
+
* </note>
|
|
1182
|
+
* <note>
|
|
1183
|
+
* <p>Placing an exception can only be performed on resources that are <code>NON_COMPLIANT</code>.
|
|
1184
|
+
* 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.
|
|
1185
|
+
* For more information on the conditions that initiate the possible Config evaluation results,
|
|
1186
|
+
* 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>
|
|
1185
1187
|
* </note>
|
|
1186
1188
|
*/
|
|
1187
1189
|
putRemediationExceptions(args: PutRemediationExceptionsCommandInput, options?: __HttpHandlerOptions): Promise<PutRemediationExceptionsCommandOutput>;
|
|
@@ -1192,11 +1194,11 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1192
1194
|
*
|
|
1193
1195
|
* The configuration state of a resource is represented in Config as Configuration Items.
|
|
1194
1196
|
* 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>
|
|
1195
|
-
*
|
|
1197
|
+
* <note>
|
|
1196
1198
|
* <p>The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.</p>
|
|
1197
|
-
*
|
|
1199
|
+
* <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.
|
|
1198
1200
|
* </p>
|
|
1199
|
-
*
|
|
1201
|
+
* <p>Write-only schema properites are not recorded as part of the published configuration item.</p>
|
|
1200
1202
|
* </note>
|
|
1201
1203
|
*/
|
|
1202
1204
|
putResourceConfig(args: PutResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<PutResourceConfigCommandOutput>;
|
|
@@ -1210,10 +1212,10 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1210
1212
|
* as <b>default</b>. When you have a
|
|
1211
1213
|
* <code>RetentionConfiguration</code> object named <b>default</b>, calling the API modifies the
|
|
1212
1214
|
* default object. </p>
|
|
1213
|
-
*
|
|
1214
|
-
*
|
|
1215
|
+
* <note>
|
|
1216
|
+
* <p>Currently, Config supports only one retention
|
|
1215
1217
|
* configuration per region in your account.</p>
|
|
1216
|
-
*
|
|
1218
|
+
* </note>
|
|
1217
1219
|
*/
|
|
1218
1220
|
putRetentionConfiguration(args: PutRetentionConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutRetentionConfigurationCommandOutput>;
|
|
1219
1221
|
putRetentionConfiguration(args: PutRetentionConfigurationCommandInput, cb: (err: any, data?: PutRetentionConfigurationCommandOutput) => void): void;
|
|
@@ -1221,6 +1223,11 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1221
1223
|
/**
|
|
1222
1224
|
* <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.
|
|
1223
1225
|
* You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.</p>
|
|
1226
|
+
* <note>
|
|
1227
|
+
* <p>
|
|
1228
|
+
* <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,
|
|
1229
|
+
* 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>
|
|
1230
|
+
* </note>
|
|
1224
1231
|
*/
|
|
1225
1232
|
putStoredQuery(args: PutStoredQueryCommandInput, options?: __HttpHandlerOptions): Promise<PutStoredQueryCommandOutput>;
|
|
1226
1233
|
putStoredQuery(args: PutStoredQueryCommandInput, cb: (err: any, data?: PutStoredQueryCommandOutput) => void): void;
|
|
@@ -1228,25 +1235,23 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1228
1235
|
/**
|
|
1229
1236
|
* <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,
|
|
1230
1237
|
* performs the corresponding search, and returns resource configurations matching the properties.</p>
|
|
1231
|
-
*
|
|
1238
|
+
* <p>For more information about query components, see the
|
|
1232
1239
|
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html">
|
|
1233
1240
|
* <b>Query Components</b>
|
|
1234
1241
|
* </a> section in the Config Developer Guide.</p>
|
|
1235
|
-
*
|
|
1236
|
-
*
|
|
1237
|
-
* <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>)
|
|
1242
|
+
* <note>
|
|
1243
|
+
* <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>)
|
|
1238
1244
|
* and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 500.</p>
|
|
1239
|
-
*
|
|
1240
|
-
* <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>)
|
|
1245
|
+
* <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>)
|
|
1241
1246
|
* and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 25.</p>
|
|
1242
|
-
*
|
|
1247
|
+
* </note>
|
|
1243
1248
|
*/
|
|
1244
1249
|
selectAggregateResourceConfig(args: SelectAggregateResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<SelectAggregateResourceConfigCommandOutput>;
|
|
1245
1250
|
selectAggregateResourceConfig(args: SelectAggregateResourceConfigCommandInput, cb: (err: any, data?: SelectAggregateResourceConfigCommandOutput) => void): void;
|
|
1246
1251
|
selectAggregateResourceConfig(args: SelectAggregateResourceConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SelectAggregateResourceConfigCommandOutput) => void): void;
|
|
1247
1252
|
/**
|
|
1248
1253
|
* <p>Accepts a structured query language (SQL) <code>SELECT</code> command, performs the corresponding search, and returns resource configurations matching the properties.</p>
|
|
1249
|
-
*
|
|
1254
|
+
* <p>For more information about query components, see the
|
|
1250
1255
|
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html">
|
|
1251
1256
|
* <b>Query Components</b>
|
|
1252
1257
|
* </a> section in the <i>Config Developer Guide</i>.</p>
|
|
@@ -1262,46 +1267,44 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1262
1267
|
* <code>StartConfigRulesEvaluation</code> does not re-record the
|
|
1263
1268
|
* latest configuration state for your resources. It re-runs an
|
|
1264
1269
|
* evaluation against the last known state of your resources. </p>
|
|
1265
|
-
*
|
|
1266
|
-
*
|
|
1267
|
-
*
|
|
1268
|
-
* <p>An existing <code>StartConfigRulesEvaluation</code> call for
|
|
1270
|
+
* <p>You can specify up to 25 Config rules per request. </p>
|
|
1271
|
+
* <p>An existing <code>StartConfigRulesEvaluation</code> call for
|
|
1269
1272
|
* the specified rules must complete before you can call the API again.
|
|
1270
1273
|
* If you chose to have Config stream to an Amazon SNS topic, you
|
|
1271
1274
|
* will receive a <code>ConfigRuleEvaluationStarted</code> notification
|
|
1272
1275
|
* when the evaluation starts.</p>
|
|
1273
|
-
*
|
|
1274
|
-
*
|
|
1276
|
+
* <note>
|
|
1277
|
+
* <p>You don't need to call the
|
|
1275
1278
|
* <code>StartConfigRulesEvaluation</code> API to run an
|
|
1276
1279
|
* evaluation for a new rule. When you create a rule, Config
|
|
1277
1280
|
* evaluates your resources against the rule automatically.
|
|
1278
1281
|
* </p>
|
|
1279
|
-
*
|
|
1280
|
-
*
|
|
1282
|
+
* </note>
|
|
1283
|
+
* <p>The <code>StartConfigRulesEvaluation</code> API is useful if
|
|
1281
1284
|
* you want to run on-demand evaluations, such as the following
|
|
1282
1285
|
* example:</p>
|
|
1283
|
-
*
|
|
1286
|
+
* <ol>
|
|
1284
1287
|
* <li>
|
|
1285
|
-
*
|
|
1288
|
+
* <p>You have a custom rule that evaluates your IAM
|
|
1286
1289
|
* resources every 24 hours.</p>
|
|
1287
|
-
*
|
|
1290
|
+
* </li>
|
|
1288
1291
|
* <li>
|
|
1289
|
-
*
|
|
1292
|
+
* <p>You update your Lambda function to add additional
|
|
1290
1293
|
* conditions to your rule.</p>
|
|
1291
|
-
*
|
|
1294
|
+
* </li>
|
|
1292
1295
|
* <li>
|
|
1293
|
-
*
|
|
1296
|
+
* <p>Instead of waiting for the next periodic evaluation,
|
|
1294
1297
|
* you call the <code>StartConfigRulesEvaluation</code>
|
|
1295
1298
|
* API.</p>
|
|
1296
|
-
*
|
|
1299
|
+
* </li>
|
|
1297
1300
|
* <li>
|
|
1298
|
-
*
|
|
1301
|
+
* <p>Config invokes your Lambda function and evaluates
|
|
1299
1302
|
* your IAM resources.</p>
|
|
1300
|
-
*
|
|
1303
|
+
* </li>
|
|
1301
1304
|
* <li>
|
|
1302
|
-
*
|
|
1305
|
+
* <p>Your custom rule will still run periodic evaluations
|
|
1303
1306
|
* every 24 hours.</p>
|
|
1304
|
-
*
|
|
1307
|
+
* </li>
|
|
1305
1308
|
* </ol>
|
|
1306
1309
|
*/
|
|
1307
1310
|
startConfigRulesEvaluation(args: StartConfigRulesEvaluationCommandInput, options?: __HttpHandlerOptions): Promise<StartConfigRulesEvaluationCommandOutput>;
|
|
@@ -1310,7 +1313,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1310
1313
|
/**
|
|
1311
1314
|
* <p>Starts recording configurations of the Amazon Web Services resources you have
|
|
1312
1315
|
* selected to record in your Amazon Web Services account.</p>
|
|
1313
|
-
*
|
|
1316
|
+
* <p>You must have created at least one delivery channel to
|
|
1314
1317
|
* successfully start the configuration recorder.</p>
|
|
1315
1318
|
*/
|
|
1316
1319
|
startConfigurationRecorder(args: StartConfigurationRecorderCommandInput, options?: __HttpHandlerOptions): Promise<StartConfigurationRecorderCommandOutput>;
|
|
@@ -1318,7 +1321,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1318
1321
|
startConfigurationRecorder(args: StartConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartConfigurationRecorderCommandOutput) => void): void;
|
|
1319
1322
|
/**
|
|
1320
1323
|
* <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>
|
|
1321
|
-
*
|
|
1324
|
+
* <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>
|
|
1322
1325
|
*/
|
|
1323
1326
|
startRemediationExecution(args: StartRemediationExecutionCommandInput, options?: __HttpHandlerOptions): Promise<StartRemediationExecutionCommandOutput>;
|
|
1324
1327
|
startRemediationExecution(args: StartRemediationExecutionCommandInput, cb: (err: any, data?: StartRemediationExecutionCommandOutput) => void): void;
|
|
@@ -1327,10 +1330,13 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1327
1330
|
* <p>Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules.
|
|
1328
1331
|
* You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all
|
|
1329
1332
|
* of the Config rules in your account that match with the specified proactive mode and resource type.</p>
|
|
1330
|
-
*
|
|
1331
|
-
*
|
|
1332
|
-
* <p>
|
|
1333
|
-
*
|
|
1333
|
+
* <note>
|
|
1334
|
+
* <p>Ensure you have the <code>cloudformation:DescribeType</code> role setup to validate the resource type schema.</p>
|
|
1335
|
+
* <p>You can find the
|
|
1336
|
+
* <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:
|
|
1337
|
+
* <code>aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE</code>.</p>
|
|
1338
|
+
* <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>
|
|
1339
|
+
* 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>
|
|
1334
1340
|
* </note>
|
|
1335
1341
|
*/
|
|
1336
1342
|
startResourceEvaluation(args: StartResourceEvaluationCommandInput, options?: __HttpHandlerOptions): Promise<StartResourceEvaluationCommandOutput>;
|
|
@@ -1344,7 +1350,7 @@ export declare class ConfigService extends ConfigServiceClient {
|
|
|
1344
1350
|
stopConfigurationRecorder(args: StopConfigurationRecorderCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopConfigurationRecorderCommandOutput) => void): void;
|
|
1345
1351
|
/**
|
|
1346
1352
|
* <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.
|
|
1347
|
-
* When a resource is deleted, the tags associated with that resource are deleted as well.</p>
|
|
1353
|
+
* 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>
|
|
1348
1354
|
*/
|
|
1349
1355
|
tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
|
|
1350
1356
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|