Class: Aws::ConfigService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ConfigService::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-configservice/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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
Returns a list of
ConfigurationItems
for the specified resource. -
#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 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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
380 381 382 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 380 def initialize(*args) super 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.
- The API does not return tags and relationships.
453 454 455 456 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 453 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.
- The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.
518 519 520 521 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 518 def batch_get_resource_config(params = {}, = {}) req = build_request(:batch_get_resource_config, params) req.send_request() end |
#delete_aggregation_authorization(params = {}) ⇒ Struct
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
545 546 547 548 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 545 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.
575 576 577 578 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 575 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.
598 599 600 601 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 598 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.
632 633 634 635 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 632 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.
660 661 662 663 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 660 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.
685 686 687 688 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 685 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.
711 712 713 714 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 711 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.
743 744 745 746 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 743 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.
776 777 778 779 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 776 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.
803 804 805 806 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 803 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.
830 831 832 833 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 830 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.
881 882 883 884 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 881 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.
910 911 912 913 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 910 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.
932 933 934 935 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 932 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.
955 956 957 958 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 955 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.
994 995 996 997 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 994 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.
nextToken
, the results are displayed on the next page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1058 1059 1060 1061 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1058 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.
nextToken
, the results are displayed on the next page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1127 1128 1129 1130 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1127 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.
1170 1171 1172 1173 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1170 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 theLastSuccessfulInvocationTime
andLastFailedInvocationTime
.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 theconfig: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.
1239 1240 1241 1242 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1239 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 theLastSuccessfulInvocationTime
andLastFailedInvocationTime
.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 theconfig: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.
1326 1327 1328 1329 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1326 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.
1397 1398 1399 1400 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1397 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.
1472 1473 1474 1475 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1472 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.
1535 1536 1537 1538 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1535 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.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1595 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.
1643 1644 1645 1646 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1643 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.
1687 1688 1689 1690 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1687 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1746 1747 1748 1749 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1746 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1799 1800 1801 1802 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1799 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.
1854 1855 1856 1857 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1854 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.
1906 1907 1908 1909 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1906 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.
1947 1948 1949 1950 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1947 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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2009 2010 2011 2012 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2009 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.
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 organzation
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2116 2117 2118 2119 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2116 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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2178 2179 2180 2181 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2178 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.
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 organzation
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2255 2256 2257 2258 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2255 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.
2295 2296 2297 2298 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2295 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.
2340 2341 2342 2343 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2340 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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2414 2415 2416 2417 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2414 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.
2482 2483 2484 2485 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2482 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2535 2536 2537 2538 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2535 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.
nextToken
, the results are displayed on the next page.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2620 2621 2622 2623 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2620 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2689 2690 2691 2692 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2689 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2757 2758 2759 2760 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2757 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.
2826 2827 2828 2829 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2826 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.
2889 2890 2891 2892 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2889 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.
2954 2955 2956 2957 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2954 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.
3029 3030 3031 3032 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3029 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.
3053 3054 3055 3056 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3053 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.
3096 3097 3098 3099 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3096 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.
3160 3161 3162 3163 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3160 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.
3205 3206 3207 3208 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3205 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.
3234 3235 3236 3237 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3234 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.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3333 3334 3335 3336 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3333 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.
3391 3392 3393 3394 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3391 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.
3449 3450 3451 3452 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3449 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.
3478 3479 3480 3481 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3478 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
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.
limit
. In such cases, you can make another call, using the
nextToken
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3584 3585 3586 3587 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3584 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.
3646 3647 3648 3649 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3646 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.
3678 3679 3680 3681 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3678 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.
3750 3751 3752 3753 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3750 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.
INSUFFICIENT_DATA
.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3836 3837 3838 3839 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3836 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.
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.
3918 3919 3920 3921 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3918 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.
3971 3972 3973 3974 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3971 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.
4013 4014 4015 4016 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4013 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.
4060 4061 4062 4063 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4060 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.
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 n