aws-sdk-configservice 1.65.0 → 1.66.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-configservice/client.rb +384 -372
- data/lib/aws-sdk-configservice/types.rb +624 -614
- data/lib/aws-sdk-configservice.rb +1 -1
- metadata +5 -5
@@ -26,7 +26,7 @@ module Aws::ConfigService
|
|
26
26
|
# @return [Array<String>]
|
27
27
|
#
|
28
28
|
# @!attribute [rw] all_aws_regions
|
29
|
-
# If true, aggregate existing
|
29
|
+
# If true, aggregate existing Config regions and future regions.
|
30
30
|
# @return [Boolean]
|
31
31
|
#
|
32
32
|
# @!attribute [rw] aws_regions
|
@@ -43,7 +43,7 @@ module Aws::ConfigService
|
|
43
43
|
include Aws::Structure
|
44
44
|
end
|
45
45
|
|
46
|
-
# Indicates whether an
|
46
|
+
# Indicates whether an Config rule is compliant based on account ID,
|
47
47
|
# region, compliance, and rule name.
|
48
48
|
#
|
49
49
|
# A rule is compliant if all of the resources that the rule evaluated
|
@@ -51,12 +51,13 @@ module Aws::ConfigService
|
|
51
51
|
# comply.
|
52
52
|
#
|
53
53
|
# @!attribute [rw] config_rule_name
|
54
|
-
# The name of the
|
54
|
+
# The name of the Config rule.
|
55
55
|
# @return [String]
|
56
56
|
#
|
57
57
|
# @!attribute [rw] compliance
|
58
|
-
# Indicates whether an
|
59
|
-
# and provides the number of contributors that affect the
|
58
|
+
# Indicates whether an Amazon Web Services resource or Config rule is
|
59
|
+
# compliant and provides the number of contributors that affect the
|
60
|
+
# compliance.
|
60
61
|
# @return [Types::Compliance]
|
61
62
|
#
|
62
63
|
# @!attribute [rw] account_id
|
@@ -100,11 +101,12 @@ module Aws::ConfigService
|
|
100
101
|
# @return [Types::AggregateConformancePackCompliance]
|
101
102
|
#
|
102
103
|
# @!attribute [rw] account_id
|
103
|
-
# The 12-digit
|
104
|
+
# The 12-digit Amazon Web Services account ID of the source account.
|
104
105
|
# @return [String]
|
105
106
|
#
|
106
107
|
# @!attribute [rw] aws_region
|
107
|
-
# The source
|
108
|
+
# The source Amazon Web Services Region from where the data is
|
109
|
+
# aggregated.
|
108
110
|
# @return [String]
|
109
111
|
#
|
110
112
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/AggregateComplianceByConformancePack AWS API Documentation
|
@@ -126,7 +128,7 @@ module Aws::ConfigService
|
|
126
128
|
# @return [String]
|
127
129
|
#
|
128
130
|
# @!attribute [rw] compliance_summary
|
129
|
-
# The number of compliant and noncompliant
|
131
|
+
# The number of compliant and noncompliant Config rules.
|
130
132
|
# @return [Types::ComplianceSummary]
|
131
133
|
#
|
132
134
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/AggregateComplianceCount AWS API Documentation
|
@@ -158,11 +160,11 @@ module Aws::ConfigService
|
|
158
160
|
# @return [String]
|
159
161
|
#
|
160
162
|
# @!attribute [rw] compliant_rule_count
|
161
|
-
# The number of compliant
|
163
|
+
# The number of compliant Config Rules.
|
162
164
|
# @return [Integer]
|
163
165
|
#
|
164
166
|
# @!attribute [rw] non_compliant_rule_count
|
165
|
-
# The number of noncompliant
|
167
|
+
# The number of noncompliant Config Rules.
|
166
168
|
# @return [Integer]
|
167
169
|
#
|
168
170
|
# @!attribute [rw] total_rule_count
|
@@ -223,11 +225,12 @@ module Aws::ConfigService
|
|
223
225
|
# @return [String]
|
224
226
|
#
|
225
227
|
# @!attribute [rw] account_id
|
226
|
-
# The 12-digit
|
228
|
+
# The 12-digit Amazon Web Services account ID of the source account.
|
227
229
|
# @return [String]
|
228
230
|
#
|
229
231
|
# @!attribute [rw] aws_region
|
230
|
-
# The source
|
232
|
+
# The source Amazon Web Services Region from where the data is
|
233
|
+
# aggregated.
|
231
234
|
# @return [String]
|
232
235
|
#
|
233
236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/AggregateConformancePackComplianceFilters AWS API Documentation
|
@@ -248,7 +251,8 @@ module Aws::ConfigService
|
|
248
251
|
# @return [Types::AggregateConformancePackComplianceCount]
|
249
252
|
#
|
250
253
|
# @!attribute [rw] group_name
|
251
|
-
# Groups the result based on
|
254
|
+
# Groups the result based on Amazon Web Services account ID or Amazon
|
255
|
+
# Web Services Region.
|
252
256
|
# @return [String]
|
253
257
|
#
|
254
258
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/AggregateConformancePackComplianceSummary AWS API Documentation
|
@@ -271,11 +275,12 @@ module Aws::ConfigService
|
|
271
275
|
# }
|
272
276
|
#
|
273
277
|
# @!attribute [rw] account_id
|
274
|
-
# The 12-digit
|
278
|
+
# The 12-digit Amazon Web Services account ID of the source account.
|
275
279
|
# @return [String]
|
276
280
|
#
|
277
281
|
# @!attribute [rw] aws_region
|
278
|
-
# The source
|
282
|
+
# The source Amazon Web Services Region from where the data is
|
283
|
+
# aggregated.
|
279
284
|
# @return [String]
|
280
285
|
#
|
281
286
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/AggregateConformancePackComplianceSummaryFilters AWS API Documentation
|
@@ -287,10 +292,10 @@ module Aws::ConfigService
|
|
287
292
|
include Aws::Structure
|
288
293
|
end
|
289
294
|
|
290
|
-
# The details of an
|
291
|
-
#
|
292
|
-
# compliance of the resource, related time stamps, and
|
293
|
-
# information.
|
295
|
+
# The details of an Config evaluation for an account ID and region in an
|
296
|
+
# aggregator. Provides the Amazon Web Services resource that was
|
297
|
+
# evaluated, the compliance of the resource, related time stamps, and
|
298
|
+
# supplementary information.
|
294
299
|
#
|
295
300
|
# @!attribute [rw] evaluation_result_identifier
|
296
301
|
# Uniquely identifies the evaluation result.
|
@@ -299,17 +304,18 @@ module Aws::ConfigService
|
|
299
304
|
# @!attribute [rw] compliance_type
|
300
305
|
# The resource compliance status.
|
301
306
|
#
|
302
|
-
# For the `AggregationEvaluationResult` data type,
|
303
|
-
# only the `COMPLIANT` and `NON_COMPLIANT`.
|
304
|
-
#
|
307
|
+
# For the `AggregationEvaluationResult` data type, Config supports
|
308
|
+
# only the `COMPLIANT` and `NON_COMPLIANT`. Config does not support
|
309
|
+
# the `NOT_APPLICABLE` and `INSUFFICIENT_DATA` value.
|
305
310
|
# @return [String]
|
306
311
|
#
|
307
312
|
# @!attribute [rw] result_recorded_time
|
308
|
-
# The time when
|
313
|
+
# The time when Config recorded the aggregate evaluation result.
|
309
314
|
# @return [Time]
|
310
315
|
#
|
311
316
|
# @!attribute [rw] config_rule_invoked_time
|
312
|
-
# The time when the
|
317
|
+
# The time when the Config rule evaluated the Amazon Web Services
|
318
|
+
# resource.
|
313
319
|
# @return [Time]
|
314
320
|
#
|
315
321
|
# @!attribute [rw] annotation
|
@@ -339,7 +345,7 @@ module Aws::ConfigService
|
|
339
345
|
include Aws::Structure
|
340
346
|
end
|
341
347
|
|
342
|
-
# The details that identify a resource that is collected by
|
348
|
+
# The details that identify a resource that is collected by Config
|
343
349
|
# aggregator, including the resource type, ID, (if available) the custom
|
344
350
|
# resource name, the source account, and source region.
|
345
351
|
#
|
@@ -363,15 +369,15 @@ module Aws::ConfigService
|
|
363
369
|
# @return [String]
|
364
370
|
#
|
365
371
|
# @!attribute [rw] resource_id
|
366
|
-
# The ID of the
|
372
|
+
# The ID of the Amazon Web Services resource.
|
367
373
|
# @return [String]
|
368
374
|
#
|
369
375
|
# @!attribute [rw] resource_type
|
370
|
-
# The type of the
|
376
|
+
# The type of the Amazon Web Services resource.
|
371
377
|
# @return [String]
|
372
378
|
#
|
373
379
|
# @!attribute [rw] resource_name
|
374
|
-
# The name of the
|
380
|
+
# The name of the Amazon Web Services resource.
|
375
381
|
# @return [String]
|
376
382
|
#
|
377
383
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/AggregateResourceIdentifier AWS API Documentation
|
@@ -415,7 +421,7 @@ module Aws::ConfigService
|
|
415
421
|
# @return [Time]
|
416
422
|
#
|
417
423
|
# @!attribute [rw] last_error_code
|
418
|
-
# The error code that
|
424
|
+
# The error code that Config returned when the source account
|
419
425
|
# aggregation last failed.
|
420
426
|
# @return [String]
|
421
427
|
#
|
@@ -475,7 +481,8 @@ module Aws::ConfigService
|
|
475
481
|
# @return [String]
|
476
482
|
#
|
477
483
|
# @!attribute [rw] account_id
|
478
|
-
# The 12-digit
|
484
|
+
# The 12-digit Amazon Web Services account ID associated with the
|
485
|
+
# resource.
|
479
486
|
# @return [String]
|
480
487
|
#
|
481
488
|
# @!attribute [rw] configuration_item_capture_time
|
@@ -514,7 +521,7 @@ module Aws::ConfigService
|
|
514
521
|
# @return [String]
|
515
522
|
#
|
516
523
|
# @!attribute [rw] resource_type
|
517
|
-
# The type of
|
524
|
+
# The type of Amazon Web Services resource.
|
518
525
|
# @return [String]
|
519
526
|
#
|
520
527
|
# @!attribute [rw] resource_id
|
@@ -542,9 +549,9 @@ module Aws::ConfigService
|
|
542
549
|
# @return [String]
|
543
550
|
#
|
544
551
|
# @!attribute [rw] supplementary_configuration
|
545
|
-
# Configuration attributes that
|
546
|
-
#
|
547
|
-
#
|
552
|
+
# Configuration attributes that Config returns for certain resource
|
553
|
+
# types to supplement the information returned for the configuration
|
554
|
+
# parameter.
|
548
555
|
# @return [Hash<String,String>]
|
549
556
|
#
|
550
557
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/BaseConfigurationItem AWS API Documentation
|
@@ -669,32 +676,34 @@ module Aws::ConfigService
|
|
669
676
|
include Aws::Structure
|
670
677
|
end
|
671
678
|
|
672
|
-
# Indicates whether an
|
673
|
-
# provides the number of contributors that affect the
|
679
|
+
# Indicates whether an Amazon Web Services resource or Config rule is
|
680
|
+
# compliant and provides the number of contributors that affect the
|
681
|
+
# compliance.
|
674
682
|
#
|
675
683
|
# @!attribute [rw] compliance_type
|
676
|
-
# Indicates whether an
|
684
|
+
# Indicates whether an Amazon Web Services resource or Config rule is
|
685
|
+
# compliant.
|
677
686
|
#
|
678
|
-
# A resource is compliant if it complies with all of the
|
679
|
-
#
|
680
|
-
#
|
687
|
+
# A resource is compliant if it complies with all of the Config rules
|
688
|
+
# that evaluate it. A resource is noncompliant if it does not comply
|
689
|
+
# with one or more of these rules.
|
681
690
|
#
|
682
691
|
# A rule is compliant if all of the resources that the rule evaluates
|
683
692
|
# comply with it. A rule is noncompliant if any of these resources do
|
684
693
|
# not comply.
|
685
694
|
#
|
686
|
-
#
|
687
|
-
# results are available for the
|
695
|
+
# Config returns the `INSUFFICIENT_DATA` value when no evaluation
|
696
|
+
# results are available for the Amazon Web Services resource or Config
|
697
|
+
# rule.
|
688
698
|
#
|
689
|
-
# For the `Compliance` data type,
|
690
|
-
# `
|
691
|
-
#
|
692
|
-
# `Compliance` data type.
|
699
|
+
# For the `Compliance` data type, Config supports only `COMPLIANT`,
|
700
|
+
# `NON_COMPLIANT`, and `INSUFFICIENT_DATA` values. Config does not
|
701
|
+
# support the `NOT_APPLICABLE` value for the `Compliance` data type.
|
693
702
|
# @return [String]
|
694
703
|
#
|
695
704
|
# @!attribute [rw] compliance_contributor_count
|
696
|
-
# The number of
|
697
|
-
# of `NON_COMPLIANT`, up to a maximum number.
|
705
|
+
# The number of Amazon Web Services resources or Config rules that
|
706
|
+
# cause a result of `NON_COMPLIANT`, up to a maximum number.
|
698
707
|
# @return [Types::ComplianceContributorCount]
|
699
708
|
#
|
700
709
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/Compliance AWS API Documentation
|
@@ -706,16 +715,16 @@ module Aws::ConfigService
|
|
706
715
|
include Aws::Structure
|
707
716
|
end
|
708
717
|
|
709
|
-
# Indicates whether an
|
710
|
-
#
|
711
|
-
#
|
718
|
+
# Indicates whether an Config rule is compliant. A rule is compliant if
|
719
|
+
# all of the resources that the rule evaluated comply with it. A rule is
|
720
|
+
# noncompliant if any of these resources do not comply.
|
712
721
|
#
|
713
722
|
# @!attribute [rw] config_rule_name
|
714
|
-
# The name of the
|
723
|
+
# The name of the Config rule.
|
715
724
|
# @return [String]
|
716
725
|
#
|
717
726
|
# @!attribute [rw] compliance
|
718
|
-
# Indicates whether the
|
727
|
+
# Indicates whether the Config rule is compliant.
|
719
728
|
# @return [Types::Compliance]
|
720
729
|
#
|
721
730
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ComplianceByConfigRule AWS API Documentation
|
@@ -727,22 +736,23 @@ module Aws::ConfigService
|
|
727
736
|
include Aws::Structure
|
728
737
|
end
|
729
738
|
|
730
|
-
# Indicates whether an
|
731
|
-
# or more
|
732
|
-
# complies with all of the rules that evaluate it. A
|
733
|
-
# noncompliant if it does not comply with one or more of
|
739
|
+
# Indicates whether an Amazon Web Services resource that is evaluated
|
740
|
+
# according to one or more Config rules is compliant. A resource is
|
741
|
+
# compliant if it complies with all of the rules that evaluate it. A
|
742
|
+
# resource is noncompliant if it does not comply with one or more of
|
743
|
+
# these rules.
|
734
744
|
#
|
735
745
|
# @!attribute [rw] resource_type
|
736
|
-
# The type of the
|
746
|
+
# The type of the Amazon Web Services resource that was evaluated.
|
737
747
|
# @return [String]
|
738
748
|
#
|
739
749
|
# @!attribute [rw] resource_id
|
740
|
-
# The ID of the
|
750
|
+
# The ID of the Amazon Web Services resource that was evaluated.
|
741
751
|
# @return [String]
|
742
752
|
#
|
743
753
|
# @!attribute [rw] compliance
|
744
|
-
# Indicates whether the
|
745
|
-
# Config rules that evaluated it.
|
754
|
+
# Indicates whether the Amazon Web Services resource complies with all
|
755
|
+
# of the Config rules that evaluated it.
|
746
756
|
# @return [Types::Compliance]
|
747
757
|
#
|
748
758
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ComplianceByResource AWS API Documentation
|
@@ -755,12 +765,13 @@ module Aws::ConfigService
|
|
755
765
|
include Aws::Structure
|
756
766
|
end
|
757
767
|
|
758
|
-
# The number of
|
759
|
-
# current compliance of the item, up to a maximum
|
768
|
+
# The number of Amazon Web Services resources or Config rules
|
769
|
+
# responsible for the current compliance of the item, up to a maximum
|
770
|
+
# number.
|
760
771
|
#
|
761
772
|
# @!attribute [rw] capped_count
|
762
|
-
# The number of
|
763
|
-
# current compliance of the item.
|
773
|
+
# The number of Amazon Web Services resources or Config rules
|
774
|
+
# responsible for the current compliance of the item.
|
764
775
|
# @return [Integer]
|
765
776
|
#
|
766
777
|
# @!attribute [rw] cap_exceeded
|
@@ -776,21 +787,21 @@ module Aws::ConfigService
|
|
776
787
|
include Aws::Structure
|
777
788
|
end
|
778
789
|
|
779
|
-
# The number of
|
780
|
-
# noncompliant.
|
790
|
+
# The number of Config rules or Amazon Web Services resources that are
|
791
|
+
# compliant and noncompliant.
|
781
792
|
#
|
782
793
|
# @!attribute [rw] compliant_resource_count
|
783
|
-
# The number of
|
784
|
-
# up to a maximum of 25 for rules and 100 for resources.
|
794
|
+
# The number of Config rules or Amazon Web Services resources that are
|
795
|
+
# compliant, up to a maximum of 25 for rules and 100 for resources.
|
785
796
|
# @return [Types::ComplianceContributorCount]
|
786
797
|
#
|
787
798
|
# @!attribute [rw] non_compliant_resource_count
|
788
|
-
# The number of
|
799
|
+
# The number of Config rules or Amazon Web Services resources that are
|
789
800
|
# noncompliant, up to a maximum of 25 for rules and 100 for resources.
|
790
801
|
# @return [Types::ComplianceContributorCount]
|
791
802
|
#
|
792
803
|
# @!attribute [rw] compliance_summary_timestamp
|
793
|
-
# The time that
|
804
|
+
# The time that Config created the compliance summary.
|
794
805
|
# @return [Time]
|
795
806
|
#
|
796
807
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ComplianceSummary AWS API Documentation
|
@@ -803,16 +814,16 @@ module Aws::ConfigService
|
|
803
814
|
include Aws::Structure
|
804
815
|
end
|
805
816
|
|
806
|
-
# The number of
|
807
|
-
# noncompliant, up to a maximum of 100 for each.
|
817
|
+
# The number of Amazon Web Services resources of a specific type that
|
818
|
+
# are compliant or noncompliant, up to a maximum of 100 for each.
|
808
819
|
#
|
809
820
|
# @!attribute [rw] resource_type
|
810
|
-
# The type of
|
821
|
+
# The type of Amazon Web Services resource.
|
811
822
|
# @return [String]
|
812
823
|
#
|
813
824
|
# @!attribute [rw] compliance_summary
|
814
|
-
# The number of
|
815
|
-
# to a maximum of 100 for each.
|
825
|
+
# The number of Amazon Web Services resources that are compliant or
|
826
|
+
# noncompliant, up to a maximum of 100 for each.
|
816
827
|
# @return [Types::ComplianceSummary]
|
817
828
|
#
|
818
829
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ComplianceSummaryByResourceType AWS API Documentation
|
@@ -866,24 +877,24 @@ module Aws::ConfigService
|
|
866
877
|
include Aws::Structure
|
867
878
|
end
|
868
879
|
|
869
|
-
# An
|
870
|
-
#
|
871
|
-
#
|
872
|
-
# resources comply with your desired configurations. This
|
873
|
-
# run when
|
874
|
-
# and at a periodic frequency that you
|
875
|
-
# hours).
|
880
|
+
# An Config rule represents an Lambda function that you create for a
|
881
|
+
# custom rule or a predefined function for an Config managed rule. The
|
882
|
+
# function evaluates configuration items to assess whether your Amazon
|
883
|
+
# Web Services resources comply with your desired configurations. This
|
884
|
+
# function can run when Config detects a configuration change to an
|
885
|
+
# Amazon Web Services resource and at a periodic frequency that you
|
886
|
+
# choose (for example, every 24 hours).
|
876
887
|
#
|
877
|
-
# <note markdown="1"> You can use the
|
878
|
-
#
|
879
|
-
# configuration snapshot. For more
|
880
|
-
# ConfigSnapshotDeliveryProperties.
|
888
|
+
# <note markdown="1"> You can use the Amazon Web Services CLI and Amazon Web Services SDKs
|
889
|
+
# if you want to create a rule that triggers evaluations for your
|
890
|
+
# resources when Config delivers the configuration snapshot. For more
|
891
|
+
# information, see ConfigSnapshotDeliveryProperties.
|
881
892
|
#
|
882
893
|
# </note>
|
883
894
|
#
|
884
|
-
# For more information about developing and using
|
885
|
-
# [Evaluating
|
886
|
-
# *
|
895
|
+
# For more information about developing and using Config rules, see
|
896
|
+
# [Evaluating Amazon Web Services resource Configurations with
|
897
|
+
# Config][1] in the *Config Developer Guide*.
|
887
898
|
#
|
888
899
|
#
|
889
900
|
#
|
@@ -921,20 +932,20 @@ module Aws::ConfigService
|
|
921
932
|
# }
|
922
933
|
#
|
923
934
|
# @!attribute [rw] config_rule_name
|
924
|
-
# The name that you assign to the
|
925
|
-
#
|
935
|
+
# The name that you assign to the Config rule. The name is required if
|
936
|
+
# you are adding a new rule.
|
926
937
|
# @return [String]
|
927
938
|
#
|
928
939
|
# @!attribute [rw] config_rule_arn
|
929
|
-
# The Amazon Resource Name (ARN) of the
|
940
|
+
# The Amazon Resource Name (ARN) of the Config rule.
|
930
941
|
# @return [String]
|
931
942
|
#
|
932
943
|
# @!attribute [rw] config_rule_id
|
933
|
-
# The ID of the
|
944
|
+
# The ID of the Config rule.
|
934
945
|
# @return [String]
|
935
946
|
#
|
936
947
|
# @!attribute [rw] description
|
937
|
-
# The description that you provide for the
|
948
|
+
# The description that you provide for the Config rule.
|
938
949
|
# @return [String]
|
939
950
|
#
|
940
951
|
# @!attribute [rw] scope
|
@@ -952,24 +963,24 @@ module Aws::ConfigService
|
|
952
963
|
# @return [Types::Scope]
|
953
964
|
#
|
954
965
|
# @!attribute [rw] source
|
955
|
-
# Provides the rule owner (
|
956
|
-
# the notifications that cause the function to
|
957
|
-
# resources.
|
966
|
+
# Provides the rule owner (Amazon Web Services or customer), the rule
|
967
|
+
# identifier, and the notifications that cause the function to
|
968
|
+
# evaluate your Amazon Web Services resources.
|
958
969
|
# @return [Types::Source]
|
959
970
|
#
|
960
971
|
# @!attribute [rw] input_parameters
|
961
|
-
# A string, in JSON format, that is passed to the
|
962
|
-
#
|
972
|
+
# A string, in JSON format, that is passed to the Config rule Lambda
|
973
|
+
# function.
|
963
974
|
# @return [String]
|
964
975
|
#
|
965
976
|
# @!attribute [rw] maximum_execution_frequency
|
966
|
-
# The maximum frequency with which
|
967
|
-
#
|
977
|
+
# The maximum frequency with which Config runs evaluations for a rule.
|
978
|
+
# You can specify a value for `MaximumExecutionFrequency` when:
|
968
979
|
#
|
969
|
-
# * You are using an
|
970
|
-
# frequency.
|
980
|
+
# * You are using an Config managed rule that is triggered at a
|
981
|
+
# periodic frequency.
|
971
982
|
#
|
972
|
-
# * Your custom rule is triggered when
|
983
|
+
# * Your custom rule is triggered when Config delivers the
|
973
984
|
# configuration snapshot. For more information, see
|
974
985
|
# ConfigSnapshotDeliveryProperties.
|
975
986
|
#
|
@@ -981,22 +992,22 @@ module Aws::ConfigService
|
|
981
992
|
# @return [String]
|
982
993
|
#
|
983
994
|
# @!attribute [rw] config_rule_state
|
984
|
-
# Indicates whether the
|
985
|
-
#
|
986
|
-
#
|
995
|
+
# Indicates whether the Config rule is active or is currently being
|
996
|
+
# deleted by Config. It can also indicate the evaluation status for
|
997
|
+
# the Config rule.
|
987
998
|
#
|
988
|
-
#
|
989
|
-
#
|
990
|
-
#
|
999
|
+
# Config sets the state of the rule to `EVALUATING` temporarily after
|
1000
|
+
# you use the `StartConfigRulesEvaluation` request to evaluate your
|
1001
|
+
# resources against the Config rule.
|
991
1002
|
#
|
992
|
-
#
|
993
|
-
#
|
994
|
-
#
|
1003
|
+
# Config sets the state of the rule to `DELETING_RESULTS` temporarily
|
1004
|
+
# after you use the `DeleteEvaluationResults` request to delete the
|
1005
|
+
# current evaluation results for the Config rule.
|
995
1006
|
#
|
996
|
-
#
|
997
|
-
#
|
998
|
-
#
|
999
|
-
#
|
1007
|
+
# Config temporarily sets the state of a rule to `DELETING` after you
|
1008
|
+
# use the `DeleteConfigRule` request to delete the rule. After Config
|
1009
|
+
# deletes the rule, the rule and all of its evaluations are erased and
|
1010
|
+
# are no longer available.
|
1000
1011
|
# @return [String]
|
1001
1012
|
#
|
1002
1013
|
# @!attribute [rw] created_by
|
@@ -1039,15 +1050,15 @@ module Aws::ConfigService
|
|
1039
1050
|
# }
|
1040
1051
|
#
|
1041
1052
|
# @!attribute [rw] config_rule_name
|
1042
|
-
# The name of the
|
1053
|
+
# The name of the Config rule.
|
1043
1054
|
# @return [String]
|
1044
1055
|
#
|
1045
1056
|
# @!attribute [rw] compliance_type
|
1046
1057
|
# The rule compliance status.
|
1047
1058
|
#
|
1048
|
-
# For the `ConfigRuleComplianceFilters` data type,
|
1049
|
-
# only `COMPLIANT` and `NON_COMPLIANT`.
|
1050
|
-
#
|
1059
|
+
# For the `ConfigRuleComplianceFilters` data type, Config supports
|
1060
|
+
# only `COMPLIANT` and `NON_COMPLIANT`. Config does not support the
|
1061
|
+
# `NOT_APPLICABLE` and the `INSUFFICIENT_DATA` values.
|
1051
1062
|
# @return [String]
|
1052
1063
|
#
|
1053
1064
|
# @!attribute [rw] account_id
|
@@ -1096,71 +1107,70 @@ module Aws::ConfigService
|
|
1096
1107
|
include Aws::Structure
|
1097
1108
|
end
|
1098
1109
|
|
1099
|
-
# Status information for your
|
1100
|
-
#
|
1101
|
-
#
|
1110
|
+
# Status information for your Config managed rules. The status includes
|
1111
|
+
# information such as the last time the rule ran, the last time it
|
1112
|
+
# failed, and the related error for the last failure.
|
1102
1113
|
#
|
1103
|
-
# This action does not return status information about custom
|
1114
|
+
# This action does not return status information about custom Config
|
1104
1115
|
# rules.
|
1105
1116
|
#
|
1106
1117
|
# @!attribute [rw] config_rule_name
|
1107
|
-
# The name of the
|
1118
|
+
# The name of the Config rule.
|
1108
1119
|
# @return [String]
|
1109
1120
|
#
|
1110
1121
|
# @!attribute [rw] config_rule_arn
|
1111
|
-
# The Amazon Resource Name (ARN) of the
|
1122
|
+
# The Amazon Resource Name (ARN) of the Config rule.
|
1112
1123
|
# @return [String]
|
1113
1124
|
#
|
1114
1125
|
# @!attribute [rw] config_rule_id
|
1115
|
-
# The ID of the
|
1126
|
+
# The ID of the Config rule.
|
1116
1127
|
# @return [String]
|
1117
1128
|
#
|
1118
1129
|
# @!attribute [rw] last_successful_invocation_time
|
1119
|
-
# The time that
|
1120
|
-
#
|
1130
|
+
# The time that Config last successfully invoked the Config rule to
|
1131
|
+
# evaluate your Amazon Web Services resources.
|
1121
1132
|
# @return [Time]
|
1122
1133
|
#
|
1123
1134
|
# @!attribute [rw] last_failed_invocation_time
|
1124
|
-
# The time that
|
1125
|
-
#
|
1135
|
+
# The time that Config last failed to invoke the Config rule to
|
1136
|
+
# evaluate your Amazon Web Services resources.
|
1126
1137
|
# @return [Time]
|
1127
1138
|
#
|
1128
1139
|
# @!attribute [rw] last_successful_evaluation_time
|
1129
|
-
# The time that
|
1130
|
-
# resources against the rule.
|
1140
|
+
# The time that Config last successfully evaluated your Amazon Web
|
1141
|
+
# Services resources against the rule.
|
1131
1142
|
# @return [Time]
|
1132
1143
|
#
|
1133
1144
|
# @!attribute [rw] last_failed_evaluation_time
|
1134
|
-
# The time that
|
1135
|
-
# against the rule.
|
1145
|
+
# The time that Config last failed to evaluate your Amazon Web
|
1146
|
+
# Services resources against the rule.
|
1136
1147
|
# @return [Time]
|
1137
1148
|
#
|
1138
1149
|
# @!attribute [rw] first_activated_time
|
1139
|
-
# The time that you first activated the
|
1150
|
+
# The time that you first activated the Config rule.
|
1140
1151
|
# @return [Time]
|
1141
1152
|
#
|
1142
1153
|
# @!attribute [rw] last_deactivated_time
|
1143
|
-
# The time that you last turned off the
|
1154
|
+
# The time that you last turned off the Config rule.
|
1144
1155
|
# @return [Time]
|
1145
1156
|
#
|
1146
1157
|
# @!attribute [rw] last_error_code
|
1147
|
-
# The error code that
|
1158
|
+
# The error code that Config returned when the rule last failed.
|
1148
1159
|
# @return [String]
|
1149
1160
|
#
|
1150
1161
|
# @!attribute [rw] last_error_message
|
1151
|
-
# The error message that
|
1152
|
-
# failed.
|
1162
|
+
# The error message that Config returned when the rule last failed.
|
1153
1163
|
# @return [String]
|
1154
1164
|
#
|
1155
1165
|
# @!attribute [rw] first_evaluation_started
|
1156
|
-
# Indicates whether
|
1157
|
-
#
|
1166
|
+
# Indicates whether Config has evaluated your resources against the
|
1167
|
+
# rule at least once.
|
1158
1168
|
#
|
1159
|
-
# * `true` -
|
1160
|
-
# rule at least once.
|
1169
|
+
# * `true` - Config has evaluated your Amazon Web Services resources
|
1170
|
+
# against the rule at least once.
|
1161
1171
|
#
|
1162
|
-
# * `false` -
|
1163
|
-
# resources against the rule.
|
1172
|
+
# * `false` - Config has not once finished evaluating your Amazon Web
|
1173
|
+
# Services resources against the rule.
|
1164
1174
|
# @return [Boolean]
|
1165
1175
|
#
|
1166
1176
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ConfigRuleEvaluationStatus AWS API Documentation
|
@@ -1182,27 +1192,27 @@ module Aws::ConfigService
|
|
1182
1192
|
include Aws::Structure
|
1183
1193
|
end
|
1184
1194
|
|
1185
|
-
# Provides options for how often
|
1186
|
-
#
|
1195
|
+
# Provides options for how often Config delivers configuration snapshots
|
1196
|
+
# to the Amazon S3 bucket in your delivery channel.
|
1187
1197
|
#
|
1188
1198
|
# The frequency for a rule that triggers evaluations for your resources
|
1189
|
-
# when
|
1190
|
-
#
|
1199
|
+
# when Config delivers the configuration snapshot is set by one of two
|
1200
|
+
# values, depending on which is less frequent:
|
1191
1201
|
#
|
1192
1202
|
# * The value for the `deliveryFrequency` parameter within the delivery
|
1193
|
-
# channel configuration, which sets how often
|
1194
|
-
# configuration snapshots. This value also sets how often
|
1195
|
-
# invokes evaluations for
|
1203
|
+
# channel configuration, which sets how often Config delivers
|
1204
|
+
# configuration snapshots. This value also sets how often Config
|
1205
|
+
# invokes evaluations for Config rules.
|
1196
1206
|
#
|
1197
1207
|
# * The value for the `MaximumExecutionFrequency` parameter, which sets
|
1198
|
-
# the maximum frequency with which
|
1199
|
-
#
|
1208
|
+
# the maximum frequency with which Config invokes evaluations for the
|
1209
|
+
# rule. For more information, see ConfigRule.
|
1200
1210
|
#
|
1201
1211
|
# If the `deliveryFrequency` value is less frequent than the
|
1202
|
-
# `MaximumExecutionFrequency` value for a rule,
|
1203
|
-
#
|
1212
|
+
# `MaximumExecutionFrequency` value for a rule, Config invokes the rule
|
1213
|
+
# only as often as the `deliveryFrequency` value.
|
1204
1214
|
#
|
1205
|
-
# 1. For example, you want your rule to run evaluations when
|
1215
|
+
# 1. For example, you want your rule to run evaluations when Config
|
1206
1216
|
# delivers the configuration snapshot.
|
1207
1217
|
#
|
1208
1218
|
# 2. You specify the `MaximumExecutionFrequency` value for `Six_Hours`.
|
@@ -1211,15 +1221,15 @@ module Aws::ConfigService
|
|
1211
1221
|
# for `TwentyFour_Hours`.
|
1212
1222
|
#
|
1213
1223
|
# 4. Because the value for `deliveryFrequency` is less frequent than
|
1214
|
-
# `MaximumExecutionFrequency`,
|
1215
|
-
#
|
1224
|
+
# `MaximumExecutionFrequency`, Config invokes evaluations for the
|
1225
|
+
# rule every 24 hours.
|
1216
1226
|
#
|
1217
1227
|
# You should set the `MaximumExecutionFrequency` value to be at least as
|
1218
1228
|
# frequent as the `deliveryFrequency` value. You can view the
|
1219
1229
|
# `deliveryFrequency` value by using the `DescribeDeliveryChannnels`
|
1220
1230
|
# action.
|
1221
1231
|
#
|
1222
|
-
# To update the `deliveryFrequency` with which
|
1232
|
+
# To update the `deliveryFrequency` with which Config delivers your
|
1223
1233
|
# configuration snapshots, use the `PutDeliveryChannel` action.
|
1224
1234
|
#
|
1225
1235
|
# @note When making an API call, you may pass ConfigSnapshotDeliveryProperties
|
@@ -1230,8 +1240,7 @@ module Aws::ConfigService
|
|
1230
1240
|
# }
|
1231
1241
|
#
|
1232
1242
|
# @!attribute [rw] delivery_frequency
|
1233
|
-
# The frequency with which
|
1234
|
-
# snapshots.
|
1243
|
+
# The frequency with which Config delivers configuration snapshots.
|
1235
1244
|
# @return [String]
|
1236
1245
|
#
|
1237
1246
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ConfigSnapshotDeliveryProperties AWS API Documentation
|
@@ -1248,9 +1257,9 @@ module Aws::ConfigService
|
|
1248
1257
|
# @!attribute [rw] last_status
|
1249
1258
|
# Status of the last attempted delivery.
|
1250
1259
|
#
|
1251
|
-
# **Note** Providing an SNS topic on a [DeliveryChannel][1] for
|
1252
|
-
#
|
1253
|
-
#
|
1260
|
+
# **Note** Providing an SNS topic on a [DeliveryChannel][1] for Config
|
1261
|
+
# is optional. If the SNS delivery is turned off, the last status will
|
1262
|
+
# be **Not\_Applicable**.
|
1254
1263
|
#
|
1255
1264
|
#
|
1256
1265
|
#
|
@@ -1308,7 +1317,8 @@ module Aws::ConfigService
|
|
1308
1317
|
# @return [Time]
|
1309
1318
|
#
|
1310
1319
|
# @!attribute [rw] created_by
|
1311
|
-
#
|
1320
|
+
# Amazon Web Services service that created the configuration
|
1321
|
+
# aggregator.
|
1312
1322
|
# @return [String]
|
1313
1323
|
#
|
1314
1324
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ConfigurationAggregator AWS API Documentation
|
@@ -1332,7 +1342,8 @@ module Aws::ConfigService
|
|
1332
1342
|
# @return [String]
|
1333
1343
|
#
|
1334
1344
|
# @!attribute [rw] account_id
|
1335
|
-
# The 12-digit
|
1345
|
+
# The 12-digit Amazon Web Services account ID associated with the
|
1346
|
+
# resource.
|
1336
1347
|
# @return [String]
|
1337
1348
|
#
|
1338
1349
|
# @!attribute [rw] configuration_item_capture_time
|
@@ -1378,7 +1389,7 @@ module Aws::ConfigService
|
|
1378
1389
|
# @return [String]
|
1379
1390
|
#
|
1380
1391
|
# @!attribute [rw] resource_type
|
1381
|
-
# The type of
|
1392
|
+
# The type of Amazon Web Services resource.
|
1382
1393
|
# @return [String]
|
1383
1394
|
#
|
1384
1395
|
# @!attribute [rw] resource_id
|
@@ -1410,12 +1421,12 @@ module Aws::ConfigService
|
|
1410
1421
|
#
|
1411
1422
|
# A populated field indicates that the current configuration was
|
1412
1423
|
# initiated by the events recorded in the CloudTrail log. For more
|
1413
|
-
# information about CloudTrail, see [What Is
|
1424
|
+
# information about CloudTrail, see [What Is CloudTrail][1].
|
1414
1425
|
#
|
1415
1426
|
# An empty field indicates that the current configuration was not
|
1416
1427
|
# initiated by any event. As of Version 1.3, the relatedEvents field
|
1417
|
-
# is empty. You can access the [LookupEvents API][2] in the
|
1418
|
-
# CloudTrail API Reference* to retrieve the events for the resource.
|
1428
|
+
# is empty. You can access the [LookupEvents API][2] in the
|
1429
|
+
# *CloudTrail API Reference* to retrieve the events for the resource.
|
1419
1430
|
#
|
1420
1431
|
#
|
1421
1432
|
#
|
@@ -1424,7 +1435,7 @@ module Aws::ConfigService
|
|
1424
1435
|
# @return [Array<String>]
|
1425
1436
|
#
|
1426
1437
|
# @!attribute [rw] relationships
|
1427
|
-
# A list of related
|
1438
|
+
# A list of related Amazon Web Services resources.
|
1428
1439
|
# @return [Array<Types::Relationship>]
|
1429
1440
|
#
|
1430
1441
|
# @!attribute [rw] configuration
|
@@ -1432,9 +1443,9 @@ module Aws::ConfigService
|
|
1432
1443
|
# @return [String]
|
1433
1444
|
#
|
1434
1445
|
# @!attribute [rw] supplementary_configuration
|
1435
|
-
# Configuration attributes that
|
1436
|
-
#
|
1437
|
-
#
|
1446
|
+
# Configuration attributes that Config returns for certain resource
|
1447
|
+
# types to supplement the information returned for the `configuration`
|
1448
|
+
# parameter.
|
1438
1449
|
# @return [Hash<String,String>]
|
1439
1450
|
#
|
1440
1451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ConfigurationItem AWS API Documentation
|
@@ -1463,7 +1474,7 @@ module Aws::ConfigService
|
|
1463
1474
|
end
|
1464
1475
|
|
1465
1476
|
# An object that represents the recording of configuration changes of an
|
1466
|
-
#
|
1477
|
+
# Amazon Web Services resource.
|
1467
1478
|
#
|
1468
1479
|
# @note When making an API call, you may pass ConfigurationRecorder
|
1469
1480
|
# data as a hash:
|
@@ -1479,19 +1490,19 @@ module Aws::ConfigService
|
|
1479
1490
|
# }
|
1480
1491
|
#
|
1481
1492
|
# @!attribute [rw] name
|
1482
|
-
# The name of the recorder. By default,
|
1483
|
-
#
|
1484
|
-
#
|
1493
|
+
# The name of the recorder. By default, Config automatically assigns
|
1494
|
+
# the name "default" when creating the configuration recorder. You
|
1495
|
+
# cannot change the assigned name.
|
1485
1496
|
# @return [String]
|
1486
1497
|
#
|
1487
1498
|
# @!attribute [rw] role_arn
|
1488
|
-
# Amazon Resource Name (ARN) of the IAM role used to describe the
|
1489
|
-
# resources associated with the account.
|
1499
|
+
# Amazon Resource Name (ARN) of the IAM role used to describe the
|
1500
|
+
# Amazon Web Services resources associated with the account.
|
1490
1501
|
# @return [String]
|
1491
1502
|
#
|
1492
1503
|
# @!attribute [rw] recording_group
|
1493
|
-
# Specifies the types of
|
1494
|
-
# configuration changes.
|
1504
|
+
# Specifies the types of Amazon Web Services resources for which
|
1505
|
+
# Config records configuration changes.
|
1495
1506
|
# @return [Types::RecordingGroup]
|
1496
1507
|
#
|
1497
1508
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ConfigurationRecorder AWS API Documentation
|
@@ -1553,7 +1564,7 @@ module Aws::ConfigService
|
|
1553
1564
|
include Aws::Structure
|
1554
1565
|
end
|
1555
1566
|
|
1556
|
-
# Filters the conformance pack by compliance types and
|
1567
|
+
# Filters the conformance pack by compliance types and Config rule
|
1557
1568
|
# names.
|
1558
1569
|
#
|
1559
1570
|
# @note When making an API call, you may pass ConformancePackComplianceFilters
|
@@ -1565,7 +1576,7 @@ module Aws::ConfigService
|
|
1565
1576
|
# }
|
1566
1577
|
#
|
1567
1578
|
# @!attribute [rw] config_rule_names
|
1568
|
-
# Filters the results by
|
1579
|
+
# Filters the results by Config rule names.
|
1569
1580
|
# @return [Array<String>]
|
1570
1581
|
#
|
1571
1582
|
# @!attribute [rw] compliance_type
|
@@ -1605,8 +1616,8 @@ module Aws::ConfigService
|
|
1605
1616
|
end
|
1606
1617
|
|
1607
1618
|
# Returns details of a conformance pack. A conformance pack is a
|
1608
|
-
# collection of
|
1609
|
-
#
|
1619
|
+
# collection of Config rules and remediation actions that can be easily
|
1620
|
+
# deployed in an account and a region.
|
1610
1621
|
#
|
1611
1622
|
# @!attribute [rw] conformance_pack_name
|
1612
1623
|
# Name of the conformance pack.
|
@@ -1621,7 +1632,8 @@ module Aws::ConfigService
|
|
1621
1632
|
# @return [String]
|
1622
1633
|
#
|
1623
1634
|
# @!attribute [rw] delivery_s3_bucket
|
1624
|
-
# Amazon S3 bucket where
|
1635
|
+
# The name of the Amazon S3 bucket where Config stores conformance
|
1636
|
+
# pack templates.
|
1625
1637
|
#
|
1626
1638
|
# <note markdown="1"> This field is optional.
|
1627
1639
|
#
|
@@ -1645,7 +1657,7 @@ module Aws::ConfigService
|
|
1645
1657
|
# @return [Time]
|
1646
1658
|
#
|
1647
1659
|
# @!attribute [rw] created_by
|
1648
|
-
#
|
1660
|
+
# Amazon Web Services service that created the conformance pack.
|
1649
1661
|
# @return [String]
|
1650
1662
|
#
|
1651
1663
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/ConformancePackDetail AWS API Documentation
|
@@ -1663,8 +1675,8 @@ module Aws::ConfigService
|
|
1663
1675
|
include Aws::Structure
|
1664
1676
|
end
|
1665
1677
|
|
1666
|
-
# Filters a conformance pack by
|
1667
|
-
#
|
1678
|
+
# Filters a conformance pack by Config rule names, compliance types,
|
1679
|
+
# Amazon Web Services resource types, and resource IDs.
|
1668
1680
|
#
|
1669
1681
|
# @note When making an API call, you may pass ConformancePackEvaluationFilters
|
1670
1682
|
# data as a hash:
|
@@ -1677,7 +1689,7 @@ module Aws::ConfigService
|
|
1677
1689
|
# }
|
1678
1690
|
#
|
1679
1691
|
# @!attribute [rw] config_rule_names
|
1680
|
-
# Filters the results by
|
1692
|
+
# Filters the results by Config rule names.
|
1681
1693
|
# @return [Array<String>]
|
1682
1694
|
#
|
1683
1695
|
# @!attribute [rw] compliance_type
|
@@ -1712,9 +1724,10 @@ module Aws::ConfigService
|
|
1712
1724
|
include Aws::Structure
|
1713
1725
|
end
|
1714
1726
|
|
1715
|
-
# The details of a conformance pack evaluation. Provides
|
1716
|
-
#
|
1717
|
-
# conformance pack, related time stamps, and supplementary
|
1727
|
+
# The details of a conformance pack evaluation. Provides Config rule and
|
1728
|
+
# Amazon Web Services resource type that was evaluated, the compliance
|
1729
|
+
# of the conformance pack, related time stamps, and supplementary
|
1730
|
+
# information.
|
1718
1731
|
#
|
1719
1732
|
# @!attribute [rw] compliance_type
|
1720
1733
|
# The compliance type. The allowed values are `COMPLIANT` and
|
@@ -1726,11 +1739,11 @@ module Aws::ConfigService
|
|
1726
1739
|
# @return [Types::EvaluationResultIdentifier]
|
1727
1740
|
#
|
1728
1741
|
# @!attribute [rw] config_rule_invoked_time
|
1729
|
-
# The time when
|
1742
|
+
# The time when Config rule evaluated Amazon Web Services resource.
|
1730
1743
|
# @return [Time]
|
1731
1744
|
#
|
1732
1745
|
# @!attribute [rw] result_recorded_time
|
1733
|
-
# The time when
|
1746
|
+
# The time when Config recorded the evaluation result.
|
1734
1747
|
# @return [Time]
|
1735
1748
|
#
|
1736
1749
|
# @!attribute [rw] annotation
|
@@ -1780,8 +1793,8 @@ module Aws::ConfigService
|
|
1780
1793
|
include Aws::Structure
|
1781
1794
|
end
|
1782
1795
|
|
1783
|
-
# Compliance information of one or more
|
1784
|
-
# conformance pack. You can filter using
|
1796
|
+
# Compliance information of one or more Config rules within a
|
1797
|
+
# conformance pack. You can filter using Config rule names and
|
1785
1798
|
# compliance types.
|
1786
1799
|
#
|
1787
1800
|
# @!attribute [rw] config_rule_name
|
@@ -1789,7 +1802,7 @@ module Aws::ConfigService
|
|
1789
1802
|
# @return [String]
|
1790
1803
|
#
|
1791
1804
|
# @!attribute [rw] compliance_type
|
1792
|
-
# Compliance of the
|
1805
|
+
# Compliance of the Config rule.
|
1793
1806
|
#
|
1794
1807
|
# The allowed values are `COMPLIANT`, `NON_COMPLIANT`, and
|
1795
1808
|
# `INSUFFICIENT_DATA`.
|
@@ -1829,7 +1842,7 @@ module Aws::ConfigService
|
|
1829
1842
|
# @!attribute [rw] conformance_pack_state
|
1830
1843
|
# Indicates deployment status of conformance pack.
|
1831
1844
|
#
|
1832
|
-
#
|
1845
|
+
# Config sets the state of the conformance pack to:
|
1833
1846
|
#
|
1834
1847
|
# * CREATE\_IN\_PROGRESS when a conformance pack creation is in
|
1835
1848
|
# progress for an account.
|
@@ -1848,7 +1861,7 @@ module Aws::ConfigService
|
|
1848
1861
|
# @return [String]
|
1849
1862
|
#
|
1850
1863
|
# @!attribute [rw] stack_arn
|
1851
|
-
# Amazon Resource Name (ARN) of
|
1864
|
+
# Amazon Resource Name (ARN) of CloudFormation stack.
|
1852
1865
|
# @return [String]
|
1853
1866
|
#
|
1854
1867
|
# @!attribute [rw] conformance_pack_status_reason
|
@@ -1917,7 +1930,7 @@ module Aws::ConfigService
|
|
1917
1930
|
# }
|
1918
1931
|
#
|
1919
1932
|
# @!attribute [rw] config_rule_name
|
1920
|
-
# The name of the
|
1933
|
+
# The name of the Config rule that you want to delete.
|
1921
1934
|
# @return [String]
|
1922
1935
|
#
|
1923
1936
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DeleteConfigRuleRequest AWS API Documentation
|
@@ -2019,7 +2032,7 @@ module Aws::ConfigService
|
|
2019
2032
|
# }
|
2020
2033
|
#
|
2021
2034
|
# @!attribute [rw] config_rule_name
|
2022
|
-
# The name of the
|
2035
|
+
# The name of the Config rule for which you want to delete the
|
2023
2036
|
# evaluation results.
|
2024
2037
|
# @return [String]
|
2025
2038
|
#
|
@@ -2032,7 +2045,7 @@ module Aws::ConfigService
|
|
2032
2045
|
end
|
2033
2046
|
|
2034
2047
|
# The output when you delete the evaluation results for the specified
|
2035
|
-
#
|
2048
|
+
# Config rule.
|
2036
2049
|
#
|
2037
2050
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DeleteEvaluationResultsResponse AWS API Documentation
|
2038
2051
|
#
|
@@ -2110,8 +2123,8 @@ module Aws::ConfigService
|
|
2110
2123
|
# }
|
2111
2124
|
#
|
2112
2125
|
# @!attribute [rw] config_rule_name
|
2113
|
-
# The name of the
|
2114
|
-
#
|
2126
|
+
# The name of the Config rule for which you want to delete remediation
|
2127
|
+
# configuration.
|
2115
2128
|
# @return [String]
|
2116
2129
|
#
|
2117
2130
|
# @!attribute [rw] resource_type
|
@@ -2145,14 +2158,14 @@ module Aws::ConfigService
|
|
2145
2158
|
# }
|
2146
2159
|
#
|
2147
2160
|
# @!attribute [rw] config_rule_name
|
2148
|
-
# The name of the
|
2149
|
-
#
|
2161
|
+
# The name of the Config rule for which you want to delete remediation
|
2162
|
+
# exception configuration.
|
2150
2163
|
# @return [String]
|
2151
2164
|
#
|
2152
2165
|
# @!attribute [rw] resource_keys
|
2153
2166
|
# An exception list of resource exception keys to be processed with
|
2154
|
-
# the current request.
|
2155
|
-
#
|
2167
|
+
# the current request. Config adds exception for each resource key.
|
2168
|
+
# For example, Config adds 3 exceptions for 3 resource keys.
|
2156
2169
|
# @return [Array<Types::RemediationExceptionResourceKey>]
|
2157
2170
|
#
|
2158
2171
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DeleteRemediationExceptionsRequest AWS API Documentation
|
@@ -2281,8 +2294,8 @@ module Aws::ConfigService
|
|
2281
2294
|
include Aws::Structure
|
2282
2295
|
end
|
2283
2296
|
|
2284
|
-
# The channel through which
|
2285
|
-
#
|
2297
|
+
# The channel through which Config delivers notifications and updated
|
2298
|
+
# configuration states.
|
2286
2299
|
#
|
2287
2300
|
# @note When making an API call, you may pass DeliveryChannel
|
2288
2301
|
# data as a hash:
|
@@ -2299,7 +2312,7 @@ module Aws::ConfigService
|
|
2299
2312
|
# }
|
2300
2313
|
#
|
2301
2314
|
# @!attribute [rw] name
|
2302
|
-
# The name of the delivery channel. By default,
|
2315
|
+
# The name of the delivery channel. By default, Config assigns the
|
2303
2316
|
# name "default" when creating the delivery channel. To change the
|
2304
2317
|
# delivery channel name, you must use the DeleteDeliveryChannel action
|
2305
2318
|
# to delete your current delivery channel, and then you must use the
|
@@ -2308,13 +2321,13 @@ module Aws::ConfigService
|
|
2308
2321
|
# @return [String]
|
2309
2322
|
#
|
2310
2323
|
# @!attribute [rw] s3_bucket_name
|
2311
|
-
# The name of the Amazon S3 bucket to which
|
2324
|
+
# The name of the Amazon S3 bucket to which Config delivers
|
2312
2325
|
# configuration snapshots and configuration history files.
|
2313
2326
|
#
|
2314
|
-
# If you specify a bucket that belongs to another
|
2315
|
-
# bucket must have policies that grant access
|
2316
|
-
# Config. For more information, see [Permissions for
|
2317
|
-
# Bucket][1] in the
|
2327
|
+
# If you specify a bucket that belongs to another Amazon Web Services
|
2328
|
+
# account, that bucket must have policies that grant access
|
2329
|
+
# permissions to Config. For more information, see [Permissions for
|
2330
|
+
# the Amazon S3 Bucket][1] in the Config Developer Guide.
|
2318
2331
|
#
|
2319
2332
|
#
|
2320
2333
|
#
|
@@ -2326,20 +2339,19 @@ module Aws::ConfigService
|
|
2326
2339
|
# @return [String]
|
2327
2340
|
#
|
2328
2341
|
# @!attribute [rw] s3_kms_key_arn
|
2329
|
-
# The Amazon Resource Name (ARN) of the
|
2330
|
-
#
|
2331
|
-
#
|
2332
|
-
# bucket.
|
2342
|
+
# The Amazon Resource Name (ARN) of the Key Management Service (KMS )
|
2343
|
+
# KMS key (KMS key) used to encrypt objects delivered by Config. Must
|
2344
|
+
# belong to the same Region as the destination S3 bucket.
|
2333
2345
|
# @return [String]
|
2334
2346
|
#
|
2335
2347
|
# @!attribute [rw] sns_topic_arn
|
2336
|
-
# The Amazon Resource Name (ARN) of the Amazon SNS topic to which
|
2348
|
+
# The Amazon Resource Name (ARN) of the Amazon SNS topic to which
|
2337
2349
|
# Config sends notifications about configuration changes.
|
2338
2350
|
#
|
2339
2351
|
# If you choose a topic from another account, the topic must have
|
2340
|
-
# policies that grant access permissions to
|
2352
|
+
# policies that grant access permissions to Config. For more
|
2341
2353
|
# information, see [Permissions for the Amazon SNS Topic][1] in the
|
2342
|
-
#
|
2354
|
+
# Config Developer Guide.
|
2343
2355
|
#
|
2344
2356
|
#
|
2345
2357
|
#
|
@@ -2347,8 +2359,8 @@ module Aws::ConfigService
|
|
2347
2359
|
# @return [String]
|
2348
2360
|
#
|
2349
2361
|
# @!attribute [rw] config_snapshot_delivery_properties
|
2350
|
-
# The options for how often
|
2351
|
-
#
|
2362
|
+
# The options for how often Config delivers configuration snapshots to
|
2363
|
+
# the Amazon S3 bucket.
|
2352
2364
|
# @return [Types::ConfigSnapshotDeliveryProperties]
|
2353
2365
|
#
|
2354
2366
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DeliveryChannel AWS API Documentation
|
@@ -2423,7 +2435,7 @@ module Aws::ConfigService
|
|
2423
2435
|
#
|
2424
2436
|
# @!attribute [rw] limit
|
2425
2437
|
# The maximum number of evaluation results returned on each page. The
|
2426
|
-
# default is maximum. If you specify 0,
|
2438
|
+
# default is maximum. If you specify 0, Config uses the default.
|
2427
2439
|
# @return [Integer]
|
2428
2440
|
#
|
2429
2441
|
# @!attribute [rw] next_token
|
@@ -2486,8 +2498,8 @@ module Aws::ConfigService
|
|
2486
2498
|
#
|
2487
2499
|
# @!attribute [rw] limit
|
2488
2500
|
# The maximum number of conformance packs compliance details returned
|
2489
|
-
# on each page. The default is maximum. If you specify 0,
|
2490
|
-
#
|
2501
|
+
# on each page. The default is maximum. If you specify 0, Config uses
|
2502
|
+
# the default.
|
2491
2503
|
# @return [Integer]
|
2492
2504
|
#
|
2493
2505
|
# @!attribute [rw] next_token
|
@@ -2534,7 +2546,7 @@ module Aws::ConfigService
|
|
2534
2546
|
#
|
2535
2547
|
# @!attribute [rw] limit
|
2536
2548
|
# The maximum number of AggregationAuthorizations returned on each
|
2537
|
-
# page. The default is maximum. If you specify 0,
|
2549
|
+
# page. The default is maximum. If you specify 0, Config uses the
|
2538
2550
|
# default.
|
2539
2551
|
# @return [Integer]
|
2540
2552
|
#
|
@@ -2581,8 +2593,7 @@ module Aws::ConfigService
|
|
2581
2593
|
# }
|
2582
2594
|
#
|
2583
2595
|
# @!attribute [rw] config_rule_names
|
2584
|
-
# Specify one or more
|
2585
|
-
# rule.
|
2596
|
+
# Specify one or more Config rule names to filter the results by rule.
|
2586
2597
|
# @return [Array<String>]
|
2587
2598
|
#
|
2588
2599
|
# @!attribute [rw] compliance_types
|
@@ -2607,8 +2618,7 @@ module Aws::ConfigService
|
|
2607
2618
|
end
|
2608
2619
|
|
2609
2620
|
# @!attribute [rw] compliance_by_config_rules
|
2610
|
-
# Indicates whether each of the specified
|
2611
|
-
# compliant.
|
2621
|
+
# Indicates whether each of the specified Config rules is compliant.
|
2612
2622
|
# @return [Array<Types::ComplianceByConfigRule>]
|
2613
2623
|
#
|
2614
2624
|
# @!attribute [rw] next_token
|
@@ -2637,16 +2647,17 @@ module Aws::ConfigService
|
|
2637
2647
|
# }
|
2638
2648
|
#
|
2639
2649
|
# @!attribute [rw] resource_type
|
2640
|
-
# The types of
|
2641
|
-
# (for example, `AWS::EC2::Instance`). For this
|
2642
|
-
# specify that the resource type is an
|
2643
|
-
# `AWS::::Account`.
|
2650
|
+
# The types of Amazon Web Services resources for which you want
|
2651
|
+
# compliance information (for example, `AWS::EC2::Instance`). For this
|
2652
|
+
# action, you can specify that the resource type is an Amazon Web
|
2653
|
+
# Services account by specifying `AWS::::Account`.
|
2644
2654
|
# @return [String]
|
2645
2655
|
#
|
2646
2656
|
# @!attribute [rw] resource_id
|
2647
|
-
# The ID of the
|
2648
|
-
# information. You can specify only one resource ID. If you
|
2649
|
-
# resource ID, you must also specify a type for
|
2657
|
+
# The ID of the Amazon Web Services resource for which you want
|
2658
|
+
# compliance information. You can specify only one resource ID. If you
|
2659
|
+
# specify a resource ID, you must also specify a type for
|
2660
|
+
# `ResourceType`.
|
2650
2661
|
# @return [String]
|
2651
2662
|
#
|
2652
2663
|
# @!attribute [rw] compliance_types
|
@@ -2659,7 +2670,7 @@ module Aws::ConfigService
|
|
2659
2670
|
# @!attribute [rw] limit
|
2660
2671
|
# The maximum number of evaluation results returned on each page. The
|
2661
2672
|
# default is 10. You cannot specify a number greater than 100. If you
|
2662
|
-
# specify 0,
|
2673
|
+
# specify 0, Config uses the default.
|
2663
2674
|
# @return [Integer]
|
2664
2675
|
#
|
2665
2676
|
# @!attribute [rw] next_token
|
@@ -2680,8 +2691,8 @@ module Aws::ConfigService
|
|
2680
2691
|
end
|
2681
2692
|
|
2682
2693
|
# @!attribute [rw] compliance_by_resources
|
2683
|
-
# Indicates whether the specified
|
2684
|
-
# the
|
2694
|
+
# Indicates whether the specified Amazon Web Services resource
|
2695
|
+
# complies with all of the Config rules that evaluate it.
|
2685
2696
|
# @return [Array<Types::ComplianceByResource>]
|
2686
2697
|
#
|
2687
2698
|
# @!attribute [rw] next_token
|
@@ -2708,9 +2719,9 @@ module Aws::ConfigService
|
|
2708
2719
|
# }
|
2709
2720
|
#
|
2710
2721
|
# @!attribute [rw] config_rule_names
|
2711
|
-
# The name of the
|
2712
|
-
# information. If you do not specify any names,
|
2713
|
-
#
|
2722
|
+
# The name of the Config managed rules for which you want status
|
2723
|
+
# information. If you do not specify any names, Config returns status
|
2724
|
+
# information for all Config managed rules that you use.
|
2714
2725
|
# @return [Array<String>]
|
2715
2726
|
#
|
2716
2727
|
# @!attribute [rw] next_token
|
@@ -2724,8 +2735,8 @@ module Aws::ConfigService
|
|
2724
2735
|
# This parameter is required if the rule limit for your account is
|
2725
2736
|
# more than the default of 150 rules.
|
2726
2737
|
#
|
2727
|
-
# For information about requesting a rule limit increase, see [
|
2728
|
-
#
|
2738
|
+
# For information about requesting a rule limit increase, see [Config
|
2739
|
+
# Limits][1] in the *Amazon Web Services General Reference Guide*.
|
2729
2740
|
#
|
2730
2741
|
#
|
2731
2742
|
#
|
@@ -2743,7 +2754,7 @@ module Aws::ConfigService
|
|
2743
2754
|
end
|
2744
2755
|
|
2745
2756
|
# @!attribute [rw] config_rules_evaluation_status
|
2746
|
-
# Status information about your
|
2757
|
+
# Status information about your Config managed rules.
|
2747
2758
|
# @return [Array<Types::ConfigRuleEvaluationStatus>]
|
2748
2759
|
#
|
2749
2760
|
# @!attribute [rw] next_token
|
@@ -2769,9 +2780,8 @@ module Aws::ConfigService
|
|
2769
2780
|
# }
|
2770
2781
|
#
|
2771
2782
|
# @!attribute [rw] config_rule_names
|
2772
|
-
# The names of the
|
2773
|
-
#
|
2774
|
-
# rules.
|
2783
|
+
# The names of the Config rules for which you want details. If you do
|
2784
|
+
# not specify any names, Config returns details for all your rules.
|
2775
2785
|
# @return [Array<String>]
|
2776
2786
|
#
|
2777
2787
|
# @!attribute [rw] next_token
|
@@ -2789,7 +2799,7 @@ module Aws::ConfigService
|
|
2789
2799
|
end
|
2790
2800
|
|
2791
2801
|
# @!attribute [rw] config_rules
|
2792
|
-
# The details about your
|
2802
|
+
# The details about your Config rules.
|
2793
2803
|
# @return [Array<Types::ConfigRule>]
|
2794
2804
|
#
|
2795
2805
|
# @!attribute [rw] next_token
|
@@ -2837,8 +2847,7 @@ module Aws::ConfigService
|
|
2837
2847
|
#
|
2838
2848
|
# @!attribute [rw] limit
|
2839
2849
|
# The maximum number of AggregatorSourceStatus returned on each page.
|
2840
|
-
# The default is maximum. If you specify 0,
|
2841
|
-
# default.
|
2850
|
+
# The default is maximum. If you specify 0, Config uses the default.
|
2842
2851
|
# @return [Integer]
|
2843
2852
|
#
|
2844
2853
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DescribeConfigurationAggregatorSourcesStatusRequest AWS API Documentation
|
@@ -2890,7 +2899,7 @@ module Aws::ConfigService
|
|
2890
2899
|
#
|
2891
2900
|
# @!attribute [rw] limit
|
2892
2901
|
# The maximum number of configuration aggregators returned on each
|
2893
|
-
# page. The default is maximum. If you specify 0,
|
2902
|
+
# page. The default is maximum. If you specify 0, Config uses the
|
2894
2903
|
# default.
|
2895
2904
|
# @return [Integer]
|
2896
2905
|
#
|
@@ -3018,7 +3027,7 @@ module Aws::ConfigService
|
|
3018
3027
|
# @return [Types::ConformancePackComplianceFilters]
|
3019
3028
|
#
|
3020
3029
|
# @!attribute [rw] limit
|
3021
|
-
# The maximum number of
|
3030
|
+
# The maximum number of Config rules within a conformance pack are
|
3022
3031
|
# returned on each page.
|
3023
3032
|
# @return [Integer]
|
3024
3033
|
#
|
@@ -3123,8 +3132,8 @@ module Aws::ConfigService
|
|
3123
3132
|
#
|
3124
3133
|
# @!attribute [rw] conformance_pack_names
|
3125
3134
|
# Comma-separated list of conformance pack names for which you want
|
3126
|
-
# details. If you do not specify any names,
|
3127
|
-
#
|
3135
|
+
# details. If you do not specify any names, Config returns details for
|
3136
|
+
# all your conformance packs.
|
3128
3137
|
# @return [Array<String>]
|
3129
3138
|
#
|
3130
3139
|
# @!attribute [rw] limit
|
@@ -3246,14 +3255,14 @@ module Aws::ConfigService
|
|
3246
3255
|
#
|
3247
3256
|
# @!attribute [rw] organization_config_rule_names
|
3248
3257
|
# The names of organization config rules for which you want status
|
3249
|
-
# details. If you do not specify any names,
|
3250
|
-
#
|
3258
|
+
# details. If you do not specify any names, Config returns details for
|
3259
|
+
# all your organization Config rules.
|
3251
3260
|
# @return [Array<String>]
|
3252
3261
|
#
|
3253
3262
|
# @!attribute [rw] limit
|
3254
3263
|
# The maximum number of `OrganizationConfigRuleStatuses` returned on
|
3255
|
-
# each page. If you do no specify a number,
|
3256
|
-
#
|
3264
|
+
# each page. If you do no specify a number, Config uses the default.
|
3265
|
+
# The default is 100.
|
3257
3266
|
# @return [Integer]
|
3258
3267
|
#
|
3259
3268
|
# @!attribute [rw] next_token
|
@@ -3300,14 +3309,14 @@ module Aws::ConfigService
|
|
3300
3309
|
#
|
3301
3310
|
# @!attribute [rw] organization_config_rule_names
|
3302
3311
|
# The names of organization config rules for which you want details.
|
3303
|
-
# If you do not specify any names,
|
3304
|
-
#
|
3312
|
+
# If you do not specify any names, Config returns details for all your
|
3313
|
+
# organization config rules.
|
3305
3314
|
# @return [Array<String>]
|
3306
3315
|
#
|
3307
3316
|
# @!attribute [rw] limit
|
3308
3317
|
# The maximum number of organization config rules returned on each
|
3309
|
-
# page. If you do no specify a number,
|
3310
|
-
#
|
3318
|
+
# page. If you do no specify a number, Config uses the default. The
|
3319
|
+
# default is 100.
|
3311
3320
|
# @return [Integer]
|
3312
3321
|
#
|
3313
3322
|
# @!attribute [rw] next_token
|
@@ -3354,13 +3363,13 @@ module Aws::ConfigService
|
|
3354
3363
|
#
|
3355
3364
|
# @!attribute [rw] organization_conformance_pack_names
|
3356
3365
|
# The names of organization conformance packs for which you want
|
3357
|
-
# status details. If you do not specify any names,
|
3366
|
+
# status details. If you do not specify any names, Config returns
|
3358
3367
|
# details for all your organization conformance packs.
|
3359
3368
|
# @return [Array<String>]
|
3360
3369
|
#
|
3361
3370
|
# @!attribute [rw] limit
|
3362
3371
|
# The maximum number of OrganizationConformancePackStatuses returned
|
3363
|
-
# on each page. If you do no specify a number,
|
3372
|
+
# on each page. If you do no specify a number, Config uses the
|
3364
3373
|
# default. The default is 100.
|
3365
3374
|
# @return [Integer]
|
3366
3375
|
#
|
@@ -3412,8 +3421,8 @@ module Aws::ConfigService
|
|
3412
3421
|
#
|
3413
3422
|
# @!attribute [rw] limit
|
3414
3423
|
# The maximum number of organization config packs returned on each
|
3415
|
-
# page. If you do no specify a number,
|
3416
|
-
#
|
3424
|
+
# page. If you do no specify a number, Config uses the default. The
|
3425
|
+
# default is 100.
|
3417
3426
|
# @return [Integer]
|
3418
3427
|
#
|
3419
3428
|
# @!attribute [rw] next_token
|
@@ -3459,7 +3468,7 @@ module Aws::ConfigService
|
|
3459
3468
|
#
|
3460
3469
|
# @!attribute [rw] limit
|
3461
3470
|
# The maximum number of evaluation results returned on each page. The
|
3462
|
-
# default is maximum. If you specify 0,
|
3471
|
+
# default is maximum. If you specify 0, Config uses the default.
|
3463
3472
|
# @return [Integer]
|
3464
3473
|
#
|
3465
3474
|
# @!attribute [rw] next_token
|
@@ -3502,8 +3511,8 @@ module Aws::ConfigService
|
|
3502
3511
|
# }
|
3503
3512
|
#
|
3504
3513
|
# @!attribute [rw] config_rule_names
|
3505
|
-
# A list of
|
3506
|
-
#
|
3514
|
+
# A list of Config rule names of remediation configurations for which
|
3515
|
+
# you want details.
|
3507
3516
|
# @return [Array<String>]
|
3508
3517
|
#
|
3509
3518
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/DescribeRemediationConfigurationsRequest AWS API Documentation
|
@@ -3542,18 +3551,18 @@ module Aws::ConfigService
|
|
3542
3551
|
# }
|
3543
3552
|
#
|
3544
3553
|
# @!attribute [rw] config_rule_name
|
3545
|
-
# The name of the
|
3554
|
+
# The name of the Config rule.
|
3546
3555
|
# @return [String]
|
3547
3556
|
#
|
3548
3557
|
# @!attribute [rw] resource_keys
|
3549
3558
|
# An exception list of resource exception keys to be processed with
|
3550
|
-
# the current request.
|
3551
|
-
#
|
3559
|
+
# the current request. Config adds exception for each resource key.
|
3560
|
+
# For example, Config adds 3 exceptions for 3 resource keys.
|
3552
3561
|
# @return [Array<Types::RemediationExceptionResourceKey>]
|
3553
3562
|
#
|
3554
3563
|
# @!attribute [rw] limit
|
3555
3564
|
# The maximum number of RemediationExceptionResourceKey returned on
|
3556
|
-
# each page. The default is 25. If you specify 0,
|
3565
|
+
# each page. The default is 25. If you specify 0, Config uses the
|
3557
3566
|
# default.
|
3558
3567
|
# @return [Integer]
|
3559
3568
|
#
|
@@ -3607,7 +3616,7 @@ module Aws::ConfigService
|
|
3607
3616
|
# }
|
3608
3617
|
#
|
3609
3618
|
# @!attribute [rw] config_rule_name
|
3610
|
-
# A list of
|
3619
|
+
# A list of Config rule names.
|
3611
3620
|
# @return [String]
|
3612
3621
|
#
|
3613
3622
|
# @!attribute [rw] resource_keys
|
@@ -3618,7 +3627,7 @@ module Aws::ConfigService
|
|
3618
3627
|
#
|
3619
3628
|
# @!attribute [rw] limit
|
3620
3629
|
# The maximum number of RemediationExecutionStatuses returned on each
|
3621
|
-
# page. The default is maximum. If you specify 0,
|
3630
|
+
# page. The default is maximum. If you specify 0, Config uses the
|
3622
3631
|
# default.
|
3623
3632
|
# @return [Integer]
|
3624
3633
|
#
|
@@ -3666,10 +3675,10 @@ module Aws::ConfigService
|
|
3666
3675
|
#
|
3667
3676
|
# @!attribute [rw] retention_configuration_names
|
3668
3677
|
# A list of names of retention configurations for which you want
|
3669
|
-
# details. If you do not specify a name,
|
3670
|
-
#
|
3678
|
+
# details. If you do not specify a name, Config returns details for
|
3679
|
+
# all the retention configurations for that account.
|
3671
3680
|
#
|
3672
|
-
# <note markdown="1"> Currently,
|
3681
|
+
# <note markdown="1"> Currently, Config supports only one retention configuration per
|
3673
3682
|
# region in your account.
|
3674
3683
|
#
|
3675
3684
|
# </note>
|
@@ -3707,8 +3716,8 @@ module Aws::ConfigService
|
|
3707
3716
|
include Aws::Structure
|
3708
3717
|
end
|
3709
3718
|
|
3710
|
-
# Identifies an
|
3711
|
-
#
|
3719
|
+
# Identifies an Amazon Web Services resource and indicates whether it
|
3720
|
+
# complies with the Config rule that it was evaluated against.
|
3712
3721
|
#
|
3713
3722
|
# @note When making an API call, you may pass Evaluation
|
3714
3723
|
# data as a hash:
|
@@ -3722,26 +3731,25 @@ module Aws::ConfigService
|
|
3722
3731
|
# }
|
3723
3732
|
#
|
3724
3733
|
# @!attribute [rw] compliance_resource_type
|
3725
|
-
# The type of
|
3734
|
+
# The type of Amazon Web Services resource that was evaluated.
|
3726
3735
|
# @return [String]
|
3727
3736
|
#
|
3728
3737
|
# @!attribute [rw] compliance_resource_id
|
3729
|
-
# The ID of the
|
3738
|
+
# The ID of the Amazon Web Services resource that was evaluated.
|
3730
3739
|
# @return [String]
|
3731
3740
|
#
|
3732
3741
|
# @!attribute [rw] compliance_type
|
3733
|
-
# Indicates whether the
|
3734
|
-
# that it was evaluated against.
|
3742
|
+
# Indicates whether the Amazon Web Services resource complies with the
|
3743
|
+
# Config rule that it was evaluated against.
|
3735
3744
|
#
|
3736
|
-
# For the `Evaluation` data type,
|
3737
|
-
# `COMPLIANT`, `NON_COMPLIANT`, and `NOT_APPLICABLE` values.
|
3738
|
-
#
|
3739
|
-
# type.
|
3745
|
+
# For the `Evaluation` data type, Config supports only the
|
3746
|
+
# `COMPLIANT`, `NON_COMPLIANT`, and `NOT_APPLICABLE` values. Config
|
3747
|
+
# does not support the `INSUFFICIENT_DATA` value for this data type.
|
3740
3748
|
#
|
3741
|
-
# Similarly,
|
3742
|
-
#
|
3743
|
-
#
|
3744
|
-
#
|
3749
|
+
# Similarly, Config does not accept `INSUFFICIENT_DATA` as the value
|
3750
|
+
# for `ComplianceType` from a `PutEvaluations` request. For example,
|
3751
|
+
# an Lambda function for a custom Config rule cannot pass an
|
3752
|
+
# `INSUFFICIENT_DATA` value to Config.
|
3745
3753
|
# @return [String]
|
3746
3754
|
#
|
3747
3755
|
# @!attribute [rw] annotation
|
@@ -3750,12 +3758,11 @@ module Aws::ConfigService
|
|
3750
3758
|
# @return [String]
|
3751
3759
|
#
|
3752
3760
|
# @!attribute [rw] ordering_timestamp
|
3753
|
-
# The time of the event in
|
3754
|
-
#
|
3755
|
-
#
|
3756
|
-
#
|
3757
|
-
#
|
3758
|
-
# every 24 hours).
|
3761
|
+
# The time of the event in Config that triggered the evaluation. For
|
3762
|
+
# event-based evaluations, the time indicates when Config created the
|
3763
|
+
# configuration item that triggered the evaluation. For periodic
|
3764
|
+
# evaluations, the time indicates when Config triggered the evaluation
|
3765
|
+
# at the frequency that you specified (for example, every 24 hours).
|
3759
3766
|
# @return [Time]
|
3760
3767
|
#
|
3761
3768
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/Evaluation AWS API Documentation
|
@@ -3770,30 +3777,31 @@ module Aws::ConfigService
|
|
3770
3777
|
include Aws::Structure
|
3771
3778
|
end
|
3772
3779
|
|
3773
|
-
# The details of an
|
3774
|
-
# that was evaluated, the compliance of the resource, related
|
3775
|
-
# stamps, and supplementary information.
|
3780
|
+
# The details of an Config evaluation. Provides the Amazon Web Services
|
3781
|
+
# resource that was evaluated, the compliance of the resource, related
|
3782
|
+
# time stamps, and supplementary information.
|
3776
3783
|
#
|
3777
3784
|
# @!attribute [rw] evaluation_result_identifier
|
3778
3785
|
# Uniquely identifies the evaluation result.
|
3779
3786
|
# @return [Types::EvaluationResultIdentifier]
|
3780
3787
|
#
|
3781
3788
|
# @!attribute [rw] compliance_type
|
3782
|
-
# Indicates whether the
|
3783
|
-
# that evaluated it.
|
3789
|
+
# Indicates whether the Amazon Web Services resource complies with the
|
3790
|
+
# Config rule that evaluated it.
|
3784
3791
|
#
|
3785
|
-
# For the `EvaluationResult` data type,
|
3786
|
-
# `COMPLIANT`, `NON_COMPLIANT`, and `NOT_APPLICABLE` values.
|
3787
|
-
#
|
3792
|
+
# For the `EvaluationResult` data type, Config supports only the
|
3793
|
+
# `COMPLIANT`, `NON_COMPLIANT`, and `NOT_APPLICABLE` values. Config
|
3794
|
+
# does not support the `INSUFFICIENT_DATA` value for the
|
3788
3795
|
# `EvaluationResult` data type.
|
3789
3796
|
# @return [String]
|
3790
3797
|
#
|
3791
3798
|
# @!attribute [rw] result_recorded_time
|
3792
|
-
# The time when
|
3799
|
+
# The time when Config recorded the evaluation result.
|
3793
3800
|
# @return [Time]
|
3794
3801
|
#
|
3795
3802
|
# @!attribute [rw] config_rule_invoked_time
|
3796
|
-
# The time when the
|
3803
|
+
# The time when the Config rule evaluated the Amazon Web Services
|
3804
|
+
# resource.
|
3797
3805
|
# @return [Time]
|
3798
3806
|
#
|
3799
3807
|
# @!attribute [rw] annotation
|
@@ -3802,9 +3810,10 @@ module Aws::ConfigService
|
|
3802
3810
|
# @return [String]
|
3803
3811
|
#
|
3804
3812
|
# @!attribute [rw] result_token
|
3805
|
-
# An encrypted token that associates an evaluation with an
|
3806
|
-
# rule. The token identifies the rule, the
|
3807
|
-
# evaluated, and the event that triggered the
|
3813
|
+
# An encrypted token that associates an evaluation with an Config
|
3814
|
+
# rule. The token identifies the rule, the Amazon Web Services
|
3815
|
+
# resource being evaluated, and the event that triggered the
|
3816
|
+
# evaluation.
|
3808
3817
|
# @return [String]
|
3809
3818
|
#
|
3810
3819
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/EvaluationResult AWS API Documentation
|
@@ -3823,14 +3832,14 @@ module Aws::ConfigService
|
|
3823
3832
|
# Uniquely identifies an evaluation result.
|
3824
3833
|
#
|
3825
3834
|
# @!attribute [rw] evaluation_result_qualifier
|
3826
|
-
# Identifies an
|
3827
|
-
# provides the type and ID of the evaluated resource.
|
3835
|
+
# Identifies an Config rule used to evaluate an Amazon Web Services
|
3836
|
+
# resource, and provides the type and ID of the evaluated resource.
|
3828
3837
|
# @return [Types::EvaluationResultQualifier]
|
3829
3838
|
#
|
3830
3839
|
# @!attribute [rw] ordering_timestamp
|
3831
|
-
# The time of the event that triggered the evaluation of your
|
3832
|
-
# resources. The time can indicate when
|
3833
|
-
# configuration item change notification, or it can indicate when
|
3840
|
+
# The time of the event that triggered the evaluation of your Amazon
|
3841
|
+
# Web Services resources. The time can indicate when Config delivered
|
3842
|
+
# a configuration item change notification, or it can indicate when
|
3834
3843
|
# Config delivered the configuration snapshot, depending on which
|
3835
3844
|
# event triggered the evaluation.
|
3836
3845
|
# @return [Time]
|
@@ -3844,19 +3853,20 @@ module Aws::ConfigService
|
|
3844
3853
|
include Aws::Structure
|
3845
3854
|
end
|
3846
3855
|
|
3847
|
-
# Identifies an
|
3848
|
-
# provides the type and ID of the resource that the rule
|
3856
|
+
# Identifies an Config rule that evaluated an Amazon Web Services
|
3857
|
+
# resource, and provides the type and ID of the resource that the rule
|
3858
|
+
# evaluated.
|
3849
3859
|
#
|
3850
3860
|
# @!attribute [rw] config_rule_name
|
3851
|
-
# The name of the
|
3861
|
+
# The name of the Config rule that was used in the evaluation.
|
3852
3862
|
# @return [String]
|
3853
3863
|
#
|
3854
3864
|
# @!attribute [rw] resource_type
|
3855
|
-
# The type of
|
3865
|
+
# The type of Amazon Web Services resource that was evaluated.
|
3856
3866
|
# @return [String]
|
3857
3867
|
#
|
3858
3868
|
# @!attribute [rw] resource_id
|
3859
|
-
# The ID of the evaluated
|
3869
|
+
# The ID of the evaluated Amazon Web Services resource.
|
3860
3870
|
# @return [String]
|
3861
3871
|
#
|
3862
3872
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/EvaluationResultQualifier AWS API Documentation
|
@@ -3869,7 +3879,7 @@ module Aws::ConfigService
|
|
3869
3879
|
include Aws::Structure
|
3870
3880
|
end
|
3871
3881
|
|
3872
|
-
# The controls that
|
3882
|
+
# The controls that Config uses for executing remediations.
|
3873
3883
|
#
|
3874
3884
|
# @note When making an API call, you may pass ExecutionControls
|
3875
3885
|
# data as a hash:
|
@@ -3893,8 +3903,8 @@ module Aws::ConfigService
|
|
3893
3903
|
include Aws::Structure
|
3894
3904
|
end
|
3895
3905
|
|
3896
|
-
# Identifies an
|
3897
|
-
#
|
3906
|
+
# Identifies an Amazon Web Services resource and indicates whether it
|
3907
|
+
# complies with the Config rule that it was evaluated against.
|
3898
3908
|
#
|
3899
3909
|
# @note When making an API call, you may pass ExternalEvaluation
|
3900
3910
|
# data as a hash:
|
@@ -3908,18 +3918,18 @@ module Aws::ConfigService
|
|
3908
3918
|
# }
|
3909
3919
|
#
|
3910
3920
|
# @!attribute [rw] compliance_resource_type
|
3911
|
-
# The evaluated compliance resource type.
|
3921
|
+
# The evaluated compliance resource type. Config accepts
|
3912
3922
|
# `AWS::::Account` resource type.
|
3913
3923
|
# @return [String]
|
3914
3924
|
#
|
3915
3925
|
# @!attribute [rw] compliance_resource_id
|
3916
|
-
# The evaluated compliance resource ID.
|
3917
|
-
# account ID.
|
3926
|
+
# The evaluated compliance resource ID. Config accepts only Amazon Web
|
3927
|
+
# Services account ID.
|
3918
3928
|
# @return [String]
|
3919
3929
|
#
|
3920
3930
|
# @!attribute [rw] compliance_type
|
3921
|
-
# The compliance of the
|
3922
|
-
# NON_COMPLIANT, ` and `NOT_APPLICABLE`.
|
3931
|
+
# The compliance of the Amazon Web Services resource. The valid values
|
3932
|
+
# are `COMPLIANT, NON_COMPLIANT, ` and `NOT_APPLICABLE`.
|
3923
3933
|
# @return [String]
|
3924
3934
|
#
|
3925
3935
|
# @!attribute [rw] annotation
|
@@ -3948,7 +3958,7 @@ module Aws::ConfigService
|
|
3948
3958
|
#
|
3949
3959
|
# @!attribute [rw] failure_message
|
3950
3960
|
# Returns a failure message for delete remediation exception. For
|
3951
|
-
# example,
|
3961
|
+
# example, Config creates an exception due to an internal error.
|
3952
3962
|
# @return [String]
|
3953
3963
|
#
|
3954
3964
|
# @!attribute [rw] failed_items
|
@@ -4039,7 +4049,7 @@ module Aws::ConfigService
|
|
4039
4049
|
# @return [String]
|
4040
4050
|
#
|
4041
4051
|
# @!attribute [rw] config_rule_name
|
4042
|
-
# The name of the
|
4052
|
+
# The name of the Config rule for which you want compliance
|
4043
4053
|
# information.
|
4044
4054
|
# @return [String]
|
4045
4055
|
#
|
@@ -4055,9 +4065,9 @@ module Aws::ConfigService
|
|
4055
4065
|
# The resource compliance status.
|
4056
4066
|
#
|
4057
4067
|
# <note markdown="1"> For the `GetAggregateComplianceDetailsByConfigRuleRequest` data
|
4058
|
-
# type,
|
4059
|
-
#
|
4060
|
-
#
|
4068
|
+
# type, Config supports only the `COMPLIANT` and `NON_COMPLIANT`.
|
4069
|
+
# Config does not support the `NOT_APPLICABLE` and `INSUFFICIENT_DATA`
|
4070
|
+
# values.
|
4061
4071
|
#
|
4062
4072
|
# </note>
|
4063
4073
|
# @return [String]
|
@@ -4065,7 +4075,7 @@ module Aws::ConfigService
|
|
4065
4075
|
# @!attribute [rw] limit
|
4066
4076
|
# The maximum number of evaluation results returned on each page. The
|
4067
4077
|
# default is 50. You cannot specify a number greater than 100. If you
|
4068
|
-
# specify 0,
|
4078
|
+
# specify 0, Config uses the default.
|
4069
4079
|
# @return [Integer]
|
4070
4080
|
#
|
4071
4081
|
# @!attribute [rw] next_token
|
@@ -4135,7 +4145,7 @@ module Aws::ConfigService
|
|
4135
4145
|
# @!attribute [rw] limit
|
4136
4146
|
# The maximum number of evaluation results returned on each page. The
|
4137
4147
|
# default is 1000. You cannot specify a number greater than 1000. If
|
4138
|
-
# you specify 0,
|
4148
|
+
# you specify 0, Config uses the default.
|
4139
4149
|
# @return [Integer]
|
4140
4150
|
#
|
4141
4151
|
# @!attribute [rw] next_token
|
@@ -4202,12 +4212,13 @@ module Aws::ConfigService
|
|
4202
4212
|
# @return [Types::AggregateConformancePackComplianceSummaryFilters]
|
4203
4213
|
#
|
4204
4214
|
# @!attribute [rw] group_by_key
|
4205
|
-
# Groups the result based on
|
4215
|
+
# Groups the result based on Amazon Web Services account ID or Amazon
|
4216
|
+
# Web Services Region.
|
4206
4217
|
# @return [String]
|
4207
4218
|
#
|
4208
4219
|
# @!attribute [rw] limit
|
4209
4220
|
# The maximum number of results returned on each page. The default is
|
4210
|
-
# maximum. If you specify 0,
|
4221
|
+
# maximum. If you specify 0, Config uses the default.
|
4211
4222
|
# @return [Integer]
|
4212
4223
|
#
|
4213
4224
|
# @!attribute [rw] next_token
|
@@ -4233,7 +4244,8 @@ module Aws::ConfigService
|
|
4233
4244
|
# @return [Array<Types::AggregateConformancePackComplianceSummary>]
|
4234
4245
|
#
|
4235
4246
|
# @!attribute [rw] group_by_key
|
4236
|
-
# Groups the result based on
|
4247
|
+
# Groups the result based on Amazon Web Services account ID or Amazon
|
4248
|
+
# Web Services Region.
|
4237
4249
|
# @return [String]
|
4238
4250
|
#
|
4239
4251
|
# @!attribute [rw] next_token
|
@@ -4281,7 +4293,7 @@ module Aws::ConfigService
|
|
4281
4293
|
# @!attribute [rw] limit
|
4282
4294
|
# The maximum number of GroupedResourceCount objects returned on each
|
4283
4295
|
# page. The default is 1000. You cannot specify a number greater than
|
4284
|
-
# 1000. If you specify 0,
|
4296
|
+
# 1000. If you specify 0, Config uses the default.
|
4285
4297
|
# @return [Integer]
|
4286
4298
|
#
|
4287
4299
|
# @!attribute [rw] next_token
|
@@ -4385,7 +4397,7 @@ module Aws::ConfigService
|
|
4385
4397
|
# }
|
4386
4398
|
#
|
4387
4399
|
# @!attribute [rw] config_rule_name
|
4388
|
-
# The name of the
|
4400
|
+
# The name of the Config rule for which you want compliance
|
4389
4401
|
# information.
|
4390
4402
|
# @return [String]
|
4391
4403
|
#
|
@@ -4399,7 +4411,7 @@ module Aws::ConfigService
|
|
4399
4411
|
# @!attribute [rw] limit
|
4400
4412
|
# The maximum number of evaluation results returned on each page. The
|
4401
4413
|
# default is 10. You cannot specify a number greater than 100. If you
|
4402
|
-
# specify 0,
|
4414
|
+
# specify 0, Config uses the default.
|
4403
4415
|
# @return [Integer]
|
4404
4416
|
#
|
4405
4417
|
# @!attribute [rw] next_token
|
@@ -4419,8 +4431,8 @@ module Aws::ConfigService
|
|
4419
4431
|
end
|
4420
4432
|
|
4421
4433
|
# @!attribute [rw] evaluation_results
|
4422
|
-
# Indicates whether the
|
4423
|
-
# Config rule.
|
4434
|
+
# Indicates whether the Amazon Web Services resource complies with the
|
4435
|
+
# specified Config rule.
|
4424
4436
|
# @return [Array<Types::EvaluationResult>]
|
4425
4437
|
#
|
4426
4438
|
# @!attribute [rw] next_token
|
@@ -4448,13 +4460,13 @@ module Aws::ConfigService
|
|
4448
4460
|
# }
|
4449
4461
|
#
|
4450
4462
|
# @!attribute [rw] resource_type
|
4451
|
-
# The type of the
|
4452
|
-
# information.
|
4463
|
+
# The type of the Amazon Web Services resource for which you want
|
4464
|
+
# compliance information.
|
4453
4465
|
# @return [String]
|
4454
4466
|
#
|
4455
4467
|
# @!attribute [rw] resource_id
|
4456
|
-
# The ID of the
|
4457
|
-
# information.
|
4468
|
+
# The ID of the Amazon Web Services resource for which you want
|
4469
|
+
# compliance information.
|
4458
4470
|
# @return [String]
|
4459
4471
|
#
|
4460
4472
|
# @!attribute [rw] compliance_types
|
@@ -4481,8 +4493,8 @@ module Aws::ConfigService
|
|
4481
4493
|
end
|
4482
4494
|
|
4483
4495
|
# @!attribute [rw] evaluation_results
|
4484
|
-
# Indicates whether the specified
|
4485
|
-
# Config rule.
|
4496
|
+
# Indicates whether the specified Amazon Web Services resource
|
4497
|
+
# complies each Config rule.
|
4486
4498
|
# @return [Array<Types::EvaluationResult>]
|
4487
4499
|
#
|
4488
4500
|
# @!attribute [rw] next_token
|
@@ -4500,8 +4512,8 @@ module Aws::ConfigService
|
|
4500
4512
|
end
|
4501
4513
|
|
4502
4514
|
# @!attribute [rw] compliance_summary
|
4503
|
-
# The number of
|
4504
|
-
#
|
4515
|
+
# The number of Config rules that are compliant and the number that
|
4516
|
+
# are noncompliant, up to a maximum of 25 for each.
|
4505
4517
|
# @return [Types::ComplianceSummary]
|
4506
4518
|
#
|
4507
4519
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/GetComplianceSummaryByConfigRuleResponse AWS API Documentation
|
@@ -4524,9 +4536,10 @@ module Aws::ConfigService
|
|
4524
4536
|
# that are compliant and the number that are noncompliant for each
|
4525
4537
|
# resource type.
|
4526
4538
|
#
|
4527
|
-
# For this request, you can specify an
|
4528
|
-
# `AWS::EC2::Instance`. You can specify that the resource
|
4529
|
-
#
|
4539
|
+
# For this request, you can specify an Amazon Web Services resource
|
4540
|
+
# type such as `AWS::EC2::Instance`. You can specify that the resource
|
4541
|
+
# type is an Amazon Web Services account by specifying
|
4542
|
+
# `AWS::::Account`.
|
4530
4543
|
# @return [Array<String>]
|
4531
4544
|
#
|
4532
4545
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/GetComplianceSummaryByResourceTypeRequest AWS API Documentation
|
@@ -4577,8 +4590,8 @@ module Aws::ConfigService
|
|
4577
4590
|
#
|
4578
4591
|
# @!attribute [rw] limit
|
4579
4592
|
# The maximum number of evaluation results returned on each page. If
|
4580
|
-
# you do no specify a number,
|
4581
|
-
#
|
4593
|
+
# you do no specify a number, Config uses the default. The default is
|
4594
|
+
# 100.
|
4582
4595
|
# @return [Integer]
|
4583
4596
|
#
|
4584
4597
|
# @!attribute [rw] next_token
|
@@ -4681,18 +4694,17 @@ module Aws::ConfigService
|
|
4681
4694
|
#
|
4682
4695
|
# @!attribute [rw] resource_types
|
4683
4696
|
# The comma-separated list that specifies the resource types that you
|
4684
|
-
# want
|
4697
|
+
# want Config to return (for example, `"AWS::EC2::Instance"`,
|
4685
4698
|
# `"AWS::IAM::User"`).
|
4686
4699
|
#
|
4687
|
-
# If a value for `resourceTypes` is not specified,
|
4688
|
-
#
|
4689
|
-
#
|
4700
|
+
# If a value for `resourceTypes` is not specified, Config returns all
|
4701
|
+
# resource types that Config is recording in the region for your
|
4702
|
+
# account.
|
4690
4703
|
#
|
4691
|
-
# <note markdown="1"> If the configuration recorder is turned off,
|
4692
|
-
#
|
4693
|
-
#
|
4694
|
-
#
|
4695
|
-
# objects.
|
4704
|
+
# <note markdown="1"> If the configuration recorder is turned off, Config returns an empty
|
4705
|
+
# list of ResourceCount objects. If the configuration recorder is not
|
4706
|
+
# recording a specific resource type (for example, S3 buckets), that
|
4707
|
+
# resource type is not returned in the list of ResourceCount objects.
|
4696
4708
|
#
|
4697
4709
|
# </note>
|
4698
4710
|
# @return [Array<String>]
|
@@ -4700,7 +4712,7 @@ module Aws::ConfigService
|
|
4700
4712
|
# @!attribute [rw] limit
|
4701
4713
|
# The maximum number of ResourceCount objects returned on each page.
|
4702
4714
|
# The default is 100. You cannot specify a number greater than 100. If
|
4703
|
-
# you specify 0,
|
4715
|
+
# you specify 0, Config uses the default.
|
4704
4716
|
# @return [Integer]
|
4705
4717
|
#
|
4706
4718
|
# @!attribute [rw] next_token
|
@@ -4719,22 +4731,22 @@ module Aws::ConfigService
|
|
4719
4731
|
end
|
4720
4732
|
|
4721
4733
|
# @!attribute [rw] total_discovered_resources
|
4722
|
-
# The total number of resources that
|
4723
|
-
#
|
4724
|
-
#
|
4725
|
-
#
|
4734
|
+
# The total number of resources that Config is recording in the region
|
4735
|
+
# for your account. If you specify resource types in the request,
|
4736
|
+
# Config returns only the total number of resources for those resource
|
4737
|
+
# types.
|
4726
4738
|
#
|
4727
4739
|
# **Example**
|
4728
4740
|
#
|
4729
|
-
# 1.
|
4730
|
-
#
|
4731
|
-
#
|
4741
|
+
# 1. Config is recording three resource types in the US East (Ohio)
|
4742
|
+
# Region for your account: 25 EC2 instances, 20 IAM users, and 15
|
4743
|
+
# S3 buckets, for a total of 60 resources.
|
4732
4744
|
#
|
4733
4745
|
# 2. You make a call to the `GetDiscoveredResourceCounts` action and
|
4734
4746
|
# specify the resource type, `"AWS::EC2::Instances"`, in the
|
4735
4747
|
# request.
|
4736
4748
|
#
|
4737
|
-
# 3.
|
4749
|
+
# 3. Config returns 25 for `totalDiscoveredResources`.
|
4738
4750
|
# @return [Integer]
|
4739
4751
|
#
|
4740
4752
|
# @!attribute [rw] resource_counts
|
@@ -4781,8 +4793,8 @@ module Aws::ConfigService
|
|
4781
4793
|
#
|
4782
4794
|
# @!attribute [rw] limit
|
4783
4795
|
# The maximum number of `OrganizationConfigRuleDetailedStatus`
|
4784
|
-
# returned on each page. If you do not specify a number,
|
4785
|
-
#
|
4796
|
+
# returned on each page. If you do not specify a number, Config uses
|
4797
|
+
# the default. The default is 100.
|
4786
4798
|
# @return [Integer]
|
4787
4799
|
#
|
4788
4800
|
# @!attribute [rw] next_token
|
@@ -4843,8 +4855,8 @@ module Aws::ConfigService
|
|
4843
4855
|
#
|
4844
4856
|
# @!attribute [rw] limit
|
4845
4857
|
# The maximum number of `OrganizationConformancePackDetailedStatuses`
|
4846
|
-
# returned on each page. If you do not specify a number,
|
4847
|
-
#
|
4858
|
+
# returned on each page. If you do not specify a number, Config uses
|
4859
|
+
# the default. The default is 100.
|
4848
4860
|
# @return [Integer]
|
4849
4861
|
#
|
4850
4862
|
# @!attribute [rw] next_token
|
@@ -4923,7 +4935,7 @@ module Aws::ConfigService
|
|
4923
4935
|
# @!attribute [rw] limit
|
4924
4936
|
# The maximum number of configuration items returned on each page. The
|
4925
4937
|
# default is 10. You cannot specify a number greater than 100. If you
|
4926
|
-
# specify 0,
|
4938
|
+
# specify 0, Config uses the default.
|
4927
4939
|
# @return [Integer]
|
4928
4940
|
#
|
4929
4941
|
# @!attribute [rw] next_token
|
@@ -5018,8 +5030,7 @@ module Aws::ConfigService
|
|
5018
5030
|
include Aws::Structure
|
5019
5031
|
end
|
5020
5032
|
|
5021
|
-
# Your Amazon S3 bucket policy does not permit
|
5022
|
-
# it.
|
5033
|
+
# Your Amazon S3 bucket policy does not permit Config to write to it.
|
5023
5034
|
#
|
5024
5035
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/InsufficientDeliveryPolicyException AWS API Documentation
|
5025
5036
|
#
|
@@ -5028,11 +5039,11 @@ module Aws::ConfigService
|
|
5028
5039
|
# Indicates one of the following errors:
|
5029
5040
|
#
|
5030
5041
|
# * For PutConfigRule, the rule cannot be created because the IAM role
|
5031
|
-
# assigned to
|
5042
|
+
# assigned to Config lacks permissions to perform the config:Put*
|
5032
5043
|
# action.
|
5033
5044
|
#
|
5034
|
-
# * For PutConfigRule, the
|
5035
|
-
#
|
5045
|
+
# * For PutConfigRule, the Lambda function cannot be invoked. Check the
|
5046
|
+
# function ARN, and check the function's permissions.
|
5036
5047
|
#
|
5037
5048
|
# * For PutOrganizationConfigRule, organization config rule cannot be
|
5038
5049
|
# created because you do not have permissions to call IAM `GetRole`
|
@@ -5089,9 +5100,9 @@ module Aws::ConfigService
|
|
5089
5100
|
#
|
5090
5101
|
class InvalidParameterValueException < Aws::EmptyStructure; end
|
5091
5102
|
|
5092
|
-
#
|
5093
|
-
#
|
5094
|
-
#
|
5103
|
+
# Config throws an exception if the recording group does not contain a
|
5104
|
+
# valid list of resource types. Invalid values might also be incorrectly
|
5105
|
+
# formatted.
|
5095
5106
|
#
|
5096
5107
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/InvalidRecordingGroupException AWS API Documentation
|
5097
5108
|
#
|
@@ -5173,8 +5184,7 @@ module Aws::ConfigService
|
|
5173
5184
|
# @return [String]
|
5174
5185
|
#
|
5175
5186
|
# @!attribute [rw] resource_type
|
5176
|
-
# The type of resources that you want
|
5177
|
-
# response.
|
5187
|
+
# The type of resources that you want Config to list in the response.
|
5178
5188
|
# @return [String]
|
5179
5189
|
#
|
5180
5190
|
# @!attribute [rw] filters
|
@@ -5183,7 +5193,7 @@ module Aws::ConfigService
|
|
5183
5193
|
#
|
5184
5194
|
# @!attribute [rw] limit
|
5185
5195
|
# The maximum number of resource identifiers returned on each page.
|
5186
|
-
# You cannot specify a number greater than 100. If you specify 0,
|
5196
|
+
# You cannot specify a number greater than 100. If you specify 0,
|
5187
5197
|
# Config uses the default.
|
5188
5198
|
# @return [Integer]
|
5189
5199
|
#
|
@@ -5235,32 +5245,30 @@ module Aws::ConfigService
|
|
5235
5245
|
# }
|
5236
5246
|
#
|
5237
5247
|
# @!attribute [rw] resource_type
|
5238
|
-
# The type of resources that you want
|
5239
|
-
# response.
|
5248
|
+
# The type of resources that you want Config to list in the response.
|
5240
5249
|
# @return [String]
|
5241
5250
|
#
|
5242
5251
|
# @!attribute [rw] resource_ids
|
5243
|
-
# The IDs of only those resources that you want
|
5244
|
-
#
|
5245
|
-
#
|
5252
|
+
# The IDs of only those resources that you want Config to list in the
|
5253
|
+
# response. If you do not specify this parameter, Config lists all
|
5254
|
+
# resources of the specified type that it has discovered.
|
5246
5255
|
# @return [Array<String>]
|
5247
5256
|
#
|
5248
5257
|
# @!attribute [rw] resource_name
|
5249
|
-
# The custom name of only those resources that you want
|
5250
|
-
#
|
5251
|
-
#
|
5252
|
-
# discovered.
|
5258
|
+
# The custom name of only those resources that you want Config to list
|
5259
|
+
# in the response. If you do not specify this parameter, Config lists
|
5260
|
+
# all resources of the specified type that it has discovered.
|
5253
5261
|
# @return [String]
|
5254
5262
|
#
|
5255
5263
|
# @!attribute [rw] limit
|
5256
5264
|
# The maximum number of resource identifiers returned on each page.
|
5257
5265
|
# The default is 100. You cannot specify a number greater than 100. If
|
5258
|
-
# you specify 0,
|
5266
|
+
# you specify 0, Config uses the default.
|
5259
5267
|
# @return [Integer]
|
5260
5268
|
#
|
5261
5269
|
# @!attribute [rw] include_deleted_resources
|
5262
|
-
# Specifies whether
|
5263
|
-
#
|
5270
|
+
# Specifies whether Config includes deleted resources in the results.
|
5271
|
+
# By default, deleted resources are not included.
|
5264
5272
|
# @return [Boolean]
|
5265
5273
|
#
|
5266
5274
|
# @!attribute [rw] next_token
|
@@ -5282,9 +5290,9 @@ module Aws::ConfigService
|
|
5282
5290
|
end
|
5283
5291
|
|
5284
5292
|
# @!attribute [rw] resource_identifiers
|
5285
|
-
# The details that identify a resource that is discovered by
|
5286
|
-
#
|
5287
|
-
#
|
5293
|
+
# The details that identify a resource that is discovered by Config,
|
5294
|
+
# including the resource type, ID, and (if available) the custom
|
5295
|
+
# resource name.
|
5288
5296
|
# @return [Array<Types::ResourceIdentifier>]
|
5289
5297
|
#
|
5290
5298
|
# @!attribute [rw] next_token
|
@@ -5368,7 +5376,7 @@ module Aws::ConfigService
|
|
5368
5376
|
# @!attribute [rw] limit
|
5369
5377
|
# The maximum number of tags returned on each page. The limit maximum
|
5370
5378
|
# is 50. You cannot specify a number greater than 50. If you specify
|
5371
|
-
# 0,
|
5379
|
+
# 0, Config uses the default.
|
5372
5380
|
# @return [Integer]
|
5373
5381
|
#
|
5374
5382
|
# @!attribute [rw] next_token
|
@@ -5411,9 +5419,9 @@ module Aws::ConfigService
|
|
5411
5419
|
#
|
5412
5420
|
class MaxActiveResourcesExceededException < Aws::EmptyStructure; end
|
5413
5421
|
|
5414
|
-
# Failed to add the
|
5415
|
-
#
|
5416
|
-
#
|
5422
|
+
# Failed to add the Config rule because the account already contains the
|
5423
|
+
# maximum number of 150 rules. Consider deleting any deactivated rules
|
5424
|
+
# before you add new rules.
|
5417
5425
|
#
|
5418
5426
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/MaxNumberOfConfigRulesExceededException AWS API Documentation
|
5419
5427
|
#
|
@@ -5426,7 +5434,7 @@ module Aws::ConfigService
|
|
5426
5434
|
class MaxNumberOfConfigurationRecordersExceededException < Aws::EmptyStructure; end
|
5427
5435
|
|
5428
5436
|
# You have reached the limit (6) of the number of conformance packs in
|
5429
|
-
# an account (6 conformance pack with 25
|
5437
|
+
# an account (6 conformance pack with 25 Config rules per pack).
|
5430
5438
|
#
|
5431
5439
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/MaxNumberOfConformancePacksExceededException AWS API Documentation
|
5432
5440
|
#
|
@@ -5447,7 +5455,7 @@ module Aws::ConfigService
|
|
5447
5455
|
class MaxNumberOfOrganizationConfigRulesExceededException < Aws::EmptyStructure; end
|
5448
5456
|
|
5449
5457
|
# You have reached the limit (6) of the number of organization
|
5450
|
-
# conformance packs in an account (6 conformance pack with 25
|
5458
|
+
# conformance packs in an account (6 conformance pack with 25 Config
|
5451
5459
|
# rules per pack per account).
|
5452
5460
|
#
|
5453
5461
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/MaxNumberOfOrganizationConformancePacksExceededException AWS API Documentation
|
@@ -5483,7 +5491,7 @@ module Aws::ConfigService
|
|
5483
5491
|
# `OrganizationConfigRule` and disables service access for
|
5484
5492
|
# `config-multiaccountsetup.amazonaws.com`.
|
5485
5493
|
#
|
5486
|
-
#
|
5494
|
+
# Config sets the state of the rule to:
|
5487
5495
|
#
|
5488
5496
|
# * `CREATE_SUCCESSFUL` when config rule has been created in the
|
5489
5497
|
# member account.
|
@@ -5571,14 +5579,14 @@ module Aws::ConfigService
|
|
5571
5579
|
#
|
5572
5580
|
class NoSuchBucketException < Aws::EmptyStructure; end
|
5573
5581
|
|
5574
|
-
# One or more
|
5575
|
-
#
|
5582
|
+
# One or more Config rules in the request are invalid. Verify that the
|
5583
|
+
# rule names are correct and try again.
|
5576
5584
|
#
|
5577
5585
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/NoSuchConfigRuleException AWS API Documentation
|
5578
5586
|
#
|
5579
5587
|
class NoSuchConfigRuleException < Aws::EmptyStructure; end
|
5580
5588
|
|
5581
|
-
#
|
5589
|
+
# Config rule that you passed in the filter does not exist.
|
5582
5590
|
#
|
5583
5591
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/NoSuchConfigRuleInConformancePackException AWS API Documentation
|
5584
5592
|
#
|
@@ -5614,7 +5622,7 @@ module Aws::ConfigService
|
|
5614
5622
|
#
|
5615
5623
|
class NoSuchOrganizationConfigRuleException < Aws::EmptyStructure; end
|
5616
5624
|
|
5617
|
-
#
|
5625
|
+
# Config organization conformance pack that you passed in the filter
|
5618
5626
|
# does not exist.
|
5619
5627
|
#
|
5620
5628
|
# For DeleteOrganizationConformancePack, you tried to delete an
|
@@ -5624,7 +5632,7 @@ module Aws::ConfigService
|
|
5624
5632
|
#
|
5625
5633
|
class NoSuchOrganizationConformancePackException < Aws::EmptyStructure; end
|
5626
5634
|
|
5627
|
-
# You specified an
|
5635
|
+
# You specified an Config rule without a remediation configuration.
|
5628
5636
|
#
|
5629
5637
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/NoSuchRemediationConfigurationException AWS API Documentation
|
5630
5638
|
#
|
@@ -5647,24 +5655,24 @@ module Aws::ConfigService
|
|
5647
5655
|
#
|
5648
5656
|
# * No permission to call `EnableAWSServiceAccess` API
|
5649
5657
|
#
|
5650
|
-
# * The configuration aggregator cannot be updated because your
|
5651
|
-
# Organization management account or the delegated
|
5652
|
-
# changed. Delete this aggregator and create a new
|
5653
|
-
# current
|
5658
|
+
# * The configuration aggregator cannot be updated because your Amazon
|
5659
|
+
# Web Services Organization management account or the delegated
|
5660
|
+
# administrator role changed. Delete this aggregator and create a new
|
5661
|
+
# one with the current Amazon Web Services Organization.
|
5654
5662
|
#
|
5655
|
-
# * The configuration aggregator is associated with a previous
|
5656
|
-
# Organization and
|
5657
|
-
# Organization. Delete this aggregator and
|
5658
|
-
# current
|
5663
|
+
# * The configuration aggregator is associated with a previous Amazon
|
5664
|
+
# Web Services Organization and Config cannot aggregate data with
|
5665
|
+
# current Amazon Web Services Organization. Delete this aggregator and
|
5666
|
+
# create a new one with the current Amazon Web Services Organization.
|
5659
5667
|
#
|
5660
|
-
# * You are not a registered delegated administrator for
|
5668
|
+
# * You are not a registered delegated administrator for Config with
|
5661
5669
|
# permissions to call `ListDelegatedAdministrators` API. Ensure that
|
5662
|
-
# the management account registers delagated administrator for
|
5663
|
-
#
|
5664
|
-
#
|
5670
|
+
# the management account registers delagated administrator for Config
|
5671
|
+
# service principle name before the delegated administrator creates an
|
5672
|
+
# aggregator.
|
5665
5673
|
#
|
5666
5674
|
# For all `OrganizationConfigRule` and `OrganizationConformancePack`
|
5667
|
-
# APIs,
|
5675
|
+
# APIs, Config throws an exception if APIs are called from member
|
5668
5676
|
# accounts. All APIs must be called from organization master account.
|
5669
5677
|
#
|
5670
5678
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/OrganizationAccessDeniedException AWS API Documentation
|
@@ -5684,8 +5692,8 @@ module Aws::ConfigService
|
|
5684
5692
|
# }
|
5685
5693
|
#
|
5686
5694
|
# @!attribute [rw] role_arn
|
5687
|
-
# ARN of the IAM role used to retrieve
|
5688
|
-
# associated with the aggregator account.
|
5695
|
+
# ARN of the IAM role used to retrieve Amazon Web Services
|
5696
|
+
# Organization details associated with the aggregator account.
|
5689
5697
|
# @return [String]
|
5690
5698
|
#
|
5691
5699
|
# @!attribute [rw] aws_regions
|
@@ -5693,7 +5701,7 @@ module Aws::ConfigService
|
|
5693
5701
|
# @return [Array<String>]
|
5694
5702
|
#
|
5695
5703
|
# @!attribute [rw] all_aws_regions
|
5696
|
-
# If true, aggregate existing
|
5704
|
+
# If true, aggregate existing Config regions and future regions.
|
5697
5705
|
# @return [Boolean]
|
5698
5706
|
#
|
5699
5707
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/OrganizationAggregationSource AWS API Documentation
|
@@ -5706,15 +5714,15 @@ module Aws::ConfigService
|
|
5706
5714
|
include Aws::Structure
|
5707
5715
|
end
|
5708
5716
|
|
5709
|
-
#
|
5710
|
-
#
|
5717
|
+
# Config resource cannot be created because your organization does not
|
5718
|
+
# have all features enabled.
|
5711
5719
|
#
|
5712
5720
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/OrganizationAllFeaturesNotEnabledException AWS API Documentation
|
5713
5721
|
#
|
5714
5722
|
class OrganizationAllFeaturesNotEnabledException < Aws::EmptyStructure; end
|
5715
5723
|
|
5716
5724
|
# An organization config rule that has information about config rules
|
5717
|
-
# that
|
5725
|
+
# that Config creates in member accounts.
|
5718
5726
|
#
|
5719
5727
|
# @!attribute [rw] organization_config_rule_name
|
5720
5728
|
# The name that you assign to organization config rule.
|
@@ -5772,7 +5780,7 @@ module Aws::ConfigService
|
|
5772
5780
|
# all the member accounts and disables service access for
|
5773
5781
|
# `config-multiaccountsetup.amazonaws.com`.
|
5774
5782
|
#
|
5775
|
-
#
|
5783
|
+
# Config sets the state of the rule to:
|
5776
5784
|
#
|
5777
5785
|
# * `CREATE_SUCCESSFUL` when an organization config rule has been
|
5778
5786
|
# successfully created in all the member accounts.
|
@@ -5829,7 +5837,7 @@ module Aws::ConfigService
|
|
5829
5837
|
end
|
5830
5838
|
|
5831
5839
|
# An organization conformance pack that has information about
|
5832
|
-
# conformance packs that
|
5840
|
+
# conformance packs that Config creates in member accounts.
|
5833
5841
|
#
|
5834
5842
|
# @!attribute [rw] organization_conformance_pack_name
|
5835
5843
|
# The name you assign to an organization conformance pack.
|
@@ -5840,7 +5848,8 @@ module Aws::ConfigService
|
|
5840
5848
|
# @return [String]
|
5841
5849
|
#
|
5842
5850
|
# @!attribute [rw] delivery_s3_bucket
|
5843
|
-
# Amazon S3 bucket where
|
5851
|
+
# The name of the Amazon S3 bucket where Config stores conformance
|
5852
|
+
# pack templates.
|
5844
5853
|
#
|
5845
5854
|
# <note markdown="1"> This field is optional.
|
5846
5855
|
#
|
@@ -5906,7 +5915,7 @@ module Aws::ConfigService
|
|
5906
5915
|
# `OrganizationConformancePack` and disables service access for
|
5907
5916
|
# `config-multiaccountsetup.amazonaws.com`.
|
5908
5917
|
#
|
5909
|
-
#
|
5918
|
+
# Config sets the state of the conformance pack to:
|
5910
5919
|
#
|
5911
5920
|
# * `CREATE_SUCCESSFUL` when conformance pack has been created in the
|
5912
5921
|
# member account.
|
@@ -5982,7 +5991,7 @@ module Aws::ConfigService
|
|
5982
5991
|
# OrganizationConformancePack in all the member accounts and disables
|
5983
5992
|
# service access for `config-multiaccountsetup.amazonaws.com`.
|
5984
5993
|
#
|
5985
|
-
#
|
5994
|
+
# Config sets the state of the conformance pack to:
|
5986
5995
|
#
|
5987
5996
|
# * `CREATE_SUCCESSFUL` when an organization conformance pack has been
|
5988
5997
|
# successfully created in all the member accounts.
|
@@ -6045,11 +6054,11 @@ module Aws::ConfigService
|
|
6045
6054
|
class OrganizationConformancePackTemplateValidationException < Aws::EmptyStructure; end
|
6046
6055
|
|
6047
6056
|
# An object that specifies organization custom rule metadata such as
|
6048
|
-
# resource type, resource ID of
|
6049
|
-
# organization trigger types that trigger
|
6050
|
-
#
|
6051
|
-
# which you want
|
6052
|
-
# trigger type is periodic.
|
6057
|
+
# resource type, resource ID of Amazon Web Services resource, Lambda
|
6058
|
+
# function ARN, and organization trigger types that trigger Config to
|
6059
|
+
# evaluate your Amazon Web Services resources against a rule. It also
|
6060
|
+
# provides the frequency with which you want Config to run evaluations
|
6061
|
+
# for the rule if the trigger type is periodic.
|
6053
6062
|
#
|
6054
6063
|
# @note When making an API call, you may pass OrganizationCustomRuleMetadata
|
6055
6064
|
# data as a hash:
|
@@ -6075,19 +6084,18 @@ module Aws::ConfigService
|
|
6075
6084
|
# @return [String]
|
6076
6085
|
#
|
6077
6086
|
# @!attribute [rw] organization_config_rule_trigger_types
|
6078
|
-
# The type of notification that triggers
|
6079
|
-
#
|
6080
|
-
# types:
|
6087
|
+
# The type of notification that triggers Config to run an evaluation
|
6088
|
+
# for a rule. You can specify the following notification types:
|
6081
6089
|
#
|
6082
6090
|
# * `ConfigurationItemChangeNotification` - Triggers an evaluation
|
6083
|
-
# when
|
6091
|
+
# when Config delivers a configuration item as a result of a
|
6084
6092
|
# resource change.
|
6085
6093
|
#
|
6086
6094
|
# * `OversizedConfigurationItemChangeNotification` - Triggers an
|
6087
|
-
# evaluation when
|
6088
|
-
#
|
6089
|
-
#
|
6090
|
-
#
|
6095
|
+
# evaluation when Config delivers an oversized configuration item.
|
6096
|
+
# Config may generate this notification type when a resource changes
|
6097
|
+
# and the notification exceeds the maximum size allowed by Amazon
|
6098
|
+
# SNS.
|
6091
6099
|
#
|
6092
6100
|
# * `ScheduledNotification` - Triggers a periodic evaluation at the
|
6093
6101
|
# frequency specified for `MaximumExecutionFrequency`.
|
@@ -6099,9 +6107,9 @@ module Aws::ConfigService
|
|
6099
6107
|
# @return [String]
|
6100
6108
|
#
|
6101
6109
|
# @!attribute [rw] maximum_execution_frequency
|
6102
|
-
# The maximum frequency with which
|
6103
|
-
#
|
6104
|
-
#
|
6110
|
+
# The maximum frequency with which Config runs evaluations for a rule.
|
6111
|
+
# Your custom rule is triggered when Config delivers the configuration
|
6112
|
+
# snapshot. For more information, see
|
6105
6113
|
# ConfigSnapshotDeliveryProperties.
|
6106
6114
|
#
|
6107
6115
|
# <note markdown="1"> By default, rules with a periodic trigger are evaluated every 24
|
@@ -6112,11 +6120,11 @@ module Aws::ConfigService
|
|
6112
6120
|
# @return [String]
|
6113
6121
|
#
|
6114
6122
|
# @!attribute [rw] resource_types_scope
|
6115
|
-
# The type of the
|
6123
|
+
# The type of the Amazon Web Services resource that was evaluated.
|
6116
6124
|
# @return [Array<String>]
|
6117
6125
|
#
|
6118
6126
|
# @!attribute [rw] resource_id_scope
|
6119
|
-
# The ID of the
|
6127
|
+
# The ID of the Amazon Web Services resource that was evaluated.
|
6120
6128
|
# @return [String]
|
6121
6129
|
#
|
6122
6130
|
# @!attribute [rw] tag_key_scope
|
@@ -6146,9 +6154,10 @@ module Aws::ConfigService
|
|
6146
6154
|
end
|
6147
6155
|
|
6148
6156
|
# An object that specifies organization managed rule metadata such as
|
6149
|
-
# resource type and ID of
|
6150
|
-
# It also provides the frequency with which you want
|
6151
|
-
# evaluations for the rule if the trigger type is
|
6157
|
+
# resource type and ID of Amazon Web Services resource along with the
|
6158
|
+
# rule identifier. It also provides the frequency with which you want
|
6159
|
+
# Config to run evaluations for the rule if the trigger type is
|
6160
|
+
# periodic.
|
6152
6161
|
#
|
6153
6162
|
# @note When making an API call, you may pass OrganizationManagedRuleMetadata
|
6154
6163
|
# data as a hash:
|
@@ -6171,7 +6180,7 @@ module Aws::ConfigService
|
|
6171
6180
|
# @!attribute [rw] rule_identifier
|
6172
6181
|
# For organization config managed rules, a predefined identifier from
|
6173
6182
|
# a list. For example, `IAM_PASSWORD_POLICY` is a managed rule. To
|
6174
|
-
# reference a managed rule, see [Using
|
6183
|
+
# reference a managed rule, see [Using Config managed rules][1].
|
6175
6184
|
#
|
6176
6185
|
#
|
6177
6186
|
#
|
@@ -6184,9 +6193,9 @@ module Aws::ConfigService
|
|
6184
6193
|
# @return [String]
|
6185
6194
|
#
|
6186
6195
|
# @!attribute [rw] maximum_execution_frequency
|
6187
|
-
# The maximum frequency with which
|
6188
|
-
#
|
6189
|
-
#
|
6196
|
+
# The maximum frequency with which Config runs evaluations for a rule.
|
6197
|
+
# You are using an Config managed rule that is triggered at a periodic
|
6198
|
+
# frequency.
|
6190
6199
|
#
|
6191
6200
|
# <note markdown="1"> By default, rules with a periodic trigger are evaluated every 24
|
6192
6201
|
# hours. To change the frequency, specify a valid value for the
|
@@ -6196,11 +6205,11 @@ module Aws::ConfigService
|
|
6196
6205
|
# @return [String]
|
6197
6206
|
#
|
6198
6207
|
# @!attribute [rw] resource_types_scope
|
6199
|
-
# The type of the
|
6208
|
+
# The type of the Amazon Web Services resource that was evaluated.
|
6200
6209
|
# @return [Array<String>]
|
6201
6210
|
#
|
6202
6211
|
# @!attribute [rw] resource_id_scope
|
6203
|
-
# The ID of the
|
6212
|
+
# The ID of the Amazon Web Services resource that was evaluated.
|
6204
6213
|
# @return [String]
|
6205
6214
|
#
|
6206
6215
|
# @!attribute [rw] tag_key_scope
|
@@ -6255,7 +6264,7 @@ module Aws::ConfigService
|
|
6255
6264
|
# `OrganizationConformancePack` and disables service access for
|
6256
6265
|
# `config-multiaccountsetup.amazonaws.com`.
|
6257
6266
|
#
|
6258
|
-
#
|
6267
|
+
# Config sets the state of the conformance pack to:
|
6259
6268
|
#
|
6260
6269
|
# * `CREATE_SUCCESSFUL` when conformance pack has been created in the
|
6261
6270
|
# member account.
|
@@ -6562,7 +6571,8 @@ module Aws::ConfigService
|
|
6562
6571
|
# @return [String]
|
6563
6572
|
#
|
6564
6573
|
# @!attribute [rw] delivery_s3_bucket
|
6565
|
-
# Amazon S3 bucket where
|
6574
|
+
# The name of the Amazon S3 bucket where Config stores conformance
|
6575
|
+
# pack templates.
|
6566
6576
|
#
|
6567
6577
|
# <note markdown="1"> This field is optional.
|
6568
6578
|
#
|
@@ -6656,23 +6666,22 @@ module Aws::ConfigService
|
|
6656
6666
|
# }
|
6657
6667
|
#
|
6658
6668
|
# @!attribute [rw] evaluations
|
6659
|
-
# The assessments that the
|
6660
|
-
#
|
6661
|
-
# complies with the
|
6662
|
-
# function.
|
6669
|
+
# The assessments that the Lambda function performs. Each evaluation
|
6670
|
+
# identifies an Amazon Web Services resource and indicates whether it
|
6671
|
+
# complies with the Config rule that invokes the Lambda function.
|
6663
6672
|
# @return [Array<Types::Evaluation>]
|
6664
6673
|
#
|
6665
6674
|
# @!attribute [rw] result_token
|
6666
|
-
# An encrypted token that associates an evaluation with an
|
6675
|
+
# An encrypted token that associates an evaluation with an Config
|
6667
6676
|
# rule. Identifies the rule and the event that triggered the
|
6668
6677
|
# evaluation.
|
6669
6678
|
# @return [String]
|
6670
6679
|
#
|
6671
6680
|
# @!attribute [rw] test_mode
|
6672
6681
|
# Use this parameter to specify a test run for `PutEvaluations`. You
|
6673
|
-
# can verify whether your
|
6674
|
-
# results to
|
6675
|
-
#
|
6682
|
+
# can verify whether your Lambda function will deliver evaluation
|
6683
|
+
# results to Config. No updates occur to your existing evaluations,
|
6684
|
+
# and evaluation results are not sent to Config.
|
6676
6685
|
#
|
6677
6686
|
# <note markdown="1"> When `TestMode` is `true`, `PutEvaluations` doesn't require a valid
|
6678
6687
|
# value for the `ResultToken` parameter, but the value cannot be null.
|
@@ -6717,7 +6726,7 @@ module Aws::ConfigService
|
|
6717
6726
|
# }
|
6718
6727
|
#
|
6719
6728
|
# @!attribute [rw] config_rule_name
|
6720
|
-
# The name of the
|
6729
|
+
# The name of the Config rule.
|
6721
6730
|
# @return [String]
|
6722
6731
|
#
|
6723
6732
|
# @!attribute [rw] external_evaluation
|
@@ -6845,7 +6854,8 @@ module Aws::ConfigService
|
|
6845
6854
|
# @return [String]
|
6846
6855
|
#
|
6847
6856
|
# @!attribute [rw] delivery_s3_bucket
|
6848
|
-
# Amazon S3 bucket where
|
6857
|
+
# The name of the Amazon S3 bucket where Config stores conformance
|
6858
|
+
# pack templates.
|
6849
6859
|
#
|
6850
6860
|
# <note markdown="1"> This field is optional. If used, it must be prefixed with
|
6851
6861
|
# `awsconfigconforms`.
|
@@ -6866,8 +6876,8 @@ module Aws::ConfigService
|
|
6866
6876
|
# @return [Array<Types::ConformancePackInputParameter>]
|
6867
6877
|
#
|
6868
6878
|
# @!attribute [rw] excluded_accounts
|
6869
|
-
# A list of
|
6870
|
-
# conformance pack while deploying a conformance pack.
|
6879
|
+
# A list of Amazon Web Services accounts to be excluded from an
|
6880
|
+
# organization conformance pack while deploying a conformance pack.
|
6871
6881
|
# @return [Array<String>]
|
6872
6882
|
#
|
6873
6883
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/PutOrganizationConformancePackRequest AWS API Documentation
|
@@ -6972,14 +6982,14 @@ module Aws::ConfigService
|
|
6972
6982
|
# }
|
6973
6983
|
#
|
6974
6984
|
# @!attribute [rw] config_rule_name
|
6975
|
-
# The name of the
|
6976
|
-
#
|
6985
|
+
# The name of the Config rule for which you want to create remediation
|
6986
|
+
# exception.
|
6977
6987
|
# @return [String]
|
6978
6988
|
#
|
6979
6989
|
# @!attribute [rw] resource_keys
|
6980
6990
|
# An exception list of resource exception keys to be processed with
|
6981
|
-
# the current request.
|
6982
|
-
#
|
6991
|
+
# the current request. Config adds exception for each resource key.
|
6992
|
+
# For example, Config adds 3 exceptions for 3 resource keys.
|
6983
6993
|
# @return [Array<Types::RemediationExceptionResourceKey>]
|
6984
6994
|
#
|
6985
6995
|
# @!attribute [rw] message
|
@@ -7031,17 +7041,17 @@ module Aws::ConfigService
|
|
7031
7041
|
#
|
7032
7042
|
# @!attribute [rw] resource_type
|
7033
7043
|
# The type of the resource. The custom resource type must be
|
7034
|
-
# registered with
|
7044
|
+
# registered with CloudFormation.
|
7035
7045
|
#
|
7036
|
-
# <note markdown="1"> You cannot use the organization names “
|
7037
|
-
# “
|
7038
|
-
#
|
7046
|
+
# <note markdown="1"> You cannot use the organization names “amzn”, “amazon”, “alexa”,
|
7047
|
+
# “custom” with custom resource types. It is the first part of the
|
7048
|
+
# ResourceType up to the first ::.
|
7039
7049
|
#
|
7040
7050
|
# </note>
|
7041
7051
|
# @return [String]
|
7042
7052
|
#
|
7043
7053
|
# @!attribute [rw] schema_version_id
|
7044
|
-
# Version of the schema registered for the ResourceType in
|
7054
|
+
# Version of the schema registered for the ResourceType in
|
7045
7055
|
# CloudFormation.
|
7046
7056
|
# @return [String]
|
7047
7057
|
#
|
@@ -7055,7 +7065,7 @@ module Aws::ConfigService
|
|
7055
7065
|
#
|
7056
7066
|
# @!attribute [rw] configuration
|
7057
7067
|
# The configuration object of the resource in valid JSON format. It
|
7058
|
-
# must match the schema registered with
|
7068
|
+
# must match the schema registered with CloudFormation.
|
7059
7069
|
#
|
7060
7070
|
# <note markdown="1"> The configuration JSON must not exceed 64 KB.
|
7061
7071
|
#
|
@@ -7087,7 +7097,7 @@ module Aws::ConfigService
|
|
7087
7097
|
# }
|
7088
7098
|
#
|
7089
7099
|
# @!attribute [rw] retention_period_in_days
|
7090
|
-
# Number of days
|
7100
|
+
# Number of days Config stores your historical information.
|
7091
7101
|
#
|
7092
7102
|
# <note markdown="1"> Currently, only applicable to the configuration item history.
|
7093
7103
|
#
|
@@ -7184,40 +7194,40 @@ module Aws::ConfigService
|
|
7184
7194
|
include Aws::Structure
|
7185
7195
|
end
|
7186
7196
|
|
7187
|
-
# Specifies the types of
|
7188
|
-
# configuration changes.
|
7197
|
+
# Specifies the types of Amazon Web Services resource for which Config
|
7198
|
+
# records configuration changes.
|
7189
7199
|
#
|
7190
7200
|
# In the recording group, you specify whether all supported types or
|
7191
7201
|
# specific types of resources are recorded.
|
7192
7202
|
#
|
7193
|
-
# By default,
|
7194
|
-
# types of regional resources that
|
7203
|
+
# By default, Config records configuration changes for all supported
|
7204
|
+
# types of regional resources that Config discovers in the region in
|
7195
7205
|
# which it is running. Regional resources are tied to a region and can
|
7196
7206
|
# be used only in that region. Examples of regional resources are EC2
|
7197
7207
|
# instances and EBS volumes.
|
7198
7208
|
#
|
7199
|
-
# You can also have
|
7200
|
-
#
|
7201
|
-
#
|
7202
|
-
#
|
7209
|
+
# You can also have Config record configuration changes for supported
|
7210
|
+
# types of global resources (for example, IAM resources). Global
|
7211
|
+
# resources are not tied to an individual region and can be used in all
|
7212
|
+
# regions.
|
7203
7213
|
#
|
7204
7214
|
# The configuration details for any global resource are the same in all
|
7205
|
-
# regions. If you customize
|
7206
|
-
#
|
7207
|
-
#
|
7208
|
-
#
|
7209
|
-
#
|
7210
|
-
#
|
7211
|
-
#
|
7212
|
-
#
|
7213
|
-
# If you don't want
|
7215
|
+
# regions. If you customize Config in multiple regions to record global
|
7216
|
+
# resources, it will create multiple configuration items each time a
|
7217
|
+
# global resource changes: one configuration item for each region. These
|
7218
|
+
# configuration items will contain identical data. To prevent duplicate
|
7219
|
+
# configuration items, you should consider customizing Config in only
|
7220
|
+
# one region to record global resources, unless you want the
|
7221
|
+
# configuration items to be available in multiple regions.
|
7222
|
+
#
|
7223
|
+
# If you don't want Config to record all resources, you can specify
|
7214
7224
|
# which types of resources it will record with the `resourceTypes`
|
7215
7225
|
# parameter.
|
7216
7226
|
#
|
7217
7227
|
# For a list of supported resource types, see [Supported Resource
|
7218
7228
|
# Types][1].
|
7219
7229
|
#
|
7220
|
-
# For more information, see [Selecting Which Resources
|
7230
|
+
# For more information, see [Selecting Which Resources Config
|
7221
7231
|
# Records][2].
|
7222
7232
|
#
|
7223
7233
|
#
|
@@ -7235,11 +7245,11 @@ module Aws::ConfigService
|
|
7235
7245
|
# }
|
7236
7246
|
#
|
7237
7247
|
# @!attribute [rw] all_supported
|
7238
|
-
# Specifies whether
|
7248
|
+
# Specifies whether Config records configuration changes for every
|
7239
7249
|
# supported type of regional resource.
|
7240
7250
|
#
|
7241
|
-
# If you set this option to `true`, when
|
7242
|
-
#
|
7251
|
+
# If you set this option to `true`, when Config adds support for a new
|
7252
|
+
# type of regional resource, it starts recording resources of that
|
7243
7253
|
# type automatically.
|
7244
7254
|
#
|
7245
7255
|
# If you set this option to `true`, you cannot enumerate a list of
|
@@ -7247,37 +7257,37 @@ module Aws::ConfigService
|
|
7247
7257
|
# @return [Boolean]
|
7248
7258
|
#
|
7249
7259
|
# @!attribute [rw] include_global_resource_types
|
7250
|
-
# Specifies whether
|
7260
|
+
# Specifies whether Config includes all supported types of global
|
7251
7261
|
# resources (for example, IAM resources) with the resources that it
|
7252
7262
|
# records.
|
7253
7263
|
#
|
7254
7264
|
# Before you can set this option to `true`, you must set the
|
7255
7265
|
# `allSupported` option to `true`.
|
7256
7266
|
#
|
7257
|
-
# If you set this option to `true`, when
|
7258
|
-
#
|
7259
|
-
#
|
7267
|
+
# If you set this option to `true`, when Config adds support for a new
|
7268
|
+
# type of global resource, it starts recording resources of that type
|
7269
|
+
# automatically.
|
7260
7270
|
#
|
7261
7271
|
# The configuration details for any global resource are the same in
|
7262
7272
|
# all regions. To prevent duplicate configuration items, you should
|
7263
|
-
# consider customizing
|
7273
|
+
# consider customizing Config in only one region to record global
|
7264
7274
|
# resources.
|
7265
7275
|
# @return [Boolean]
|
7266
7276
|
#
|
7267
7277
|
# @!attribute [rw] resource_types
|
7268
|
-
# A comma-separated list that specifies the types of
|
7269
|
-
# which
|
7270
|
-
# `AWS::EC2::Instance` or `AWS::CloudTrail::Trail`).
|
7278
|
+
# A comma-separated list that specifies the types of Amazon Web
|
7279
|
+
# Services resources for which Config records configuration changes
|
7280
|
+
# (for example, `AWS::EC2::Instance` or `AWS::CloudTrail::Trail`).
|
7271
7281
|
#
|
7272
7282
|
# To record all configuration changes, you must set the `allSupported`
|
7273
7283
|
# option to `true`.
|
7274
7284
|
#
|
7275
|
-
# If you set this option to `false`, when
|
7276
|
-
#
|
7285
|
+
# If you set this option to `false`, when Config adds support for a
|
7286
|
+
# new type of resource, it will not record resources of that type
|
7277
7287
|
# unless you manually add that type to your recording group.
|
7278
7288
|
#
|
7279
7289
|
# For a list of valid `resourceTypes` values, see the **resourceType
|
7280
|
-
# Value** column in [Supported
|
7290
|
+
# Value** column in [Supported Amazon Web Services resource Types][1].
|
7281
7291
|
#
|
7282
7292
|
#
|
7283
7293
|
#
|
@@ -7360,7 +7370,7 @@ module Aws::ConfigService
|
|
7360
7370
|
# }
|
7361
7371
|
#
|
7362
7372
|
# @!attribute [rw] config_rule_name
|
7363
|
-
# The name of the
|
7373
|
+
# The name of the Config rule.
|
7364
7374
|
# @return [String]
|
7365
7375
|
#
|
7366
7376
|
# @!attribute [rw] target_type
|
@@ -7403,18 +7413,18 @@ module Aws::ConfigService
|
|
7403
7413
|
# do not select a number, the default is 5.
|
7404
7414
|
#
|
7405
7415
|
# For example, if you specify MaximumAutomaticAttempts as 5 with
|
7406
|
-
# RetryAttemptSeconds as 50 seconds,
|
7416
|
+
# RetryAttemptSeconds as 50 seconds, Config will put a
|
7407
7417
|
# RemediationException on your behalf for the failing resource after
|
7408
7418
|
# the 5th failed attempt within 50 seconds.
|
7409
7419
|
# @return [Integer]
|
7410
7420
|
#
|
7411
7421
|
# @!attribute [rw] retry_attempt_seconds
|
7412
|
-
# Maximum time in seconds that
|
7413
|
-
#
|
7422
|
+
# Maximum time in seconds that Config runs auto-remediation. If you do
|
7423
|
+
# not select a number, the default is 60 seconds.
|
7414
7424
|
#
|
7415
7425
|
# For example, if you specify RetryAttemptSeconds as 50 seconds and
|
7416
|
-
# MaximumAutomaticAttempts as 5,
|
7417
|
-
#
|
7426
|
+
# MaximumAutomaticAttempts as 5, Config will run auto-remediations 5
|
7427
|
+
# times within 50 seconds before throwing an exception.
|
7418
7428
|
# @return [Integer]
|
7419
7429
|
#
|
7420
7430
|
# @!attribute [rw] arn
|
@@ -7451,7 +7461,7 @@ module Aws::ConfigService
|
|
7451
7461
|
# type.
|
7452
7462
|
#
|
7453
7463
|
# @!attribute [rw] config_rule_name
|
7454
|
-
# The name of the
|
7464
|
+
# The name of the Config rule.
|
7455
7465
|
# @return [String]
|
7456
7466
|
#
|
7457
7467
|
# @!attribute [rw] resource_type
|
@@ -7482,7 +7492,7 @@ module Aws::ConfigService
|
|
7482
7492
|
include Aws::Structure
|
7483
7493
|
end
|
7484
7494
|
|
7485
|
-
# The details that identify a resource within
|
7495
|
+
# The details that identify a resource within Config, including the
|
7486
7496
|
# resource type and resource ID.
|
7487
7497
|
#
|
7488
7498
|
# @note When making an API call, you may pass RemediationExceptionResourceKey
|
@@ -7514,8 +7524,8 @@ module Aws::ConfigService
|
|
7514
7524
|
# action for that resource.
|
7515
7525
|
#
|
7516
7526
|
# @!attribute [rw] resource_key
|
7517
|
-
# The details that identify a resource within
|
7518
|
-
#
|
7527
|
+
# The details that identify a resource within Config, including the
|
7528
|
+
# resource type and resource ID.
|
7519
7529
|
# @return [Types::ResourceKey]
|
7520
7530
|
#
|
7521
7531
|
# @!attribute [rw] state
|
@@ -7581,7 +7591,7 @@ module Aws::ConfigService
|
|
7581
7591
|
end
|
7582
7592
|
|
7583
7593
|
# Remediation action is in progress. You can either cancel execution in
|
7584
|
-
#
|
7594
|
+
# Amazon Web Services Systems Manager or wait and try again later.
|
7585
7595
|
#
|
7586
7596
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/RemediationInProgressException AWS API Documentation
|
7587
7597
|
#
|
@@ -7665,7 +7675,7 @@ module Aws::ConfigService
|
|
7665
7675
|
# }
|
7666
7676
|
#
|
7667
7677
|
# @!attribute [rw] resource_type
|
7668
|
-
# The type of the
|
7678
|
+
# The type of the Amazon Web Services resource.
|
7669
7679
|
# @return [String]
|
7670
7680
|
#
|
7671
7681
|
# @!attribute [rw] account_id
|
@@ -7726,7 +7736,7 @@ module Aws::ConfigService
|
|
7726
7736
|
include Aws::Structure
|
7727
7737
|
end
|
7728
7738
|
|
7729
|
-
# The details that identify a resource that is discovered by
|
7739
|
+
# The details that identify a resource that is discovered by Config,
|
7730
7740
|
# including the resource type, ID, and (if available) the custom
|
7731
7741
|
# resource name.
|
7732
7742
|
#
|
@@ -7759,14 +7769,14 @@ module Aws::ConfigService
|
|
7759
7769
|
|
7760
7770
|
# You see this exception in the following cases:
|
7761
7771
|
#
|
7762
|
-
# * For DeleteConfigRule,
|
7763
|
-
#
|
7772
|
+
# * For DeleteConfigRule, Config is deleting this rule. Try your request
|
7773
|
+
# again later.
|
7764
7774
|
#
|
7765
7775
|
# * For DeleteConfigRule, the rule is deleting your evaluation results.
|
7766
7776
|
# Try your request again later.
|
7767
7777
|
#
|
7768
7778
|
# * For DeleteConfigRule, a remediation action is associated with the
|
7769
|
-
# rule and
|
7779
|
+
# rule and Config cannot delete this rule. Delete the remediation
|
7770
7780
|
# action associated with the rule before deleting the rule and try
|
7771
7781
|
# your request again later.
|
7772
7782
|
#
|
@@ -7787,7 +7797,7 @@ module Aws::ConfigService
|
|
7787
7797
|
#
|
7788
7798
|
class ResourceInUseException < Aws::EmptyStructure; end
|
7789
7799
|
|
7790
|
-
# The details that identify a resource within
|
7800
|
+
# The details that identify a resource within Config, including the
|
7791
7801
|
# resource type and resource ID.
|
7792
7802
|
#
|
7793
7803
|
# @note When making an API call, you may pass ResourceKey
|
@@ -7851,14 +7861,14 @@ module Aws::ConfigService
|
|
7851
7861
|
|
7852
7862
|
# An object with the name of the retention configuration and the
|
7853
7863
|
# retention period in days. The object stores the configuration for data
|
7854
|
-
# retention in
|
7864
|
+
# retention in Config.
|
7855
7865
|
#
|
7856
7866
|
# @!attribute [rw] name
|
7857
7867
|
# The name of the retention configuration object.
|
7858
7868
|
# @return [String]
|
7859
7869
|
#
|
7860
7870
|
# @!attribute [rw] retention_period_in_days
|
7861
|
-
# Number of days
|
7871
|
+
# Number of days Config stores your historical information.
|
7862
7872
|
#
|
7863
7873
|
# <note markdown="1"> Currently, only applicable to the configuration item history.
|
7864
7874
|
#
|
@@ -7874,13 +7884,12 @@ module Aws::ConfigService
|
|
7874
7884
|
include Aws::Structure
|
7875
7885
|
end
|
7876
7886
|
|
7877
|
-
# Defines which resources trigger an evaluation for an
|
7878
|
-
#
|
7879
|
-
#
|
7880
|
-
#
|
7881
|
-
#
|
7882
|
-
#
|
7883
|
-
# configuration.
|
7887
|
+
# Defines which resources trigger an evaluation for an Config rule. The
|
7888
|
+
# scope can include one or more resource types, a combination of a tag
|
7889
|
+
# key and value, or a combination of one resource type and one resource
|
7890
|
+
# ID. Specify a scope to constrain which resources trigger an evaluation
|
7891
|
+
# for a rule. Otherwise, evaluations for the rule are triggered when any
|
7892
|
+
# resource in your recording group changes in configuration.
|
7884
7893
|
#
|
7885
7894
|
# @note When making an API call, you may pass Scope
|
7886
7895
|
# data as a hash:
|
@@ -7893,26 +7902,27 @@ module Aws::ConfigService
|
|
7893
7902
|
# }
|
7894
7903
|
#
|
7895
7904
|
# @!attribute [rw] compliance_resource_types
|
7896
|
-
# The resource types of only those
|
7897
|
-
# trigger an evaluation for the rule. You can only specify
|
7898
|
-
# you also specify a resource ID for
|
7905
|
+
# The resource types of only those Amazon Web Services resources that
|
7906
|
+
# you want to trigger an evaluation for the rule. You can only specify
|
7907
|
+
# one type if you also specify a resource ID for
|
7908
|
+
# `ComplianceResourceId`.
|
7899
7909
|
# @return [Array<String>]
|
7900
7910
|
#
|
7901
7911
|
# @!attribute [rw] tag_key
|
7902
|
-
# The tag key that is applied to only those
|
7903
|
-
# want to trigger an evaluation for the rule.
|
7912
|
+
# The tag key that is applied to only those Amazon Web Services
|
7913
|
+
# resources that you want to trigger an evaluation for the rule.
|
7904
7914
|
# @return [String]
|
7905
7915
|
#
|
7906
7916
|
# @!attribute [rw] tag_value
|
7907
|
-
# The tag value applied to only those
|
7908
|
-
# trigger an evaluation for the rule. If you specify
|
7909
|
-
# `TagValue`, you must also specify a value for `TagKey`.
|
7917
|
+
# The tag value applied to only those Amazon Web Services resources
|
7918
|
+
# that you want to trigger an evaluation for the rule. If you specify
|
7919
|
+
# a value for `TagValue`, you must also specify a value for `TagKey`.
|
7910
7920
|
# @return [String]
|
7911
7921
|
#
|
7912
7922
|
# @!attribute [rw] compliance_resource_id
|
7913
|
-
# The ID of the only
|
7914
|
-
# evaluation for the rule. If you specify a resource ID,
|
7915
|
-
# specify one resource type for `ComplianceResourceTypes`.
|
7923
|
+
# The ID of the only Amazon Web Services resource that you want to
|
7924
|
+
# trigger an evaluation for the rule. If you specify a resource ID,
|
7925
|
+
# you must specify one resource type for `ComplianceResourceTypes`.
|
7916
7926
|
# @return [String]
|
7917
7927
|
#
|
7918
7928
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/Scope AWS API Documentation
|
@@ -7950,8 +7960,8 @@ module Aws::ConfigService
|
|
7950
7960
|
# @return [Integer]
|
7951
7961
|
#
|
7952
7962
|
# @!attribute [rw] max_results
|
7953
|
-
# The maximum number of query results returned on each page.
|
7954
|
-
#
|
7963
|
+
# The maximum number of query results returned on each page. Config
|
7964
|
+
# also allows the Limit request parameter.
|
7955
7965
|
# @return [Integer]
|
7956
7966
|
#
|
7957
7967
|
# @!attribute [rw] next_token
|
@@ -8049,9 +8059,9 @@ module Aws::ConfigService
|
|
8049
8059
|
include Aws::Structure
|
8050
8060
|
end
|
8051
8061
|
|
8052
|
-
# Provides the
|
8053
|
-
# identifier, and the events that trigger the evaluation of your
|
8054
|
-
# resources.
|
8062
|
+
# Provides the Config rule owner (Amazon Web Services or customer), the
|
8063
|
+
# rule identifier, and the events that trigger the evaluation of your
|
8064
|
+
# Amazon Web Services resources.
|
8055
8065
|
#
|
8056
8066
|
# @note When making an API call, you may pass Source
|
8057
8067
|
# data as a hash:
|
@@ -8069,17 +8079,17 @@ module Aws::ConfigService
|
|
8069
8079
|
# }
|
8070
8080
|
#
|
8071
8081
|
# @!attribute [rw] owner
|
8072
|
-
# Indicates whether
|
8073
|
-
# Config rule.
|
8082
|
+
# Indicates whether Amazon Web Services or the customer owns and
|
8083
|
+
# manages the Config rule.
|
8074
8084
|
# @return [String]
|
8075
8085
|
#
|
8076
8086
|
# @!attribute [rw] source_identifier
|
8077
|
-
# For
|
8078
|
-
#
|
8079
|
-
# managed rule, see [Using
|
8087
|
+
# For Config managed rules, a predefined identifier from a list. For
|
8088
|
+
# example, `IAM_PASSWORD_POLICY` is a managed rule. To reference a
|
8089
|
+
# managed rule, see [Using Config managed rules][1].
|
8080
8090
|
#
|
8081
8091
|
# For custom rules, the identifier is the Amazon Resource Name (ARN)
|
8082
|
-
# of the rule's
|
8092
|
+
# of the rule's Lambda function, such as
|
8083
8093
|
# `arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name`.
|
8084
8094
|
#
|
8085
8095
|
#
|
@@ -8088,8 +8098,8 @@ module Aws::ConfigService
|
|
8088
8098
|
# @return [String]
|
8089
8099
|
#
|
8090
8100
|
# @!attribute [rw] source_details
|
8091
|
-
# Provides the source and type of the event that causes
|
8092
|
-
# evaluate your
|
8101
|
+
# Provides the source and type of the event that causes Config to
|
8102
|
+
# evaluate your Amazon Web Services resources.
|
8093
8103
|
# @return [Array<Types::SourceDetail>]
|
8094
8104
|
#
|
8095
8105
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/Source AWS API Documentation
|
@@ -8102,11 +8112,11 @@ module Aws::ConfigService
|
|
8102
8112
|
include Aws::Structure
|
8103
8113
|
end
|
8104
8114
|
|
8105
|
-
# Provides the source and the message types that trigger
|
8106
|
-
# evaluate your
|
8107
|
-
# frequency with which you want
|
8108
|
-
# rule if the trigger type is periodic. You can specify the
|
8109
|
-
# values for `SourceDetail` only for custom rules.
|
8115
|
+
# Provides the source and the message types that trigger Config to
|
8116
|
+
# evaluate your Amazon Web Services resources against a rule. It also
|
8117
|
+
# provides the frequency with which you want Config to run evaluations
|
8118
|
+
# for the rule if the trigger type is periodic. You can specify the
|
8119
|
+
# parameter values for `SourceDetail` only for custom rules.
|
8110
8120
|
#
|
8111
8121
|
# @note When making an API call, you may pass SourceDetail
|
8112
8122
|
# data as a hash:
|
@@ -8118,30 +8128,29 @@ module Aws::ConfigService
|
|
8118
8128
|
# }
|
8119
8129
|
#
|
8120
8130
|
# @!attribute [rw] event_source
|
8121
|
-
# The source of the event, such as an
|
8122
|
-
# Config to evaluate your
|
8131
|
+
# The source of the event, such as an Amazon Web Services service,
|
8132
|
+
# that triggers Config to evaluate your Amazon Web Services resources.
|
8123
8133
|
# @return [String]
|
8124
8134
|
#
|
8125
8135
|
# @!attribute [rw] message_type
|
8126
|
-
# The type of notification that triggers
|
8127
|
-
#
|
8128
|
-
# types:
|
8136
|
+
# The type of notification that triggers Config to run an evaluation
|
8137
|
+
# for a rule. You can specify the following notification types:
|
8129
8138
|
#
|
8130
8139
|
# * `ConfigurationItemChangeNotification` - Triggers an evaluation
|
8131
|
-
# when
|
8140
|
+
# when Config delivers a configuration item as a result of a
|
8132
8141
|
# resource change.
|
8133
8142
|
#
|
8134
8143
|
# * `OversizedConfigurationItemChangeNotification` - Triggers an
|
8135
|
-
# evaluation when
|
8136
|
-
#
|
8137
|
-
#
|
8138
|
-
#
|
8144
|
+
# evaluation when Config delivers an oversized configuration item.
|
8145
|
+
# Config may generate this notification type when a resource changes
|
8146
|
+
# and the notification exceeds the maximum size allowed by Amazon
|
8147
|
+
# SNS.
|
8139
8148
|
#
|
8140
8149
|
# * `ScheduledNotification` - Triggers a periodic evaluation at the
|
8141
8150
|
# frequency specified for `MaximumExecutionFrequency`.
|
8142
8151
|
#
|
8143
8152
|
# * `ConfigurationSnapshotDeliveryCompleted` - Triggers a periodic
|
8144
|
-
# evaluation when
|
8153
|
+
# evaluation when Config delivers a configuration snapshot.
|
8145
8154
|
#
|
8146
8155
|
# If you want your custom rule to be triggered by configuration
|
8147
8156
|
# changes, specify two SourceDetail objects, one for
|
@@ -8150,7 +8159,7 @@ module Aws::ConfigService
|
|
8150
8159
|
# @return [String]
|
8151
8160
|
#
|
8152
8161
|
# @!attribute [rw] maximum_execution_frequency
|
8153
|
-
# The frequency at which you want
|
8162
|
+
# The frequency at which you want Config to run evaluations for a
|
8154
8163
|
# custom rule with a periodic trigger. If you specify a value for
|
8155
8164
|
# `MaximumExecutionFrequency`, then `MessageType` must use the
|
8156
8165
|
# `ScheduledNotification` value.
|
@@ -8159,9 +8168,9 @@ module Aws::ConfigService
|
|
8159
8168
|
# hours. To change the frequency, specify a valid value for the
|
8160
8169
|
# `MaximumExecutionFrequency` parameter.
|
8161
8170
|
#
|
8162
|
-
# Based on the valid value you choose,
|
8163
|
-
#
|
8164
|
-
#
|
8171
|
+
# Based on the valid value you choose, Config runs evaluations once
|
8172
|
+
# for each valid value. For example, if you choose `Three_Hours`,
|
8173
|
+
# Config runs evaluations once every three hours. In this case,
|
8165
8174
|
# `Three_Hours` is the frequency of this rule.
|
8166
8175
|
#
|
8167
8176
|
# </note>
|
@@ -8177,7 +8186,8 @@ module Aws::ConfigService
|
|
8177
8186
|
include Aws::Structure
|
8178
8187
|
end
|
8179
8188
|
|
8180
|
-
#
|
8189
|
+
# Amazon Web Services Systems Manager (SSM) specific remediation
|
8190
|
+
# controls.
|
8181
8191
|
#
|
8182
8192
|
# @note When making an API call, you may pass SsmControls
|
8183
8193
|
# data as a hash:
|
@@ -8219,8 +8229,8 @@ module Aws::ConfigService
|
|
8219
8229
|
# }
|
8220
8230
|
#
|
8221
8231
|
# @!attribute [rw] config_rule_names
|
8222
|
-
# The list of names of
|
8223
|
-
#
|
8232
|
+
# The list of names of Config rules that you want to run evaluations
|
8233
|
+
# for.
|
8224
8234
|
# @return [Array<String>]
|
8225
8235
|
#
|
8226
8236
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/StartConfigRulesEvaluationRequest AWS API Documentation
|
@@ -8231,7 +8241,7 @@ module Aws::ConfigService
|
|
8231
8241
|
include Aws::Structure
|
8232
8242
|
end
|
8233
8243
|
|
8234
|
-
# The output when you start the evaluation for the specified
|
8244
|
+
# The output when you start the evaluation for the specified Config
|
8235
8245
|
# rule.
|
8236
8246
|
#
|
8237
8247
|
# @see http://docs.aws.amazon.com/goto/WebAPI/config-2014-11-12/StartConfigRulesEvaluationResponse AWS API Documentation
|
@@ -8274,8 +8284,8 @@ module Aws::ConfigService
|
|
8274
8284
|
# }
|
8275
8285
|
#
|
8276
8286
|
# @!attribute [rw] config_rule_name
|
8277
|
-
# The list of names of
|
8278
|
-
#
|
8287
|
+
# The list of names of Config rules that you want to run remediation
|
8288
|
+
# execution for.
|
8279
8289
|
# @return [String]
|
8280
8290
|
#
|
8281
8291
|
# @!attribute [rw] resource_keys
|
@@ -8359,7 +8369,7 @@ module Aws::ConfigService
|
|
8359
8369
|
# `OrganizationConfigRule` and disables service access for
|
8360
8370
|
# `config-multiaccountsetup.amazonaws.com`.
|
8361
8371
|
#
|
8362
|
-
#
|
8372
|
+
# Config sets the state of the rule to:
|
8363
8373
|
#
|
8364
8374
|
# * `CREATE_SUCCESSFUL` when config rule has been created in the
|
8365
8375
|
# member account.
|