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.
-
#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_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_discovered_resources(params = {}) ⇒ Types::ListDiscoveredResourcesResponse
Accepts a resource type and returns a list of resource identifiers for the resources of that type.
-
#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 for evaluating whether 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 the selected resource configurations.
-
#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 organization Config rule for your entire organization evaluating whether 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 specific 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.
-
#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.
358 359 360 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 358 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.
431 432 433 434 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 431 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.
496 497 498 499 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 496 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.
523 524 525 526 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 523 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.
553 554 555 556 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 553 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.
576 577 578 579 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 576 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.
610 611 612 613 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 610 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.
638 639 640 641 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 638 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.
663 664 665 666 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 663 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.
689 690 691 692 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 689 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 master 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.
721 722 723 724 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 721 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 master 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.
754 755 756 757 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 754 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.
781 782 783 784 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 781 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.
808 809 810 811 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 808 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.
859 860 861 862 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 859 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.
888 889 890 891 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 888 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.
910 911 912 913 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 910 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.
933 934 935 936 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 933 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.
972 973 974 975 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 972 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.
1036 1037 1038 1039 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1036 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.
1105 1106 1107 1108 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1105 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.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1148 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.
1219 1220 1221 1222 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1219 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.
1309 1310 1311 1312 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1309 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.
1380 1381 1382 1383 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1380 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.
1440 1441 1442 1443 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1440 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.
1503 1504 1505 1506 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1503 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.
1563 1564 1565 1566 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1563 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. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
1608 1609 1610 1611 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1608 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.
1649 1650 1651 1652 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1649 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.
1708 1709 1710 1711 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1708 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.
1761 1762 1763 1764 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1761 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.
1814 1815 1816 1817 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1814 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.
1866 1867 1868 1869 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1866 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.
1907 1908 1909 1910 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1907 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.
1969 1970 1971 1972 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1969 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2059 2060 2061 2062 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2059 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.
2121 2122 2123 2124 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2121 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2183 2184 2185 2186 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2183 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.
2223 2224 2225 2226 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2223 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.
2268 2269 2270 2271 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2268 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.
2342 2343 2344 2345 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2342 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.
2410 2411 2412 2413 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2410 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.
2463 2464 2465 2466 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2463 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.
2546 2547 2548 2549 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2546 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.
2615 2616 2617 2618 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2615 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.
2683 2684 2685 2686 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2683 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.
2752 2753 2754 2755 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2752 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.
2815 2816 2817 2818 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2815 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.
2877 2878 2879 2880 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2877 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 used, and whether the resource complies with each rule.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2939 2940 2941 2942 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2939 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.
2963 2964 2965 2966 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2963 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.
3006 3007 3008 3009 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3006 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.
3068 3069 3070 3071 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3068 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.
3113 3114 3115 3116 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3113 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.
3142 3143 3144 3145 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3142 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.
3241 3242 3243 3244 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3241 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.
3299 3300 3301 3302 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3299 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.
3357 3358 3359 3360 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3357 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.
3386 3387 3388 3389 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3386 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.
3492 3493 3494 3495 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3492 def get_resource_config_history(params = {}, = {}) req = build_request(:get_resource_config_history, params) req.send_request() end |
#get_stored_query(params = {}) ⇒ Types::GetStoredQueryResponse
Returns the details of a specific stored query.
3524 3525 3526 3527 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3524 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.
3596 3597 3598 3599 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3596 def list_aggregate_discovered_resources(params = {}, = {}) req = build_request(:list_aggregate_discovered_resources, 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.
3677 3678 3679 3680 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3677 def list_discovered_resources(params = {}, = {}) req = build_request(:list_discovered_resources, 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.
3719 3720 3721 3722 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3719 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.
3766 3767 3768 3769 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3766 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.
3811 3812 3813 3814 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3811 def (params = {}, = {}) req = build_request(:put_aggregation_authorization, params) req.send_request() end |
#put_config_rule(params = {}) ⇒ Struct
Adds or updates an Config rule for evaluating whether your Amazon Web Services resources comply with your desired configurations.
You can use this action for Config custom rules and Config managed rules. A Config custom rule is a rule that you develop and maintain. An Config managed rule is a customizable, predefined rule that Config provides.
If you are adding a new Config custom rule, you must first create the
Lambda function that the rule invokes to evaluate your resources. When
you use the PutConfigRule
action to add the rule to Config, you must
specify the Amazon Resource Name (ARN) that Lambda assigns to the
function. Specify the ARN for the SourceIdentifier
key. This key is
part of the Source
object, which is part of the ConfigRule
object.
If you are adding an Config managed rule, specify the rule's
identifier for the SourceIdentifier
key. To reference Config managed
rule identifiers, see About Config managed rules.
For any new 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.
The maximum number of rules that Config supports is 150.
For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.
For more information about developing and using Config rules, see Evaluating Amazon Web Services resource Configurations with Config in the Config Developer Guide.
3913 3914 3915 3916 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3913 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.
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.
4010 4011 4012 4013 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4010 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 the selected resource configurations.
You can use this action to change the role roleARN
or the
recordingGroup
of an existing recorder. To change the role, call the
action on the existing configuration recorder and specify a role.
If ConfigurationRecorder
does not have the recordingGroup
parameter specified, the default is to record all supported resource
types.
4055 4056 4057 4058 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4055 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 Amazon Web Services Organization.
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.
TemplateS3Uri
or the TemplateBody
parameter, but not both. If you provide both Config uses the
TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
4144 4145 4146 4147 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4144 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 to an Amazon S3 bucket and 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.
4192 4193 4194 4195 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4192 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.
4254 4255 4256 4257 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4254 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.
4288 4289 4290 4291 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4288 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 organization Config rule for your entire organization evaluating whether your Amazon Web Services resources comply with your desired configurations.
Only a master 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.
This API enables organization service access through the
EnableAWSServiceAccess
action and creates a service linked role
AWSServiceRoleForConfigMultiAccountSetup
in the master 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
.
You can use this action to create both Config custom rules and Config
managed rules. If you are adding a new Config custom rule, you must
first create Lambda function in the master 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 the
PutOrganizationConfigRule
action to add the rule to Config, you must
specify the Amazon Resource Name (ARN) that Lambda assigns to the
function. If you are adding an Config managed rule, specify the
rule's identifier for the RuleIdentifier
key.
The maximum number of organization Config rules that Config supports is 150 and 3 delegated administrator per organization.
EnableAllFeatures
API to enable all
features in an organization.
Specify either OrganizationCustomRuleMetadata
or
OrganizationManagedRuleMetadata
.
4410 4411 4412 4413 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4410 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.
Only a master 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.
This API enables organization service access for
config-multiaccountsetup.amazonaws.com
through the
EnableAWSServiceAccess
action and creates a service linked role
AWSServiceRoleForConfigMultiAccountSetup
in the master 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
.
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.
You can create 50 conformance packs with 25 Config rules in each pack and 3 delegated administrator per organization.
4518 4519 4520 4521 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4518 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.
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.
4608 4609 4610 4611 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4608 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 specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specific resource with a specific Config rule.
4672 4673 4674 4675 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4672 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.
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.
4745 4746 4747 4748 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4745 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.
4788 4789 4790 4791 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4788 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.
4842 4843 4844 4845 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4842 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 section in the Config Developer Guide.
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4920 4921 4922 4923 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4920 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 section in the Config Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4974 4975 4976 4977 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4974 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.
StartConfigRulesEvaluation
API to run an
evaluation for a new rule. When you create a rule, Config evaluates
your resources against the rule automatically.
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.
5033 5034 5035 5036 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5033 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.
5060 5061 5062 5063 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5060 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.