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
-
#associate_resource_types(params = {}) ⇒ Types::AssociateResourceTypesResponse
Adds all resource types specified in the
ResourceTypes
list to the [RecordingGroup][1] of specified configuration recorder and includes those resource types when recording. -
#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 customer managed 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_service_linked_configuration_recorder(params = {}) ⇒ Types::DeleteServiceLinkedConfigurationRecorderResponse
Deletes an existing service-linked configuration recorder.
-
#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 existing and deleted 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 configuration recorder you specify as well as the status of the last recording event for the configuration recorders.
-
#describe_configuration_recorders(params = {}) ⇒ Types::DescribeConfigurationRecordersResponse
Returns details for the configuration recorder you specify.
-
#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.
-
#disassociate_resource_types(params = {}) ⇒ Types::DisassociateResourceTypesResponse
Removes all resource types specified in the
ResourceTypes
list from the [RecordingGroup][1] of configuration recorder and excludes these resource types when recording. -
#get_aggregate_compliance_details_by_config_rule(params = {}) ⇒ Types::GetAggregateComplianceDetailsByConfigRuleResponse
Returns the evaluation results for the specified Config rule for a specific resource in a rule.
-
#get_aggregate_config_rule_compliance_summary(params = {}) ⇒ Types::GetAggregateConfigRuleComplianceSummaryResponse
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
-
#get_aggregate_conformance_pack_compliance_summary(params = {}) ⇒ Types::GetAggregateConformancePackComplianceSummaryResponse
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.
-
#get_aggregate_discovered_resource_counts(params = {}) ⇒ Types::GetAggregateDiscoveredResourceCountsResponse
Returns the resource counts across accounts and regions that are present in your Config aggregator.
-
#get_aggregate_resource_config(params = {}) ⇒ Types::GetAggregateResourceConfigResponse
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
-
#get_compliance_details_by_config_rule(params = {}) ⇒ Types::GetComplianceDetailsByConfigRuleResponse
Returns the evaluation results for the specified Config rule.
-
#get_compliance_details_by_resource(params = {}) ⇒ Types::GetComplianceDetailsByResourceResponse
Returns the evaluation results for the specified Amazon Web Services resource.
-
#get_compliance_summary_by_config_rule(params = {}) ⇒ Types::GetComplianceSummaryByConfigRuleResponse
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
-
#get_compliance_summary_by_resource_type(params = {}) ⇒ Types::GetComplianceSummaryByResourceTypeResponse
Returns the number of resources that are compliant and the number that are noncompliant.
-
#get_conformance_pack_compliance_details(params = {}) ⇒ Types::GetConformancePackComplianceDetailsResponse
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
-
#get_conformance_pack_compliance_summary(params = {}) ⇒ Types::GetConformancePackComplianceSummaryResponse
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
-
#get_custom_rule_policy(params = {}) ⇒ Types::GetCustomRulePolicyResponse
Returns the policy definition containing the logic for your Config Custom Policy rule.
-
#get_discovered_resource_counts(params = {}) ⇒ Types::GetDiscoveredResourceCountsResponse
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
-
#get_organization_config_rule_detailed_status(params = {}) ⇒ Types::GetOrganizationConfigRuleDetailedStatusResponse
Returns detailed status for each member account within an organization for a given organization Config rule.
-
#get_organization_conformance_pack_detailed_status(params = {}) ⇒ Types::GetOrganizationConformancePackDetailedStatusResponse
Returns detailed status for each member account within an organization for a given organization conformance pack.
-
#get_organization_custom_rule_policy(params = {}) ⇒ Types::GetOrganizationCustomRulePolicyResponse
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
-
#get_resource_config_history(params = {}) ⇒ Types::GetResourceConfigHistoryResponse
For accurate reporting on the compliance status, you must record the
AWS::Config::ResourceCompliance
resource type. -
#get_resource_evaluation_summary(params = {}) ⇒ Types::GetResourceEvaluationSummaryResponse
Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run.
-
#get_stored_query(params = {}) ⇒ Types::GetStoredQueryResponse
Returns the details of a specific stored query.
-
#list_aggregate_discovered_resources(params = {}) ⇒ Types::ListAggregateDiscoveredResourcesResponse
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.
-
#list_configuration_recorders(params = {}) ⇒ Types::ListConfigurationRecordersResponse
Returns a list of configuration recorders depending on the filters you specify.
-
#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 or updates the customer managed configuration recorder.
-
#put_conformance_pack(params = {}) ⇒ Types::PutConformancePackResponse
Creates or updates a conformance pack.
-
#put_delivery_channel(params = {}) ⇒ Struct
Creates or updates a delivery channel to deliver configuration information and other compliance information.
-
#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_service_linked_configuration_recorder(params = {}) ⇒ Types::PutServiceLinkedConfigurationRecorderResponse
Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the
ServicePrincipal
you specify. -
#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 the customer managed configuration recorder.
-
#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 the customer managed configuration recorder.
-
#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.
451 452 453 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 451 def initialize(*args) super end |
Instance Method Details
#associate_resource_types(params = {}) ⇒ Types::AssociateResourceTypesResponse
Adds all resource types specified in the ResourceTypes
list to the
RecordingGroup of specified configuration recorder and includes
those resource types when recording.
For this operation, the specified configuration recorder must use a
RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES
or
EXCLUSION_BY_RESOURCE_TYPES
.
514 515 516 517 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 514 def associate_resource_types(params = {}, = {}) req = build_request(:associate_resource_types, params) req.send_request() end |
#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.
588 589 590 591 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 588 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.
655 656 657 658 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 655 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.
682 683 684 685 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 682 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.
It is highly recommended that you stop recording for the
AWS::Config::ResourceCompliance
resource type before you delete
rules in your account. Deleting rules creates CIs for
AWS::Config::ResourceCompliance
and can affect your Config
configuration recorder costs. If you are deleting rules which
evaluate a large number of resource types, this can lead to a spike in
the number of CIs recorded.
Best practice:
Stop recording
AWS::Config::ResourceCompliance
Delete rule(s)
Turn on recording for
AWS::Config::ResourceCompliance
737 738 739 740 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 737 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.
760 761 762 763 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 760 def delete_configuration_aggregator(params = {}, = {}) req = build_request(:delete_configuration_aggregator, params) req.send_request() end |
#delete_configuration_recorder(params = {}) ⇒ Struct
Deletes the customer managed configuration recorder.
This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new customer managed configuration recorder.
799 800 801 802 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 799 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.
827 828 829 830 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 827 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 customer managed configuration recorder. You can use the StopConfigurationRecorder operation to stop the customer managed configuration recorder.
854 855 856 857 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 854 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.
880 881 882 883 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 880 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.
912 913 914 915 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 912 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.
945 946 947 948 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 945 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.
972 973 974 975 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 972 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.
999 1000 1001 1002 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 999 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.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1050 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.
1079 1080 1081 1082 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1079 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.
1101 1102 1103 1104 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1101 def delete_retention_configuration(params = {}, = {}) req = build_request(:delete_retention_configuration, params) req.send_request() end |
#delete_service_linked_configuration_recorder(params = {}) ⇒ Types::DeleteServiceLinkedConfigurationRecorderResponse
Deletes an existing service-linked configuration recorder.
This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new service-linked configuration recorder for the same service.
The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel.
1152 1153 1154 1155 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1152 def delete_service_linked_configuration_recorder(params = {}, = {}) req = build_request(:delete_service_linked_configuration_recorder, 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.
1175 1176 1177 1178 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1175 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.
1214 1215 1216 1217 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1214 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.
1278 1279 1280 1281 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1278 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 existing and deleted 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.
1347 1348 1349 1350 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1347 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.
1390 1391 1392 1393 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1390 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 operation 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.
1459 1460 1461 1462 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1459 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 operation 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.
1546 1547 1548 1549 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1546 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.
1617 1618 1619 1620 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1617 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.
1692 1693 1694 1695 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1692 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.
1755 1756 1757 1758 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1755 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 operation 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.
1821 1822 1823 1824 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1821 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 configuration recorder you specify as well as the status of the last recording event for the configuration recorders.
For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
If a configuration recorder is not specified, this operation returns the status for the customer managed configuration recorder configured for the account, if applicable.
1891 1892 1893 1894 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1891 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 details for the configuration recorder you specify.
If a configuration recorder is not specified, this operation returns details for the customer managed configuration recorder configured for the account, if applicable.
1958 1959 1960 1961 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1958 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.
2017 2018 2019 2020 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2017 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.
2070 2071 2072 2073 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2070 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.
2125 2126 2127 2128 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2125 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 operation returns the current status of all delivery channels associated with the account.
2177 2178 2179 2180 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2177 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 operation returns the details of all delivery channels associated with the account.
2218 2219 2220 2221 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2218 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.
2280 2281 2282 2283 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2280 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 organization
If you deploy an organizational rule or conformance pack in an
organization administrator account, and then establish a delegated
administrator and deploy an organizational rule or conformance pack in
the delegated administrator account, you won't be able to see the
organizational rule or conformance pack in the organization
administrator account from the delegated administrator account or see
the organizational rule or conformance pack in the delegated
administrator account from organization administrator account. The
DescribeOrganizationConfigRules
and
DescribeOrganizationConformancePacks
APIs can only see and interact
with the organization-related resource that were deployed from within
the account calling those APIs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2387 2388 2389 2390 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2387 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.
2449 2450 2451 2452 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2449 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 organization
If you deploy an organizational rule or conformance pack in an
organization administrator account, and then establish a delegated
administrator and deploy an organizational rule or conformance pack in
the delegated administrator account, you won't be able to see the
organizational rule or conformance pack in the organization
administrator account from the delegated administrator account or see
the organizational rule or conformance pack in the delegated
administrator account from organization administrator account. The
DescribeOrganizationConfigRules
and
DescribeOrganizationConformancePacks
APIs can only see and interact
with the organization-related resource that were deployed from within
the account calling those APIs.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2526 2527 2528 2529 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2526 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.
2566 2567 2568 2569 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2566 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.
2611 2612 2613 2614 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2611 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.
2685 2686 2687 2688 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2685 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.
2753 2754 2755 2756 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2753 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 operation 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.
2806 2807 2808 2809 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2806 def describe_retention_configurations(params = {}, = {}) req = build_request(:describe_retention_configurations, params) req.send_request() end |
#disassociate_resource_types(params = {}) ⇒ Types::DisassociateResourceTypesResponse
Removes all resource types specified in the ResourceTypes
list from
the RecordingGroup of configuration recorder and excludes these
resource types when recording.
For this operation, the configuration recorder must use a
RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES
or
EXCLUSION_BY_RESOURCE_TYPES
.
2868 2869 2870 2871 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2868 def disassociate_resource_types(params = {}, = {}) req = build_request(:disassociate_resource_types, 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.
2953 2954 2955 2956 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2953 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.
3022 3023 3024 3025 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3022 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.
3090 3091 3092 3093 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3090 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.
3159 3160 3161 3162 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3159 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.
3228 3229 3230 3231 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3228 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.
3293 3294 3295 3296 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3293 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.
3368 3369 3370 3371 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3368 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.
3392 3393 3394 3395 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3392 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.
3435 3436 3437 3438 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3435 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.
3499 3500 3501 3502 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3499 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.
3544 3545 3546 3547 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3544 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.
3573 3574 3575 3576 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3573 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.
3672 3673 3674 3675 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3672 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.
3730 3731 3732 3733 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3730 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.
3788 3789 3790 3791 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3788 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.
3817 3818 3819 3820 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3817 def get_organization_custom_rule_policy(params = {}, = {}) req = build_request(:get_organization_custom_rule_policy, params) req.send_request() end |
#get_resource_config_history(params = {}) ⇒ Types::GetResourceConfigHistoryResponse
For accurate reporting on the compliance status, you must record the
AWS::Config::ResourceCompliance
resource type. For more information,
see Selecting Which Resources Config Records.
Returns a list of ConfigurationItems
for the specified resource. The
list contains details about each state of the resource during the
specified time interval. If you specified a retention period to retain
your ConfigurationItems
between a minimum of 30 days and a maximum
of 7 years (2557 days), Config returns the ConfigurationItems
for
the specified retention period.
The response is paginated. By default, Config returns a limit of 10
configuration items per page. You can customize this number with the
limit
parameter. The response includes a nextToken
string. To get
the next page of results, run the request again and specify the string
for the nextToken
parameter.
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.
3934 3935 3936 3937 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3934 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.
3996 3997 3998 3999 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3996 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.
4028 4029 4030 4031 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4028 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.
4100 4101 4102 4103 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4100 def list_aggregate_discovered_resources(params = {}, = {}) req = build_request(:list_aggregate_discovered_resources, params) req.send_request() end |
#list_configuration_recorders(params = {}) ⇒ Types::ListConfigurationRecordersResponse
Returns a list of configuration recorders depending on the filters you specify.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4152 4153 4154 4155 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4152 def list_configuration_recorders(params = {}, = {}) req = build_request(:list_configuration_recorders, 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.
4238 4239 4240 4241 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4238 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.
4320 4321 4322 4323 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4320 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.
4373 4374 4375 4376 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4373 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.
4415 4416 4417 4418 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4415 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.
4477 4478 4479 4480 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4477 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 not be updated, even if they are
different.
Use TagResource and UntagResource to update tags after creation.
4542 4543 4544 4545 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4542 def (params = {}, = {}) req = build_request(:put_aggregation_authorization, params) req.send_request() end |
#put_config_rule(params = {}) ⇒ Struct
Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
There are two types of rules: Config Managed Rules and Config
Custom Rules. You can use PutConfigRule
to create both Config
Managed Rules and Config Custom Rules.
Config Managed Rules are predefined, customizable rules created by
Config. For a list of managed rules, see List of Config Managed
Rules. If you are adding an Config managed rule, you must specify
the rule's identifier for the SourceIdentifier
key.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda rule, you first need to
create an Lambda function that the rule invokes to evaluate your
resources. When you use PutConfigRule
to add a Custom Lambda rule to
Config, you must specify the Amazon Resource Name (ARN) that Lambda
assigns to the function. You specify the ARN in the SourceIdentifier
key. This key is part of the Source
object, which is part of the
ConfigRule
object.
For any new Config rule that you add, specify the ConfigRuleName
in
the ConfigRule
object. Do not specify the ConfigRuleArn
or the
ConfigRuleId
. These values are generated by Config for new rules.
If you are updating a rule that you added previously, you can specify
the rule by ConfigRuleName
, ConfigRuleId
, or ConfigRuleArn
in
the ConfigRule
data type that you use in this request.
For more information about developing and using Config rules, see Evaluating Resources with Config Rules in the Config Developer Guide.
PutConfigRule
is an idempotent API. Subsequent requests won’t create
a duplicate resource if one was already created. If a following
request has different tags
values, Config will ignore these
differences and treat it as an idempotent request of the previous. In
this case, tags
will not be updated, even if they are different.
Use TagResource and UntagResource to update tags after creation.
4673 4674 4675 4676 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4673 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.
PutConfigurationAggregator
is an idempotent API. Subsequent requests
won’t create a duplicate resource if one was already created. If a
following request has different tags
values, Config will ignore
these differences and treat it as an idempotent request of the
previous. In this case, tags
will not be updated, even if they are
different.
Use TagResource and UntagResource to update tags after creation.
4807 4808 4809 4810 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4807 def put_configuration_aggregator(params = {}, = {}) req = build_request(:put_configuration_aggregator, params) req.send_request() end |
#put_configuration_recorder(params = {}) ⇒ Struct
Creates or updates the customer managed configuration recorder.
You can use this operation to create a new customer managed
configuration recorder or to update the roleARN
and the
recordingGroup
for an existing customer managed configuration
recorder.
To start the customer managed configuration recorder and begin recording configuration changes for the resource types you specify, use the StartConfigurationRecorder operation.
For more information, see Working with the Configuration Recorder in the Config Developer Guide.
You can create only one customer managed configuration recorder for each account for each Amazon Web Services Region.
Default is to record all supported resource types, excluding the global IAM resource types
If you have not specified values for the recordingGroup
field, the
default for the customer managed configuration recorder is to record
all supported resource types, excluding the global IAM resource types:
AWS::IAM::Group
, AWS::IAM::Policy
, AWS::IAM::Role
, and
AWS::IAM::User
.
Tags are added at creation and cannot be updated
PutConfigurationRecorder
is an idempotent API. Subsequent requests
won’t create a duplicate resource if one was already created. If a
following request has different tags values, Config will ignore these
differences and treat it as an idempotent request of the previous. In
this case, tags will not be updated, even if they are different.
Use TagResource and UntagResource to update tags after creation.
4913 4914 4915 4916 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4913 def put_configuration_recorder(params = {}, = {}) req = build_request(:put_configuration_recorder, params) req.send_request() end |
#put_conformance_pack(params = {}) ⇒ Types::PutConformancePackResponse
Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.
This API creates a service-linked role
AWSServiceRoleForConfigConforms
in your account. The service-linked
role is created only when the role does not exist in your account.
TemplateS3Uri
,
TemplateBody
or TemplateSSMDocumentDetails
.
5023 5024 5025 5026 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5023 def put_conformance_pack(params = {}, = {}) req = build_request(:put_conformance_pack, params) req.send_request() end |
#put_delivery_channel(params = {}) ⇒ Struct
Creates or updates a delivery channel to deliver configuration information and other compliance information.
You can use this operation to create a new delivery channel or to update the Amazon S3 bucket and the Amazon SNS topic of an existing delivery channel.
For more information, see Working with the Delivery Channel in the Config Developer Guide.
You can have only one delivery channel for each account for each Amazon Web Services Region.
5074 5075 5076 5077 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5074 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 operation is required in every Lambda function that is invoked by an Config rule.
5136 5137 5138 5139 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5136 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.
5170 5171 5172 5173 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5170 def put_external_evaluation(params = {}, = {}) req = build_request(:put_external_evaluation, params) req.send_request() end |
#put_organization_config_rule(params = {}) ⇒ Types::PutOrganizationConfigRuleResponse
Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can create or
update an organization Config rule. When calling this API with a
delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added. An organization
can have up to 3 delegated administrators.
This API enables organization service access through the
EnableAWSServiceAccess
action and creates a service-linked role
AWSServiceRoleForConfigMultiAccountSetup
in the management or
delegated administrator account of your organization. The
service-linked role is created only when the role does not exist in
the caller account. Config verifies the existence of role with
GetRole
action.
To use this API with delegated administrator, register a delegated
administrator by calling Amazon Web Services Organization
register-delegated-administrator
for
config-multiaccountsetup.amazonaws.com
.
There are two types of rules: Config Managed Rules and Config
Custom Rules. You can use PutOrganizationConfigRule
to create both
Config Managed Rules and Config Custom Rules.
Config Managed Rules are predefined, customizable rules created by
Config. For a list of managed rules, see List of Config Managed
Rules. If you are adding an Config managed rule, you must specify
the rule's identifier for the RuleIdentifier
key.
Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda rule, you first need to
create an Lambda function in the management account or a delegated
administrator that the rule invokes to evaluate your resources. You
also need to create an IAM role in the managed account that can be
assumed by the Lambda function. When you use
PutOrganizationConfigRule
to add a Custom Lambda rule to Config, you
must specify the Amazon Resource Name (ARN) that Lambda assigns to the
function.
EnableAllFeatures
API to enable all
features in an organization.
Make sure to specify one of either
OrganizationCustomPolicyRuleMetadata
for Custom Policy rules,
OrganizationCustomRuleMetadata
for Custom Lambda rules, or
OrganizationManagedRuleMetadata
for managed rules.
5328 5329 5330 5331 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5328 def put_organization_config_rule(params = {}, = {}) req = build_request(:put_organization_config_rule, params) req.send_request() end |
#put_organization_conformance_pack(params = {}) ⇒ Types::PutOrganizationConformancePackResponse
Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can call this
API. When calling this API with a delegated administrator, you must
ensure Organizations ListDelegatedAdministrator
permissions are
added. An organization can have up to 3 delegated administrators.
This API enables organization service access for
config-multiaccountsetup.amazonaws.com
through the
EnableAWSServiceAccess
action and creates a service-linked role
AWSServiceRoleForConfigMultiAccountSetup
in the management or
delegated administrator account of your organization. The
service-linked role is created only when the role does not exist in
the caller account. To use this API with delegated administrator,
register a delegated administrator by calling Amazon Web Services
Organization register-delegate-admin
for
config-multiaccountsetup.amazonaws.com
.
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.
5446 5447 5448 5449 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5446 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.
If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.
This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
For manual remediation configuration, you need to provide a value for
automationAssumeRole
or use a value in the assumeRole
field to
remediate your resources. The SSM automation document can use either
as long as it maps to a valid parameter.
However, for automatic remediation configuration, the only valid
assumeRole
field value is AutomationAssumeRole
and you need to
provide a value for AutomationAssumeRole
to remediate your
resources.
If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console, it initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
5574 5575 5576 5577 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5574 def put_remediation_configurations(params = {}, = {}) req = build_request(:put_remediation_configurations, params) req.send_request() end |
#put_remediation_exceptions(params = {}) ⇒ Types::PutRemediationExceptionsResponse
A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.
Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When placing an exception on an Amazon Web Services resource, it is
recommended that remediation is set as manual remediation until the
given Config rule for the specified resource evaluates the resource as
NON_COMPLIANT
. Once the resource has been evaluated as
NON_COMPLIANT
, you can add remediation exceptions and change the
remediation type back from Manual to Auto if you want to use
auto-remediation. Otherwise, using auto-remediation before a
NON_COMPLIANT
evaluation result can delete resources before the
exception is applied.
Placing an exception can only be performed on resources that are
NON_COMPLIANT
. If you use this API for COMPLIANT
resources or
resources that are NOT_APPLICABLE
, a remediation exception will not
be generated. For more information on the conditions that initiate the
possible Config evaluation results, see Concepts | Config Rules
in the Config Developer Guide.
You cannot place an exception on service-linked remediation actions, such as remediation actions put by an organizational conformance pack.
If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console, it initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
5695 5696 5697 5698 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5695 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.
5775 5776 5777 5778 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5775 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.
5818 5819 5820 5821 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5818 def put_retention_configuration(params = {}, = {}) req = build_request(:put_retention_configuration, params) req.send_request() end |
#put_service_linked_configuration_recorder(params = {}) ⇒ Types::PutServiceLinkedConfigurationRecorderResponse
Creates a service-linked configuration recorder that is linked to a
specific Amazon Web Services service based on the ServicePrincipal
you specify.
The configuration recorder's name
, recordingGroup
,
recordingMode
, and recordingScope
is set by the service that is
linked to the configuration recorder.
For more information, see Working with the Configuration Recorder in the Config Developer Guide.
This API creates a service-linked role AWSServiceRoleForConfig
in
your account. The service-linked role is created only when the role
does not exist in your account.
The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel.
Tags are added at creation and cannot be updated with this operation
Use TagResource and UntagResource to update tags after creation.
5893 5894 5895 5896 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5893 def put_service_linked_configuration_recorder(params = {}, = {}) req = build_request(:put_service_linked_configuration_recorder, 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.
PutStoredQuery
is an idempotent API. Subsequent requests won’t
create a duplicate resource if one was already created. If a following
request has different tags
values, Config will ignore these
differences and treat it as an idempotent request of the previous. In
this case, tags
will not be updated, even if they are different.
5957 5958 5959 5960 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 5957 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.
6035 6036 6037 6038 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 6035 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.
6089 6090 6091 6092 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 6089 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.
6148 6149 6150 6151 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 6148 def start_config_rules_evaluation(params = {}, = {}) req = build_request(:start_config_rules_evaluation, params) req.send_request() end |
#start_configuration_recorder(params = {}) ⇒ Struct
Starts the customer managed configuration recorder. The customer managed configuration recorder will begin recording configuration changes for the resource types you specify.
You must have created a delivery channel to successfully start the customer managed configuration recorder. You can use the PutDeliveryChannel operation to create a delivery channel.
6181 6182 6183 6184 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 6181 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.
6231 6232 6233 6234 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 6231 def start_remediation_execution(params = {}, = {}) req = build_request(:start_remediation_execution, params) req.send_request() end |
#start_resource_evaluation(params = {}) ⇒ Types::StartResourceEvaluationResponse
Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.
cloudformation:DescribeType
role setup to
validate the resource type schema.
You can find the Resource type schema in "Amazon Web Services
public extensions" within the CloudFormation registry or with the
following CLI commmand: aws cloudformation describe-type --type-name
"AWS::S3::Bucket" --type RESOURCE
.
For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.
6322 6323 6324 6325 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 6322 def start_resource_evaluation(params = {}, = {}) req = build_request(:start_resource_evaluation, params) req.send_request() end |
#stop_configuration_recorder(params = {}) ⇒ Struct
Stops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified.
6347 6348 6349 6350 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 6347 def stop_configuration_recorder(params = {}, = {}) req = build_request(:stop_configuration_recorder, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
ResourceArn
. If existing tags on a resource are not specified in the
request parameters, they are not changed. If existing tags are
specified, however, then their values will be updated. When a resource
is deleted, the tags associated with that resource are deleted as
well.
6400 6401 6402 6403 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 6400 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
6443 6444 6445 6446 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 6443 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |