@aws-sdk/client-config-service 3.138.0 → 3.141.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/CHANGELOG.md CHANGED
@@ -3,6 +3,14 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.141.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.140.0...v3.141.0) (2022-08-01)
7
+
8
+ **Note:** Version bump only for package @aws-sdk/client-config-service
9
+
10
+
11
+
12
+
13
+
6
14
  # [3.138.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.137.0...v3.138.0) (2022-07-27)
7
15
 
8
16
 
package/README.md CHANGED
@@ -187,7 +187,7 @@ try {
187
187
  const data = await client.send(command);
188
188
  // process data.
189
189
  } catch (error) {
190
- const { requestId, cfId, extendedRequestId } = error.$metadata;
190
+ const { requestId, cfId, extendedRequestId } = error.$$metadata;
191
191
  console.log({ requestId, cfId, extendedRequestId });
192
192
  /**
193
193
  * The keys within exceptions are also parsed.
@@ -880,7 +880,10 @@ export declare class ConfigService extends ConfigServiceClient {
880
880
  * <p>Returns a list of conformance pack compliance scores.
881
881
  * A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack.
882
882
  * This metric provides you with a high-level view of the compliance state of your conformance packs, and can be used to identify, investigate, and understand
883
- * compliance deviations in your conformance packs.</p>
883
+ * the level of compliance in your conformance packs.</p>
884
+ * <note>
885
+ * <p>Conformance packs with no evaluation results will have a compliance score of <code>INSUFFICIENT_DATA</code>.</p>
886
+ * </note>
884
887
  */
885
888
  listConformancePackComplianceScores(args: ListConformancePackComplianceScoresCommandInput, options?: __HttpHandlerOptions): Promise<ListConformancePackComplianceScoresCommandOutput>;
886
889
  listConformancePackComplianceScores(args: ListConformancePackComplianceScoresCommandInput, cb: (err: any, data?: ListConformancePackComplianceScoresCommandOutput) => void): void;
@@ -927,23 +930,33 @@ export declare class ConfigService extends ConfigServiceClient {
927
930
  putAggregationAuthorization(args: PutAggregationAuthorizationCommandInput, cb: (err: any, data?: PutAggregationAuthorizationCommandOutput) => void): void;
928
931
  putAggregationAuthorization(args: PutAggregationAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAggregationAuthorizationCommandOutput) => void): void;
929
932
  /**
930
- * <p>Adds or updates an Config rule for evaluating whether your
931
- * Amazon Web Services resources comply with your desired configurations.</p>
932
- * <p>You can use this action for Config custom rules and Config
933
- * managed rules. A Config custom rule is a rule that you
934
- * develop and maintain. An Config managed rule is a customizable,
935
- * predefined rule that Config provides.</p>
936
- * <p>If you are adding a new Config custom rule, you must first
937
- * create the Lambda function that the rule invokes to evaluate
938
- * your resources. When you use the <code>PutConfigRule</code> action
939
- * to add the rule to Config, you must specify the Amazon Resource
940
- * Name (ARN) that Lambda assigns to the function. Specify the ARN
941
- * for the <code>SourceIdentifier</code> key. This key is part of the
942
- * <code>Source</code> object, which is part of the
943
- * <code>ConfigRule</code> object. </p>
944
- * <p>If you are adding an Config managed rule, specify the
945
- * rule's identifier for the <code>SourceIdentifier</code> key. To
946
- * reference Config managed rule identifiers, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">About Config managed rules</a>.</p>
933
+ * <p>Adds or updates an Config rule to evaluate if your
934
+ * Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account,
935
+ * see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
936
+ * <b>Service Limits</b>
937
+ * </a> in the <i>Config Developer Guide</i>.</p>
938
+ *
939
+ * <p>There are two types of rules: Config Custom Rules and Config Managed Rules.
940
+ * You can use <code>PutConfigRule</code> to create both Config custom rules and Config managed rules.</p>
941
+ *
942
+ * <p>Custom rules are rules that you can create using either Guard or Lambda functions.
943
+ * Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
944
+ * Repository</a>) is a policy-as-code language that allows you to write policies that
945
+ * are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to
946
+ * evaluate a custom rule. If you are adding a new Custom Lambda rule,
947
+ * you first need to create an Lambda function that the rule invokes to evaluate
948
+ * your resources. When you use <code>PutConfigRule</code> to add a Custom Lambda rule to Config, you must specify the Amazon Resource
949
+ * Name (ARN) that Lambda assigns to the function. You specify the ARN
950
+ * in the <code>SourceIdentifier</code> key. This key is part of the
951
+ * <code>Source</code> object, which is part of the
952
+ * <code>ConfigRule</code> object. </p>
953
+ *
954
+ * <p>Managed rules are predefined,
955
+ * customizable rules created by Config. For a list of managed rules, see
956
+ * <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
957
+ * Managed Rules</a>. If you are adding an Config managed rule, you must specify the
958
+ * rule's identifier for the <code>SourceIdentifier</code> key.</p>
959
+ *
947
960
  * <p>For any new rule that you add, specify the
948
961
  * <code>ConfigRuleName</code> in the <code>ConfigRule</code>
949
962
  * object. Do not specify the <code>ConfigRuleArn</code> or the
@@ -953,10 +966,6 @@ export declare class ConfigService extends ConfigServiceClient {
953
966
  * <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the
954
967
  * <code>ConfigRule</code> data type that you use in this
955
968
  * request.</p>
956
- * <p>For information on how many Config rules you can have per account,
957
- * see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
958
- * <b>Service Limits</b>
959
- * </a> in the Config Developer Guide.</p>
960
969
  *
961
970
  * <p>For more information about developing and using Config
962
971
  * rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating Amazon Web Services resource Configurations with Config</a>
@@ -980,7 +989,7 @@ export declare class ConfigService extends ConfigServiceClient {
980
989
  * <p>If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization.
981
990
  * If the caller is a management account, Config calls <code>EnableAwsServiceAccess</code> API to enable integration between Config and Organizations.
982
991
  * If the caller is a registered delegated administrator, Config calls <code>ListDelegatedAdministrators</code> API to verify whether the caller is a valid delegated administrator.</p>
983
- * <p>To register a delegated administrator, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli">Register a Delegated Administrator</a> in the Config developer guide. </p>
992
+ * <p>To register a delegated administrator, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli">Register a Delegated Administrator</a> in the <i>Config developer guide</i>. </p>
984
993
  * </note>
985
994
  */
986
995
  putConfigurationAggregator(args: PutConfigurationAggregatorCommandInput, options?: __HttpHandlerOptions): Promise<PutConfigurationAggregatorCommandOutput>;
@@ -1011,8 +1020,8 @@ export declare class ConfigService extends ConfigServiceClient {
1011
1020
  * see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
1012
1021
  * <b>Service Limits</b>
1013
1022
  * </a> in the Config Developer Guide.</p>
1014
- * <p>This API creates a service linked role <code>AWSServiceRoleForConfigConforms</code> in your account.
1015
- * The service linked role is created only when the role does not exist in your account. </p>
1023
+ * <p>This API creates a service-linked role <code>AWSServiceRoleForConfigConforms</code> in your account.
1024
+ * The service-linked role is created only when the role does not exist in your account. </p>
1016
1025
  * <note>
1017
1026
  * <p>You must specify either the <code>TemplateS3Uri</code> or the <code>TemplateBody</code> parameter, but not both.
1018
1027
  * If you provide both Config uses the <code>TemplateS3Uri</code> parameter and ignores the <code>TemplateBody</code> parameter.</p>
@@ -1059,29 +1068,42 @@ export declare class ConfigService extends ConfigServiceClient {
1059
1068
  putExternalEvaluation(args: PutExternalEvaluationCommandInput, cb: (err: any, data?: PutExternalEvaluationCommandOutput) => void): void;
1060
1069
  putExternalEvaluation(args: PutExternalEvaluationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutExternalEvaluationCommandOutput) => void): void;
1061
1070
  /**
1062
- * <p>Adds or updates organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your
1071
+ * <p>Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your
1063
1072
  * desired configurations. For information on how many organization Config rules you can have per account,
1064
1073
  * see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
1065
1074
  * <b>Service Limits</b>
1066
- * </a> in the Config Developer Guide.</p>
1075
+ * </a> in the <i>Config Developer Guide</i>.</p>
1067
1076
  * <p> Only a master account and a delegated administrator can create or update an organization Config rule.
1068
1077
  * When calling this API with a delegated administrator, you must ensure Organizations
1069
1078
  * <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
1070
- * <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service linked
1079
+ * <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service-linked
1071
1080
  * role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization.
1072
- * The service linked role is created only when the role does not exist in the caller account.
1081
+ * The service-linked role is created only when the role does not exist in the caller account.
1073
1082
  * Config verifies the existence of role with <code>GetRole</code> action.</p>
1074
1083
  * <p>To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
1075
1084
  * <code>register-delegated-administrator</code> for <code>config-multiaccountsetup.amazonaws.com</code>. </p>
1076
- * <p>You can use this action to create both Config custom rules and Config managed rules.
1077
- * If you are adding a new Config custom rule, you must first create Lambda function in the master account or a delegated
1078
- * administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed-account that can be assumed by the Lambda function.
1079
- * When you use the <code>PutOrganizationConfigRule</code> action to add the rule to Config, you must
1080
- * specify the Amazon Resource Name (ARN) that Lambda assigns to the function.
1081
- * If you are adding an Config managed rule, specify the rule's identifier for the <code>RuleIdentifier</code> key.</p>
1085
+ *
1086
+ * <p>There are two types of rules: Config Custom Rules and Config Managed Rules.
1087
+ * You can use <code>PutOrganizationConfigRule</code> to create both Config custom rules and Config managed rules.</p>
1088
+ *
1089
+ * <p>Custom rules are rules that you can create using either Guard or Lambda functions.
1090
+ * Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
1091
+ * Repository</a>) is a policy-as-code language that allows you to write policies that
1092
+ * are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to
1093
+ * evaluate a custom rule. If you are adding a new Custom Lambda rule, you first need to create an Lambda function in the master account or a delegated
1094
+ * administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function.
1095
+ * When you use <code>PutOrganizationConfigRule</code> to add a Custom Lambda rule to Config, you must
1096
+ * specify the Amazon Resource Name (ARN) that Lambda assigns to the function.</p>
1097
+ *
1098
+ * <p>Managed rules are predefined,
1099
+ * customizable rules created by Config. For a list of managed rules, see
1100
+ * <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
1101
+ * Managed Rules</a>. If you are adding an Config managed rule, you must specify the rule's identifier for the <code>RuleIdentifier</code> key.</p>
1102
+ *
1103
+ *
1082
1104
  * <note>
1083
1105
  * <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p>
1084
- * <p>Specify either <code>OrganizationCustomRuleMetadata</code> or <code>OrganizationManagedRuleMetadata</code>.</p>
1106
+ * <p>Make sure to specify one of either <code>OrganizationCustomPolicyRuleMetadata</code> for Custom Policy rules, <code>OrganizationCustomRuleMetadata</code> for Custom Lambda rules, or <code>OrganizationManagedRuleMetadata</code> for managed rules.</p>
1085
1107
  * </note>
1086
1108
  */
1087
1109
  putOrganizationConfigRule(args: PutOrganizationConfigRuleCommandInput, options?: __HttpHandlerOptions): Promise<PutOrganizationConfigRuleCommandOutput>;
@@ -1097,8 +1119,8 @@ export declare class ConfigService extends ConfigServiceClient {
1097
1119
  * <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
1098
1120
  * <p>This API enables organization service access for <code>config-multiaccountsetup.amazonaws.com</code>
1099
1121
  * through the <code>EnableAWSServiceAccess</code> action and creates a
1100
- * service linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization.
1101
- * The service linked role is created only when the role does not exist in the caller account.
1122
+ * service-linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization.
1123
+ * The service-linked role is created only when the role does not exist in the caller account.
1102
1124
  * To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
1103
1125
  * <code>register-delegate-admin</code> for <code>config-multiaccountsetup.amazonaws.com</code>.</p>
1104
1126
  *
@@ -1208,7 +1230,7 @@ export declare class ConfigService extends ConfigServiceClient {
1208
1230
  * <p>For more information about query components, see the
1209
1231
  * <a href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html">
1210
1232
  * <b>Query Components</b>
1211
- * </a> section in the Config Developer Guide.</p>
1233
+ * </a> section in the <i>Config Developer Guide</i>.</p>
1212
1234
  */
1213
1235
  selectResourceConfig(args: SelectResourceConfigCommandInput, options?: __HttpHandlerOptions): Promise<SelectResourceConfigCommandOutput>;
1214
1236
  selectResourceConfig(args: SelectResourceConfigCommandInput, cb: (err: any, data?: SelectResourceConfigCommandOutput) => void): void;
@@ -10,7 +10,10 @@ export interface ListConformancePackComplianceScoresCommandOutput extends ListCo
10
10
  * <p>Returns a list of conformance pack compliance scores.
11
11
  * A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack.
12
12
  * This metric provides you with a high-level view of the compliance state of your conformance packs, and can be used to identify, investigate, and understand
13
- * compliance deviations in your conformance packs.</p>
13
+ * the level of compliance in your conformance packs.</p>
14
+ * <note>
15
+ * <p>Conformance packs with no evaluation results will have a compliance score of <code>INSUFFICIENT_DATA</code>.</p>
16
+ * </note>
14
17
  * @example
15
18
  * Use a bare-bones client and the command you need to make an API call.
16
19
  * ```javascript
@@ -7,23 +7,33 @@ export interface PutConfigRuleCommandInput extends PutConfigRuleRequest {
7
7
  export interface PutConfigRuleCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Adds or updates an Config rule for evaluating whether your
11
- * Amazon Web Services resources comply with your desired configurations.</p>
12
- * <p>You can use this action for Config custom rules and Config
13
- * managed rules. A Config custom rule is a rule that you
14
- * develop and maintain. An Config managed rule is a customizable,
15
- * predefined rule that Config provides.</p>
16
- * <p>If you are adding a new Config custom rule, you must first
17
- * create the Lambda function that the rule invokes to evaluate
18
- * your resources. When you use the <code>PutConfigRule</code> action
19
- * to add the rule to Config, you must specify the Amazon Resource
20
- * Name (ARN) that Lambda assigns to the function. Specify the ARN
21
- * for the <code>SourceIdentifier</code> key. This key is part of the
22
- * <code>Source</code> object, which is part of the
23
- * <code>ConfigRule</code> object. </p>
24
- * <p>If you are adding an Config managed rule, specify the
25
- * rule's identifier for the <code>SourceIdentifier</code> key. To
26
- * reference Config managed rule identifiers, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">About Config managed rules</a>.</p>
10
+ * <p>Adds or updates an Config rule to evaluate if your
11
+ * Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account,
12
+ * see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
13
+ * <b>Service Limits</b>
14
+ * </a> in the <i>Config Developer Guide</i>.</p>
15
+ *
16
+ * <p>There are two types of rules: Config Custom Rules and Config Managed Rules.
17
+ * You can use <code>PutConfigRule</code> to create both Config custom rules and Config managed rules.</p>
18
+ *
19
+ * <p>Custom rules are rules that you can create using either Guard or Lambda functions.
20
+ * Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
21
+ * Repository</a>) is a policy-as-code language that allows you to write policies that
22
+ * are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to
23
+ * evaluate a custom rule. If you are adding a new Custom Lambda rule,
24
+ * you first need to create an Lambda function that the rule invokes to evaluate
25
+ * your resources. When you use <code>PutConfigRule</code> to add a Custom Lambda rule to Config, you must specify the Amazon Resource
26
+ * Name (ARN) that Lambda assigns to the function. You specify the ARN
27
+ * in the <code>SourceIdentifier</code> key. This key is part of the
28
+ * <code>Source</code> object, which is part of the
29
+ * <code>ConfigRule</code> object. </p>
30
+ *
31
+ * <p>Managed rules are predefined,
32
+ * customizable rules created by Config. For a list of managed rules, see
33
+ * <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
34
+ * Managed Rules</a>. If you are adding an Config managed rule, you must specify the
35
+ * rule's identifier for the <code>SourceIdentifier</code> key.</p>
36
+ *
27
37
  * <p>For any new rule that you add, specify the
28
38
  * <code>ConfigRuleName</code> in the <code>ConfigRule</code>
29
39
  * object. Do not specify the <code>ConfigRuleArn</code> or the
@@ -33,10 +43,6 @@ export interface PutConfigRuleCommandOutput extends __MetadataBearer {
33
43
  * <code>ConfigRuleId</code>, or <code>ConfigRuleArn</code> in the
34
44
  * <code>ConfigRule</code> data type that you use in this
35
45
  * request.</p>
36
- * <p>For information on how many Config rules you can have per account,
37
- * see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
38
- * <b>Service Limits</b>
39
- * </a> in the Config Developer Guide.</p>
40
46
  *
41
47
  * <p>For more information about developing and using Config
42
48
  * rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating Amazon Web Services resource Configurations with Config</a>
@@ -21,7 +21,7 @@ export interface PutConfigurationAggregatorCommandOutput extends PutConfiguratio
21
21
  * <p>If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization.
22
22
  * If the caller is a management account, Config calls <code>EnableAwsServiceAccess</code> API to enable integration between Config and Organizations.
23
23
  * If the caller is a registered delegated administrator, Config calls <code>ListDelegatedAdministrators</code> API to verify whether the caller is a valid delegated administrator.</p>
24
- * <p>To register a delegated administrator, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli">Register a Delegated Administrator</a> in the Config developer guide. </p>
24
+ * <p>To register a delegated administrator, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli">Register a Delegated Administrator</a> in the <i>Config developer guide</i>. </p>
25
25
  * </note>
26
26
  * @example
27
27
  * Use a bare-bones client and the command you need to make an API call.
@@ -13,8 +13,8 @@ export interface PutConformancePackCommandOutput extends PutConformancePackRespo
13
13
  * see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
14
14
  * <b>Service Limits</b>
15
15
  * </a> in the Config Developer Guide.</p>
16
- * <p>This API creates a service linked role <code>AWSServiceRoleForConfigConforms</code> in your account.
17
- * The service linked role is created only when the role does not exist in your account. </p>
16
+ * <p>This API creates a service-linked role <code>AWSServiceRoleForConfigConforms</code> in your account.
17
+ * The service-linked role is created only when the role does not exist in your account. </p>
18
18
  * <note>
19
19
  * <p>You must specify either the <code>TemplateS3Uri</code> or the <code>TemplateBody</code> parameter, but not both.
20
20
  * If you provide both Config uses the <code>TemplateS3Uri</code> parameter and ignores the <code>TemplateBody</code> parameter.</p>
@@ -7,29 +7,42 @@ export interface PutOrganizationConfigRuleCommandInput extends PutOrganizationCo
7
7
  export interface PutOrganizationConfigRuleCommandOutput extends PutOrganizationConfigRuleResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Adds or updates organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your
10
+ * <p>Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your
11
11
  * desired configurations. For information on how many organization Config rules you can have per account,
12
12
  * see <a href="https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html">
13
13
  * <b>Service Limits</b>
14
- * </a> in the Config Developer Guide.</p>
14
+ * </a> in the <i>Config Developer Guide</i>.</p>
15
15
  * <p> Only a master account and a delegated administrator can create or update an organization Config rule.
16
16
  * When calling this API with a delegated administrator, you must ensure Organizations
17
17
  * <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
18
- * <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service linked
18
+ * <p>This API enables organization service access through the <code>EnableAWSServiceAccess</code> action and creates a service-linked
19
19
  * role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization.
20
- * The service linked role is created only when the role does not exist in the caller account.
20
+ * The service-linked role is created only when the role does not exist in the caller account.
21
21
  * Config verifies the existence of role with <code>GetRole</code> action.</p>
22
22
  * <p>To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
23
23
  * <code>register-delegated-administrator</code> for <code>config-multiaccountsetup.amazonaws.com</code>. </p>
24
- * <p>You can use this action to create both Config custom rules and Config managed rules.
25
- * If you are adding a new Config custom rule, you must first create Lambda function in the master account or a delegated
26
- * administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed-account that can be assumed by the Lambda function.
27
- * When you use the <code>PutOrganizationConfigRule</code> action to add the rule to Config, you must
28
- * specify the Amazon Resource Name (ARN) that Lambda assigns to the function.
29
- * If you are adding an Config managed rule, specify the rule's identifier for the <code>RuleIdentifier</code> key.</p>
24
+ *
25
+ * <p>There are two types of rules: Config Custom Rules and Config Managed Rules.
26
+ * You can use <code>PutOrganizationConfigRule</code> to create both Config custom rules and Config managed rules.</p>
27
+ *
28
+ * <p>Custom rules are rules that you can create using either Guard or Lambda functions.
29
+ * Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
30
+ * Repository</a>) is a policy-as-code language that allows you to write policies that
31
+ * are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to
32
+ * evaluate a custom rule. If you are adding a new Custom Lambda rule, you first need to create an Lambda function in the master account or a delegated
33
+ * administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function.
34
+ * When you use <code>PutOrganizationConfigRule</code> to add a Custom Lambda rule to Config, you must
35
+ * specify the Amazon Resource Name (ARN) that Lambda assigns to the function.</p>
36
+ *
37
+ * <p>Managed rules are predefined,
38
+ * customizable rules created by Config. For a list of managed rules, see
39
+ * <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
40
+ * Managed Rules</a>. If you are adding an Config managed rule, you must specify the rule's identifier for the <code>RuleIdentifier</code> key.</p>
41
+ *
42
+ *
30
43
  * <note>
31
44
  * <p>Prerequisite: Ensure you call <code>EnableAllFeatures</code> API to enable all features in an organization.</p>
32
- * <p>Specify either <code>OrganizationCustomRuleMetadata</code> or <code>OrganizationManagedRuleMetadata</code>.</p>
45
+ * <p>Make sure to specify one of either <code>OrganizationCustomPolicyRuleMetadata</code> for Custom Policy rules, <code>OrganizationCustomRuleMetadata</code> for Custom Lambda rules, or <code>OrganizationManagedRuleMetadata</code> for managed rules.</p>
33
46
  * </note>
34
47
  * @example
35
48
  * Use a bare-bones client and the command you need to make an API call.
@@ -16,8 +16,8 @@ export interface PutOrganizationConformancePackCommandOutput extends PutOrganiza
16
16
  * <code>ListDelegatedAdministrator</code> permissions are added. An organization can have up to 3 delegated administrators.</p>
17
17
  * <p>This API enables organization service access for <code>config-multiaccountsetup.amazonaws.com</code>
18
18
  * through the <code>EnableAWSServiceAccess</code> action and creates a
19
- * service linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization.
20
- * The service linked role is created only when the role does not exist in the caller account.
19
+ * service-linked role <code>AWSServiceRoleForConfigMultiAccountSetup</code> in the master or delegated administrator account of your organization.
20
+ * The service-linked role is created only when the role does not exist in the caller account.
21
21
  * To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
22
22
  * <code>register-delegate-admin</code> for <code>config-multiaccountsetup.amazonaws.com</code>.</p>
23
23
  *
@@ -11,7 +11,7 @@ export interface SelectResourceConfigCommandOutput extends SelectResourceConfigR
11
11
  * <p>For more information about query components, see the
12
12
  * <a href="https://docs.aws.amazon.com/config/latest/developerguide/query-components.html">
13
13
  * <b>Query Components</b>
14
- * </a> section in the Config Developer Guide.</p>
14
+ * </a> section in the <i>Config Developer Guide</i>.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
17
17
  * ```javascript
@@ -1029,7 +1029,7 @@ export interface SourceDetail {
1029
1029
  MaximumExecutionFrequency?: MaximumExecutionFrequency | string;
1030
1030
  }
1031
1031
  /**
1032
- * <p>Provides the CustomPolicyDetails, the rule owner (Amazon Web Services or customer), the rule
1032
+ * <p>Provides the CustomPolicyDetails, the rule owner (<code>Amazon Web Services</code> for managed rules, <code>CUSTOM_POLICY</code> for Custom Policy rules, and <code>CUSTOM_LAMBDA</code> for Custom Lambda rules), the rule
1033
1033
  * identifier, and the events that cause the evaluation of your Amazon Web Services
1034
1034
  * resources.</p>
1035
1035
  */
@@ -1037,9 +1037,9 @@ export interface Source {
1037
1037
  /**
1038
1038
  * <p>Indicates whether Amazon Web Services or the customer owns and manages the Config rule.</p>
1039
1039
  *
1040
- * <p>Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Config Managed Rules</a> in the Config developer guide.</p>
1040
+ * <p>Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html">Config Managed Rules</a> in the <i>Config developer guide</i>.</p>
1041
1041
  *
1042
- * <p>Config Custom Rules are rules that you can develop either with Guard (<code>CUSTOM_POLICY</code>) or Lambda (<code>CUSTOM_LAMBDA</code>). For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html">Config Custom Rules </a> in the Config developer guide.</p>
1042
+ * <p>Config Custom Rules are rules that you can develop either with Guard (<code>CUSTOM_POLICY</code>) or Lambda (<code>CUSTOM_LAMBDA</code>). For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_develop-rules.html">Config Custom Rules </a> in the <i>Config developer guide</i>.</p>
1043
1043
  */
1044
1044
  Owner: Owner | string | undefined;
1045
1045
  /**
@@ -1065,22 +1065,28 @@ export interface Source {
1065
1065
  CustomPolicyDetails?: CustomPolicyDetails;
1066
1066
  }
1067
1067
  /**
1068
- * <p>An Config rule represents an Lambda function that you
1069
- * create for a custom rule or a predefined function for an Config managed
1070
- * rule. The function evaluates configuration items to assess whether
1071
- * your Amazon Web Services resources comply with your desired configurations. This
1072
- * function can run when Config detects a configuration change to
1073
- * an Amazon Web Services resource and at a periodic frequency that you choose (for
1074
- * example, every 24 hours).</p>
1068
+ * <p>Config rules evaluate the configuration settings of your Amazon Web Services resources. A rule can run when Config detects a configuration change to
1069
+ * an Amazon Web Services resource or at a periodic frequency that you choose (for
1070
+ * example, every 24 hours). There are two types of rules: Config Managed Rules and Config Custom Rules.
1071
+ * Managed rules are predefined, customizable rules created by Config. For a list of managed rules, see
1072
+ * <a href="https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html">List of Config
1073
+ * Managed Rules</a>.</p>
1074
+ *
1075
+ * <p>Custom rules are rules that you can create using either Guard or Lambda functions.
1076
+ * Guard (<a href="https://github.com/aws-cloudformation/cloudformation-guard">Guard GitHub
1077
+ * Repository</a>) is a policy-as-code language that allows you to write policies that
1078
+ * are enforced by Config Custom Policy rules. Lambda uses custom code that you upload to
1079
+ * evaluate a custom rule. It is invoked by events that are published to it by an event source, which Config invokes when the custom rule is initiated.</p>
1080
+ *
1081
+ * <p>For more information about developing and using Config
1082
+ * rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating Amazon Web Services resource Configurations with Config</a>
1083
+ * in the <i>Config Developer Guide</i>.</p>
1075
1084
  *
1076
1085
  * <note>
1077
1086
  * <p>You can use the Amazon Web Services CLI and Amazon Web Services SDKs if you want to create
1078
1087
  * a rule that triggers evaluations for your resources when Config delivers the configuration snapshot. For more
1079
1088
  * information, see <a>ConfigSnapshotDeliveryProperties</a>.</p>
1080
1089
  * </note>
1081
- * <p>For more information about developing and using Config
1082
- * rules, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html">Evaluating Amazon Web Services resource Configurations with Config</a>
1083
- * in the <i>Config Developer Guide</i>.</p>
1084
1090
  */
1085
1091
  export interface ConfigRule {
1086
1092
  /**
@@ -1116,7 +1122,7 @@ export interface ConfigRule {
1116
1122
  */
1117
1123
  Scope?: Scope;
1118
1124
  /**
1119
- * <p>Provides the rule owner (Amazon Web Services or customer), the rule identifier,
1125
+ * <p>Provides the rule owner (<code>Amazon Web Services</code> for managed rules, <code>CUSTOM_POLICY</code> for Custom Policy rules, and <code>CUSTOM_LAMBDA</code> for Custom Lambda rules), the rule identifier,
1120
1126
  * and the notifications that cause the function to evaluate your Amazon Web Services
1121
1127
  * resources.</p>
1122
1128
  */
@@ -1177,7 +1183,7 @@ export interface ConfigRule {
1177
1183
  * <p>Service principal name of the service that created the
1178
1184
  * rule.</p>
1179
1185
  * <note>
1180
- * <p>The field is populated only if the service linked rule is
1186
+ * <p>The field is populated only if the service-linked rule is
1181
1187
  * created by a service. The field is empty if you create your own
1182
1188
  * rule.</p>
1183
1189
  * </note>
@@ -1779,11 +1785,11 @@ export interface ConformancePackComplianceFilters {
1779
1785
  /**
1780
1786
  * <p>A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack.
1781
1787
  * This metric provides you with a high-level view of the compliance state of your conformance packs, and can be used to identify, investigate, and understand
1782
- * compliance deviations in your conformance packs.</p>
1788
+ * the level of compliance in your conformance packs.</p>
1783
1789
  */
1784
1790
  export interface ConformancePackComplianceScore {
1785
1791
  /**
1786
- * <p>Compliance score for the conformance pack.</p>
1792
+ * <p>Compliance score for the conformance pack. Conformance packs with no evaluation results will have a compliance score of <code>INSUFFICIENT_DATA</code>.</p>
1787
1793
  */
1788
1794
  Score?: string;
1789
1795
  /**
@@ -1796,11 +1802,12 @@ export interface ConformancePackComplianceScore {
1796
1802
  LastUpdatedTime?: Date;
1797
1803
  }
1798
1804
  /**
1799
- * <p>A list of filters to apply to the conformance pack compliance score result set.</p>
1805
+ * <p>A list of filters to apply to the conformance pack compliance score result set. </p>
1800
1806
  */
1801
1807
  export interface ConformancePackComplianceScoresFilters {
1802
1808
  /**
1803
- * <p>The name of a conformance pack whose score should be included in the compliance score result.</p>
1809
+ * <p>The names of the conformance packs whose compliance scores you want to include in the conformance pack compliance score result set.
1810
+ * You can include up to 25 conformance packs in the <code>ConformancePackNames</code> array of strings, each with a character limit of 256 characters for the conformance pack name.</p>
1804
1811
  */
1805
1812
  ConformancePackNames: string[] | undefined;
1806
1813
  }
@@ -2289,13 +2296,13 @@ export interface DeleteRemediationConfigurationResponse {
2289
2296
  * <p>For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.</p>
2290
2297
  * </li>
2291
2298
  * <li>
2292
- * <p>For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM <code>GetRole</code> action or create a service linked role.</p>
2299
+ * <p>For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM <code>GetRole</code> action or create a service-linked role.</p>
2293
2300
  * </li>
2294
2301
  * <li>
2295
2302
  * <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have permissions: </p>
2296
2303
  * <ul>
2297
2304
  * <li>
2298
- * <p>To call IAM <code>GetRole</code> action or create a service linked role.</p>
2305
+ * <p>To call IAM <code>GetRole</code> action or create a service-linked role.</p>
2299
2306
  * </li>
2300
2307
  * <li>
2301
2308
  * <p>To read Amazon S3 bucket.</p>
@@ -2483,8 +2490,8 @@ export interface DeliveryChannel {
2483
2490
  * <p>The name of the Amazon S3 bucket to which Config delivers
2484
2491
  * configuration snapshots and configuration history files.</p>
2485
2492
  * <p>If you specify a bucket that belongs to another Amazon Web Services account,
2486
- * that bucket must have policies that grant access permissions to Config. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html">Permissions for the Amazon S3 Bucket</a> in the Config
2487
- * Developer Guide.</p>
2493
+ * that bucket must have policies that grant access permissions to Config. For more information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html">Permissions for the Amazon S3 Bucket</a> in the <i>Config
2494
+ * Developer Guide</i>.</p>
2488
2495
  */
2489
2496
  s3BucketName?: string;
2490
2497
  /**
@@ -2502,8 +2509,8 @@ export interface DeliveryChannel {
2502
2509
  * changes.</p>
2503
2510
  * <p>If you choose a topic from another account, the topic must have
2504
2511
  * policies that grant access permissions to Config. For more
2505
- * information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html">Permissions for the Amazon SNS Topic</a> in the Config
2506
- * Developer Guide.</p>
2512
+ * information, see <a href="https://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html">Permissions for the Amazon SNS Topic</a> in the <i>Config
2513
+ * Developer Guide</i>.</p>
2507
2514
  */
2508
2515
  snsTopicARN?: string;
2509
2516
  /**
@@ -3750,7 +3757,7 @@ export interface RemediationConfiguration {
3750
3757
  */
3751
3758
  Arn?: string;
3752
3759
  /**
3753
- * <p>Name of the service that owns the service linked rule, if applicable.</p>
3760
+ * <p>Name of the service that owns the service-linked rule, if applicable.</p>
3754
3761
  */
3755
3762
  CreatedByService?: string;
3756
3763
  }
@@ -5281,10 +5288,12 @@ export interface ListConformancePackComplianceScoresRequest {
5281
5288
  Filters?: ConformancePackComplianceScoresFilters;
5282
5289
  /**
5283
5290
  * <p>Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.</p>
5291
+ * <p>Conformance packs with a compliance score of <code>INSUFFICIENT_DATA</code> will be first when sorting by ascending order and last when sorting by descending order.</p>
5284
5292
  */
5285
5293
  SortOrder?: SortOrder | string;
5286
5294
  /**
5287
5295
  * <p>Sorts your conformance pack compliance scores in either ascending or descending order, depending on <code>SortOrder</code>.</p>
5296
+ * <p>By default, conformance pack compliance scores are sorted in ascending order by compliance score and alphabetically by name of the conformance pack if there is more than one conformance pack with the same compliance score.</p>
5288
5297
  */
5289
5298
  SortBy?: SortBy | string;
5290
5299
  /**
@@ -5302,7 +5311,7 @@ export interface ListConformancePackComplianceScoresResponse {
5302
5311
  */
5303
5312
  NextToken?: string;
5304
5313
  /**
5305
- * <p>A list of <code>ConformancePackComplianceScore</code> objects</p>
5314
+ * <p>A list of <code>ConformancePackComplianceScore</code> objects.</p>
5306
5315
  */
5307
5316
  ConformancePackComplianceScores: ConformancePackComplianceScore[] | undefined;
5308
5317
  }
@@ -78,11 +78,15 @@ export interface PutOrganizationConfigRuleRequest {
78
78
  */
79
79
  OrganizationConfigRuleName: string | undefined;
80
80
  /**
81
- * <p>An <code>OrganizationManagedRuleMetadata</code> object. </p>
81
+ * <p>An <code>OrganizationManagedRuleMetadata</code> object. This object specifies organization
82
+ * managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier.
83
+ * It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.</p>
82
84
  */
83
85
  OrganizationManagedRuleMetadata?: OrganizationManagedRuleMetadata;
84
86
  /**
85
- * <p>An <code>OrganizationCustomRuleMetadata</code> object.</p>
87
+ * <p>An <code>OrganizationCustomRuleMetadata</code> object. This object specifies organization custom rule metadata such as resource type,
88
+ * resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule.
89
+ * It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.</p>
86
90
  */
87
91
  OrganizationCustomRuleMetadata?: OrganizationCustomRuleMetadata;
88
92
  /**
@@ -90,9 +94,9 @@ export interface PutOrganizationConfigRuleRequest {
90
94
  */
91
95
  ExcludedAccounts?: string[];
92
96
  /**
93
- * <p>An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug
97
+ * <p>An <code>OrganizationCustomPolicyRuleMetadata</code> object. This object specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug
94
98
  * logging enabled, and other custom rule metadata, such as resource type, resource ID of
95
- * Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.</p>
99
+ * Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.</p>
96
100
  */
97
101
  OrganizationCustomPolicyRuleMetadata?: OrganizationCustomPolicyRuleMetadata;
98
102
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-config-service",
3
3
  "description": "AWS SDK for JavaScript Config Service Client for Node.js, Browser and React Native",
4
- "version": "3.138.0",
4
+ "version": "3.141.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -18,9 +18,9 @@
18
18
  "dependencies": {
19
19
  "@aws-crypto/sha256-browser": "2.0.0",
20
20
  "@aws-crypto/sha256-js": "2.0.0",
21
- "@aws-sdk/client-sts": "3.137.0",
21
+ "@aws-sdk/client-sts": "3.141.0",
22
22
  "@aws-sdk/config-resolver": "3.130.0",
23
- "@aws-sdk/credential-provider-node": "3.137.0",
23
+ "@aws-sdk/credential-provider-node": "3.141.0",
24
24
  "@aws-sdk/fetch-http-handler": "3.131.0",
25
25
  "@aws-sdk/hash-node": "3.127.0",
26
26
  "@aws-sdk/invalid-dependency": "3.127.0",