View Source aws_config (aws v1.0.4)

Config

Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account.

You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by Config, see Supported Amazon Web Services resources: https://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources.

You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see Signature Version 4 Signing Process: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html. For detailed information about Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see What Is Config: https://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html in the Config Developer Guide.

Summary

Functions

Returns the current configuration items for resources that are present in your Config aggregator.

Returns the BaseConfigurationItem for one or more requested resources.

Deletes the authorization granted to the specified configuration aggregator account in a specified region.

Deletes the specified Config rule and all of its evaluation results.

Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

Deletes the configuration recorder.

Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.

Deletes the delivery channel.

Deletes the evaluation results for the specified Config rule.

Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.

Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.

Deletes pending authorization requests for a specified aggregator account in a specified region.
Deletes the remediation configuration.

Deletes one or more remediation exceptions mentioned in the resource keys.

Records the configuration state for a custom resource that has been deleted.

Deletes the retention configuration.
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.

Returns a list of authorizations granted to various aggregator accounts and regions.

Indicates whether the specified Config rules are compliant.

Indicates whether the specified Amazon Web Services resources are compliant.

Returns status information for each of your Config managed rules.

Returns details about your Config rules.

Returns status information for sources within an aggregator.

Returns the details of one or more configuration aggregators.

Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder.

Returns the details for the specified configuration recorders.

Returns compliance details for each rule in that conformance pack.

Provides one or more conformance packs deployment status.

Returns a list of one or more conformance packs.

Returns the current status of the specified delivery channel.

Returns details about the specified delivery channel.

Provides organization Config rule deployment status for an organization.

Returns a list of organization Config rules.

Provides organization conformance pack deployment status for an organization.

Returns a list of organization conformance packs.

Returns a list of all pending aggregation requests.
Returns the details of one or more remediation configurations.

Returns the details of one or more remediation exceptions.

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.

Returns the details of one or more retention configurations.

Returns the evaluation results for the specified Config rule for a specific resource in a rule.

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.

Returns the resource counts across accounts and regions that are present in your Config aggregator.

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

Returns the evaluation results for the specified Config rule.

Returns the evaluation results for the specified Amazon Web Services resource.

Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

Returns the number of resources that are compliant and the number that are noncompliant.

Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
Returns the policy definition containing the logic for your Config Custom Policy rule.

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.

Returns detailed status for each member account within an organization for a given organization Config rule.
Returns detailed status for each member account within an organization for a given organization conformance pack.
Returns the policy definition containing the logic for your organization Config Custom Policy rule.

For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type.

Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run.

Returns the details of a specific stored query.

Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.

Returns a list of conformance pack compliance scores.

Accepts a resource type and returns a list of resource identifiers for the resources of that type.

Returns a list of proactive resource evaluations.

Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region.

List the tags for Config resource.

Authorizes the aggregator account and region to collect data from the source account and region.

Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations.

Creates and updates the configuration aggregator with the selected source accounts and regions.

Creates a new configuration recorder to record configuration changes for specified resource types.

Creates or updates a conformance pack.

Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic.

Used by an Lambda function to deliver evaluation results to Config.

Add or updates the evaluations for process checks.

Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations.

Deploys conformance packs across member accounts in an Amazon Web Services Organization.

Adds or updates the remediation configuration with a specific Config rule with the selected target or action.

A remediation exception is when a specified resource is no longer considered for auto-remediation.

Records the configuration state for the resource provided in the request.

Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information.

Saves a new query or updates an existing saved query.

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.

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties.

Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources.

Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

Runs an on-demand remediation for the specified Config rules against the last known remediation configuration.

Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules.

Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

Associates the specified tags to a resource with the specified resourceArn.

Deletes specified tags from a resource.

Functions

Link to this function

batch_get_aggregate_resource_config(Client, Input)

View Source

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 results for deleted resources.

The API does not return tags and relationships.
Link to this function

batch_get_aggregate_resource_config(Client, Input, Options)

View Source
Link to this function

batch_get_resource_config(Client, Input)

View Source

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 results for deleted resources.

The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.
Link to this function

batch_get_resource_config(Client, Input, Options)

View Source
Link to this function

delete_aggregation_authorization(Client, Input)

View Source
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
Link to this function

delete_aggregation_authorization(Client, Input, Options)

View Source
Link to this function

delete_config_rule(Client, Input)

View Source

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.
Link to this function

delete_config_rule(Client, Input, Options)

View Source
Link to this function

delete_configuration_aggregator(Client, Input)

View Source
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
Link to this function

delete_configuration_aggregator(Client, Input, Options)

View Source
Link to this function

delete_configuration_recorder(Client, Input)

View Source

Deletes the configuration recorder.

After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.

This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the Config console until you create a new configuration recorder.
Link to this function

delete_configuration_recorder(Client, Input, Options)

View Source
Link to this function

delete_conformance_pack(Client, Input)

View Source

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.
Link to this function

delete_conformance_pack(Client, Input, Options)

View Source
Link to this function

delete_delivery_channel(Client, Input)

View Source

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
Link to this function

delete_delivery_channel(Client, Input, Options)

View Source
Link to this function

delete_evaluation_results(Client, Input)

View Source

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.
Link to this function

delete_evaluation_results(Client, Input, Options)

View Source
Link to this function

delete_organization_config_rule(Client, Input)

View Source

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.
Link to this function

delete_organization_config_rule(Client, Input, Options)

View Source
Link to this function

delete_organization_conformance_pack(Client, Input)

View Source

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.
Link to this function

delete_organization_conformance_pack(Client, Input, Options)

View Source
Link to this function

delete_pending_aggregation_request(Client, Input)

View Source
Deletes pending authorization requests for a specified aggregator account in a specified region.
Link to this function

delete_pending_aggregation_request(Client, Input, Options)

View Source
Link to this function

delete_remediation_configuration(Client, Input)

View Source
Deletes the remediation configuration.
Link to this function

delete_remediation_configuration(Client, Input, Options)

View Source
Link to this function

delete_remediation_exceptions(Client, Input)

View Source

Deletes one or more remediation exceptions mentioned in the resource keys.

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
Link to this function

delete_remediation_exceptions(Client, Input, Options)

View Source
Link to this function

delete_resource_config(Client, Input)

View Source

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.
Link to this function

delete_resource_config(Client, Input, Options)

View Source
Link to this function

delete_retention_configuration(Client, Input)

View Source
Deletes the retention configuration.
Link to this function

delete_retention_configuration(Client, Input, Options)

View Source
Link to this function

delete_stored_query(Client, Input)

View Source
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
Link to this function

delete_stored_query(Client, Input, Options)

View Source
Link to this function

deliver_config_snapshot(Client, Input)

View Source

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.

Link to this function

deliver_config_snapshot(Client, Input, Options)

View Source
Link to this function

describe_aggregate_compliance_by_config_rules(Client, Input)

View Source

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.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Link to this function

describe_aggregate_compliance_by_config_rules(Client, Input, Options)

View Source
Link to this function

describe_aggregate_compliance_by_conformance_packs(Client, Input)

View Source

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.

Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Link to this function

describe_aggregate_compliance_by_conformance_packs(Client, Input, Options)

View Source
Link to this function

describe_aggregation_authorizations(Client, Input)

View Source
Returns a list of authorizations granted to various aggregator accounts and regions.
Link to this function

describe_aggregation_authorizations(Client, Input, Options)

View Source
Link to this function

describe_compliance_by_config_rule(Client, Input)

View Source

Indicates whether the specified Config rules are compliant.

If a rule is noncompliant, this action returns the number of Amazon Web Services resources that do not comply with the rule.

A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply.

If Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions:

  • Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.

  • The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Link to this function

describe_compliance_by_config_rule(Client, Input, Options)

View Source
Link to this function

describe_compliance_by_resource(Client, Input)

View Source

Indicates whether the specified Amazon Web Services resources are compliant.

If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.

A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.

If Config has no current evaluation results for the resource, it returns INSUFFICIENT_DATA. This result might indicate one of the following conditions about the rules that evaluate the resource:

  • Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations permission.

  • The rule's Lambda function has returned NOT_APPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Link to this function

describe_compliance_by_resource(Client, Input, Options)

View Source
Link to this function

describe_config_rule_evaluation_status(Client, Input)

View Source

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.
Link to this function

describe_config_rule_evaluation_status(Client, Input, Options)

View Source
Link to this function

describe_config_rules(Client, Input)

View Source
Returns details about your Config rules.
Link to this function

describe_config_rules(Client, Input, Options)

View Source
Link to this function

describe_configuration_aggregator_sources_status(Client, Input)

View Source

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.
Link to this function

describe_configuration_aggregator_sources_status(Client, Input, Options)

View Source
Link to this function

describe_configuration_aggregators(Client, Input)

View Source

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.
Link to this function

describe_configuration_aggregators(Client, Input, Options)

View Source
Link to this function

describe_configuration_recorder_status(Client, Input)

View Source

Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder.

If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.

>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
Link to this function

describe_configuration_recorder_status(Client, Input, Options)

View Source
Link to this function

describe_configuration_recorders(Client, Input)

View Source

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.

You can specify only one configuration recorder for each Amazon Web Services Region for each account.
Link to this function

describe_configuration_recorders(Client, Input, Options)

View Source
Link to this function

describe_conformance_pack_compliance(Client, Input)

View Source

Returns compliance details for each rule in that conformance pack.

You must provide exact rule names.
Link to this function

describe_conformance_pack_compliance(Client, Input, Options)

View Source
Link to this function

describe_conformance_pack_status(Client, Input)

View Source

Provides one or more conformance packs deployment status.

If there are no conformance packs then you will see an empty result.
Link to this function

describe_conformance_pack_status(Client, Input, Options)

View Source
Link to this function

describe_conformance_packs(Client, Input)

View Source
Returns a list of one or more conformance packs.
Link to this function

describe_conformance_packs(Client, Input, Options)

View Source
Link to this function

describe_delivery_channel_status(Client, Input)

View Source

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.

Currently, you can specify only one delivery channel per region in your account.
Link to this function

describe_delivery_channel_status(Client, Input, Options)

View Source
Link to this function

describe_delivery_channels(Client, Input)

View Source

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.

Currently, you can specify only one delivery channel per region in your account.
Link to this function

describe_delivery_channels(Client, Input, Options)

View Source
Link to this function

describe_organization_config_rule_statuses(Client, Input)

View Source

Provides organization Config rule deployment status for an organization.

The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
Link to this function

describe_organization_config_rule_statuses(Client, Input, Options)

View Source
Link to this function

describe_organization_config_rules(Client, Input)

View Source

Returns a list of organization Config rules.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.

For accounts within an organization

If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
Link to this function

describe_organization_config_rules(Client, Input, Options)

View Source
Link to this function

describe_organization_conformance_pack_statuses(Client, Input)

View Source

Provides organization conformance pack deployment status for an organization.

The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.

When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
Link to this function

describe_organization_conformance_pack_statuses(Client, Input, Options)

View Source
Link to this function

describe_organization_conformance_packs(Client, Input)

View Source

Returns a list of organization conformance packs.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.

For accounts within an organization

If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The DescribeOrganizationConfigRules and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
Link to this function

describe_organization_conformance_packs(Client, Input, Options)

View Source
Link to this function

describe_pending_aggregation_requests(Client, Input)

View Source
Returns a list of all pending aggregation requests.
Link to this function

describe_pending_aggregation_requests(Client, Input, Options)

View Source
Link to this function

describe_remediation_configurations(Client, Input)

View Source
Returns the details of one or more remediation configurations.
Link to this function

describe_remediation_configurations(Client, Input, Options)

View Source
Link to this function

describe_remediation_exceptions(Client, Input)

View Source

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.

Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

When you specify the limit and the next token, you receive a paginated response.

Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
Link to this function

describe_remediation_exceptions(Client, Input, Options)

View Source
Link to this function

describe_remediation_execution_status(Client, Input)

View Source

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.
Link to this function

describe_remediation_execution_status(Client, Input, Options)

View Source
Link to this function

describe_retention_configurations(Client, Input)

View Source

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.

Currently, Config supports only one retention configuration per region in your account.
Link to this function

describe_retention_configurations(Client, Input, Options)

View Source
Link to this function

get_aggregate_compliance_details_by_config_rule(Client, Input)

View Source

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.

The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.
Link to this function

get_aggregate_compliance_details_by_config_rule(Client, Input, Options)

View Source
Link to this function

get_aggregate_config_rule_compliance_summary(Client, Input)

View Source

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.

The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Link to this function

get_aggregate_config_rule_compliance_summary(Client, Input, Options)

View Source
Link to this function

get_aggregate_conformance_pack_compliance_summary(Client, Input)

View Source

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 results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
Link to this function

get_aggregate_conformance_pack_compliance_summary(Client, Input, Options)

View Source
Link to this function

get_aggregate_discovered_resource_counts(Client, Input)

View Source

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.
Link to this function

get_aggregate_discovered_resource_counts(Client, Input, Options)

View Source
Link to this function

get_aggregate_resource_config(Client, Input)

View Source
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
Link to this function

get_aggregate_resource_config(Client, Input, Options)

View Source
Link to this function

get_compliance_details_by_config_rule(Client, Input)

View Source

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.
Link to this function

get_compliance_details_by_config_rule(Client, Input, Options)

View Source
Link to this function

get_compliance_details_by_resource(Client, Input)

View Source

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.
Link to this function

get_compliance_details_by_resource(Client, Input, Options)

View Source
Link to this function

get_compliance_summary_by_config_rule(Client, Input)

View Source
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
Link to this function

get_compliance_summary_by_config_rule(Client, Input, Options)

View Source
Link to this function

get_compliance_summary_by_resource_type(Client, Input)

View Source

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.
Link to this function

get_compliance_summary_by_resource_type(Client, Input, Options)

View Source
Link to this function

get_conformance_pack_compliance_details(Client, Input)

View Source
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
Link to this function

get_conformance_pack_compliance_details(Client, Input, Options)

View Source
Link to this function

get_conformance_pack_compliance_summary(Client, Input)

View Source
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
Link to this function

get_conformance_pack_compliance_summary(Client, Input, Options)

View Source
Link to this function

get_custom_rule_policy(Client, Input)

View Source
Returns the policy definition containing the logic for your Config Custom Policy rule.
Link to this function

get_custom_rule_policy(Client, Input, Options)

View Source
Link to this function

get_discovered_resource_counts(Client, Input)

View Source

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

  1. 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.

  2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

  3. 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.

If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

You are a new Config customer.

You just enabled resource recording.

It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
Link to this function

get_discovered_resource_counts(Client, Input, Options)

View Source
Link to this function

get_organization_config_rule_detailed_status(Client, Input)

View Source
Returns detailed status for each member account within an organization for a given organization Config rule.
Link to this function

get_organization_config_rule_detailed_status(Client, Input, Options)

View Source
Link to this function

get_organization_conformance_pack_detailed_status(Client, Input)

View Source
Returns detailed status for each member account within an organization for a given organization conformance pack.
Link to this function

get_organization_conformance_pack_detailed_status(Client, Input, Options)

View Source
Link to this function

get_organization_custom_rule_policy(Client, Input)

View Source
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
Link to this function

get_organization_custom_rule_policy(Client, Input, Options)

View Source
Link to this function

get_resource_config_history(Client, Input)

View Source

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: https://docs.aws.amazon.com/config/latest/developerguide/select-resources.html.

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.

Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.
Link to this function

get_resource_config_history(Client, Input, Options)

View Source
Link to this function

get_resource_evaluation_summary(Client, Input)

View Source

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.

To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource: https://docs.aws.amazon.com/config/latest/APIReference/API_GetComplianceDetailsByResource.html API. For more information, see the Examples: https://docs.aws.amazon.com/config/latest/APIReference/API_GetResourceEvaluationSummary.html#API_GetResourceEvaluationSummary_Examples section.
Link to this function

get_resource_evaluation_summary(Client, Input, Options)

View Source
Link to this function

get_stored_query(Client, Input)

View Source
Returns the details of a specific stored query.
Link to this function

get_stored_query(Client, Input, Options)

View Source
Link to this function

list_aggregate_discovered_resources(Client, Input)

View Source

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.
Link to this function

list_aggregate_discovered_resources(Client, Input, Options)

View Source
Link to this function

list_conformance_pack_compliance_scores(Client, Input)

View Source

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.

Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.
Link to this function

list_conformance_pack_compliance_scores(Client, Input, Options)

View Source
Link to this function

list_discovered_resources(Client, Input)

View Source

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.

You can specify either resource IDs or a resource name, but not both, in the same request.

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.
Link to this function

list_discovered_resources(Client, Input, Options)

View Source
Link to this function

list_resource_evaluations(Client, Input)

View Source
Returns a list of proactive resource evaluations.
Link to this function

list_resource_evaluations(Client, Input, Options)

View Source
Link to this function

list_stored_queries(Client, Input)

View Source

Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region.

The default is 100.
Link to this function

list_stored_queries(Client, Input, Options)

View Source
Link to this function

list_tags_for_resource(Client, Input)

View Source
List the tags for Config resource.
Link to this function

list_tags_for_resource(Client, Input, Options)

View Source
Link to this function

put_aggregation_authorization(Client, Input)

View Source

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.
Link to this function

put_aggregation_authorization(Client, Input, Options)

View Source
Link to this function

put_config_rule(Client, Input)

View Source

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 : https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html 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: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html. 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: https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function) and with Guard (Guard GitHub Repository: https://github.com/aws-cloudformation/cloudformation-guard), 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: https://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html 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.
Link to this function

put_config_rule(Client, Input, Options)

View Source
Link to this function

put_configuration_aggregator(Client, Input)

View Source

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.

Config should be enabled in source accounts and regions you want to aggregate.

If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls EnableAwsServiceAccess API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

To register a delegated administrator, see Register a Delegated Administrator: https://docs.aws.amazon.com/config/latest/developerguide/set-up-aggregator-cli.html#register-a-delegated-administrator-cli 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.
Link to this function

put_configuration_aggregator(Client, Input, Options)

View Source
Link to this function

put_configuration_recorder(Client, Input)

View Source

Creates a new configuration recorder to record configuration changes for specified resource types.

You can also use this action to change the roleARN or the recordingGroup of an existing recorder. For more information, see Managing the Configuration Recorder : https://docs.aws.amazon.com/config/latest/developerguide/stop-start-recorder.html in the Config Developer Guide.

You can specify only one configuration recorder for each Amazon Web Services Region for each account.

If the configuration recorder does not have the recordingGroup field specified, the default is to record all supported resource types.
Link to this function

put_configuration_recorder(Client, Input, Options)

View Source
Link to this function

put_conformance_pack(Client, Input)

View Source

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 : https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html 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.

You must specify only one of the follow parameters: TemplateS3Uri, TemplateBody or TemplateSSMDocumentDetails.
Link to this function

put_conformance_pack(Client, Input, Options)

View Source
Link to this function

put_delivery_channel(Client, Input)

View Source

Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic.

For more information, see Notifications that Config Sends to an Amazon SNS topic: https://docs.aws.amazon.com/config/latest/developerguide/notifications-for-AWS-Config.html.

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.

You can have only one delivery channel per region in your account.
Link to this function

put_delivery_channel(Client, Input, Options)

View Source
Link to this function

put_evaluations(Client, Input)

View Source

Used by an Lambda function to deliver evaluation results to Config.

This action is required in every Lambda function that is invoked by an Config rule.
Link to this function

put_evaluations(Client, Input, Options)

View Source
Link to this function

put_external_evaluation(Client, Input)

View Source

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.
Link to this function

put_external_evaluation(Client, Input, Options)

View Source
Link to this function

put_organization_config_rule(Client, Input)

View Source

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 : https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html 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: https://docs.aws.amazon.com/config/latest/developerguide/managed-rules-by-aws-config.html. 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: https://docs.aws.amazon.com/config/latest/developerguide/gettingstarted-concepts.html#gettingstarted-concepts-function) and with Guard (Guard GitHub Repository: https://github.com/aws-cloudformation/cloudformation-guard), 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.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

Make sure to specify one of either OrganizationCustomPolicyRuleMetadata for Custom Policy rules, OrganizationCustomRuleMetadata for Custom Lambda rules, or OrganizationManagedRuleMetadata for managed rules.
Link to this function

put_organization_config_rule(Client, Input, Options)

View Source
Link to this function

put_organization_conformance_pack(Client, Input)

View Source

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 : https://docs.aws.amazon.com/config/latest/developerguide/configlimits.html 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.

Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
Link to this function

put_organization_conformance_pack(Client, Input, Options)

View Source
Link to this function

put_remediation_configurations(Client, Input)

View Source

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.

Be aware of backward incompatible changes

If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.

This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.

Required fields

For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield 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.

Auto remediation can be initiated even for compliant resources

If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations: https://docs.aws.amazon.com/config/latest/APIReference/emAPI_PutRemediationConfigurations.html 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.
Link to this function

put_remediation_configurations(Client, Input, Options)

View Source
Link to this function

put_remediation_exceptions(Client, Input)

View Source

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.

Exceptions block auto remediation

Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

Manual remediation is recommended when placing an exception

When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as NON_COMPLIANT. Once the resource has been evaluated as NON_COMPLIANT, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before a NON_COMPLIANT evaluation result can delete resources before the exception is applied.

Exceptions can only be performed on non-compliant resources

Placing an exception can only be performed on resources that are NON_COMPLIANT. If you use this API for COMPLIANT resources or resources that are NOT_APPLICABLE, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see Concepts | Config Rules: https://docs.aws.amazon.com/config/latest/developerguide/config-concepts.html#aws-config-rules in the Config Developer Guide.

Auto remediation can be initiated even for compliant resources

If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations: https://docs.aws.amazon.com/config/latest/APIReference/emAPI_PutRemediationConfigurations.html 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.
Link to this function

put_remediation_exceptions(Client, Input, Options)

View Source
Link to this function

put_resource_config(Client, Input)

View Source

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.

The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.

When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.

Write-only schema properites are not recorded as part of the published configuration item.
Link to this function

put_resource_config(Client, Input, Options)

View Source
Link to this function

put_retention_configuration(Client, Input)

View Source

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.

Currently, Config supports only one retention configuration per region in your account.
Link to this function

put_retention_configuration(Client, Input, Options)

View Source
Link to this function

put_stored_query(Client, Input)

View Source

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.
Link to this function

put_stored_query(Client, Input, Options)

View Source
Link to this function

select_aggregate_resource_config(Client, Input)

View Source

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 : https://docs.aws.amazon.com/config/latest/developerguide/query-components.html section in the Config Developer Guide.

If you run an aggregation query (i.e., using GROUP BY or using aggregate functions such as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType =AWS::IAM::Role' GROUP BY resourceId') and do not specify the MaxResults or the Limit query parameters, the default page size is set to 500.

If you run a non-aggregation query (i.e., not using GROUP BY or aggregate function; e.g., SELECT * WHERE resourceType =AWS::IAM::Role'') and do not specify the MaxResults or the Limit query parameters, the default page size is set to 25.
Link to this function

select_aggregate_resource_config(Client, Input, Options)

View Source
Link to this function

select_resource_config(Client, Input)

View Source

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 : https://docs.aws.amazon.com/config/latest/developerguide/query-components.html section in the Config Developer Guide.
Link to this function

select_resource_config(Client, Input, Options)

View Source
Link to this function

start_config_rules_evaluation(Client, Input)

View Source

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.

You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, Config evaluates your resources against the rule automatically.

The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example:

  1. You have a custom rule that evaluates your IAM resources every 24 hours.

  2. You update your Lambda function to add additional conditions to your rule.

  3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

  4. Config invokes your Lambda function and evaluates your IAM resources.

  5. Your custom rule will still run periodic evaluations every 24 hours.

Link to this function

start_config_rules_evaluation(Client, Input, Options)

View Source
Link to this function

start_configuration_recorder(Client, Input)

View Source

Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.

You must have created at least one delivery channel to successfully start the configuration recorder.
Link to this function

start_configuration_recorder(Client, Input, Options)

View Source
Link to this function

start_remediation_execution(Client, Input)

View Source

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.
Link to this function

start_remediation_execution(Client, Input, Options)

View Source
Link to this function

start_resource_evaluation(Client, Input)

View Source

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.

Ensure you have the cloudformation:DescribeType role setup to validate the resource type schema.

You can find the Resource type schema: https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-schema.html 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: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html#registry-view and Amazon Web Services resource and property types reference: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html in the CloudFormation User Guide.
Link to this function

start_resource_evaluation(Client, Input, Options)

View Source
Link to this function

stop_configuration_recorder(Client, Input)

View Source
Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
Link to this function

stop_configuration_recorder(Client, Input, Options)

View Source
Link to this function

tag_resource(Client, Input)

View Source

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.
Link to this function

tag_resource(Client, Input, Options)

View Source
Link to this function

untag_resource(Client, Input)

View Source
Deletes specified tags from a resource.
Link to this function

untag_resource(Client, Input, Options)

View Source