Skip to content

Commit a999161

Browse files
author
awstools
committed
docs(client-config-service): Updates documentation for AWS Config
1 parent aed244d commit a999161

File tree

4 files changed

+24
-9
lines changed

4 files changed

+24
-9
lines changed

clients/client-config-service/src/commands/PutConfigRuleCommand.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ export interface PutConfigRuleCommandOutput extends __MetadataBearer {}
166166
*
167167
* @throws {@link MaxNumberOfConfigRulesExceededException} (client fault)
168168
* <p>Failed to add the Config rule because the account already
169-
* contains the maximum number of 150 rules. Consider deleting any
169+
* contains the maximum number of 1000 rules. Consider deleting any
170170
* deactivated rules before you add new rules.</p>
171171
*
172172
* @throws {@link NoAvailableConfigurationRecorderException} (client fault)

clients/client-config-service/src/models/models_0.ts

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1235,6 +1235,12 @@ export interface BaseConfigurationItem {
12351235

12361236
/**
12371237
* <p>The time when configuration changes for the resource were delivered.</p>
1238+
* <note>
1239+
* <p>This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,
1240+
* this field will be populated. However, if you are using continuous recording,
1241+
* this field will be omitted since the delivery time is instantaneous as the CI is available right away. For more information on daily recording and continuous recording, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency">Recording Frequency</a> in the <i>Config
1242+
* Developer Guide</i>.</p>
1243+
* </note>
12381244
* @public
12391245
*/
12401246
configurationItemDeliveryTime?: Date;
@@ -2529,6 +2535,12 @@ export interface ConfigurationItem {
25292535

25302536
/**
25312537
* <p>The time when configuration changes for the resource were delivered.</p>
2538+
* <note>
2539+
* <p>This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,
2540+
* this field will be populated. However, if you are using continuous recording,
2541+
* this field will be omitted since the delivery time is instantaneous as the CI is available right away. For more information on daily recording and continuous recording, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency">Recording Frequency</a> in the <i>Config
2542+
* Developer Guide</i>.</p>
2543+
* </note>
25322544
* @public
25332545
*/
25342546
configurationItemDeliveryTime?: Date;
@@ -4722,7 +4734,7 @@ export interface DescribeConfigRuleEvaluationStatusRequest {
47224734
* <p>The number of rule evaluation results that you want
47234735
* returned.</p>
47244736
* <p>This parameter is required if the rule limit for your account
4725-
* is more than the default of 150 rules.</p>
4737+
* is more than the default of 1000 rules.</p>
47264738
* <p>For information about requesting a rule limit increase, see
47274739
* <a href="http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config">Config Limits</a> in the <i>Amazon Web Services General
47284740
* Reference Guide</i>.</p>
@@ -8799,7 +8811,10 @@ export interface TimeWindow {
87998811
*/
88008812
export interface ResourceEvaluationFilters {
88018813
/**
8802-
* <p>Filters all resource evaluations results based on an evaluation mode. the valid value for this API is <code>Proactive</code>.</p>
8814+
* <p>Filters all resource evaluations results based on an evaluation mode.</p>
8815+
* <important>
8816+
* <p>Currently, <code>DECTECTIVE</code> is not supported as a valid value. Ignore other documentation stating otherwise.</p>
8817+
* </important>
88038818
* @public
88048819
*/
88058820
EvaluationMode?: EvaluationMode;

clients/client-config-service/src/models/models_1.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ export class MaxActiveResourcesExceededException extends __BaseException {
9393

9494
/**
9595
* <p>Failed to add the Config rule because the account already
96-
* contains the maximum number of 150 rules. Consider deleting any
96+
* contains the maximum number of 1000 rules. Consider deleting any
9797
* deactivated rules before you add new rules.</p>
9898
* @public
9999
*/

codegen/sdk-codegen/aws-models/config-service.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -747,7 +747,7 @@
747747
"configurationItemDeliveryTime": {
748748
"target": "com.amazonaws.configservice#ConfigurationItemDeliveryTime",
749749
"traits": {
750-
"smithy.api#documentation": "<p>The time when configuration changes for the resource were delivered.</p>"
750+
"smithy.api#documentation": "<p>The time when configuration changes for the resource were delivered.</p>\n <note>\n <p>This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,\n\t\t\tthis field will be populated. However, if you are using continuous recording,\n\t\t\tthis field will be omitted since the delivery time is instantaneous as the CI is available right away. For more information on daily recording and continuous recording, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency\">Recording Frequency</a> in the <i>Config\n\t\t\t\t\tDeveloper Guide</i>.</p>\n </note>"
751751
}
752752
}
753753
},
@@ -1739,7 +1739,7 @@
17391739
"configurationItemDeliveryTime": {
17401740
"target": "com.amazonaws.configservice#ConfigurationItemDeliveryTime",
17411741
"traits": {
1742-
"smithy.api#documentation": "<p>The time when configuration changes for the resource were delivered.</p>"
1742+
"smithy.api#documentation": "<p>The time when configuration changes for the resource were delivered.</p>\n <note>\n <p>This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,\n\t\t\tthis field will be populated. However, if you are using continuous recording,\n\t\t\tthis field will be omitted since the delivery time is instantaneous as the CI is available right away. For more information on daily recording and continuous recording, see <a href=\"https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency\">Recording Frequency</a> in the <i>Config\n\t\t\t\t\tDeveloper Guide</i>.</p>\n </note>"
17431743
}
17441744
}
17451745
},
@@ -3789,7 +3789,7 @@
37893789
"target": "com.amazonaws.configservice#RuleLimit",
37903790
"traits": {
37913791
"smithy.api#default": 0,
3792-
"smithy.api#documentation": "<p>The number of rule evaluation results that you want\n\t\t\treturned.</p>\n <p>This parameter is required if the rule limit for your account\n\t\t\tis more than the default of 150 rules.</p>\n <p>For information about requesting a rule limit increase, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config\">Config Limits</a> in the <i>Amazon Web Services General\n\t\t\t\tReference Guide</i>.</p>"
3792+
"smithy.api#documentation": "<p>The number of rule evaluation results that you want\n\t\t\treturned.</p>\n <p>This parameter is required if the rule limit for your account\n\t\t\tis more than the default of 1000 rules.</p>\n <p>For information about requesting a rule limit increase, see\n\t\t\t\t<a href=\"http://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_config\">Config Limits</a> in the <i>Amazon Web Services General\n\t\t\t\tReference Guide</i>.</p>"
37933793
}
37943794
}
37953795
},
@@ -8040,7 +8040,7 @@
80408040
}
80418041
},
80428042
"traits": {
8043-
"smithy.api#documentation": "<p>Failed to add the Config rule because the account already\n\t\t\tcontains the maximum number of 150 rules. Consider deleting any\n\t\t\tdeactivated rules before you add new rules.</p>",
8043+
"smithy.api#documentation": "<p>Failed to add the Config rule because the account already\n\t\t\tcontains the maximum number of 1000 rules. Consider deleting any\n\t\t\tdeactivated rules before you add new rules.</p>",
80448044
"smithy.api#error": "client"
80458045
}
80468046
},
@@ -11440,7 +11440,7 @@
1144011440
"EvaluationMode": {
1144111441
"target": "com.amazonaws.configservice#EvaluationMode",
1144211442
"traits": {
11443-
"smithy.api#documentation": "<p>Filters all resource evaluations results based on an evaluation mode. the valid value for this API is <code>Proactive</code>.</p>"
11443+
"smithy.api#documentation": "<p>Filters all resource evaluations results based on an evaluation mode.</p>\n <important>\n <p>Currently, <code>DECTECTIVE</code> is not supported as a valid value. Ignore other documentation stating otherwise.</p>\n </important>"
1144411444
}
1144511445
},
1144611446
"TimeWindow": {

0 commit comments

Comments
 (0)