|
20 | 20 | "DescribeComplianceByResource": "<p>Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with.</p> <p>A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.</p> <p>If AWS Config has no current evaluation results for the resource, it returns <code>INSUFFICIENT_DATA</code>. This result might indicate one of the following conditions about the rules that evaluate the resource:</p> <ul> <li> <p>AWS Config has never invoked an evaluation for the rule. To check whether it has, use the <code>DescribeConfigRuleEvaluationStatus</code> action to get the <code>LastSuccessfulInvocationTime</code> and <code>LastFailedInvocationTime</code>.</p> </li> <li> <p>The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the <code>config:PutEvaluations</code> permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the <code>config:PutEvaluations</code> permission.</p> </li> <li> <p>The rule's AWS Lambda function has returned <code>NOT_APPLICABLE</code> for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.</p> </li> </ul>", |
21 | 21 | "DescribeConfigRuleEvaluationStatus": "<p>Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.</p>", |
22 | 22 | "DescribeConfigRules": "<p>Returns details about your AWS Config rules.</p>", |
23 | | - "DescribeConfigurationAggregatorSourcesStatus": "<p> Returns status information for sources within an aggregator. The status includes information about the last time AWS Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message. </p>", |
| 23 | + "DescribeConfigurationAggregatorSourcesStatus": "<p>Returns status information for sources within an aggregator. The status includes information about the last time AWS Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message. </p>", |
24 | 24 | "DescribeConfigurationAggregators": "<p>Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account. </p>", |
25 | 25 | "DescribeConfigurationRecorderStatus": "<p>Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.</p> <note> <p>Currently, you can specify only one configuration recorder per region in your account.</p> </note>", |
26 | 26 | "DescribeConfigurationRecorders": "<p>Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.</p> <note> <p>Currently, you can specify only one configuration recorder per region in your account.</p> </note>", |
|
51 | 51 | "PutEvaluations": "<p>Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.</p>", |
52 | 52 | "PutRemediationConfigurations": "<p>Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the <code>RemediationConfiguration</code> object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. </p>", |
53 | 53 | "PutRetentionConfiguration": "<p>Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information. The API creates the <code>RetentionConfiguration</code> object and names the object as <b>default</b>. When you have a <code>RetentionConfiguration</code> object named <b>default</b>, calling the API modifies the default object. </p> <note> <p>Currently, AWS Config supports only one retention configuration per region in your account.</p> </note>", |
| 54 | + "SelectResourceConfig": "<p>Accepts a structured query language (SQL) <code>SELECT</code> command, performs the corresponding search, and returns resource configurations matching the properties.</p> <p>For more information about query components, see the <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/query-components.html\"> <b>Query Components</b> </a> section in the AWS Config Developer Guide.</p>", |
54 | 55 | "StartConfigRulesEvaluation": "<p>Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the resources. Use <code>StartConfigRulesEvaluation</code> when you want to test that a rule you updated is working as expected. <code>StartConfigRulesEvaluation</code> does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources. </p> <p>You can specify up to 25 AWS Config rules per request. </p> <p>An existing <code>StartConfigRulesEvaluation</code> call for the specified rules must complete before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a <code>ConfigRuleEvaluationStarted</code> notification when the evaluation starts.</p> <note> <p>You don't need to call the <code>StartConfigRulesEvaluation</code> API to run an evaluation for a new rule. When you create a rule, AWS Config evaluates your resources against the rule automatically. </p> </note> <p>The <code>StartConfigRulesEvaluation</code> API is useful if you want to run on-demand evaluations, such as the following example:</p> <ol> <li> <p>You have a custom rule that evaluates your IAM resources every 24 hours.</p> </li> <li> <p>You update your Lambda function to add additional conditions to your rule.</p> </li> <li> <p>Instead of waiting for the next periodic evaluation, you call the <code>StartConfigRulesEvaluation</code> API.</p> </li> <li> <p>AWS Config invokes your Lambda function and evaluates your IAM resources.</p> </li> <li> <p>Your custom rule will still run periodic evaluations every 24 hours.</p> </li> </ol>", |
55 | 56 | "StartConfigurationRecorder": "<p>Starts recording configurations of the AWS resources you have selected to record in your AWS account.</p> <p>You must have created at least one delivery channel to successfully start the configuration recorder.</p>", |
56 | 57 | "StartRemediationExecution": "<p>Runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.</p> <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>", |
|
972 | 973 | "SourceDetail$EventSource": "<p>The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.</p>" |
973 | 974 | } |
974 | 975 | }, |
| 976 | + "Expression": { |
| 977 | + "base": null, |
| 978 | + "refs": { |
| 979 | + "SelectResourceConfigRequest$Expression": "<p>The SQL query <code>SELECT</code> command.</p>" |
| 980 | + } |
| 981 | + }, |
975 | 982 | "FailedRemediationBatch": { |
976 | 983 | "base": "<p>List of each of the failed remediations with specific reasons.</p>", |
977 | 984 | "refs": { |
|
984 | 991 | "PutRemediationConfigurationsResponse$FailedBatches": "<p>Returns a list of failed remediation batch objects.</p>" |
985 | 992 | } |
986 | 993 | }, |
| 994 | + "FieldInfo": { |
| 995 | + "base": "<p>Details about the fields such as name of the field.</p>", |
| 996 | + "refs": { |
| 997 | + "FieldInfoList$member": null |
| 998 | + } |
| 999 | + }, |
| 1000 | + "FieldInfoList": { |
| 1001 | + "base": null, |
| 1002 | + "refs": { |
| 1003 | + "QueryInfo$SelectFields": "<p>Returns a <code>FieldInfo</code> object.</p>" |
| 1004 | + } |
| 1005 | + }, |
| 1006 | + "FieldName": { |
| 1007 | + "base": null, |
| 1008 | + "refs": { |
| 1009 | + "FieldInfo$Name": "<p>Name of the field.</p>" |
| 1010 | + } |
| 1011 | + }, |
987 | 1012 | "GetAggregateComplianceDetailsByConfigRuleRequest": { |
988 | 1013 | "base": null, |
989 | 1014 | "refs": { |
|
1131 | 1156 | "refs": { |
1132 | 1157 | } |
1133 | 1158 | }, |
| 1159 | + "InvalidExpressionException": { |
| 1160 | + "base": "<p>The syntax of the query is incorrect.</p>", |
| 1161 | + "refs": { |
| 1162 | + } |
| 1163 | + }, |
1134 | 1164 | "InvalidLimitException": { |
1135 | 1165 | "base": "<p>The specified limit is outside the allowable range.</p>", |
1136 | 1166 | "refs": { |
|
1201 | 1231 | "GetResourceConfigHistoryRequest$limit": "<p>The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</p>", |
1202 | 1232 | "ListAggregateDiscoveredResourcesRequest$Limit": "<p>The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</p>", |
1203 | 1233 | "ListDiscoveredResourcesRequest$limit": "<p>The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.</p>", |
1204 | | - "ListTagsForResourceRequest$Limit": "<p>The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, AWS Config uses the default. </p>" |
| 1234 | + "ListTagsForResourceRequest$Limit": "<p>The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, AWS Config uses the default. </p>", |
| 1235 | + "SelectResourceConfigRequest$Limit": "<p>The maximum number of query results returned on each page. </p>" |
1205 | 1236 | } |
1206 | 1237 | }, |
1207 | 1238 | "LimitExceededException": { |
|
1314 | 1345 | "ListDiscoveredResourcesRequest$nextToken": "<p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>", |
1315 | 1346 | "ListDiscoveredResourcesResponse$nextToken": "<p>The string that you use in a subsequent request to get the next page of results in a paginated response.</p>", |
1316 | 1347 | "ListTagsForResourceRequest$NextToken": "<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. </p>", |
1317 | | - "ListTagsForResourceResponse$NextToken": "<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. </p>" |
| 1348 | + "ListTagsForResourceResponse$NextToken": "<p>The nextToken string returned on a previous page that you use to get the next page of results in a paginated response. </p>", |
| 1349 | + "SelectResourceConfigRequest$NextToken": "<p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response. </p>", |
| 1350 | + "SelectResourceConfigResponse$NextToken": "<p>The <code>nextToken</code> string returned in a previous request that you use to request the next page of results in a paginated response. </p>" |
1318 | 1351 | } |
1319 | 1352 | }, |
1320 | 1353 | "NoAvailableConfigurationRecorderException": { |
|
1483 | 1516 | "refs": { |
1484 | 1517 | } |
1485 | 1518 | }, |
| 1519 | + "QueryInfo": { |
| 1520 | + "base": "<p>Details about the query.</p>", |
| 1521 | + "refs": { |
| 1522 | + "SelectResourceConfigResponse$QueryInfo": "<p>Returns the <code>QueryInfo</code> object.</p>" |
| 1523 | + } |
| 1524 | + }, |
1486 | 1525 | "RecorderName": { |
1487 | 1526 | "base": null, |
1488 | 1527 | "refs": { |
|
1776 | 1815 | "ResourceValue$Value": "<p>The value is a resource ID.</p>" |
1777 | 1816 | } |
1778 | 1817 | }, |
| 1818 | + "Results": { |
| 1819 | + "base": null, |
| 1820 | + "refs": { |
| 1821 | + "SelectResourceConfigResponse$Results": "<p>Returns the results for the SQL query.</p>" |
| 1822 | + } |
| 1823 | + }, |
1779 | 1824 | "RetentionConfiguration": { |
1780 | 1825 | "base": "<p>An object with the name of the retention configuration and the retention period in days. The object stores the configuration for data retention in AWS Config.</p>", |
1781 | 1826 | "refs": { |
|
1822 | 1867 | "ConfigRule$Scope": "<p>Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.</p>" |
1823 | 1868 | } |
1824 | 1869 | }, |
| 1870 | + "SelectResourceConfigRequest": { |
| 1871 | + "base": null, |
| 1872 | + "refs": { |
| 1873 | + } |
| 1874 | + }, |
| 1875 | + "SelectResourceConfigResponse": { |
| 1876 | + "base": null, |
| 1877 | + "refs": { |
| 1878 | + } |
| 1879 | + }, |
1825 | 1880 | "Source": { |
1826 | 1881 | "base": "<p>Provides the AWS Config rule owner (AWS or customer), the rule identifier, and the events that trigger the evaluation of your AWS resources.</p>", |
1827 | 1882 | "refs": { |
|
1934 | 1989 | "RemediationConfiguration$ResourceType": "<p>The type of a resource. </p>", |
1935 | 1990 | "RemediationExecutionStep$Name": "<p>The details of the step.</p>", |
1936 | 1991 | "RemediationExecutionStep$ErrorMessage": "<p>An error message if the step was interrupted during execution.</p>", |
| 1992 | + "Results$member": null, |
1937 | 1993 | "StartRemediationExecutionResponse$FailureMessage": "<p>Returns a failure message. For example, the resource is already compliant.</p>" |
1938 | 1994 | } |
1939 | 1995 | }, |
|
0 commit comments