Class: Aws::ConfigService::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ConfigService::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb
Overview
An API client for ConfigService. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::ConfigService::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#batch_get_aggregate_resource_config(params = {}) ⇒ Types::BatchGetAggregateResourceConfigResponse
Returns the current configuration items for resources that are present in your AWS Config aggregator.
-
#batch_get_resource_config(params = {}) ⇒ Types::BatchGetResourceConfigResponse
Returns the current configuration 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 AWS Config rule and all of its evaluation results.
-
#delete_configuration_aggregator(params = {}) ⇒ Struct
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
-
#delete_configuration_recorder(params = {}) ⇒ Struct
Deletes the configuration recorder.
-
#delete_conformance_pack(params = {}) ⇒ Struct
Deletes the specified conformance pack and all the AWS 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 AWS Config rule.
-
#delete_organization_config_rule(params = {}) ⇒ Struct
Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization.
-
#delete_organization_conformance_pack(params = {}) ⇒ Struct
Deletes the specified organization conformance pack and all of the config rules and remediation actions from all member accounts in that organization.
-
#delete_pending_aggregation_request(params = {}) ⇒ Struct
Deletes pending authorization requests for a specified aggregator account in a specified region.
-
#delete_remediation_configuration(params = {}) ⇒ Struct
Deletes the remediation configuration.
-
#delete_remediation_exceptions(params = {}) ⇒ Types::DeleteRemediationExceptionsResponse
Deletes one or more remediation exceptions mentioned in the resource keys.
-
#delete_resource_config(params = {}) ⇒ Struct
Records the configuration state for a custom resource that has been deleted.
-
#delete_retention_configuration(params = {}) ⇒ Struct
Deletes the retention configuration.
-
#delete_stored_query(params = {}) ⇒ Struct
Deletes the stored query for an AWS account in an AWS 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_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 AWS Config rules are compliant.
-
#describe_compliance_by_resource(params = {}) ⇒ Types::DescribeComplianceByResourceResponse
Indicates whether the specified AWS resources are compliant.
-
#describe_config_rule_evaluation_status(params = {}) ⇒ Types::DescribeConfigRuleEvaluationStatusResponse
Returns status information for each of your AWS managed Config rules.
-
#describe_config_rules(params = {}) ⇒ Types::DescribeConfigRulesResponse
Returns details about your AWS Config rules.
-
#describe_configuration_aggregator_sources_status(params = {}) ⇒ Types::DescribeConfigurationAggregatorSourcesStatusResponse
Returns status information for sources within an aggregator.
-
#describe_configuration_aggregators(params = {}) ⇒ Types::DescribeConfigurationAggregatorsResponse
Returns the details of one or more configuration aggregators.
-
#describe_configuration_recorder_status(params = {}) ⇒ Types::DescribeConfigurationRecorderStatusResponse
Returns the current status of the specified configuration recorder.
-
#describe_configuration_recorders(params = {}) ⇒ Types::DescribeConfigurationRecordersResponse
Returns the details for the specified configuration recorders.
-
#describe_conformance_pack_compliance(params = {}) ⇒ Types::DescribeConformancePackComplianceResponse
Returns compliance details for each rule in that conformance pack.
-
#describe_conformance_pack_status(params = {}) ⇒ Types::DescribeConformancePackStatusResponse
Provides one or more conformance packs deployment status.
-
#describe_conformance_packs(params = {}) ⇒ Types::DescribeConformancePacksResponse
Returns a list of one or more conformance packs.
-
#describe_delivery_channel_status(params = {}) ⇒ Types::DescribeDeliveryChannelStatusResponse
Returns the current status of the specified delivery channel.
-
#describe_delivery_channels(params = {}) ⇒ Types::DescribeDeliveryChannelsResponse
Returns details about the specified delivery channel.
-
#describe_organization_config_rule_statuses(params = {}) ⇒ Types::DescribeOrganizationConfigRuleStatusesResponse
Provides organization config rule deployment status for an organization.
-
#describe_organization_config_rules(params = {}) ⇒ Types::DescribeOrganizationConfigRulesResponse
Returns a list of organization config rules.
-
#describe_organization_conformance_pack_statuses(params = {}) ⇒ Types::DescribeOrganizationConformancePackStatusesResponse
Provides organization conformance pack deployment status for an organization.
-
#describe_organization_conformance_packs(params = {}) ⇒ Types::DescribeOrganizationConformancePacksResponse
Returns a list of organization conformance packs.
-
#describe_pending_aggregation_requests(params = {}) ⇒ Types::DescribePendingAggregationRequestsResponse
Returns a list of all pending aggregation requests.
-
#describe_remediation_configurations(params = {}) ⇒ Types::DescribeRemediationConfigurationsResponse
Returns the details of one or more remediation configurations.
-
#describe_remediation_exceptions(params = {}) ⇒ Types::DescribeRemediationExceptionsResponse
Returns the details of one or more remediation exceptions.
-
#describe_remediation_execution_status(params = {}) ⇒ Types::DescribeRemediationExecutionStatusResponse
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed.
-
#describe_retention_configurations(params = {}) ⇒ Types::DescribeRetentionConfigurationsResponse
Returns the details of one or more retention configurations.
-
#get_aggregate_compliance_details_by_config_rule(params = {}) ⇒ Types::GetAggregateComplianceDetailsByConfigRuleResponse
Returns the evaluation results for the specified AWS 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_discovered_resource_counts(params = {}) ⇒ Types::GetAggregateDiscoveredResourceCountsResponse
Returns the resource counts across accounts and regions that are present in your AWS 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 AWS Config rule.
-
#get_compliance_details_by_resource(params = {}) ⇒ Types::GetComplianceDetailsByResourceResponse
Returns the evaluation results for the specified AWS resource.
-
#get_compliance_summary_by_config_rule(params = {}) ⇒ Types::GetComplianceSummaryByConfigRuleResponse
Returns the number of AWS 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 AWS 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_discovered_resource_counts(params = {}) ⇒ Types::GetDiscoveredResourceCountsResponse
Returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS 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_resource_config_history(params = {}) ⇒ Types::GetResourceConfigHistoryResponse
Returns a list of configuration items for the specified resource.
-
#get_stored_query(params = {}) ⇒ Types::GetStoredQueryResponse
Returns the details of a specific stored query.
-
#list_aggregate_discovered_resources(params = {}) ⇒ Types::ListAggregateDiscoveredResourcesResponse
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.
-
#list_discovered_resources(params = {}) ⇒ Types::ListDiscoveredResourcesResponse
Accepts a resource type and returns a list of resource identifiers for the resources of that type.
-
#list_stored_queries(params = {}) ⇒ Types::ListStoredQueriesResponse
List the stored queries for an AWS account in an AWS Region.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
List the tags for AWS 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 AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
-
#put_configuration_aggregator(params = {}) ⇒ Types::PutConfigurationAggregatorResponse
Creates and updates the configuration aggregator with the selected source accounts and regions.
-
#put_configuration_recorder(params = {}) ⇒ Struct
Creates a new configuration recorder to record the selected resource configurations.
-
#put_conformance_pack(params = {}) ⇒ Types::PutConformancePackResponse
Creates or updates a conformance pack.
-
#put_delivery_channel(params = {}) ⇒ Struct
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.
-
#put_evaluations(params = {}) ⇒ Types::PutEvaluationsResponse
Used by an AWS Lambda function to deliver evaluation results to AWS Config.
-
#put_external_evaluation(params = {}) ⇒ Struct
Returns an empty response.
-
#put_organization_config_rule(params = {}) ⇒ Types::PutOrganizationConfigRuleResponse
Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations.
-
#put_organization_conformance_pack(params = {}) ⇒ Types::PutOrganizationConformancePackResponse
Deploys conformance packs across member accounts in an AWS Organization.
-
#put_remediation_configurations(params = {}) ⇒ Types::PutRemediationConfigurationsResponse
Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action.
-
#put_remediation_exceptions(params = {}) ⇒ Types::PutRemediationExceptionsResponse
A remediation exception is when a specific resource is no longer considered for auto-remediation.
-
#put_resource_config(params = {}) ⇒ Struct
Records the configuration state for the resource provided in the request.
-
#put_retention_configuration(params = {}) ⇒ Types::PutRetentionConfigurationResponse
Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information.
-
#put_stored_query(params = {}) ⇒ Types::PutStoredQueryResponse
Saves a new query or updates an existing saved query.
-
#select_aggregate_resource_config(params = {}) ⇒ Types::SelectAggregateResourceConfigResponse
Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of AWS 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 AWS Config rules against the last known configuration state of the resources.
-
#start_configuration_recorder(params = {}) ⇒ Struct
Starts recording configurations of the AWS resources you have selected to record in your AWS account.
-
#start_remediation_execution(params = {}) ⇒ Types::StartRemediationExecutionResponse
Runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration.
-
#stop_configuration_recorder(params = {}) ⇒ Struct
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified resourceArn.
-
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
334 335 336 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#batch_get_aggregate_resource_config(params = {}) ⇒ Types::BatchGetAggregateResourceConfigResponse
Returns the current configuration items for resources that are present
in your AWS 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.
407 408 409 410 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 407 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 current configuration 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.
471 472 473 474 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 471 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.
498 499 500 501 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 498 def (params = {}, = {}) req = build_request(:delete_aggregation_authorization, params) req.send_request() end |
#delete_config_rule(params = {}) ⇒ Struct
Deletes the specified AWS Config rule and all of its evaluation results.
AWS 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.
529 530 531 532 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 529 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.
552 553 554 555 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 552 def delete_configuration_aggregator(params = {}, = {}) req = build_request(:delete_configuration_aggregator, params) req.send_request() end |
#delete_configuration_recorder(params = {}) ⇒ Struct
Deletes the configuration recorder.
After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder.
This action does not delete the configuration information that was
previously recorded. You will be able to access the previously
recorded information by using the GetResourceConfigHistory
action,
but you will not be able to access this information in the AWS Config
console until you create a new configuration recorder.
586 587 588 589 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 586 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 AWS Config rules, remediation actions, and all evaluation results within that conformance pack.
AWS 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.
614 615 616 617 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 614 def delete_conformance_pack(params = {}, = {}) req = build_request(:delete_conformance_pack, params) req.send_request() end |
#delete_delivery_channel(params = {}) ⇒ Struct
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
639 640 641 642 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 639 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 AWS Config rule. You can specify one AWS Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule.
665 666 667 668 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 665 def delete_evaluation_results(params = {}, = {}) req = build_request(:delete_evaluation_results, params) req.send_request() end |
#delete_organization_config_rule(params = {}) ⇒ Struct
Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization.
Only a master account and a delegated administrator account can delete
an organization config rule. When calling this API with a delegated
administrator, you must ensure AWS Organizations
ListDelegatedAdministrator
permissions are added.
AWS 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.
697 698 699 700 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 697 def delete_organization_config_rule(params = {}, = {}) req = build_request(:delete_organization_config_rule, params) req.send_request() end |
#delete_organization_conformance_pack(params = {}) ⇒ Struct
Deletes the specified organization conformance pack and all of the config rules and remediation actions from all member accounts in that organization.
Only a master account or a delegated administrator account can delete
an organization conformance pack. When calling this API with a
delegated administrator, you must ensure AWS Organizations
ListDelegatedAdministrator
permissions are added.
AWS 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.
730 731 732 733 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 730 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.
757 758 759 760 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 757 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.
784 785 786 787 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 784 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.
835 836 837 838 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 835 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 AWS Config History.
864 865 866 867 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 864 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.
886 887 888 889 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 886 def delete_retention_configuration(params = {}, = {}) req = build_request(:delete_retention_configuration, params) req.send_request() end |
#delete_stored_query(params = {}) ⇒ Struct
Deletes the stored query for an AWS account in an AWS Region.
908 909 910 911 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 908 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, AWS 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.
947 948 949 950 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 947 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.
nextToken
, the results are displayed on the next page.
1008 1009 1010 1011 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1008 def describe_aggregate_compliance_by_config_rules(params = {}, = {}) req = build_request(:describe_aggregate_compliance_by_config_rules, params) req.send_request() end |
#describe_aggregation_authorizations(params = {}) ⇒ Types::DescribeAggregationAuthorizationsResponse
Returns a list of authorizations granted to various aggregator accounts and regions.
1049 1050 1051 1052 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1049 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 AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS 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 AWS Config has no current evaluation results for the rule, it
returns INSUFFICIENT_DATA
. This result might indicate one of the
following conditions:
AWS 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 AWS Lambda function is failing to send evaluation results to AWS 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 AWS Lambda execution role includes theconfig:PutEvaluations
permission.The rule's AWS 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.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1119 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 AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with.
A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If AWS 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:
AWS 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 AWS Lambda function is failing to send evaluation results to AWS 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 AWS Lambda execution role includes theconfig:PutEvaluations
permission.The rule's AWS 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.
1206 1207 1208 1209 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1206 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 AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.
1272 1273 1274 1275 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1272 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 AWS Config rules.
1328 1329 1330 1331 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1328 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 AWS 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.
1389 1390 1391 1392 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1389 def describe_configuration_aggregator_sources_status(params = {}, = {}) req = build_request(:describe_configuration_aggregator_sources_status, params) req.send_request() end |
#describe_configuration_aggregators(params = {}) ⇒ Types::DescribeConfigurationAggregatorsResponse
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.
1447 1448 1449 1450 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1447 def describe_configuration_aggregators(params = {}, = {}) req = build_request(:describe_configuration_aggregators, params) req.send_request() end |
#describe_configuration_recorder_status(params = {}) ⇒ Types::DescribeConfigurationRecorderStatusResponse
Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
1492 1493 1494 1495 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1492 def describe_configuration_recorder_status(params = {}, = {}) req = build_request(:describe_configuration_recorder_status, params) req.send_request() end |
#describe_configuration_recorders(params = {}) ⇒ Types::DescribeConfigurationRecordersResponse
Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.
1533 1534 1535 1536 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1533 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.
1588 1589 1590 1591 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1588 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.
1639 1640 1641 1642 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1639 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.
1690 1691 1692 1693 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1690 def describe_conformance_packs(params = {}, = {}) req = build_request(:describe_conformance_packs, params) req.send_request() end |
#describe_delivery_channel_status(params = {}) ⇒ Types::DescribeDeliveryChannelStatusResponse
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
1742 1743 1744 1745 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1742 def describe_delivery_channel_status(params = {}, = {}) req = build_request(:describe_delivery_channel_status, params) req.send_request() end |
#describe_delivery_channels(params = {}) ⇒ Types::DescribeDeliveryChannelsResponse
Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
1782 1783 1784 1785 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1782 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.
1842 1843 1844 1845 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1842 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.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1917 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.
1977 1978 1979 1980 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 1977 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.
2037 2038 2039 2040 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2037 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.
2075 2076 2077 2078 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2075 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.
2120 2121 2122 2123 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2120 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.
2195 2196 2197 2198 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2195 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.
2263 2264 2265 2266 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2263 def describe_remediation_execution_status(params = {}, = {}) req = build_request(:describe_remediation_execution_status, params) req.send_request() end |
#describe_retention_configurations(params = {}) ⇒ Types::DescribeRetentionConfigurationsResponse
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
2314 2315 2316 2317 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2314 def describe_retention_configurations(params = {}, = {}) req = build_request(:describe_retention_configurations, params) req.send_request() end |
#get_aggregate_compliance_details_by_config_rule(params = {}) ⇒ Types::GetAggregateComplianceDetailsByConfigRuleResponse
Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS 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.
2397 2398 2399 2400 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2397 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.
2464 2465 2466 2467 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2464 def get_aggregate_config_rule_compliance_summary(params = {}, = {}) req = build_request(:get_aggregate_config_rule_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 AWS 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.
2531 2532 2533 2534 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2531 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.
2594 2595 2596 2597 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2594 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 AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
2655 2656 2657 2658 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2655 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 AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.
2714 2715 2716 2717 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2714 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 AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
2738 2739 2740 2741 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2738 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.
2781 2782 2783 2784 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2781 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 AWS resources that are monitered by conformance pack.
2842 2843 2844 2845 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2842 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.
2885 2886 2887 2888 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2885 def get_conformance_pack_compliance_summary(params = {}, = {}) req = build_request(:get_conformance_pack_compliance_summary, 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 AWS Config is recording in this region for your AWS account.
Example
AWS 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.AWS 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, AWS 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 AWS Config customer.
You just enabled resource recording.
It might take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
2982 2983 2984 2985 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 2982 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.
3038 3039 3040 3041 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3038 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.
3094 3095 3096 3097 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3094 def get_organization_conformance_pack_detailed_status(params = {}, = {}) req = build_request(:get_organization_conformance_pack_detailed_status, params) req.send_request() end |
#get_resource_config_history(params = {}) ⇒ Types::GetResourceConfigHistoryResponse
Returns a list of configuration items 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), AWS Config returns the ConfigurationItems
for the specified retention period.
The response is paginated. By default, AWS 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.
3200 3201 3202 3203 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3200 def get_resource_config_history(params = {}, = {}) req = build_request(:get_resource_config_history, params) req.send_request() end |
#get_stored_query(params = {}) ⇒ Types::GetStoredQueryResponse
Returns the details of a specific stored query.
3232 3233 3234 3235 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3232 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.
3303 3304 3305 3306 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3303 def list_aggregate_discovered_resources(params = {}, = {}) req = build_request(:list_aggregate_discovered_resources, params) req.send_request() end |
#list_discovered_resources(params = {}) ⇒ Types::ListDiscoveredResourcesResponse
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS 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, AWS 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.
3383 3384 3385 3386 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3383 def list_discovered_resources(params = {}, = {}) req = build_request(:list_discovered_resources, params) req.send_request() end |
#list_stored_queries(params = {}) ⇒ Types::ListStoredQueriesResponse
List the stored queries for an AWS account in an AWS Region. The default is 100.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
3425 3426 3427 3428 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3425 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 AWS Config resource.
3470 3471 3472 3473 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3470 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.
3515 3516 3517 3518 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3515 def (params = {}, = {}) req = build_request(:put_aggregation_authorization, params) req.send_request() end |
#put_config_rule(params = {}) ⇒ Struct
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.
If you are adding a new custom AWS Config rule, you must first create
the AWS Lambda function that the rule invokes to evaluate your
resources. When you use the PutConfigRule
action to add the rule to
AWS Config, you must specify the Amazon Resource Name (ARN) that AWS
Lambda assigns to the function. Specify the ARN for the
SourceIdentifier
key. This key is part of the Source
object, which
is part of the ConfigRule
object.
If you are adding an AWS managed Config rule, specify the rule's
identifier for the SourceIdentifier
key. To reference AWS managed
Config rule identifiers, see About AWS Managed Config Rules.
For any new rule that you add, specify the ConfigRuleName
in the
ConfigRule
object. Do not specify the ConfigRuleArn
or the
ConfigRuleId
. These values are generated by AWS Config for new
rules.
If you are updating a rule that you added previously, you can specify
the rule by ConfigRuleName
, ConfigRuleId
, or ConfigRuleArn
in
the ConfigRule
data type that you use in this request.
The maximum number of rules that AWS Config supports is 150.
For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
3614 3615 3616 3617 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3614 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.
If your source type is an organization, you must be signed in to the
master account and all features must be enabled in your organization.
AWS Config calls EnableAwsServiceAccess
API to enable integration
between AWS Config and AWS Organizations.
3695 3696 3697 3698 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3695 def put_configuration_aggregator(params = {}, = {}) req = build_request(:put_configuration_aggregator, params) req.send_request() end |
#put_configuration_recorder(params = {}) ⇒ Struct
Creates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN
or the
recordingGroup
of an existing recorder. To change the role, call the
action on the existing configuration recorder and specify a role.
If ConfigurationRecorder
does not have the recordingGroup
parameter specified, the default is to record all supported resource
types.
3740 3741 3742 3743 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3740 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 AWS Config rules that can be easily deployed in an account and a region and across AWS Organization.
This API creates a service linked role
AWSServiceRoleForConfigConforms
in your account. The service linked
role is created only when the role does not exist in your account.
TemplateS3Uri
or the TemplateBody
parameter, but not both. If you provide both AWS Config uses the
TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
3820 3821 3822 3823 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3820 def put_conformance_pack(params = {}, = {}) req = build_request(:put_conformance_pack, params) req.send_request() end |
#put_delivery_channel(params = {}) ⇒ Struct
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.
Before you can create a delivery channel, you must create a configuration recorder.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
3867 3868 3869 3870 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3867 def put_delivery_channel(params = {}, = {}) req = build_request(:put_delivery_channel, params) req.send_request() end |
#put_evaluations(params = {}) ⇒ Types::PutEvaluationsResponse
Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.
3929 3930 3931 3932 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3929 def put_evaluations(params = {}, = {}) req = build_request(:put_evaluations, params) req.send_request() end |
#put_external_evaluation(params = {}) ⇒ Struct
Returns an empty response.
3957 3958 3959 3960 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 3957 def put_external_evaluation(params = {}, = {}) req = build_request(:put_external_evaluation, params) req.send_request() end |
#put_organization_config_rule(params = {}) ⇒ Types::PutOrganizationConfigRuleResponse
Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations.
Only a master account and a delegated administrator can create or
update an organization config rule. When calling this API with a
delegated administrator, you must ensure AWS Organizations
ListDelegatedAdministrator
permissions are added.
This API enables organization service access through the
EnableAWSServiceAccess
action and creates a service linked role
AWSServiceRoleForConfigMultiAccountSetup
in the master or delegated
administrator account of your organization. The service linked role is
created only when the role does not exist in the caller account. AWS
Config verifies the existence of role with GetRole
action.
To use this API with delegated administrator, register a delegated
administrator by calling AWS Organization
register-delegated-administrator
for
config-multiaccountsetup.amazonaws.com
.
You can use this action to create both custom AWS Config rules and AWS
managed Config rules. If you are adding a new custom AWS Config rule,
you must first create AWS Lambda function in the master account or a
delegated administrator that the rule invokes to evaluate your
resources. When you use the PutOrganizationConfigRule
action to add
the rule to AWS Config, you must specify the Amazon Resource Name
(ARN) that AWS Lambda assigns to the function. If you are adding an
AWS managed Config rule, specify the rule's identifier for the
RuleIdentifier
key.
The maximum number of organization config rules that AWS Config supports is 150 and 3 delegated administrator per organization.
EnableAllFeatures
API to enable all
features in an organization.
Specify either OrganizationCustomRuleMetadata
or
OrganizationManagedRuleMetadata
.
4057 4058 4059 4060 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4057 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 AWS Organization.
Only a master account and a delegated administrator can call this API.
When calling this API with a delegated administrator, you must ensure
AWS Organizations ListDelegatedAdministrator
permissions are added.
This API enables organization service access for
config-multiaccountsetup.amazonaws.com
through the
EnableAWSServiceAccess
action and creates a service linked role
AWSServiceRoleForConfigMultiAccountSetup
in the master or delegated
administrator account of your organization. The service linked role is
created only when the role does not exist in the caller account. To
use this API with delegated administrator, register a delegated
administrator by calling AWS 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 AWS Config uses the
TemplateS3Uri
parameter and ignores the TemplateBody
parameter.
AWS Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
You can create 6 conformance packs with 25 AWS Config rules in each pack and 3 delegated administrator per organization.
4165 4166 4167 4168 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4165 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 AWS
Config rule with the selected target or action. The API creates the
RemediationConfiguration
object for the AWS Config rule. The AWS
Config rule must already exist for you to add a remediation
configuration. The target (SSM document) must exist and have
permissions to use the target.
This API does not support adding remediation configurations for service-linked AWS Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by AWS Security Hub.
4255 4256 4257 4258 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4255 def put_remediation_configurations(params = {}, = {}) req = build_request(:put_remediation_configurations, params) req.send_request() end |
#put_remediation_exceptions(params = {}) ⇒ Types::PutRemediationExceptionsResponse
A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an exisiting exception for a specific resource with a specific AWS Config rule.
4319 4320 4321 4322 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4319 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 AWS 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 AWS Config APIs.
When you call this API, AWS 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.
4393 4394 4395 4396 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4393 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 AWS 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.
4436 4437 4438 4439 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4436 def put_retention_configuration(params = {}, = {}) req = build_request(:put_retention_configuration, params) req.send_request() end |
#put_stored_query(params = {}) ⇒ Types::PutStoredQueryResponse
Saves a new query or updates an existing saved query. The QueryName
must be unique for an AWS account in an AWS Region. You can create
upto 300 queries in an AWS account in an AWS Region.
4482 4483 4484 4485 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4482 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 AWS 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 AWS Config Developer Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
4546 4547 4548 4549 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4546 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 AWS Config Developer Guide.
4598 4599 4600 4601 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4598 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 AWS 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 AWS 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
AWS 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, AWS 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.AWS Config invokes your Lambda function and evaluates your IAM resources.
Your custom rule will still run periodic evaluations every 24 hours.
4657 4658 4659 4660 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4657 def start_config_rules_evaluation(params = {}, = {}) req = build_request(:start_config_rules_evaluation, params) req.send_request() end |
#start_configuration_recorder(params = {}) ⇒ Struct
Starts recording configurations of the AWS resources you have selected to record in your AWS account.
You must have created at least one delivery channel to successfully start the configuration recorder.
4684 4685 4686 4687 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4684 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 AWS 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.
4734 4735 4736 4737 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4734 def start_remediation_execution(params = {}, = {}) req = build_request(:start_remediation_execution, params) req.send_request() end |
#stop_configuration_recorder(params = {}) ⇒ Struct
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
4758 4759 4760 4761 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4758 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. When a resource is deleted, the tags associated with that resource are deleted as well.
4794 4795 4796 4797 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4794 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
4822 4823 4824 4825 |
# File 'gems/aws-sdk-configservice/lib/aws-sdk-configservice/client.rb', line 4822 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |