Package-level declarations

Types

Link copied to clipboard

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.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

Adds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when recording.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Deletes the customer managed configuration recorder.

Link copied to clipboard

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

Link copied to clipboard

Deletes the delivery channel.

Link copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Deletes the remediation configuration.

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

Deletes the retention configuration.

Link copied to clipboard

Deletes an existing service-linked configuration recorder.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Returns a list of the existing and deleted conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.

Link copied to clipboard

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

Link copied to clipboard

Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this operation returns the number of Amazon Web Services resources that do not comply with the rule.

Link copied to clipboard

Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this operation returns the number of Config rules that the resource does not comply with.

Link copied to clipboard

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 copied to clipboard

Returns details about your Config rules.

Link copied to clipboard

Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this operation returns the details for all the configuration aggregators associated with the account.

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 copied to clipboard

Returns details for the configuration recorder you specify.

Link copied to clipboard

Returns the current status of the configuration recorder you specify as well as the status of the last recording event for the configuration recorders.

Link copied to clipboard

Returns compliance details for each rule in that conformance pack.

Link copied to clipboard

Returns a list of one or more conformance packs.

Link copied to clipboard

Provides one or more conformance packs deployment status.

Link copied to clipboard

Returns details about the specified delivery channel. If a delivery channel is not specified, this operation returns the details of all delivery channels associated with the account.

Link copied to clipboard

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this operation returns the current status of all delivery channels associated with the account.

Link copied to clipboard

Returns a list of organization Config rules.

Link copied to clipboard

Provides organization Config rule deployment status for an organization.

Link copied to clipboard

Returns a list of organization conformance packs.

Provides organization conformance pack deployment status for an organization.

Link copied to clipboard

Returns a list of all pending aggregation requests.

Link copied to clipboard

Returns the details of one or more remediation configurations.

Link copied to clipboard

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.

Link copied to clipboard

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 copied to clipboard

Returns the details of one or more retention configurations. If the retention configuration name is not specified, this operation returns the details for all the retention configurations for that account.

Link copied to clipboard

Removes all resource types specified in the ResourceTypes list from the RecordingGroup of configuration recorder and excludes these resource types when recording.

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.

Link copied to clipboard

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. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

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 copied to clipboard

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

Link copied to clipboard

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 copied to clipboard

Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.

Link copied to clipboard

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

Link copied to clipboard

Returns the policy definition containing the logic for your Config Custom Policy rule.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Returns the policy definition containing the logic for your organization Config Custom Policy rule.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Returns the details of a specific stored query.

Link copied to clipboard

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.

Link copied to clipboard

Returns a list of configuration recorders depending on the filters you specify.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Returns a list of proactive resource evaluations.

Link copied to clipboard

Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.

Link copied to clipboard

List the tags for Config resource.

Link copied to clipboard

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

Link copied to clipboard

Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide.

Link copied to clipboard

Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.

Link copied to clipboard

Creates or updates the customer managed configuration recorder.

Link copied to clipboard

Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.

Link copied to clipboard

Creates or updates a delivery channel to deliver configuration information and other compliance information.

Link copied to clipboard

Used by an Lambda function to deliver evaluation results to Config. This operation is required in every Lambda function that is invoked by an Config rule.

Link copied to clipboard

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 copied to clipboard

Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.

Link copied to clipboard

Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Starts the customer managed configuration recorder. The customer managed configuration recorder will begin recording configuration changes for the resource types you specify.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Stops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified.

Link copied to clipboard
inline suspend fun ConfigClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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 copied to clipboard

Deletes specified tags from a resource.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.