Skip to content

Commit b111cc4

Browse files
Documentation improvements have been made to the EvaluationModel and DescribeConfigurationRecorders APIs.
1 parent 8ffae4d commit b111cc4

25 files changed

+1441
-340
lines changed

generator/ServiceModels/config/config-2014-11-12.docs.json

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

generator/ServiceModels/config/config-2014-11-12.normal.json

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

sdk/src/Services/ConfigService/Generated/Model/BaseConfigurationItem.cs

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,9 @@ internal bool IsSetAwsRegion()
127127
/// <summary>
128128
/// Gets and sets the property Configuration.
129129
/// <para>
130-
/// The description of the resource configuration.
130+
/// A JSON-encoded string that contains the contents for the resource configuration. This
131+
/// string needs to be deserialized using <c>json.loads()</c> before you can access the
132+
/// contents.
131133
/// </para>
132134
/// </summary>
133135
public string Configuration
@@ -252,6 +254,15 @@ internal bool IsSetConfigurationStateId()
252254
/// <para>
253255
/// The recording frequency that Config uses to record configuration changes for the resource.
254256
/// </para>
257+
/// <note>
258+
/// <para>
259+
/// This field only appears in the API response when <c>DAILY</c> recording is enabled
260+
/// for a resource type. If this field is not present, <c>CONTINUOUS</c> recording is
261+
/// enabled for that resource type. For more information on daily recording and continuous
262+
/// recording, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency">Recording
263+
/// Frequency</a> in the <i>Config Developer Guide</i>.
264+
/// </para>
265+
/// </note>
255266
/// </summary>
256267
public RecordingFrequency RecordingFrequency
257268
{
@@ -341,8 +352,14 @@ internal bool IsSetResourceType()
341352
/// <summary>
342353
/// Gets and sets the property SupplementaryConfiguration.
343354
/// <para>
344-
/// Configuration attributes that Config returns for certain resource types to supplement
345-
/// the information returned for the configuration parameter.
355+
/// A string to string map that contains additional contents for the resource configuration.Config
356+
/// returns this field for certain resource types to supplement the information returned
357+
/// for the <c>configuration</c> field.
358+
/// </para>
359+
///
360+
/// <para>
361+
/// This string needs to be deserialized using <c>json.loads()</c> before you can access
362+
/// the contents.
346363
/// </para>
347364
/// <para />
348365
/// Starting with version 4 of the SDK this property will default to null. If no data for this property is returned

sdk/src/Services/ConfigService/Generated/Model/ConfigRule.cs

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -302,11 +302,6 @@ internal bool IsSetMaximumExecutionFrequency()
302302
/// that can trigger an evaluation for the rule. If you do not specify a scope, evaluations
303303
/// are triggered when any resource in the recording group changes.
304304
/// </para>
305-
/// <note>
306-
/// <para>
307-
/// The scope can be empty.
308-
/// </para>
309-
/// </note>
310305
/// </summary>
311306
public Scope Scope
312307
{

sdk/src/Services/ConfigService/Generated/Model/ConfigurationItem.cs

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,9 @@ internal bool IsSetAwsRegion()
131131
/// <summary>
132132
/// Gets and sets the property Configuration.
133133
/// <para>
134-
/// The description of the resource configuration.
134+
/// A JSON-encoded string that contains the contents for the resource configuration. This
135+
/// string needs to be deserialized using <c>json.loads()</c> before you can access the
136+
/// contents.
135137
/// </para>
136138
/// </summary>
137139
public string Configuration
@@ -174,8 +176,11 @@ internal bool IsSetConfigurationItemCaptureTime()
174176
/// This field is optional and is not guaranteed to be present in a configuration item
175177
/// (CI). If you are using daily recording, this field will be populated. However, if
176178
/// you are using continuous recording, this field will be omitted since the delivery
177-
/// time is instantaneous as the CI is available right away. For more information on daily
178-
/// recording and continuous recording, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency">Recording
179+
/// time is instantaneous as the CI is available right away.
180+
/// </para>
181+
///
182+
/// <para>
183+
/// 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
179184
/// Frequency</a> in the <i>Config Developer Guide</i>.
180185
/// </para>
181186
/// </note>
@@ -279,6 +284,15 @@ internal bool IsSetConfigurationStateId()
279284
/// <para>
280285
/// The recording frequency that Config uses to record configuration changes for the resource.
281286
/// </para>
287+
/// <note>
288+
/// <para>
289+
/// This field only appears in the API response when <c>DAILY</c> recording is enabled
290+
/// for a resource type. If this field is not present, <c>CONTINUOUS</c> recording is
291+
/// enabled for that resource type. For more information on daily recording and continuous
292+
/// recording, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html#select-resources-recording-frequency">Recording
293+
/// Frequency</a> in the <i>Config Developer Guide</i>.
294+
/// </para>
295+
/// </note>
282296
/// </summary>
283297
public RecordingFrequency RecordingFrequency
284298
{
@@ -426,8 +440,14 @@ internal bool IsSetResourceType()
426440
/// <summary>
427441
/// Gets and sets the property SupplementaryConfiguration.
428442
/// <para>
429-
/// Configuration attributes that Config returns for certain resource types to supplement
430-
/// the information returned for the <c>configuration</c> parameter.
443+
/// A string to string map that contains additional contents for the resource configuration.Config
444+
/// returns this field for certain resource types to supplement the information returned
445+
/// for the <c>configuration</c> field.
446+
/// </para>
447+
///
448+
/// <para>
449+
/// This string to string map needs to be deserialized using <c>json.loads()</c> before
450+
/// you can accessing the contents.
431451
/// </para>
432452
/// <para />
433453
/// Starting with version 4 of the SDK this property will default to null. If no data for this property is returned

sdk/src/Services/ConfigService/Generated/Model/ConfigurationRecorder.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,8 @@ internal bool IsSetArn()
8181
///
8282
/// <para>
8383
/// For service-linked configuration recorders, Config automatically assigns a name that
84-
/// has the prefix "<c>AWS</c>" to a new service-linked configuration recorder.
84+
/// has the prefix "<c>AWSConfigurationRecorderFor</c>" to a new service-linked configuration
85+
/// recorder.
8586
/// </para>
8687
/// <note>
8788
/// <para>

sdk/src/Services/ConfigService/Generated/Model/DeleteConfigRuleRequest.cs

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -45,33 +45,29 @@ namespace Amazon.ConfigService.Model
4545
/// </para>
4646
/// <note>
4747
/// <para>
48-
/// <b>Recommendation: Stop recording resource compliance before deleting rules</b>
48+
/// <b>Recommendation: Consider excluding the <c>AWS::Config::ResourceCompliance</c>
49+
/// resource type from recording before deleting rules</b>
4950
/// </para>
5051
///
5152
/// <para>
52-
/// It is highly recommended that you stop recording for the <c>AWS::Config::ResourceCompliance</c>
53-
/// resource type before you delete rules in your account. Deleting rules creates CIs
54-
/// for <c>AWS::Config::ResourceCompliance</c> and can affect your Config <a href="https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html">configuration
55-
/// recorder</a> costs. If you are deleting rules which evaluate a large number of resource
56-
/// types, this can lead to a spike in the number of CIs recorded.
53+
/// Deleting rules creates configuration items (CIs) for <c>AWS::Config::ResourceCompliance</c>
54+
/// that can affect your costs for the configuration recorder. If you are deleting rules
55+
/// which evaluate a large number of resource types, this can lead to a spike in the number
56+
/// of CIs recorded.
5757
/// </para>
5858
///
5959
/// <para>
60-
/// Best practice:
60+
/// To avoid the associated costs, you can opt to disable recording for the <c>AWS::Config::ResourceCompliance</c>
61+
/// resource type before deleting rules, and re-enable recording after the rules have
62+
/// been deleted.
6163
/// </para>
62-
/// <ol> <li>
63-
/// <para>
64-
/// Stop recording <c>AWS::Config::ResourceCompliance</c>
65-
/// </para>
66-
/// </li> <li>
67-
/// <para>
68-
/// Delete rule(s)
69-
/// </para>
70-
/// </li> <li>
64+
///
7165
/// <para>
72-
/// Turn on recording for <c>AWS::Config::ResourceCompliance</c>
66+
/// However, since deleting rules is an asynchronous process, it might take an hour or
67+
/// more to complete. During the time when recording is disabled for <c>AWS::Config::ResourceCompliance</c>,
68+
/// rule evaluations will not be recorded in the associated resource’s history.
7369
/// </para>
74-
/// </li> </ol> </note>
70+
/// </note>
7571
/// </summary>
7672
public partial class DeleteConfigRuleRequest : AmazonConfigServiceRequest
7773
{

sdk/src/Services/ConfigService/Generated/Model/DeleteConformancePackRequest.cs

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,31 @@ namespace Amazon.ConfigService.Model
3939
/// Config sets the conformance pack to <c>DELETE_IN_PROGRESS</c> until the deletion is
4040
/// complete. You cannot update a conformance pack while it is in this state.
4141
/// </para>
42+
/// <note>
43+
/// <para>
44+
/// <b>Recommendation: Consider excluding the <c>AWS::Config::ResourceCompliance</c>
45+
/// resource type from recording before deleting rules</b>
46+
/// </para>
47+
///
48+
/// <para>
49+
/// Deleting rules creates configuration items (CIs) for <c>AWS::Config::ResourceCompliance</c>
50+
/// that can affect your costs for the configuration recorder. If you are deleting rules
51+
/// which evaluate a large number of resource types, this can lead to a spike in the number
52+
/// of CIs recorded.
53+
/// </para>
54+
///
55+
/// <para>
56+
/// To avoid the associated costs, you can opt to disable recording for the <c>AWS::Config::ResourceCompliance</c>
57+
/// resource type before deleting rules, and re-enable recording after the rules have
58+
/// been deleted.
59+
/// </para>
60+
///
61+
/// <para>
62+
/// However, since deleting rules is an asynchronous process, it might take an hour or
63+
/// more to complete. During the time when recording is disabled for <c>AWS::Config::ResourceCompliance</c>,
64+
/// rule evaluations will not be recorded in the associated resource’s history.
65+
/// </para>
66+
/// </note>
4267
/// </summary>
4368
public partial class DeleteConformancePackRequest : AmazonConfigServiceRequest
4469
{

sdk/src/Services/ConfigService/Generated/Model/DeleteOrganizationConfigRuleRequest.cs

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,31 @@ namespace Amazon.ConfigService.Model
4545
/// Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete.
4646
/// You cannot update a rule while it is in this state.
4747
/// </para>
48+
/// <note>
49+
/// <para>
50+
/// <b>Recommendation: Consider excluding the <c>AWS::Config::ResourceCompliance</c>
51+
/// resource type from recording before deleting rules</b>
52+
/// </para>
53+
///
54+
/// <para>
55+
/// Deleting rules creates configuration items (CIs) for <c>AWS::Config::ResourceCompliance</c>
56+
/// that can affect your costs for the configuration recorder. If you are deleting rules
57+
/// which evaluate a large number of resource types, this can lead to a spike in the number
58+
/// of CIs recorded.
59+
/// </para>
60+
///
61+
/// <para>
62+
/// To avoid the associated costs, you can opt to disable recording for the <c>AWS::Config::ResourceCompliance</c>
63+
/// resource type before deleting rules, and re-enable recording after the rules have
64+
/// been deleted.
65+
/// </para>
66+
///
67+
/// <para>
68+
/// However, since deleting rules is an asynchronous process, it might take an hour or
69+
/// more to complete. During the time when recording is disabled for <c>AWS::Config::ResourceCompliance</c>,
70+
/// rule evaluations will not be recorded in the associated resource’s history.
71+
/// </para>
72+
/// </note>
4873
/// </summary>
4974
public partial class DeleteOrganizationConfigRuleRequest : AmazonConfigServiceRequest
5075
{

sdk/src/Services/ConfigService/Generated/Model/DeleteOrganizationConformancePackRequest.cs

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,31 @@ namespace Amazon.ConfigService.Model
4545
/// Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion
4646
/// is complete. You cannot update a conformance pack while it is in this state.
4747
/// </para>
48+
/// <note>
49+
/// <para>
50+
/// <b>Recommendation: Consider excluding the <c>AWS::Config::ResourceCompliance</c>
51+
/// resource type from recording before deleting rules</b>
52+
/// </para>
53+
///
54+
/// <para>
55+
/// Deleting rules creates configuration items (CIs) for <c>AWS::Config::ResourceCompliance</c>
56+
/// that can affect your costs for the configuration recorder. If you are deleting rules
57+
/// which evaluate a large number of resource types, this can lead to a spike in the number
58+
/// of CIs recorded.
59+
/// </para>
60+
///
61+
/// <para>
62+
/// To avoid the associated costs, you can opt to disable recording for the <c>AWS::Config::ResourceCompliance</c>
63+
/// resource type before deleting rules, and re-enable recording after the rules have
64+
/// been deleted.
65+
/// </para>
66+
///
67+
/// <para>
68+
/// However, since deleting rules is an asynchronous process, it might take an hour or
69+
/// more to complete. During the time when recording is disabled for <c>AWS::Config::ResourceCompliance</c>,
70+
/// rule evaluations will not be recorded in the associated resource’s history.
71+
/// </para>
72+
/// </note>
4873
/// </summary>
4974
public partial class DeleteOrganizationConformancePackRequest : AmazonConfigServiceRequest
5075
{

0 commit comments

Comments
 (0)