Skip to content

Commit

Permalink
docs(client-config-service): Updates documentation for AWS Config
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed Apr 12, 2024
1 parent aed244d commit a999161
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 9 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ export interface PutConfigRuleCommandOutput extends __MetadataBearer {}
*
* @throws {@link MaxNumberOfConfigRulesExceededException} (client fault)
* <p>Failed to add the Config rule because the account already
* contains the maximum number of 150 rules. Consider deleting any
* contains the maximum number of 1000 rules. Consider deleting any
* deactivated rules before you add new rules.</p>
*
* @throws {@link NoAvailableConfigurationRecorderException} (client fault)
Expand Down
19 changes: 17 additions & 2 deletions clients/client-config-service/src/models/models_0.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1235,6 +1235,12 @@ export interface BaseConfigurationItem {

/**
* <p>The time when configuration changes for the resource were delivered.</p>
* <note>
* <p>This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,
* this field will be populated. However, if you are using continuous recording,
* 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
* Developer Guide</i>.</p>
* </note>
* @public
*/
configurationItemDeliveryTime?: Date;
Expand Down Expand Up @@ -2529,6 +2535,12 @@ export interface ConfigurationItem {

/**
* <p>The time when configuration changes for the resource were delivered.</p>
* <note>
* <p>This field is optional and is not guaranteed to be present in a configuration item (CI). If you are using daily recording,
* this field will be populated. However, if you are using continuous recording,
* 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
* Developer Guide</i>.</p>
* </note>
* @public
*/
configurationItemDeliveryTime?: Date;
Expand Down Expand Up @@ -4722,7 +4734,7 @@ export interface DescribeConfigRuleEvaluationStatusRequest {
* <p>The number of rule evaluation results that you want
* returned.</p>
* <p>This parameter is required if the rule limit for your account
* is more than the default of 150 rules.</p>
* is more than the default of 1000 rules.</p>
* <p>For information about requesting a rule limit increase, see
* <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
* Reference Guide</i>.</p>
Expand Down Expand Up @@ -8799,7 +8811,10 @@ export interface TimeWindow {
*/
export interface ResourceEvaluationFilters {
/**
* <p>Filters all resource evaluations results based on an evaluation mode. the valid value for this API is <code>Proactive</code>.</p>
* <p>Filters all resource evaluations results based on an evaluation mode.</p>
* <important>
* <p>Currently, <code>DECTECTIVE</code> is not supported as a valid value. Ignore other documentation stating otherwise.</p>
* </important>
* @public
*/
EvaluationMode?: EvaluationMode;
Expand Down
2 changes: 1 addition & 1 deletion clients/client-config-service/src/models/models_1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ export class MaxActiveResourcesExceededException extends __BaseException {

/**
* <p>Failed to add the Config rule because the account already
* contains the maximum number of 150 rules. Consider deleting any
* contains the maximum number of 1000 rules. Consider deleting any
* deactivated rules before you add new rules.</p>
* @public
*/
Expand Down
10 changes: 5 additions & 5 deletions codegen/sdk-codegen/aws-models/config-service.json
Original file line number Diff line number Diff line change
Expand Up @@ -747,7 +747,7 @@
"configurationItemDeliveryTime": {
"target": "com.amazonaws.configservice#ConfigurationItemDeliveryTime",
"traits": {
"smithy.api#documentation": "<p>The time when configuration changes for the resource were delivered.</p>"
"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>"
}
}
},
Expand Down Expand Up @@ -1739,7 +1739,7 @@
"configurationItemDeliveryTime": {
"target": "com.amazonaws.configservice#ConfigurationItemDeliveryTime",
"traits": {
"smithy.api#documentation": "<p>The time when configuration changes for the resource were delivered.</p>"
"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>"
}
}
},
Expand Down Expand Up @@ -3789,7 +3789,7 @@
"target": "com.amazonaws.configservice#RuleLimit",
"traits": {
"smithy.api#default": 0,
"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>"
"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>"
}
}
},
Expand Down Expand Up @@ -8040,7 +8040,7 @@
}
},
"traits": {
"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>",
"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>",
"smithy.api#error": "client"
}
},
Expand Down Expand Up @@ -11440,7 +11440,7 @@
"EvaluationMode": {
"target": "com.amazonaws.configservice#EvaluationMode",
"traits": {
"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>"
"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>"
}
},
"TimeWindow": {
Expand Down

0 comments on commit a999161

Please sign in to comment.