@aws-sdk/client-config-service 3.293.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 +3 -3
|
@@ -19,16 +19,16 @@ export interface PutRemediationConfigurationsCommandOutput extends PutRemediatio
|
|
|
19
19
|
* The API creates the <code>RemediationConfiguration</code> object for the Config rule.
|
|
20
20
|
* The Config rule must already exist for you to add a remediation configuration.
|
|
21
21
|
* The target (SSM document) must exist and have permissions to use the target. </p>
|
|
22
|
-
*
|
|
22
|
+
* <note>
|
|
23
23
|
* <p>If you make backward incompatible changes to the SSM document,
|
|
24
24
|
* you must call this again to ensure the remediations can run.</p>
|
|
25
|
-
*
|
|
25
|
+
* <p>This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules,
|
|
26
26
|
* the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.</p>
|
|
27
27
|
* </note>
|
|
28
|
-
*
|
|
28
|
+
* <note>
|
|
29
29
|
* <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>
|
|
30
|
-
*
|
|
31
|
-
*
|
|
30
|
+
* <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>
|
|
31
|
+
* </note>
|
|
32
32
|
* @example
|
|
33
33
|
* Use a bare-bones client and the command you need to make an API call.
|
|
34
34
|
* ```javascript
|
|
@@ -45,7 +45,7 @@ export interface PutRemediationConfigurationsCommandOutput extends PutRemediatio
|
|
|
45
45
|
*
|
|
46
46
|
* @throws {@link InsufficientPermissionsException} (client fault)
|
|
47
47
|
* <p>Indicates one of the following errors:</p>
|
|
48
|
-
*
|
|
48
|
+
* <ul>
|
|
49
49
|
* <li>
|
|
50
50
|
* <p>For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.</p>
|
|
51
51
|
* </li>
|
|
@@ -57,7 +57,7 @@ export interface PutRemediationConfigurationsCommandOutput extends PutRemediatio
|
|
|
57
57
|
* </li>
|
|
58
58
|
* <li>
|
|
59
59
|
* <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions: </p>
|
|
60
|
-
*
|
|
60
|
+
* <ul>
|
|
61
61
|
* <li>
|
|
62
62
|
* <p>You do not have permission to call IAM <code>GetRole</code> action or create a service-linked role.</p>
|
|
63
63
|
* </li>
|
|
@@ -65,11 +65,11 @@ export interface PutRemediationConfigurationsCommandOutput extends PutRemediatio
|
|
|
65
65
|
* <p>You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.</p>
|
|
66
66
|
* </li>
|
|
67
67
|
* </ul>
|
|
68
|
-
*
|
|
68
|
+
* </li>
|
|
69
69
|
* </ul>
|
|
70
70
|
*
|
|
71
71
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
72
|
-
* <p>One or more of the specified parameters are
|
|
72
|
+
* <p>One or more of the specified parameters are not valid. Verify
|
|
73
73
|
* that your parameters are valid and try again.</p>
|
|
74
74
|
*
|
|
75
75
|
*
|
|
@@ -14,14 +14,23 @@ export interface PutRemediationExceptionsCommandInput extends PutRemediationExce
|
|
|
14
14
|
export interface PutRemediationExceptionsCommandOutput extends PutRemediationExceptionsResponse, __MetadataBearer {
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
|
-
* <p>A remediation exception is when a
|
|
18
|
-
* This API adds a new exception or updates an existing exception for a
|
|
19
|
-
*
|
|
20
|
-
* <p>Config generates a remediation exception when a problem occurs
|
|
17
|
+
* <p>A remediation exception is when a specified resource is no longer considered for auto-remediation.
|
|
18
|
+
* This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule. </p>
|
|
19
|
+
* <note>
|
|
20
|
+
* <p>Config generates a remediation exception when a problem occurs running a remediation action for a specified resource.
|
|
21
21
|
* Remediation exceptions blocks auto-remediation until the exception is cleared.</p>
|
|
22
22
|
* </note>
|
|
23
|
-
*
|
|
24
|
-
* <p>
|
|
23
|
+
* <note>
|
|
24
|
+
* <p>When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until
|
|
25
|
+
* the given Config rule for the specified resource evaluates the resource as <code>NON_COMPLIANT</code>.
|
|
26
|
+
* 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.
|
|
27
|
+
* Otherwise, using auto-remediation before a <code>NON_COMPLIANT</code> evaluation result can delete resources before the exception is applied.</p>
|
|
28
|
+
* </note>
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>Placing an exception can only be performed on resources that are <code>NON_COMPLIANT</code>.
|
|
31
|
+
* 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.
|
|
32
|
+
* For more information on the conditions that initiate the possible Config evaluation results,
|
|
33
|
+
* 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>
|
|
25
34
|
* </note>
|
|
26
35
|
* @example
|
|
27
36
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -39,7 +48,7 @@ export interface PutRemediationExceptionsCommandOutput extends PutRemediationExc
|
|
|
39
48
|
*
|
|
40
49
|
* @throws {@link InsufficientPermissionsException} (client fault)
|
|
41
50
|
* <p>Indicates one of the following errors:</p>
|
|
42
|
-
*
|
|
51
|
+
* <ul>
|
|
43
52
|
* <li>
|
|
44
53
|
* <p>For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.</p>
|
|
45
54
|
* </li>
|
|
@@ -51,7 +60,7 @@ export interface PutRemediationExceptionsCommandOutput extends PutRemediationExc
|
|
|
51
60
|
* </li>
|
|
52
61
|
* <li>
|
|
53
62
|
* <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions: </p>
|
|
54
|
-
*
|
|
63
|
+
* <ul>
|
|
55
64
|
* <li>
|
|
56
65
|
* <p>You do not have permission to call IAM <code>GetRole</code> action or create a service-linked role.</p>
|
|
57
66
|
* </li>
|
|
@@ -59,11 +68,11 @@ export interface PutRemediationExceptionsCommandOutput extends PutRemediationExc
|
|
|
59
68
|
* <p>You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.</p>
|
|
60
69
|
* </li>
|
|
61
70
|
* </ul>
|
|
62
|
-
*
|
|
71
|
+
* </li>
|
|
63
72
|
* </ul>
|
|
64
73
|
*
|
|
65
74
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
66
|
-
* <p>One or more of the specified parameters are
|
|
75
|
+
* <p>One or more of the specified parameters are not valid. Verify
|
|
67
76
|
* that your parameters are valid and try again.</p>
|
|
68
77
|
*
|
|
69
78
|
*
|
|
@@ -18,11 +18,11 @@ export interface PutResourceConfigCommandOutput extends __MetadataBearer {
|
|
|
18
18
|
*
|
|
19
19
|
* The configuration state of a resource is represented in Config as Configuration Items.
|
|
20
20
|
* 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>
|
|
21
|
-
*
|
|
21
|
+
* <note>
|
|
22
22
|
* <p>The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.</p>
|
|
23
|
-
*
|
|
23
|
+
* <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.
|
|
24
24
|
* </p>
|
|
25
|
-
*
|
|
25
|
+
* <p>Write-only schema properites are not recorded as part of the published configuration item.</p>
|
|
26
26
|
* </note>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -40,7 +40,7 @@ export interface PutResourceConfigCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
*
|
|
41
41
|
* @throws {@link InsufficientPermissionsException} (client fault)
|
|
42
42
|
* <p>Indicates one of the following errors:</p>
|
|
43
|
-
*
|
|
43
|
+
* <ul>
|
|
44
44
|
* <li>
|
|
45
45
|
* <p>For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.</p>
|
|
46
46
|
* </li>
|
|
@@ -52,7 +52,7 @@ export interface PutResourceConfigCommandOutput extends __MetadataBearer {
|
|
|
52
52
|
* </li>
|
|
53
53
|
* <li>
|
|
54
54
|
* <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions: </p>
|
|
55
|
-
*
|
|
55
|
+
* <ul>
|
|
56
56
|
* <li>
|
|
57
57
|
* <p>You do not have permission to call IAM <code>GetRole</code> action or create a service-linked role.</p>
|
|
58
58
|
* </li>
|
|
@@ -60,7 +60,7 @@ export interface PutResourceConfigCommandOutput extends __MetadataBearer {
|
|
|
60
60
|
* <p>You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.</p>
|
|
61
61
|
* </li>
|
|
62
62
|
* </ul>
|
|
63
|
-
*
|
|
63
|
+
* </li>
|
|
64
64
|
* </ul>
|
|
65
65
|
*
|
|
66
66
|
* @throws {@link MaxActiveResourcesExceededException} (client fault)
|
|
@@ -72,9 +72,9 @@ export interface PutResourceConfigCommandOutput extends __MetadataBearer {
|
|
|
72
72
|
* <p>There is no configuration recorder running.</p>
|
|
73
73
|
*
|
|
74
74
|
* @throws {@link ValidationException} (client fault)
|
|
75
|
-
* <p>The requested action is
|
|
76
|
-
*
|
|
77
|
-
*
|
|
75
|
+
* <p>The requested action is not valid.</p>
|
|
76
|
+
* <p>For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.</p>
|
|
77
|
+
* <p>For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.</p>
|
|
78
78
|
*
|
|
79
79
|
*
|
|
80
80
|
*/
|
|
@@ -21,10 +21,10 @@ export interface PutRetentionConfigurationCommandOutput extends PutRetentionConf
|
|
|
21
21
|
* as <b>default</b>. When you have a
|
|
22
22
|
* <code>RetentionConfiguration</code> object named <b>default</b>, calling the API modifies the
|
|
23
23
|
* default object. </p>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
24
|
+
* <note>
|
|
25
|
+
* <p>Currently, Config supports only one retention
|
|
26
26
|
* configuration per region in your account.</p>
|
|
27
|
-
*
|
|
27
|
+
* </note>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -40,7 +40,7 @@ export interface PutRetentionConfigurationCommandOutput extends PutRetentionConf
|
|
|
40
40
|
* @see {@link ConfigServiceClientResolvedConfig | config} for ConfigServiceClient's `config` shape.
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
43
|
-
* <p>One or more of the specified parameters are
|
|
43
|
+
* <p>One or more of the specified parameters are not valid. Verify
|
|
44
44
|
* that your parameters are valid and try again.</p>
|
|
45
45
|
*
|
|
46
46
|
* @throws {@link MaxNumberOfRetentionConfigurationsExceededException} (client fault)
|
|
@@ -16,6 +16,11 @@ export interface PutStoredQueryCommandOutput extends PutStoredQueryResponse, __M
|
|
|
16
16
|
/**
|
|
17
17
|
* <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.
|
|
18
18
|
* You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.</p>
|
|
19
|
+
* <note>
|
|
20
|
+
* <p>
|
|
21
|
+
* <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,
|
|
22
|
+
* 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>
|
|
23
|
+
* </note>
|
|
19
24
|
* @example
|
|
20
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
26
|
* ```javascript
|
|
@@ -40,9 +45,9 @@ export interface PutStoredQueryCommandOutput extends PutStoredQueryResponse, __M
|
|
|
40
45
|
* </a> in the Config Developer Guide.</p>
|
|
41
46
|
*
|
|
42
47
|
* @throws {@link ValidationException} (client fault)
|
|
43
|
-
* <p>The requested action is
|
|
44
|
-
*
|
|
45
|
-
*
|
|
48
|
+
* <p>The requested action is not valid.</p>
|
|
49
|
+
* <p>For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.</p>
|
|
50
|
+
* <p>For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.</p>
|
|
46
51
|
*
|
|
47
52
|
*
|
|
48
53
|
*/
|
|
@@ -16,18 +16,16 @@ export interface SelectAggregateResourceConfigCommandOutput extends SelectAggreg
|
|
|
16
16
|
/**
|
|
17
17
|
* <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,
|
|
18
18
|
* performs the corresponding search, and returns resource configurations matching the properties.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>For more information about query components, see the
|
|
20
20
|
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html">
|
|
21
21
|
* <b>Query Components</b>
|
|
22
22
|
* </a> section in the Config Developer Guide.</p>
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* <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>)
|
|
23
|
+
* <note>
|
|
24
|
+
* <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>)
|
|
26
25
|
* and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 500.</p>
|
|
27
|
-
*
|
|
28
|
-
* <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>)
|
|
26
|
+
* <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>)
|
|
29
27
|
* and do not specify the <code>MaxResults</code> or the <code>Limit</code> query parameters, the default page size is set to 25.</p>
|
|
30
|
-
*
|
|
28
|
+
* </note>
|
|
31
29
|
* @example
|
|
32
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
33
31
|
* ```javascript
|
|
@@ -49,7 +47,7 @@ export interface SelectAggregateResourceConfigCommandOutput extends SelectAggreg
|
|
|
49
47
|
* <p>The specified limit is outside the allowable range.</p>
|
|
50
48
|
*
|
|
51
49
|
* @throws {@link InvalidNextTokenException} (client fault)
|
|
52
|
-
* <p>The specified next token is
|
|
50
|
+
* <p>The specified next token is not valid. Specify the
|
|
53
51
|
* <code>nextToken</code> string that was returned in the previous
|
|
54
52
|
* response to get the next page of results.</p>
|
|
55
53
|
*
|
|
@@ -15,7 +15,7 @@ export interface SelectResourceConfigCommandOutput extends SelectResourceConfigR
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <p>Accepts a structured query language (SQL) <code>SELECT</code> command, performs the corresponding search, and returns resource configurations matching the properties.</p>
|
|
18
|
-
*
|
|
18
|
+
* <p>For more information about query components, see the
|
|
19
19
|
* <a href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html">
|
|
20
20
|
* <b>Query Components</b>
|
|
21
21
|
* </a> section in the <i>Config Developer Guide</i>.</p>
|
|
@@ -40,7 +40,7 @@ export interface SelectResourceConfigCommandOutput extends SelectResourceConfigR
|
|
|
40
40
|
* <p>The specified limit is outside the allowable range.</p>
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link InvalidNextTokenException} (client fault)
|
|
43
|
-
* <p>The specified next token is
|
|
43
|
+
* <p>The specified next token is not valid. Specify the
|
|
44
44
|
* <code>nextToken</code> string that was returned in the previous
|
|
45
45
|
* response to get the next page of results.</p>
|
|
46
46
|
*
|
|
@@ -21,46 +21,44 @@ export interface StartConfigRulesEvaluationCommandOutput extends StartConfigRule
|
|
|
21
21
|
* <code>StartConfigRulesEvaluation</code> does not re-record the
|
|
22
22
|
* latest configuration state for your resources. It re-runs an
|
|
23
23
|
* evaluation against the last known state of your resources. </p>
|
|
24
|
-
*
|
|
25
|
-
*
|
|
26
|
-
*
|
|
27
|
-
* <p>An existing <code>StartConfigRulesEvaluation</code> call for
|
|
24
|
+
* <p>You can specify up to 25 Config rules per request. </p>
|
|
25
|
+
* <p>An existing <code>StartConfigRulesEvaluation</code> call for
|
|
28
26
|
* the specified rules must complete before you can call the API again.
|
|
29
27
|
* If you chose to have Config stream to an Amazon SNS topic, you
|
|
30
28
|
* will receive a <code>ConfigRuleEvaluationStarted</code> notification
|
|
31
29
|
* when the evaluation starts.</p>
|
|
32
|
-
*
|
|
33
|
-
*
|
|
30
|
+
* <note>
|
|
31
|
+
* <p>You don't need to call the
|
|
34
32
|
* <code>StartConfigRulesEvaluation</code> API to run an
|
|
35
33
|
* evaluation for a new rule. When you create a rule, Config
|
|
36
34
|
* evaluates your resources against the rule automatically.
|
|
37
35
|
* </p>
|
|
38
|
-
*
|
|
39
|
-
*
|
|
36
|
+
* </note>
|
|
37
|
+
* <p>The <code>StartConfigRulesEvaluation</code> API is useful if
|
|
40
38
|
* you want to run on-demand evaluations, such as the following
|
|
41
39
|
* example:</p>
|
|
42
|
-
*
|
|
40
|
+
* <ol>
|
|
43
41
|
* <li>
|
|
44
|
-
*
|
|
42
|
+
* <p>You have a custom rule that evaluates your IAM
|
|
45
43
|
* resources every 24 hours.</p>
|
|
46
|
-
*
|
|
44
|
+
* </li>
|
|
47
45
|
* <li>
|
|
48
|
-
*
|
|
46
|
+
* <p>You update your Lambda function to add additional
|
|
49
47
|
* conditions to your rule.</p>
|
|
50
|
-
*
|
|
48
|
+
* </li>
|
|
51
49
|
* <li>
|
|
52
|
-
*
|
|
50
|
+
* <p>Instead of waiting for the next periodic evaluation,
|
|
53
51
|
* you call the <code>StartConfigRulesEvaluation</code>
|
|
54
52
|
* API.</p>
|
|
55
|
-
*
|
|
53
|
+
* </li>
|
|
56
54
|
* <li>
|
|
57
|
-
*
|
|
55
|
+
* <p>Config invokes your Lambda function and evaluates
|
|
58
56
|
* your IAM resources.</p>
|
|
59
|
-
*
|
|
57
|
+
* </li>
|
|
60
58
|
* <li>
|
|
61
|
-
*
|
|
59
|
+
* <p>Your custom rule will still run periodic evaluations
|
|
62
60
|
* every 24 hours.</p>
|
|
63
|
-
*
|
|
61
|
+
* </li>
|
|
64
62
|
* </ol>
|
|
65
63
|
* @example
|
|
66
64
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -77,23 +75,23 @@ export interface StartConfigRulesEvaluationCommandOutput extends StartConfigRule
|
|
|
77
75
|
* @see {@link ConfigServiceClientResolvedConfig | config} for ConfigServiceClient's `config` shape.
|
|
78
76
|
*
|
|
79
77
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
80
|
-
* <p>One or more of the specified parameters are
|
|
78
|
+
* <p>One or more of the specified parameters are not valid. Verify
|
|
81
79
|
* that your parameters are valid and try again.</p>
|
|
82
80
|
*
|
|
83
81
|
* @throws {@link LimitExceededException} (client fault)
|
|
84
82
|
* <p>For <code>StartConfigRulesEvaluation</code> API, this exception
|
|
85
83
|
* is thrown if an evaluation is in progress or if you call the <a>StartConfigRulesEvaluation</a> API more than once per
|
|
86
84
|
* minute.</p>
|
|
87
|
-
*
|
|
85
|
+
* <p>For <code>PutConfigurationAggregator</code> API, this exception
|
|
88
86
|
* is thrown if the number of accounts and aggregators exceeds the
|
|
89
87
|
* limit.</p>
|
|
90
88
|
*
|
|
91
89
|
* @throws {@link NoSuchConfigRuleException} (client fault)
|
|
92
|
-
* <p>The Config rule in the request is
|
|
90
|
+
* <p>The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.</p>
|
|
93
91
|
*
|
|
94
92
|
* @throws {@link ResourceInUseException} (client fault)
|
|
95
93
|
* <p>You see this exception in the following cases: </p>
|
|
96
|
-
*
|
|
94
|
+
* <ul>
|
|
97
95
|
* <li>
|
|
98
96
|
* <p>For DeleteConfigRule, Config is deleting this rule. Try your request again later.</p>
|
|
99
97
|
* </li>
|
|
@@ -16,7 +16,7 @@ export interface StartConfigurationRecorderCommandOutput extends __MetadataBeare
|
|
|
16
16
|
/**
|
|
17
17
|
* <p>Starts recording configurations of the Amazon Web Services resources you have
|
|
18
18
|
* selected to record in your Amazon Web Services account.</p>
|
|
19
|
-
*
|
|
19
|
+
* <p>You must have created at least one delivery channel to
|
|
20
20
|
* successfully start the configuration recorder.</p>
|
|
21
21
|
* @example
|
|
22
22
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -15,7 +15,7 @@ export interface StartRemediationExecutionCommandOutput extends StartRemediation
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <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>
|
|
18
|
-
*
|
|
18
|
+
* <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>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -32,7 +32,7 @@ export interface StartRemediationExecutionCommandOutput extends StartRemediation
|
|
|
32
32
|
*
|
|
33
33
|
* @throws {@link InsufficientPermissionsException} (client fault)
|
|
34
34
|
* <p>Indicates one of the following errors:</p>
|
|
35
|
-
*
|
|
35
|
+
* <ul>
|
|
36
36
|
* <li>
|
|
37
37
|
* <p>For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.</p>
|
|
38
38
|
* </li>
|
|
@@ -44,7 +44,7 @@ export interface StartRemediationExecutionCommandOutput extends StartRemediation
|
|
|
44
44
|
* </li>
|
|
45
45
|
* <li>
|
|
46
46
|
* <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions: </p>
|
|
47
|
-
*
|
|
47
|
+
* <ul>
|
|
48
48
|
* <li>
|
|
49
49
|
* <p>You do not have permission to call IAM <code>GetRole</code> action or create a service-linked role.</p>
|
|
50
50
|
* </li>
|
|
@@ -52,11 +52,11 @@ export interface StartRemediationExecutionCommandOutput extends StartRemediation
|
|
|
52
52
|
* <p>You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.</p>
|
|
53
53
|
* </li>
|
|
54
54
|
* </ul>
|
|
55
|
-
*
|
|
55
|
+
* </li>
|
|
56
56
|
* </ul>
|
|
57
57
|
*
|
|
58
58
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
59
|
-
* <p>One or more of the specified parameters are
|
|
59
|
+
* <p>One or more of the specified parameters are not valid. Verify
|
|
60
60
|
* that your parameters are valid and try again.</p>
|
|
61
61
|
*
|
|
62
62
|
* @throws {@link NoSuchRemediationConfigurationException} (client fault)
|
|
@@ -17,10 +17,13 @@ export interface StartResourceEvaluationCommandOutput extends StartResourceEvalu
|
|
|
17
17
|
* <p>Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules.
|
|
18
18
|
* You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all
|
|
19
19
|
* of the Config rules in your account that match with the specified proactive mode and resource type.</p>
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
* <p>
|
|
23
|
-
*
|
|
20
|
+
* <note>
|
|
21
|
+
* <p>Ensure you have the <code>cloudformation:DescribeType</code> role setup to validate the resource type schema.</p>
|
|
22
|
+
* <p>You can find the
|
|
23
|
+
* <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:
|
|
24
|
+
* <code>aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE</code>.</p>
|
|
25
|
+
* <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>
|
|
26
|
+
* 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>
|
|
24
27
|
* </note>
|
|
25
28
|
* @example
|
|
26
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -40,7 +43,7 @@ export interface StartResourceEvaluationCommandOutput extends StartResourceEvalu
|
|
|
40
43
|
* <p>Using the same client token with one or more different parameters. Specify a new client token with the parameter changes and try again.</p>
|
|
41
44
|
*
|
|
42
45
|
* @throws {@link InvalidParameterValueException} (client fault)
|
|
43
|
-
* <p>One or more of the specified parameters are
|
|
46
|
+
* <p>One or more of the specified parameters are not valid. Verify
|
|
44
47
|
* that your parameters are valid and try again.</p>
|
|
45
48
|
*
|
|
46
49
|
*
|
|
@@ -15,7 +15,7 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* <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.
|
|
18
|
-
* When a resource is deleted, the tags associated with that resource are deleted as well.</p>
|
|
18
|
+
* 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>
|
|
19
19
|
* @example
|
|
20
20
|
* Use a bare-bones client and the command you need to make an API call.
|
|
21
21
|
* ```javascript
|
|
@@ -40,9 +40,9 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
|
|
|
40
40
|
* </a> in the Config Developer Guide.</p>
|
|
41
41
|
*
|
|
42
42
|
* @throws {@link ValidationException} (client fault)
|
|
43
|
-
* <p>The requested action is
|
|
44
|
-
*
|
|
45
|
-
*
|
|
43
|
+
* <p>The requested action is not valid.</p>
|
|
44
|
+
* <p>For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.</p>
|
|
45
|
+
* <p>For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.</p>
|
|
46
46
|
*
|
|
47
47
|
*
|
|
48
48
|
*/
|
|
@@ -33,9 +33,9 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
|
|
|
33
33
|
* <p>You have specified a resource that does not exist.</p>
|
|
34
34
|
*
|
|
35
35
|
* @throws {@link ValidationException} (client fault)
|
|
36
|
-
* <p>The requested action is
|
|
37
|
-
*
|
|
38
|
-
*
|
|
36
|
+
* <p>The requested action is not valid.</p>
|
|
37
|
+
* <p>For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.</p>
|
|
38
|
+
* <p>For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.</p>
|
|
39
39
|
*
|
|
40
40
|
*
|
|
41
41
|
*/
|
|
@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
|
|
|
12
12
|
defaultSigningName: string;
|
|
13
13
|
};
|
|
14
14
|
export interface EndpointParameters extends __EndpointParameters {
|
|
15
|
-
Region
|
|
15
|
+
Region?: string;
|
|
16
16
|
UseDualStack?: boolean;
|
|
17
17
|
UseFIPS?: boolean;
|
|
18
18
|
Endpoint?: string;
|