Class: Aws::ConfigService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ConfigService::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- lib/aws-sdk-configservice/client.rb
Overview
An API client for ConfigService. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::ConfigService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#batch_get_aggregate_resource_config(params = {}) ⇒ Types::BatchGetAggregateResourceConfigResponse
Returns the current configuration items for resources that are present in your Config aggregator.
-
#batch_get_resource_config(params = {}) ⇒ Types::BatchGetResourceConfigResponse
Returns the ‘BaseConfigurationItem` for one or more requested resources.
-
#delete_aggregation_authorization(params = {}) ⇒ Struct
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
-
#delete_config_rule(params = {}) ⇒ Struct
Deletes the specified Config rule and all of its evaluation results.
-
#delete_configuration_aggregator(params = {}) ⇒ Struct
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
-
#delete_configuration_recorder(params = {}) ⇒ Struct
Deletes the configuration recorder.
-
#delete_conformance_pack(params = {}) ⇒ Struct
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
-
#delete_delivery_channel(params = {}) ⇒ Struct
Deletes the delivery channel.
-
#delete_evaluation_results(params = {}) ⇒ Struct
Deletes the evaluation results for the specified Config rule.
-
#delete_organization_config_rule(params = {}) ⇒ Struct
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
-
#delete_organization_conformance_pack(params = {}) ⇒ Struct
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
-
#delete_pending_aggregation_request(params = {}) ⇒ Struct
Deletes pending authorization requests for a specified aggregator account in a specified region.
-
#delete_remediation_configuration(params = {}) ⇒ Struct
Deletes the remediation configuration.
-
#delete_remediation_exceptions(params = {}) ⇒ Types::DeleteRemediationExceptionsResponse
Deletes one or more remediation exceptions mentioned in the resource keys.
-
#delete_resource_config(params = {}) ⇒ Struct
Records the configuration state for a custom resource that has been deleted.
-
#delete_retention_configuration(params = {}) ⇒ Struct
Deletes the retention configuration.
-
#delete_stored_query(params = {}) ⇒ Struct
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
-
#deliver_config_snapshot(params = {}) ⇒ Types::DeliverConfigSnapshotResponse
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
-
#describe_aggregate_compliance_by_config_rules(params = {}) ⇒ Types::DescribeAggregateComplianceByConfigRulesResponse
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.
-
#describe_aggregate_compliance_by_conformance_packs(params = {}) ⇒ Types::DescribeAggregateComplianceByConformancePacksResponse
Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.
-
#describe_aggregation_authorizations(params = {}) ⇒ Types::DescribeAggregationAuthorizationsResponse
Returns a list of authorizations granted to various aggregator accounts and regions.
-
#describe_compliance_by_config_rule(params = {}) ⇒ Types::DescribeComplianceByConfigRuleResponse
Indicates whether the specified Config rules are compliant.
-
#describe_compliance_by_resource(params = {}) ⇒ Types::DescribeComplianceByResourceResponse
Indicates whether the specified Amazon Web Services resources are compliant.
-
#describe_config_rule_evaluation_status(params = {}) ⇒ Types::DescribeConfigRuleEvaluationStatusResponse
Returns status information for each of your Config managed rules.
-
#describe_config_rules(params = {}) ⇒ Types::DescribeConfigRulesResponse
Returns details about your Config rules.
-
#describe_configuration_aggregator_sources_status(params = {}) ⇒ Types::DescribeConfigurationAggregatorSourcesStatusResponse
Returns status information for sources within an aggregator.
-
#describe_configuration_aggregators(params = {}) ⇒ Types::DescribeConfigurationAggregatorsResponse
Returns the details of one or more configuration aggregators.
-
#describe_configuration_recorder_status(params = {}) ⇒ Types::DescribeConfigurationRecorderStatusResponse
Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder.
-
#describe_configuration_recorders(params = {}) ⇒ Types::DescribeConfigurationRecordersResponse
Returns the details for the specified configuration recorders.
-
#describe_conformance_pack_compliance(params = {}) ⇒ Types::DescribeConformancePackComplianceResponse
Returns compliance details for each rule in that conformance pack.
-
#describe_conformance_pack_status(params = {}) ⇒ Types::DescribeConformancePackStatusResponse
Provides one or more conformance packs deployment status.
-
#describe_conformance_packs(params = {}) ⇒ Types::DescribeConformancePacksResponse
Returns a list of one or more conformance packs.
-
#describe_delivery_channel_status(params = {}) ⇒ Types::DescribeDeliveryChannelStatusResponse
Returns the current status of the specified delivery channel.
-
#describe_delivery_channels(params = {}) ⇒ Types::DescribeDeliveryChannelsResponse
Returns details about the specified delivery channel.
-
#describe_organization_config_rule_statuses(params = {}) ⇒ Types::DescribeOrganizationConfigRuleStatusesResponse
Provides organization Config rule deployment status for an organization.
-
#describe_organization_config_rules(params = {}) ⇒ Types::DescribeOrganizationConfigRulesResponse
Returns a list of organization Config rules.
-
#describe_organization_conformance_pack_statuses(params = {}) ⇒ Types::DescribeOrganizationConformancePackStatusesResponse
Provides organization conformance pack deployment status for an organization.
-
#describe_organization_conformance_packs(params = {}) ⇒ Types::DescribeOrganizationConformancePacksResponse
Returns a list of organization conformance packs.
-
#describe_pending_aggregation_requests(params = {}) ⇒ Types::DescribePendingAggregationRequestsResponse
Returns a list of all pending aggregation requests.
-
#describe_remediation_configurations(params = {}) ⇒ Types::DescribeRemediationConfigurationsResponse
Returns the details of one or more remediation configurations.
-
#describe_remediation_exceptions(params = {}) ⇒ Types::DescribeRemediationExceptionsResponse
Returns the details of one or more remediation exceptions.
-
#describe_remediation_execution_status(params = {}) ⇒ Types::DescribeRemediationExecutionStatusResponse
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed.
-
#describe_retention_configurations(params = {}) ⇒ Types::DescribeRetentionConfigurationsResponse
Returns the details of one or more retention configurations.
-
#get_aggregate_compliance_details_by_config_rule(params = {}) ⇒ Types::GetAggregateComplianceDetailsByConfigRuleResponse
Returns the evaluation results for the specified Config rule for a specific resource in a rule.
-
#get_aggregate_config_rule_compliance_summary(params = {}) ⇒ Types::GetAggregateConfigRuleComplianceSummaryResponse
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
-
#get_aggregate_conformance_pack_compliance_summary(params = {}) ⇒ Types::GetAggregateConformancePackComplianceSummaryResponse
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.
-
#get_aggregate_discovered_resource_counts(params = {}) ⇒ Types::GetAggregateDiscoveredResourceCountsResponse
Returns the resource counts across accounts and regions that are present in your Config aggregator.
-
#get_aggregate_resource_config(params = {}) ⇒ Types::GetAggregateResourceConfigResponse
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
-
#get_compliance_details_by_config_rule(params = {}) ⇒ Types::GetComplianceDetailsByConfigRuleResponse
Returns the evaluation results for the specified Config rule.
-
#get_compliance_details_by_resource(params = {}) ⇒ Types::GetComplianceDetailsByResourceResponse
Returns the evaluation results for the specified Amazon Web Services resource.
-
#get_compliance_summary_by_config_rule(params = {}) ⇒ Types::GetComplianceSummaryByConfigRuleResponse
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
-
#get_compliance_summary_by_resource_type(params = {}) ⇒ Types::GetComplianceSummaryByResourceTypeResponse
Returns the number of resources that are compliant and the number that are noncompliant.
-
#get_conformance_pack_compliance_details(params = {}) ⇒ Types::GetConformancePackComplianceDetailsResponse
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
-
#get_conformance_pack_compliance_summary(params = {}) ⇒ Types::GetConformancePackComplianceSummaryResponse
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
-
#get_custom_rule_policy(params = {}) ⇒ Types::GetCustomRulePolicyResponse
Returns the policy definition containing the logic for your Config Custom Policy rule.
-
#get_discovered_resource_counts(params = {}) ⇒ Types::GetDiscoveredResourceCountsResponse
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
-
#get_organization_config_rule_detailed_status(params = {}) ⇒ Types::GetOrganizationConfigRuleDetailedStatusResponse
Returns detailed status for each member account within an organization for a given organization Config rule.
-
#get_organization_conformance_pack_detailed_status(params = {}) ⇒ Types::GetOrganizationConformancePackDetailedStatusResponse
Returns detailed status for each member account within an organization for a given organization conformance pack.
-
#get_organization_custom_rule_policy(params = {}) ⇒ Types::GetOrganizationCustomRulePolicyResponse
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
-
#get_resource_config_history(params = {}) ⇒ Types::GetResourceConfigHistoryResponse
For accurate reporting on the compliance status, you must record the ‘AWS::Config::ResourceCompliance` resource type.
-
#get_resource_evaluation_summary(params = {}) ⇒ Types::GetResourceEvaluationSummaryResponse
Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run.
-
#get_stored_query(params = {}) ⇒ Types::GetStoredQueryResponse
Returns the details of a specific stored query.
-
#list_aggregate_discovered_resources(params = {}) ⇒ Types::ListAggregateDiscoveredResourcesResponse
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.
-
#list_conformance_pack_compliance_scores(params = {}) ⇒ Types::ListConformancePackComplianceScoresResponse
Returns a list of conformance pack compliance scores.
-
#list_discovered_resources(params = {}) ⇒ Types::ListDiscoveredResourcesResponse
Accepts a resource type and returns a list of resource identifiers for the resources of that type.
-
#list_resource_evaluations(params = {}) ⇒ Types::ListResourceEvaluationsResponse
Returns a list of proactive resource evaluations.
-
#list_stored_queries(params = {}) ⇒ Types::ListStoredQueriesResponse
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for Config resource.
-
#put_aggregation_authorization(params = {}) ⇒ Types::PutAggregationAuthorizationResponse
Authorizes the aggregator account and region to collect data from the source account and region.
-
#put_config_rule(params = {}) ⇒ Struct
Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations.
-
#put_configuration_aggregator(params = {}) ⇒ Types::PutConfigurationAggregatorResponse
Creates and updates the configuration aggregator with the selected source accounts and regions.
-
#put_configuration_recorder(params = {}) ⇒ Struct
Creates a new configuration recorder to record configuration changes for specified resource types.
-
#put_conformance_pack(params = {}) ⇒ Types::PutConformancePackResponse
Creates or updates a conformance pack.
-
#put_delivery_channel(params = {}) ⇒ Struct
Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic.
-
#put_evaluations(params = {}) ⇒ Types::PutEvaluationsResponse
Used by an Lambda function to deliver evaluation results to Config.
-
#put_external_evaluation(params = {}) ⇒ Struct
Add or updates the evaluations for process checks.
-
#put_organization_config_rule(params = {}) ⇒ Types::PutOrganizationConfigRuleResponse
Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations.
-
#put_organization_conformance_pack(params = {}) ⇒ Types::PutOrganizationConformancePackResponse
Deploys conformance packs across member accounts in an Amazon Web Services Organization.
-
#put_remediation_configurations(params = {}) ⇒ Types::PutRemediationConfigurationsResponse
Adds or updates the remediation configuration with a specific Config rule with the selected target or action.
-
#put_remediation_exceptions(params = {}) ⇒ Types::PutRemediationExceptionsResponse
A remediation exception is when a specified resource is no longer considered for auto-remediation.
-
#put_resource_config(params = {}) ⇒ Struct
Records the configuration state for the resource provided in the request.
-
#put_retention_configuration(params = {}) ⇒ Types::PutRetentionConfigurationResponse
Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information.
-
#put_stored_query(params = {}) ⇒ Types::PutStoredQueryResponse
Saves a new query or updates an existing saved query.
-
#select_aggregate_resource_config(params = {}) ⇒ Types::SelectAggregateResourceConfigResponse
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
-
#select_resource_config(params = {}) ⇒ Types::SelectResourceConfigResponse
Accepts a structured query language (SQL) ‘SELECT` command, performs the corresponding search, and returns resource configurations matching the properties.
-
#start_config_rules_evaluation(params = {}) ⇒ Struct
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources.
-
#start_configuration_recorder(params = {}) ⇒ Struct
Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
-
#start_remediation_execution(params = {}) ⇒ Types::StartRemediationExecutionResponse
Runs an on-demand remediation for the specified Config rules against the last known remediation configuration.
-
#start_resource_evaluation(params = {}) ⇒ Types::StartResourceEvaluationResponse
Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules.
-
#stop_configuration_recorder(params = {}) ⇒ Struct
Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified resourceArn.
-
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'lib/aws-sdk-configservice/client.rb', line 429 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5923 5924 5925 |
# File 'lib/aws-sdk-configservice/client.rb', line 5923 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5926 5927 5928 |
# File 'lib/aws-sdk-configservice/client.rb', line 5926 def errors_module Errors end |
Instance Method Details
#batch_get_aggregate_resource_config(params = {}) ⇒ Types::BatchGetAggregateResourceConfigResponse
Returns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty ‘unprocessedResourceIdentifiers` list.
<note markdown=“1”> * The API does not return results for deleted resources.
-
The API does not return tags and relationships.
</note>
504 505 506 507 |
# File 'lib/aws-sdk-configservice/client.rb', line 504 def batch_get_aggregate_resource_config(params = {}, = {}) req = build_request(:batch_get_aggregate_resource_config, params) req.send_request() end |
#batch_get_resource_config(params = {}) ⇒ Types::BatchGetResourceConfigResponse
Returns the ‘BaseConfigurationItem` for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.
<note markdown=“1”> * The API does not return results for deleted resources.
-
The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.
</note>
571 572 573 574 |
# File 'lib/aws-sdk-configservice/client.rb', line 571 def batch_get_resource_config(params = {}, = {}) req = build_request(:batch_get_resource_config, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 |
# File 'lib/aws-sdk-configservice/client.rb', line 5901 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-configservice' context[:gem_version] = '1.113.0' Seahorse::Client::Request.new(handlers, context) end |
#delete_aggregation_authorization(params = {}) ⇒ Struct
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
598 599 600 601 |
# File 'lib/aws-sdk-configservice/client.rb', line 598 def (params = {}, = {}) req = build_request(:delete_aggregation_authorization, params) req.send_request() end |
#delete_config_rule(params = {}) ⇒ Struct
Deletes the specified Config rule and all of its evaluation results.
Config sets the state of a rule to ‘DELETING` until the deletion is complete. You cannot update a rule while it is in this state. If you make a `PutConfigRule` or `DeleteConfigRule` request for the rule, you will receive a `ResourceInUseException`.
You can check the state of a rule by using the ‘DescribeConfigRules` request.
628 629 630 631 |
# File 'lib/aws-sdk-configservice/client.rb', line 628 def delete_config_rule(params = {}, = {}) req = build_request(:delete_config_rule, params) req.send_request() end |
#delete_configuration_aggregator(params = {}) ⇒ Struct
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
651 652 653 654 |
# File 'lib/aws-sdk-configservice/client.rb', line 651 def delete_configuration_aggregator(params = {}, = {}) req = build_request(:delete_configuration_aggregator, params) req.send_request() end |
#delete_configuration_recorder(params = {}) ⇒ Struct
Deletes the configuration recorder.
After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.
This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the ‘GetResourceConfigHistory` action, but you will not be able to access this information in the Config console until you create a new configuration recorder.
685 686 687 688 |
# File 'lib/aws-sdk-configservice/client.rb', line 685 def delete_configuration_recorder(params = {}, = {}) req = build_request(:delete_configuration_recorder, params) req.send_request() end |
#delete_conformance_pack(params = {}) ⇒ Struct
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
Config sets the conformance pack to ‘DELETE_IN_PROGRESS` until the deletion is complete. You cannot update a conformance pack while it is in this state.
713 714 715 716 |
# File 'lib/aws-sdk-configservice/client.rb', line 713 def delete_conformance_pack(params = {}, = {}) req = build_request(:delete_conformance_pack, params) req.send_request() end |
#delete_delivery_channel(params = {}) ⇒ Struct
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
738 739 740 741 |
# File 'lib/aws-sdk-configservice/client.rb', line 738 def delete_delivery_channel(params = {}, = {}) req = build_request(:delete_delivery_channel, params) req.send_request() end |
#delete_evaluation_results(params = {}) ⇒ Struct
Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.
764 765 766 767 |
# File 'lib/aws-sdk-configservice/client.rb', line 764 def delete_evaluation_results(params = {}, = {}) req = build_request(:delete_evaluation_results, params) req.send_request() end |
#delete_organization_config_rule(params = {}) ⇒ Struct
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
Only a management account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ‘ListDelegatedAdministrator` permissions are added.
Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.
796 797 798 799 |
# File 'lib/aws-sdk-configservice/client.rb', line 796 def delete_organization_config_rule(params = {}, = {}) req = build_request(:delete_organization_config_rule, params) req.send_request() end |
#delete_organization_conformance_pack(params = {}) ⇒ Struct
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
Only a management account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations ‘ListDelegatedAdministrator` permissions are added.
Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
829 830 831 832 |
# File 'lib/aws-sdk-configservice/client.rb', line 829 def delete_organization_conformance_pack(params = {}, = {}) req = build_request(:delete_organization_conformance_pack, params) req.send_request() end |
#delete_pending_aggregation_request(params = {}) ⇒ Struct
Deletes pending authorization requests for a specified aggregator account in a specified region.
856 857 858 859 |
# File 'lib/aws-sdk-configservice/client.rb', line 856 def delete_pending_aggregation_request(params = {}, = {}) req = build_request(:delete_pending_aggregation_request, params) req.send_request() end |
#delete_remediation_configuration(params = {}) ⇒ Struct
Deletes the remediation configuration.
883 884 885 886 |
# File 'lib/aws-sdk-configservice/client.rb', line 883 def delete_remediation_configuration(params = {}, = {}) req = build_request(:delete_remediation_configuration, params) req.send_request() end |
#delete_remediation_exceptions(params = {}) ⇒ Types::DeleteRemediationExceptionsResponse
Deletes one or more remediation exceptions mentioned in the resource keys.
<note markdown=“1”> Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
</note>
934 935 936 937 |
# File 'lib/aws-sdk-configservice/client.rb', line 934 def delete_remediation_exceptions(params = {}, = {}) req = build_request(:delete_remediation_exceptions, params) req.send_request() end |
#delete_resource_config(params = {}) ⇒ Struct
Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.
963 964 965 966 |
# File 'lib/aws-sdk-configservice/client.rb', line 963 def delete_resource_config(params = {}, = {}) req = build_request(:delete_resource_config, params) req.send_request() end |
#delete_retention_configuration(params = {}) ⇒ Struct
Deletes the retention configuration.
985 986 987 988 |
# File 'lib/aws-sdk-configservice/client.rb', line 985 def delete_retention_configuration(params = {}, = {}) req = build_request(:delete_retention_configuration, params) req.send_request() end |
#delete_stored_query(params = {}) ⇒ Struct
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
1008 1009 1010 1011 |
# File 'lib/aws-sdk-configservice/client.rb', line 1008 def delete_stored_query(params = {}, = {}) req = build_request(:delete_stored_query, params) req.send_request() end |
#deliver_config_snapshot(params = {}) ⇒ Types::DeliverConfigSnapshotResponse
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the following notifications using an Amazon SNS topic that you have specified.
-
Notification of the start of the delivery.
-
Notification of the completion of the delivery, if the delivery was successfully completed.
-
Notification of delivery failure, if the delivery failed.
1047 1048 1049 1050 |
# File 'lib/aws-sdk-configservice/client.rb', line 1047 def deliver_config_snapshot(params = {}, = {}) req = build_request(:deliver_config_snapshot, params) req.send_request() end |
#describe_aggregate_compliance_by_config_rules(params = {}) ⇒ Types::DescribeAggregateComplianceByConfigRulesResponse
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
<note markdown=“1”> The results can return an empty result page, but if you have a ‘nextToken`, the results are displayed on the next page.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1111 1112 1113 1114 |
# File 'lib/aws-sdk-configservice/client.rb', line 1111 def describe_aggregate_compliance_by_config_rules(params = {}, = {}) req = build_request(:describe_aggregate_compliance_by_config_rules, params) req.send_request() end |
#describe_aggregate_compliance_by_conformance_packs(params = {}) ⇒ Types::DescribeAggregateComplianceByConformancePacksResponse
Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
<note markdown=“1”> The results can return an empty result page, but if you have a ‘nextToken`, the results are displayed on the next page.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1180 1181 1182 1183 |
# File 'lib/aws-sdk-configservice/client.rb', line 1180 def describe_aggregate_compliance_by_conformance_packs(params = {}, = {}) req = build_request(:describe_aggregate_compliance_by_conformance_packs, params) req.send_request() end |
#describe_aggregation_authorizations(params = {}) ⇒ Types::DescribeAggregationAuthorizationsResponse
Returns a list of authorizations granted to various aggregator accounts and regions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1223 1224 1225 1226 |
# File 'lib/aws-sdk-configservice/client.rb', line 1223 def (params = {}, = {}) req = build_request(:describe_aggregation_authorizations, params) req.send_request() end |
#describe_compliance_by_config_rule(params = {}) ⇒ Types::DescribeComplianceByConfigRuleResponse
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.
A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.
If Config has no current evaluation results for the rule, it returns ‘INSUFFICIENT_DATA`. This result might indicate one of the following conditions:
-
Config has never invoked an evaluation for the rule. To check whether it has, use the ‘DescribeConfigRuleEvaluationStatus` action to get the `LastSuccessfulInvocationTime` and `LastFailedInvocationTime`.
-
The rule’s Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the ‘config:PutEvaluations` permission. If the rule is a custom rule, verify that the Lambda execution role includes the `config:PutEvaluations` permission.
-
The rule’s Lambda function has returned ‘NOT_APPLICABLE` for all evaluation results. This can occur if the resources were deleted or removed from the rule’s scope.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1292 1293 1294 1295 |
# File 'lib/aws-sdk-configservice/client.rb', line 1292 def describe_compliance_by_config_rule(params = {}, = {}) req = build_request(:describe_compliance_by_config_rule, params) req.send_request() end |
#describe_compliance_by_resource(params = {}) ⇒ Types::DescribeComplianceByResourceResponse
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If Config has no current evaluation results for the resource, it returns ‘INSUFFICIENT_DATA`. This result might indicate one of the following conditions about the rules that evaluate the resource:
-
Config has never invoked an evaluation for the rule. To check whether it has, use the ‘DescribeConfigRuleEvaluationStatus` action to get the `LastSuccessfulInvocationTime` and `LastFailedInvocationTime`.
-
The rule’s Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the ‘config:PutEvaluations` permission. If the rule is a custom rule, verify that the Lambda execution role includes the `config:PutEvaluations` permission.
-
The rule’s Lambda function has returned ‘NOT_APPLICABLE` for all evaluation results. This can occur if the resources were deleted or removed from the rule’s scope.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1379 1380 1381 1382 |
# File 'lib/aws-sdk-configservice/client.rb', line 1379 def describe_compliance_by_resource(params = {}, = {}) req = build_request(:describe_compliance_by_resource, params) req.send_request() end |
#describe_config_rule_evaluation_status(params = {}) ⇒ Types::DescribeConfigRuleEvaluationStatusResponse
Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1450 1451 1452 1453 |
# File 'lib/aws-sdk-configservice/client.rb', line 1450 def describe_config_rule_evaluation_status(params = {}, = {}) req = build_request(:describe_config_rule_evaluation_status, params) req.send_request() end |
#describe_config_rules(params = {}) ⇒ Types::DescribeConfigRulesResponse
Returns details about your Config rules.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1525 1526 1527 1528 |
# File 'lib/aws-sdk-configservice/client.rb', line 1525 def describe_config_rules(params = {}, = {}) req = build_request(:describe_config_rules, params) req.send_request() end |
#describe_configuration_aggregator_sources_status(params = {}) ⇒ Types::DescribeConfigurationAggregatorSourcesStatusResponse
Returns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1588 1589 1590 1591 |
# File 'lib/aws-sdk-configservice/client.rb', line 1588 def describe_configuration_aggregator_sources_status(params = {}, = {}) req = build_request(:describe_configuration_aggregator_sources_status, params) req.send_request() end |
#describe_configuration_aggregators(params = {}) ⇒ Types::DescribeConfigurationAggregatorsResponse
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1648 1649 1650 1651 |
# File 'lib/aws-sdk-configservice/client.rb', line 1648 def describe_configuration_aggregators(params = {}, = {}) req = build_request(:describe_configuration_aggregators, params) req.send_request() end |
#describe_configuration_recorder_status(params = {}) ⇒ Types::DescribeConfigurationRecorderStatusResponse
Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
<note markdown=“1”> >You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
</note>
1696 1697 1698 1699 |
# File 'lib/aws-sdk-configservice/client.rb', line 1696 def describe_configuration_recorder_status(params = {}, = {}) req = build_request(:describe_configuration_recorder_status, params) req.send_request() end |
#describe_configuration_recorders(params = {}) ⇒ Types::DescribeConfigurationRecordersResponse
Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.
<note markdown=“1”> You can specify only one configuration recorder for each Amazon Web Services Region for each account.
</note>
1746 1747 1748 1749 |
# File 'lib/aws-sdk-configservice/client.rb', line 1746 def describe_configuration_recorders(params = {}, = {}) req = build_request(:describe_configuration_recorders, params) req.send_request() end |
#describe_conformance_pack_compliance(params = {}) ⇒ Types::DescribeConformancePackComplianceResponse
Returns compliance details for each rule in that conformance pack.
<note markdown=“1”> You must provide exact rule names.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1805 1806 1807 1808 |
# File 'lib/aws-sdk-configservice/client.rb', line 1805 def describe_conformance_pack_compliance(params = {}, = {}) req = build_request(:describe_conformance_pack_compliance, params) req.send_request() end |
#describe_conformance_pack_status(params = {}) ⇒ Types::DescribeConformancePackStatusResponse
Provides one or more conformance packs deployment status.
<note markdown=“1”> If there are no conformance packs then you will see an empty result.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1858 1859 1860 1861 |
# File 'lib/aws-sdk-configservice/client.rb', line 1858 def describe_conformance_pack_status(params = {}, = {}) req = build_request(:describe_conformance_pack_status, params) req.send_request() end |
#describe_conformance_packs(params = {}) ⇒ Types::DescribeConformancePacksResponse
Returns a list of one or more conformance packs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1913 1914 1915 1916 |
# File 'lib/aws-sdk-configservice/client.rb', line 1913 def describe_conformance_packs(params = {}, = {}) req = build_request(:describe_conformance_packs, params) req.send_request() end |
#describe_delivery_channel_status(params = {}) ⇒ Types::DescribeDeliveryChannelStatusResponse
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
<note markdown=“1”> Currently, you can specify only one delivery channel per region in your account.
</note>
1965 1966 1967 1968 |
# File 'lib/aws-sdk-configservice/client.rb', line 1965 def describe_delivery_channel_status(params = {}, = {}) req = build_request(:describe_delivery_channel_status, params) req.send_request() end |
#describe_delivery_channels(params = {}) ⇒ Types::DescribeDeliveryChannelsResponse
Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
<note markdown=“1”> Currently, you can specify only one delivery channel per region in your account.
</note>
2006 2007 2008 2009 |
# File 'lib/aws-sdk-configservice/client.rb', line 2006 def describe_delivery_channels(params = {}, = {}) req = build_request(:describe_delivery_channels, params) req.send_request() end |
#describe_organization_config_rule_statuses(params = {}) ⇒ Types::DescribeOrganizationConfigRuleStatusesResponse
Provides organization Config rule deployment status for an organization.
<note markdown=“1”> The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated
response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2068 2069 2070 2071 |
# File 'lib/aws-sdk-configservice/client.rb', line 2068 def describe_organization_config_rule_statuses(params = {}, = {}) req = build_request(:describe_organization_config_rule_statuses, params) req.send_request() end |
#describe_organization_config_rules(params = {}) ⇒ Types::DescribeOrganizationConfigRulesResponse
Returns a list of organization Config rules.
<note markdown=“1”> When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization
Config rule names. It is only applicable, when you request all the organization Config rules.
*For accounts within an organization*
If you deploy an organizational rule or conformance pack in an
organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won’t be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The ‘DescribeOrganizationConfigRules` and `DescribeOrganizationConformancePacks` APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2175 2176 2177 2178 |
# File 'lib/aws-sdk-configservice/client.rb', line 2175 def describe_organization_config_rules(params = {}, = {}) req = build_request(:describe_organization_config_rules, params) req.send_request() end |
#describe_organization_conformance_pack_statuses(params = {}) ⇒ Types::DescribeOrganizationConformancePackStatusesResponse
Provides organization conformance pack deployment status for an organization.
<note markdown=“1”> The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated
response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2237 2238 2239 2240 |
# File 'lib/aws-sdk-configservice/client.rb', line 2237 def describe_organization_conformance_pack_statuses(params = {}, = {}) req = build_request(:describe_organization_conformance_pack_statuses, params) req.send_request() end |
#describe_organization_conformance_packs(params = {}) ⇒ Types::DescribeOrganizationConformancePacksResponse
Returns a list of organization conformance packs.
<note markdown=“1”> When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization
conformance packs names. They are only applicable, when you request all the organization conformance packs.
*For accounts within an organization*
If you deploy an organizational rule or conformance pack in an
organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won’t be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The ‘DescribeOrganizationConfigRules` and `DescribeOrganizationConformancePacks` APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2314 2315 2316 2317 |
# File 'lib/aws-sdk-configservice/client.rb', line 2314 def describe_organization_conformance_packs(params = {}, = {}) req = build_request(:describe_organization_conformance_packs, params) req.send_request() end |
#describe_pending_aggregation_requests(params = {}) ⇒ Types::DescribePendingAggregationRequestsResponse
Returns a list of all pending aggregation requests.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2354 2355 2356 2357 |
# File 'lib/aws-sdk-configservice/client.rb', line 2354 def describe_pending_aggregation_requests(params = {}, = {}) req = build_request(:describe_pending_aggregation_requests, params) req.send_request() end |
#describe_remediation_configurations(params = {}) ⇒ Types::DescribeRemediationConfigurationsResponse
Returns the details of one or more remediation configurations.
2399 2400 2401 2402 |
# File 'lib/aws-sdk-configservice/client.rb', line 2399 def describe_remediation_configurations(params = {}, = {}) req = build_request(:describe_remediation_configurations, params) req.send_request() end |
#describe_remediation_exceptions(params = {}) ⇒ Types::DescribeRemediationExceptionsResponse
Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
<note markdown=“1”> Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated
response.
Limit and next token are not applicable if you request resources in
batch. It is only applicable, when you request all resources.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2473 2474 2475 2476 |
# File 'lib/aws-sdk-configservice/client.rb', line 2473 def describe_remediation_exceptions(params = {}, = {}) req = build_request(:describe_remediation_exceptions, params) req.send_request() end |
#describe_remediation_execution_status(params = {}) ⇒ Types::DescribeRemediationExecutionStatusResponse
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2541 2542 2543 2544 |
# File 'lib/aws-sdk-configservice/client.rb', line 2541 def describe_remediation_execution_status(params = {}, = {}) req = build_request(:describe_remediation_execution_status, params) req.send_request() end |
#describe_retention_configurations(params = {}) ⇒ Types::DescribeRetentionConfigurationsResponse
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
<note markdown=“1”> Currently, Config supports only one retention configuration per region in your account.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2594 2595 2596 2597 |
# File 'lib/aws-sdk-configservice/client.rb', line 2594 def describe_retention_configurations(params = {}, = {}) req = build_request(:describe_retention_configurations, params) req.send_request() end |
#get_aggregate_compliance_details_by_config_rule(params = {}) ⇒ Types::GetAggregateComplianceDetailsByConfigRuleResponse
Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
<note markdown=“1”> The results can return an empty result page. But if you have a ‘nextToken`, the results are displayed on the next page.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2679 2680 2681 2682 |
# File 'lib/aws-sdk-configservice/client.rb', line 2679 def get_aggregate_compliance_details_by_config_rule(params = {}, = {}) req = build_request(:get_aggregate_compliance_details_by_config_rule, params) req.send_request() end |
#get_aggregate_config_rule_compliance_summary(params = {}) ⇒ Types::GetAggregateConfigRuleComplianceSummaryResponse
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
<note markdown=“1”> The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2748 2749 2750 2751 |
# File 'lib/aws-sdk-configservice/client.rb', line 2748 def get_aggregate_config_rule_compliance_summary(params = {}, = {}) req = build_request(:get_aggregate_config_rule_compliance_summary, params) req.send_request() end |
#get_aggregate_conformance_pack_compliance_summary(params = {}) ⇒ Types::GetAggregateConformancePackComplianceSummaryResponse
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
<note markdown=“1”> The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2816 2817 2818 2819 |
# File 'lib/aws-sdk-configservice/client.rb', line 2816 def get_aggregate_conformance_pack_compliance_summary(params = {}, = {}) req = build_request(:get_aggregate_conformance_pack_compliance_summary, params) req.send_request() end |
#get_aggregate_discovered_resource_counts(params = {}) ⇒ Types::GetAggregateDiscoveredResourceCountsResponse
Returns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters and GroupByKey.
For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2885 2886 2887 2888 |
# File 'lib/aws-sdk-configservice/client.rb', line 2885 def get_aggregate_discovered_resource_counts(params = {}, = {}) req = build_request(:get_aggregate_discovered_resource_counts, params) req.send_request() end |
#get_aggregate_resource_config(params = {}) ⇒ Types::GetAggregateResourceConfigResponse
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
2950 2951 2952 2953 |
# File 'lib/aws-sdk-configservice/client.rb', line 2950 def get_aggregate_resource_config(params = {}, = {}) req = build_request(:get_aggregate_resource_config, params) req.send_request() end |
#get_compliance_details_by_config_rule(params = {}) ⇒ Types::GetComplianceDetailsByConfigRuleResponse
Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3015 3016 3017 3018 |
# File 'lib/aws-sdk-configservice/client.rb', line 3015 def get_compliance_details_by_config_rule(params = {}, = {}) req = build_request(:get_compliance_details_by_config_rule, params) req.send_request() end |
#get_compliance_details_by_resource(params = {}) ⇒ Types::GetComplianceDetailsByResourceResponse
Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3090 3091 3092 3093 |
# File 'lib/aws-sdk-configservice/client.rb', line 3090 def get_compliance_details_by_resource(params = {}, = {}) req = build_request(:get_compliance_details_by_resource, params) req.send_request() end |
#get_compliance_summary_by_config_rule(params = {}) ⇒ Types::GetComplianceSummaryByConfigRuleResponse
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
3114 3115 3116 3117 |
# File 'lib/aws-sdk-configservice/client.rb', line 3114 def get_compliance_summary_by_config_rule(params = {}, = {}) req = build_request(:get_compliance_summary_by_config_rule, params) req.send_request() end |
#get_compliance_summary_by_resource_type(params = {}) ⇒ Types::GetComplianceSummaryByResourceTypeResponse
Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.
3157 3158 3159 3160 |
# File 'lib/aws-sdk-configservice/client.rb', line 3157 def get_compliance_summary_by_resource_type(params = {}, = {}) req = build_request(:get_compliance_summary_by_resource_type, params) req.send_request() end |
#get_conformance_pack_compliance_details(params = {}) ⇒ Types::GetConformancePackComplianceDetailsResponse
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3221 3222 3223 3224 |
# File 'lib/aws-sdk-configservice/client.rb', line 3221 def get_conformance_pack_compliance_details(params = {}, = {}) req = build_request(:get_conformance_pack_compliance_details, params) req.send_request() end |
#get_conformance_pack_compliance_summary(params = {}) ⇒ Types::GetConformancePackComplianceSummaryResponse
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3266 3267 3268 3269 |
# File 'lib/aws-sdk-configservice/client.rb', line 3266 def get_conformance_pack_compliance_summary(params = {}, = {}) req = build_request(:get_conformance_pack_compliance_summary, params) req.send_request() end |
#get_custom_rule_policy(params = {}) ⇒ Types::GetCustomRulePolicyResponse
Returns the policy definition containing the logic for your Config Custom Policy rule.
3295 3296 3297 3298 |
# File 'lib/aws-sdk-configservice/client.rb', line 3295 def get_custom_rule_policy(params = {}, = {}) req = build_request(:get_custom_rule_policy, params) req.send_request() end |
#get_discovered_resource_counts(params = {}) ⇒ Types::GetDiscoveredResourceCountsResponse
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Example
-
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
-
You make a call to the ‘GetDiscoveredResourceCounts` action and specify that you want all resource types.
-
Config returns the following:
-
The resource types (EC2 instances, IAM users, and S3 buckets).
-
The number of each resource type (25, 20, and 15).
-
The total number of all resources (60).
-
The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the ‘limit` parameter. The response includes a `nextToken` string. To get the next page of results, run the request again and specify the string for the `nextToken` parameter.
<note markdown=“1”> If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
* You are a new Config customer.
-
You just enabled resource recording.
It might take a few minutes for Config to record and count your
resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3394 3395 3396 3397 |
# File 'lib/aws-sdk-configservice/client.rb', line 3394 def get_discovered_resource_counts(params = {}, = {}) req = build_request(:get_discovered_resource_counts, params) req.send_request() end |
#get_organization_config_rule_detailed_status(params = {}) ⇒ Types::GetOrganizationConfigRuleDetailedStatusResponse
Returns detailed status for each member account within an organization for a given organization Config rule.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3452 3453 3454 3455 |
# File 'lib/aws-sdk-configservice/client.rb', line 3452 def get_organization_config_rule_detailed_status(params = {}, = {}) req = build_request(:get_organization_config_rule_detailed_status, params) req.send_request() end |
#get_organization_conformance_pack_detailed_status(params = {}) ⇒ Types::GetOrganizationConformancePackDetailedStatusResponse
Returns detailed status for each member account within an organization for a given organization conformance pack.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3510 3511 3512 3513 |
# File 'lib/aws-sdk-configservice/client.rb', line 3510 def get_organization_conformance_pack_detailed_status(params = {}, = {}) req = build_request(:get_organization_conformance_pack_detailed_status, params) req.send_request() end |
#get_organization_custom_rule_policy(params = {}) ⇒ Types::GetOrganizationCustomRulePolicyResponse
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
3539 3540 3541 3542 |
# File 'lib/aws-sdk-configservice/client.rb', line 3539 def get_organization_custom_rule_policy(params = {}, = {}) req = build_request(:get_organization_custom_rule_policy, params) req.send_request() end |
#get_resource_config_history(params = {}) ⇒ Types::GetResourceConfigHistoryResponse
For accurate reporting on the compliance status, you must record the ‘AWS::Config::ResourceCompliance` resource type. For more information, see [Selecting Which Resources Config Records].
Returns a list of ‘ConfigurationItems` for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your `ConfigurationItems` between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the `ConfigurationItems` for the specified retention period.
The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the ‘limit` parameter. The response includes a `nextToken` string. To get the next page of results, run the request again and specify the string for the `nextToken` parameter.
<note markdown=“1”> Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified ‘limit`. In such cases, you can make another call, using the `nextToken`.
</note>
[1]: docs.aws.amazon.com/config/latest/developerguide/select-resources.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3656 3657 3658 3659 |
# File 'lib/aws-sdk-configservice/client.rb', line 3656 def get_resource_config_history(params = {}, = {}) req = build_request(:get_resource_config_history, params) req.send_request() end |
#get_resource_evaluation_summary(params = {}) ⇒ Types::GetResourceEvaluationSummaryResponse
Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.
<note markdown=“1”> To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the
- GetComplianceDetailsByResource][1
-
API. For more information, see the
- Examples][2
-
section.
</note>
[1]: docs.aws.amazon.com/config/latest/APIReference/API_GetComplianceDetailsByResource.html [2]: docs.aws.amazon.com/config/latest/APIReference/API_GetResourceEvaluationSummary.html#API_GetResourceEvaluationSummary_Examples
3718 3719 3720 3721 |
# File 'lib/aws-sdk-configservice/client.rb', line 3718 def get_resource_evaluation_summary(params = {}, = {}) req = build_request(:get_resource_evaluation_summary, params) req.send_request() end |
#get_stored_query(params = {}) ⇒ Types::GetStoredQueryResponse
Returns the details of a specific stored query.
3750 3751 3752 3753 |
# File 'lib/aws-sdk-configservice/client.rb', line 3750 def get_stored_query(params = {}, = {}) req = build_request(:get_stored_query, params) req.send_request() end |
#list_aggregate_discovered_resources(params = {}) ⇒ Types::ListAggregateDiscoveredResourcesResponse
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.
For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type ‘AWS::EC2::Instance` then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3822 3823 3824 3825 |
# File 'lib/aws-sdk-configservice/client.rb', line 3822 def list_aggregate_discovered_resources(params = {}, = {}) req = build_request(:list_aggregate_discovered_resources, params) req.send_request() end |
#list_conformance_pack_compliance_scores(params = {}) ⇒ Types::ListConformancePackComplianceScoresResponse
Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.
<note markdown=“1”> Conformance packs with no evaluation results will have a compliance score of ‘INSUFFICIENT_DATA`.
</note>
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3908 3909 3910 3911 |
# File 'lib/aws-sdk-configservice/client.rb', line 3908 def list_conformance_pack_compliance_scores(params = {}, = {}) req = build_request(:list_conformance_pack_compliance_scores, params) req.send_request() end |
#list_discovered_resources(params = {}) ⇒ Types::ListDiscoveredResourcesResponse
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that Config has discovered, including those that Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
<note markdown=“1”> You can specify either resource IDs or a resource name, but not both, in the same request.
</note>
The response is paginated. By default, Config lists 100 resource identifiers on each page. You can customize this number with the ‘limit` parameter. The response includes a `nextToken` string. To get the next page of results, run the request again and specify the string for the `nextToken` parameter.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3990 3991 3992 3993 |
# File 'lib/aws-sdk-configservice/client.rb', line 3990 def list_discovered_resources(params = {}, = {}) req = build_request(:list_discovered_resources, params) req.send_request() end |
#list_resource_evaluations(params = {}) ⇒ Types::ListResourceEvaluationsResponse
Returns a list of proactive resource evaluations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4043 4044 4045 4046 |
# File 'lib/aws-sdk-configservice/client.rb', line 4043 def list_resource_evaluations(params = {}, = {}) req = build_request(:list_resource_evaluations, params) req.send_request() end |
#list_stored_queries(params = {}) ⇒ Types::ListStoredQueriesResponse
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4085 4086 4087 4088 |
# File 'lib/aws-sdk-configservice/client.rb', line 4085 def list_stored_queries(params = {}, = {}) req = build_request(:list_stored_queries, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for Config resource.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4132 4133 4134 4135 |
# File 'lib/aws-sdk-configservice/client.rb', line 4132 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#put_aggregation_authorization(params = {}) ⇒ Types::PutAggregationAuthorizationResponse
Authorizes the aggregator account and region to collect data from the source account and region.
<note markdown=“1”> ‘PutAggregationAuthorization` is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different `tags` values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, `tags` will not be updated, even if they are different.
</note>
4186 4187 4188 4189 |
# File 'lib/aws-sdk-configservice/client.rb', line 4186 def (params = {}, = {}) req = build_request(:put_aggregation_authorization, params) req.send_request() end |
#put_config_rule(params = {}) ⇒ Struct
Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see [ **Service Limits** ][1] in the *Config Developer Guide*.
There are two types of rules: *Config Managed Rules* and *Config Custom Rules*. You can use ‘PutConfigRule` to create both Config Managed Rules and Config Custom Rules.
Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see [List of Config Managed Rules]. If you are adding an Config managed rule, you must specify the rule’s identifier for the ‘SourceIdentifier` key.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ([ Lambda Developer Guide]) and with Guard ([Guard GitHub Repository]), a policy-as-code language. Config custom rules created with Lambda are called *Config Custom Lambda Rules* and Config custom rules created with Guard are called *Config Custom Policy Rules*.
If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function that the rule invokes to evaluate your resources. When you use ‘PutConfigRule` to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. You specify the ARN in the `SourceIdentifier` key. This key is part of the `Source` object, which is part of the `ConfigRule` object.
For any new Config rule that you add, specify the ‘ConfigRuleName` in the `ConfigRule` object. Do not specify the `ConfigRuleArn` or the `ConfigRuleId`. These values are generated by Config for new rules.
If you are updating a rule that you added previously, you can specify the rule by ‘ConfigRuleName`, `ConfigRuleId`, or `ConfigRuleArn` in the `ConfigRule` data type that you use in this request.
For more information about developing and using Config rules, see
- Evaluating Resources with Config Rules][5
-
in the *Config Developer
Guide*.
<note markdown=“1”> ‘PutConfigRule` is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different `tags` values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, `tags` will not be updated, even if they are different.
</note>
[1]: docs.aws.amazon.com/config/latest/developerguide/configlimits.html [2]: docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html [3]: docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function [4]: github.com/aws-cloudformation/cloudformation-guard [5]: docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html
4309 4310 4311 4312 |
# File 'lib/aws-sdk-configservice/client.rb', line 4309 def put_config_rule(params = {}, = {}) req = build_request(:put_config_rule, params) req.send_request() end |
#put_configuration_aggregator(params = {}) ⇒ Types::PutConfigurationAggregatorResponse
Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
‘accountIds` that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call `DescribeConfigurationAggregators` to get the previous accounts and then append new ones.
<note markdown=“1”> Config should be enabled in source accounts and regions you want to aggregate.
If your source type is an organization, you must be signed in to the
management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls ‘EnableAwsServiceAccess` API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls `ListDelegatedAdministrators` API to verify whether the caller is a valid delegated administrator.
To register a delegated administrator, see [Register a Delegated
Administrator] in the *Config developer guide*.
</note>
<note markdown=“1”> ‘PutConfigurationAggregator` is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different `tags` values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, `tags` will not be updated, even if they are different.
</note>
4415 4416 4417 4418 |
# File 'lib/aws-sdk-configservice/client.rb', line 4415 def put_configuration_aggregator(params = {}, = {}) req = build_request(:put_configuration_aggregator, params) req.send_request() end |
#put_configuration_recorder(params = {}) ⇒ Struct
Creates a new configuration recorder to record configuration changes for specified resource types.
You can also use this action to change the ‘roleARN` or the `recordingGroup` of an existing recorder. For more information, see [ **Managing the Configuration Recorder** ][1] in the *Config Developer Guide*.
<note markdown=“1”> You can specify only one configuration recorder for each Amazon Web Services Region for each account.
If the configuration recorder does not have the `recordingGroup` field
specified, the default is to record all supported resource types.
</note>
[1]: docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html
4480 4481 4482 4483 |
# File 'lib/aws-sdk-configservice/client.rb', line 4480 def put_configuration_recorder(params = {}, = {}) req = build_request(:put_configuration_recorder, params) req.send_request() end |
#put_conformance_pack(params = {}) ⇒ Types::PutConformancePackResponse
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see [ **Service Limits** ][1] in the *Config Developer Guide*.
This API creates a service-linked role ‘AWSServiceRoleForConfigConforms` in your account. The service-linked role is created only when the role does not exist in your account.
<note markdown=“1”> You must specify only one of the follow parameters: ‘TemplateS3Uri`, `TemplateBody` or `TemplateSSMDocumentDetails`.
</note>
[1]: docs.aws.amazon.com/config/latest/developerguide/configlimits.html
4590 4591 4592 4593 |
# File 'lib/aws-sdk-configservice/client.rb', line 4590 def put_conformance_pack(params = {}, = {}) req = build_request(:put_conformance_pack, params) req.send_request() end |
#put_delivery_channel(params = {}) ⇒ Struct
Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic. For more information, see [Notifications that Config Sends to an Amazon SNS topic].
Before you can create a delivery channel, you must create a configuration recorder.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
<note markdown=“1”> You can have only one delivery channel per region in your account.
</note>
[1]: docs.aws.amazon.com/config/latest/developerguide/notifications-for-AWS-Config.html
4644 4645 4646 4647 |
# File 'lib/aws-sdk-configservice/client.rb', line 4644 def put_delivery_channel(params = {}, = {}) req = build_request(:put_delivery_channel, params) req.send_request() end |
#put_evaluations(params = {}) ⇒ Types::PutEvaluationsResponse
Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.
4706 4707 4708 4709 |
# File 'lib/aws-sdk-configservice/client.rb', line 4706 def put_evaluations(params = {}, = {}) req = build_request(:put_evaluations, params) req.send_request() end |
#put_external_evaluation(params = {}) ⇒ Struct
Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.
4740 4741 4742 4743 |
# File 'lib/aws-sdk-configservice/client.rb', line 4740 def put_external_evaluation(params = {}, = {}) req = build_request(:put_external_evaluation, params) req.send_request() end |
#put_organization_config_rule(params = {}) ⇒ Types::PutOrganizationConfigRuleResponse
Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see [ **Service Limits** ][1] in the *Config Developer Guide*.
Only a management account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations ‘ListDelegatedAdministrator` permissions are added. An organization can have up to 3 delegated administrators.
This API enables organization service access through the ‘EnableAWSServiceAccess` action and creates a service-linked role `AWSServiceRoleForConfigMultiAccountSetup` in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. Config verifies the existence of role with `GetRole` action.
To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization ‘register-delegated-administrator` for `config-multiaccountsetup.amazonaws.com`.
There are two types of rules: *Config Managed Rules* and *Config Custom Rules*. You can use ‘PutOrganizationConfigRule` to create both Config Managed Rules and Config Custom Rules.
Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see [List of Config Managed Rules]. If you are adding an Config managed rule, you must specify the rule’s identifier for the ‘RuleIdentifier` key.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ([ Lambda Developer Guide]) and with Guard ([Guard GitHub Repository]), a policy-as-code language. Config custom rules created with Lambda are called *Config Custom Lambda Rules* and Config custom rules created with Guard are called *Config Custom Policy Rules*.
If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function in the management account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. When you use ‘PutOrganizationConfigRule` to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function.
<note markdown=“1”> Prerequisite: Ensure you call ‘EnableAllFeatures` API to enable all features in an organization.
Make sure to specify one of either
‘OrganizationCustomPolicyRuleMetadata` for Custom Policy rules, `OrganizationCustomRuleMetadata` for Custom Lambda rules, or `OrganizationManagedRuleMetadata` for managed rules.
</note>
[1]: docs.aws.amazon.com/config/latest/developerguide/configlimits.html [2]: docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html [3]: docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function [4]: github.com/aws-cloudformation/cloudformation-guard
4898 4899 4900 4901 |
# File 'lib/aws-sdk-configservice/client.rb', line 4898 def put_organization_config_rule(params = {}, = {}) req = build_request(:put_organization_config_rule, params) req.send_request() end |
#put_organization_conformance_pack(params = {}) ⇒ Types::PutOrganizationConformancePackResponse
Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see [ **Service Limits** ][1] in the *Config Developer Guide*.
Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations ‘ListDelegatedAdministrator` permissions are added. An organization can have up to 3 delegated administrators.
This API enables organization service access for ‘config-multiaccountsetup.amazonaws.com` through the `EnableAWSServiceAccess` action and creates a service-linked role `AWSServiceRoleForConfigMultiAccountSetup` in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization `register-delegate-admin` for `config-multiaccountsetup.amazonaws.com`.
<note markdown=“1”> Prerequisite: Ensure you call ‘EnableAllFeatures` API to enable all features in an organization.
You must specify either the `TemplateS3Uri` or the `TemplateBody`
parameter, but not both. If you provide both Config uses the ‘TemplateS3Uri` parameter and ignores the `TemplateBody` parameter.
Config sets the state of a conformance pack to CREATE\_IN\_PROGRESS
and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
</note>
[1]: docs.aws.amazon.com/config/latest/developerguide/configlimits.html
5016 5017 5018 5019 |
# File 'lib/aws-sdk-configservice/client.rb', line 5016 def put_organization_conformance_pack(params = {}, = {}) req = build_request(:put_organization_conformance_pack, params) req.send_request() end |
#put_remediation_configurations(params = {}) ⇒ Types::PutRemediationConfigurationsResponse
Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the ‘RemediationConfiguration` object for the Config rule. The Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target.
<note markdown=“1”> **Be aware of backward incompatible changes**
If you make backward incompatible changes to the SSM document, you
must call this again to ensure the remediations can run.
This API does not support adding remediation configurations for
service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
</note>
<note markdown=“1”> **Required fields**
For manual remediation configuration, you need to provide a value for
‘automationAssumeRole` or use a value in the `assumeRole`field to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.
However, for automatic remediation configuration, the only valid
‘assumeRole` field value is `AutomationAssumeRole` and you need to provide a value for `AutomationAssumeRole` to remediate your resources.
</note>
<note markdown=“1”> **Auto remediation can be initiated even for compliant resources**
If you enable auto remediation for a specific Config rule using the
- PutRemediationConfigurations][1
-
API or the Config console, it
initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even
for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
</note>
[1]: docs.aws.amazon.com/config/latest/APIReference/emAPI_PutRemediationConfigurations.html
5144 5145 5146 5147 |
# File 'lib/aws-sdk-configservice/client.rb', line 5144 def put_remediation_configurations(params = {}, = {}) req = build_request(:put_remediation_configurations, params) req.send_request() end |
#put_remediation_exceptions(params = {}) ⇒ Types::PutRemediationExceptionsResponse
A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.
<note markdown=“1”> **Exceptions block auto remediation**
Config generates a remediation exception when a problem occurs running
a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
</note>
<note markdown=“1”> **Manual remediation is recommended when placing an exception**
When placing an exception on an Amazon Web Services resource, it is
recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as ‘NON_COMPLIANT`. Once the resource has been evaluated as `NON_COMPLIANT`, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a `NON_COMPLIANT` evaluation result can delete resources before the exception is applied.
</note>
<note markdown=“1”> **Exceptions can only be performed on non-compliant resources**
Placing an exception can only be performed on resources that are
‘NON_COMPLIANT`. If you use this API for `COMPLIANT` resources or resources that are `NOT_APPLICABLE`, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see [Concepts | Config Rules] in the *Config Developer Guide*.
</note>
<note markdown=“1”> **Auto remediation can be initiated even for compliant resources**
If you enable auto remediation for a specific Config rule using the
- PutRemediationConfigurations][2
-
API or the Config console, it
initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even
for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
</note>
[1]: docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#aws-config-rules [2]: docs.aws.amazon.com/config/latest/APIReference/emAPI_PutRemediationConfigurations.html
5258 5259 5260 5261 |
# File 'lib/aws-sdk-configservice/client.rb', line 5258 def put_remediation_exceptions(params = {}, = {}) req = build_request(:put_remediation_exceptions, params) req.send_request() end |
#put_resource_config(params = {}) ⇒ Struct
Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.
<note markdown=“1”> The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.
When you call this API, Config only stores configuration state of the
resource provided in the request. This API does not change or remediate the configuration of the resource.
Write-only schema properites are not recorded as part of the published
configuration item.
</note>
5338 5339 5340 5341 |
# File 'lib/aws-sdk-configservice/client.rb', line 5338 def put_resource_config(params = {}, = {}) req = build_request(:put_resource_config, params) req.send_request() end |
#put_retention_configuration(params = {}) ⇒ Types::PutRetentionConfigurationResponse
Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the ‘RetentionConfiguration` object and names the object as default. When you have a `RetentionConfiguration` object named default, calling the API modifies the default object.
<note markdown=“1”> Currently, Config supports only one retention configuration per region in your account.
</note>
5381 5382 5383 5384 |
# File 'lib/aws-sdk-configservice/client.rb', line 5381 def put_retention_configuration(params = {}, = {}) req = build_request(:put_retention_configuration, params) req.send_request() end |
#put_stored_query(params = {}) ⇒ Types::PutStoredQueryResponse
Saves a new query or updates an existing saved query. The ‘QueryName` must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.
<note markdown=“1”> ‘PutStoredQuery` is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has different `tags` values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case, `tags` will not be updated, even if they are different.
</note>
5443 5444 5445 5446 |
# File 'lib/aws-sdk-configservice/client.rb', line 5443 def put_stored_query(params = {}, = {}) req = build_request(:put_stored_query, params) req.send_request() end |
#select_aggregate_resource_config(params = {}) ⇒ Types::SelectAggregateResourceConfigResponse
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the [ **Query Components** ][1] section in the *Config Developer Guide*.
<note markdown=“1”> If you run an aggregation query (i.e., using ‘GROUP BY` or using aggregate functions such as `COUNT`; e.g., `SELECT resourceId, COUNT(*) WHERE resourceType = ’AWS::IAM::Role’ GROUP BY resourceId`) and do not specify the ‘MaxResults` or the `Limit` query parameters, the default page size is set to 500.
If you run a non-aggregation query (i.e., not using `GROUP BY` or
aggregate function; e.g., ‘SELECT * WHERE resourceType = ’AWS::IAM::Role’‘) and do not specify the `MaxResults` or the `Limit` query parameters, the default page size is set to 25.
</note>
[1]: docs.aws.amazon.com/config/latest/developerguide/query-components.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5521 5522 5523 5524 |
# File 'lib/aws-sdk-configservice/client.rb', line 5521 def select_aggregate_resource_config(params = {}, = {}) req = build_request(:select_aggregate_resource_config, params) req.send_request() end |
#select_resource_config(params = {}) ⇒ Types::SelectResourceConfigResponse
Accepts a structured query language (SQL) ‘SELECT` command, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the [ **Query Components** ][1] section in the *Config Developer Guide*.
[1]: docs.aws.amazon.com/config/latest/developerguide/query-components.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
5575 5576 5577 5578 |
# File 'lib/aws-sdk-configservice/client.rb', line 5575 def select_resource_config(params = {}, = {}) req = build_request(:select_resource_config, params) req.send_request() end |
#start_config_rules_evaluation(params = {}) ⇒ Struct
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use ‘StartConfigRulesEvaluation` when you want to test that a rule you updated is working as expected. `StartConfigRulesEvaluation` does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources.
You can specify up to 25 Config rules per request.
An existing ‘StartConfigRulesEvaluation` call for the specified rules must complete before you can call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a `ConfigRuleEvaluationStarted` notification when the evaluation starts.
<note markdown=“1”> You don’t need to call the ‘StartConfigRulesEvaluation` API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically.
</note>
The ‘StartConfigRulesEvaluation` API is useful if you want to run on-demand evaluations, such as the following example:
-
You have a custom rule that evaluates your IAM resources every 24 hours.
-
You update your Lambda function to add additional conditions to your rule.
-
Instead of waiting for the next periodic evaluation, you call the ‘StartConfigRulesEvaluation` API.
-
Config invokes your Lambda function and evaluates your IAM resources.
-
Your custom rule will still run periodic evaluations every 24 hours.
5634 5635 5636 5637 |
# File 'lib/aws-sdk-configservice/client.rb', line 5634 def start_config_rules_evaluation(params = {}, = {}) req = build_request(:start_config_rules_evaluation, params) req.send_request() end |
#start_configuration_recorder(params = {}) ⇒ Struct
Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
You must have created at least one delivery channel to successfully start the configuration recorder.
5661 5662 5663 5664 |
# File 'lib/aws-sdk-configservice/client.rb', line 5661 def start_configuration_recorder(params = {}, = {}) req = build_request(:start_configuration_recorder, params) req.send_request() end |
#start_remediation_execution(params = {}) ⇒ Types::StartRemediationExecutionResponse
Runs an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.
You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.
5711 5712 5713 5714 |
# File 'lib/aws-sdk-configservice/client.rb', line 5711 def start_remediation_execution(params = {}, = {}) req = build_request(:start_remediation_execution, params) req.send_request() end |
#start_resource_evaluation(params = {}) ⇒ Types::StartResourceEvaluationResponse
Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.
<note markdown=“1”> Ensure you have the ‘cloudformation:DescribeType` role setup to validate the resource type schema.
You can find the [Resource type schema][1] in "*Amazon Web Services
public extensions*“ within the CloudFormation registry or with the following CLI commmand: ‘aws cloudformation describe-type –type-name ”AWS::S3::Bucket“ –type RESOURCE`.
For more information, see [Managing extensions through the
CloudFormation registry] and [Amazon Web Services resource and property types reference] in the CloudFormation User Guide.
</note>
[1]: docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html [2]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view [3]: docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html
5802 5803 5804 5805 |
# File 'lib/aws-sdk-configservice/client.rb', line 5802 def start_resource_evaluation(params = {}, = {}) req = build_request(:start_resource_evaluation, params) req.send_request() end |
#stop_configuration_recorder(params = {}) ⇒ Struct
Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
5826 5827 5828 5829 |
# File 'lib/aws-sdk-configservice/client.rb', line 5826 def stop_configuration_recorder(params = {}, = {}) req = build_request(:stop_configuration_recorder, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.
5864 5865 5866 5867 |
# File 'lib/aws-sdk-configservice/client.rb', line 5864 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
5892 5893 5894 5895 |
# File 'lib/aws-sdk-configservice/client.rb', line 5892 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5916 5917 5918 |
# File 'lib/aws-sdk-configservice/client.rb', line 5916 def waiter_names [] end |