AWS.Config (aws-elixir v0.8.0) View Source

AWS Config

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

You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS 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 AWS Config, see Supported AWS Resources.

You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config. This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config. The AWS 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. For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config in the AWS Config Developer Guide.

Link to this section Summary

Functions

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

Returns the current configuration for one or more requested resources.

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

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

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

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

Deletes the evaluation results for the specified AWS 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 one or more remediation exceptions mentioned in the resource keys.

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

Deletes the stored query for a single AWS account and a single AWS 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 AWS Config rules within each conformance pack.

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

Indicates whether the specified AWS Config rules are compliant.

Indicates whether the specified AWS resources are compliant.

Returns status information for each of your AWS managed Config rules.

Returns details about your AWS 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.

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 AWS 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 AWS Accounts and AWS Regions in an aggregator.

Returns the resource counts across accounts and regions that are present in your AWS 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 AWS Config rule.

Returns the evaluation results for the specified AWS resource.

Returns the number of AWS 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 AWS 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 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.

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 a list of configuration items for the specified resource.

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.

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

Lists the stored queries for a single AWS account and a single AWS Region.

List the tags for AWS Config resource.

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

Adds or updates an AWS Config rule for evaluating whether your AWS 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 the selected resource configurations.

Creates or updates a conformance pack.

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

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

Add or updates the evaluations for process checks.

Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations.

Deploys conformance packs across member accounts in an AWS Organization.

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

A remediation exception is when a specific 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 AWS 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 AWS 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 AWS Config rules against the last known configuration state of the resources.

Starts recording configurations of the AWS resources you have selected to record in your AWS account.

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

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

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

Deletes specified tags from a resource.

Link to this section Functions

Link to this function

batch_get_aggregate_resource_config(client, input, options \\ [])

View Source

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

The API does not return tags and relationships.

Link to this function

batch_get_resource_config(client, input, options \\ [])

View Source

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

delete_aggregation_authorization(client, input, options \\ [])

View Source

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

Link to this function

delete_config_rule(client, input, options \\ [])

View Source

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.

Link to this function

delete_configuration_aggregator(client, input, options \\ [])

View Source

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

Link to this function

delete_configuration_recorder(client, input, options \\ [])

View Source

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.

Link to this function

delete_conformance_pack(client, input, options \\ [])

View Source

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.

Link to this function

delete_delivery_channel(client, input, options \\ [])

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_evaluation_results(client, input, options \\ [])

View Source

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.

Link to this function

delete_organization_config_rule(client, input, options \\ [])

View Source

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.

Link to this function

delete_organization_conformance_pack(client, input, options \\ [])

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

Link to this function

delete_pending_aggregation_request(client, input, options \\ [])

View Source

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

Link to this function

delete_remediation_configuration(client, input, options \\ [])

View Source

Deletes the remediation configuration.

Link to this function

delete_remediation_exceptions(client, input, options \\ [])

View Source

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

AWS 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_resource_config(client, input, options \\ [])

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 AWS Config History.

Link to this function

delete_retention_configuration(client, input, options \\ [])

View Source

Deletes the retention configuration.

Link to this function

delete_stored_query(client, input, options \\ [])

View Source

Deletes the stored query for a single AWS account and a single AWS Region.

Link to this function

deliver_config_snapshot(client, input, options \\ [])

View Source

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.

Link to this function

describe_aggregate_compliance_by_config_rules(client, input, options \\ [])

View Source

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

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

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant AWS 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_aggregation_authorizations(client, input, options \\ [])

View Source

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

Link to this function

describe_compliance_by_config_rule(client, input, options \\ [])

View Source

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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • 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 the config: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.

Link to this function

describe_compliance_by_resource(client, input, options \\ [])

View Source

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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

  • 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 the config: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.

Link to this function

describe_config_rule_evaluation_status(client, input, options \\ [])

View Source

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.

Link to this function

describe_config_rules(client, input, options \\ [])

View Source

Returns details about your AWS Config rules.

Link to this function

describe_configuration_aggregator_sources_status(client, input, options \\ [])

View Source

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.

Link to this function

describe_configuration_aggregators(client, input, options \\ [])

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_recorder_status(client, input, options \\ [])

View Source

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.

Currently, you can specify only one configuration recorder per region in your account.

Link to this function

describe_configuration_recorders(client, input, options \\ [])

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.

Currently, you can specify only one configuration recorder per region in your account.

Link to this function

describe_conformance_pack_compliance(client, input, options \\ [])

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_status(client, input, options \\ [])

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_packs(client, input, options \\ [])

View Source

Returns a list of one or more conformance packs.

Link to this function

describe_delivery_channel_status(client, input, options \\ [])

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_channels(client, input, options \\ [])

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_organization_config_rule_statuses(client, input, options \\ [])

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_rules(client, input, options \\ [])

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.

Link to this function

describe_organization_conformance_pack_statuses(client, input, options \\ [])

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_packs(client, input, options \\ [])

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.

Link to this function

describe_pending_aggregation_requests(client, input, options \\ [])

View Source

Returns a list of all pending aggregation requests.

Link to this function

describe_remediation_configurations(client, input, options \\ [])

View Source

Returns the details of one or more remediation configurations.

Link to this function

describe_remediation_exceptions(client, input, options \\ [])

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.

AWS 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_execution_status(client, input, options \\ [])

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_retention_configurations(client, input, options \\ [])

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, AWS Config supports only one retention configuration per region in your account.

Link to this function

get_aggregate_compliance_details_by_config_rule(client, input, options \\ [])

View Source

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.

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

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_conformance_pack_compliance_summary(client, input, options \\ [])

View Source

Returns the count of compliant and noncompliant conformance packs across all AWS Accounts and AWS Regions in an aggregator.

You can filter based on AWS Account ID or AWS 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_discovered_resource_counts(client, input, options \\ [])

View Source

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.

Link to this function

get_aggregate_resource_config(client, input, options \\ [])

View Source

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

Link to this function

get_compliance_details_by_config_rule(client, input, options \\ [])

View Source

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.

Link to this function

get_compliance_details_by_resource(client, input, options \\ [])

View Source

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.

Link to this function

get_compliance_summary_by_config_rule(client, input, options \\ [])

View Source

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

Link to this function

get_compliance_summary_by_resource_type(client, input, options \\ [])

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_conformance_pack_compliance_details(client, input, options \\ [])

View Source

Returns compliance details of a conformance pack for all AWS resources that are monitered by conformance pack.

Link to this function

get_conformance_pack_compliance_summary(client, input, options \\ [])

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_discovered_resource_counts(client, input, options \\ [])

View Source

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

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

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

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

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

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.

Link to this function

get_organization_config_rule_detailed_status(client, input, options \\ [])

View Source

Returns detailed status for each member account within an organization for a given organization config rule.

Link to this function

get_organization_conformance_pack_detailed_status(client, input, options \\ [])

View Source

Returns detailed status for each member account within an organization for a given organization conformance pack.

Link to this function

get_resource_config_history(client, input, options \\ [])

View Source

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.

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_stored_query(client, input, options \\ [])

View Source

Returns the details of a specific stored query.

Link to this function

list_aggregate_discovered_resources(client, input, options \\ [])

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_discovered_resources(client, input, options \\ [])

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

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

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.

Link to this function

list_stored_queries(client, input, options \\ [])

View Source

Lists the stored queries for a single AWS account and a single AWS Region.

The default is 100.

Link to this function

list_tags_for_resource(client, input, options \\ [])

View Source

List the tags for AWS Config resource.

Link to this function

put_aggregation_authorization(client, input, options \\ [])

View Source

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

Link to this function

put_config_rule(client, input, options \\ [])

View Source

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.

Link to this function

put_configuration_aggregator(client, input, options \\ [])

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 DescribeAggregator to get the previous accounts and then append new ones.

AWS 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, AWS Config calls EnableAwsServiceAccess API to enable integration between AWS Config and AWS Organizations. If the caller is a registered delegated administrator, AWS Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator.

To register a delegated administrator, see Register a Delegated Administrator in the AWS Config developer guide.

Link to this function

put_configuration_recorder(client, input, options \\ [])

View Source

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.

Currently, you can specify only one configuration recorder per region in your account.

If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Link to this function

put_conformance_pack(client, input, options \\ [])

View Source

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.

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.

Link to this function

put_delivery_channel(client, input, options \\ [])

View Source

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.

You can have only one delivery channel per region in your account.

Link to this function

put_evaluations(client, input, options \\ [])

View Source

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.

Link to this function

put_external_evaluation(client, input, options \\ [])

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 AWS Config rule is provided.

Link to this function

put_organization_config_rule(client, input, options \\ [])

View Source

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.

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

Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata.

Link to this function

put_organization_conformance_pack(client, input, options \\ [])

View Source

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.

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 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 50 conformance packs with 25 AWS Config rules in each pack and 3 delegated administrator per organization.

Link to this function

put_remediation_configurations(client, input, options \\ [])

View Source

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.

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 AWS Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by AWS Security Hub.

Link to this function

put_remediation_exceptions(client, input, options \\ [])

View Source

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

This API adds a new exception or updates an existing exception for a specific resource with a specific AWS Config rule.

AWS 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

put_resource_config(client, input, options \\ [])

View Source

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.

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

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.

Link to this function

put_retention_configuration(client, input, options \\ [])

View Source

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.

Currently, AWS Config supports only one retention configuration per region in your account.

Link to this function

put_stored_query(client, input, options \\ [])

View Source

Saves a new query or updates an existing saved query.

The QueryName must be unique for a single AWS account and a single AWS Region. You can create upto 300 queries in a single AWS account and a single AWS Region.

Link to this function

select_aggregate_resource_config(client, input, options \\ [])

View Source

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.

Link to this function

select_resource_config(client, input, options \\ [])

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 section in the AWS Config Developer Guide.

Link to this function

start_config_rules_evaluation(client, input, options \\ [])

View Source

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.

You don't need to call the 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:

  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. AWS 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_configuration_recorder(client, input, options \\ [])

View Source

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.

Link to this function

start_remediation_execution(client, input, options \\ [])

View Source

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.

Link to this function

stop_configuration_recorder(client, input, options \\ [])

View Source

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Link to this function

tag_resource(client, input, options \\ [])

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. When a resource is deleted, the tags associated with that resource are deleted as well.

Link to this function

untag_resource(client, input, options \\ [])

View Source

Deletes specified tags from a resource.