commonMain.aws.sdk.kotlin.services.configservice.ConfigClient.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of configservice-jvm Show documentation
Show all versions of configservice-jvm Show documentation
The AWS SDK for Kotlin client for Config Service
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.configservice
import aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider
import aws.sdk.kotlin.runtime.auth.credentials.internal.manage
import aws.sdk.kotlin.runtime.client.AwsSdkClientConfig
import aws.sdk.kotlin.runtime.config.AbstractAwsSdkClientFactory
import aws.sdk.kotlin.runtime.config.endpoints.resolveEndpointUrl
import aws.sdk.kotlin.runtime.config.profile.AwsProfile
import aws.sdk.kotlin.runtime.config.profile.AwsSharedConfig
import aws.sdk.kotlin.runtime.http.retries.AwsRetryPolicy
import aws.sdk.kotlin.services.configservice.auth.ConfigAuthSchemeProvider
import aws.sdk.kotlin.services.configservice.auth.DefaultConfigAuthSchemeProvider
import aws.sdk.kotlin.services.configservice.endpoints.ConfigEndpointParameters
import aws.sdk.kotlin.services.configservice.endpoints.ConfigEndpointProvider
import aws.sdk.kotlin.services.configservice.endpoints.DefaultConfigEndpointProvider
import aws.sdk.kotlin.services.configservice.model.BatchGetAggregateResourceConfigRequest
import aws.sdk.kotlin.services.configservice.model.BatchGetAggregateResourceConfigResponse
import aws.sdk.kotlin.services.configservice.model.BatchGetResourceConfigRequest
import aws.sdk.kotlin.services.configservice.model.BatchGetResourceConfigResponse
import aws.sdk.kotlin.services.configservice.model.DeleteAggregationAuthorizationRequest
import aws.sdk.kotlin.services.configservice.model.DeleteAggregationAuthorizationResponse
import aws.sdk.kotlin.services.configservice.model.DeleteConfigRuleRequest
import aws.sdk.kotlin.services.configservice.model.DeleteConfigRuleResponse
import aws.sdk.kotlin.services.configservice.model.DeleteConfigurationAggregatorRequest
import aws.sdk.kotlin.services.configservice.model.DeleteConfigurationAggregatorResponse
import aws.sdk.kotlin.services.configservice.model.DeleteConfigurationRecorderRequest
import aws.sdk.kotlin.services.configservice.model.DeleteConfigurationRecorderResponse
import aws.sdk.kotlin.services.configservice.model.DeleteConformancePackRequest
import aws.sdk.kotlin.services.configservice.model.DeleteConformancePackResponse
import aws.sdk.kotlin.services.configservice.model.DeleteDeliveryChannelRequest
import aws.sdk.kotlin.services.configservice.model.DeleteDeliveryChannelResponse
import aws.sdk.kotlin.services.configservice.model.DeleteEvaluationResultsRequest
import aws.sdk.kotlin.services.configservice.model.DeleteEvaluationResultsResponse
import aws.sdk.kotlin.services.configservice.model.DeleteOrganizationConfigRuleRequest
import aws.sdk.kotlin.services.configservice.model.DeleteOrganizationConfigRuleResponse
import aws.sdk.kotlin.services.configservice.model.DeleteOrganizationConformancePackRequest
import aws.sdk.kotlin.services.configservice.model.DeleteOrganizationConformancePackResponse
import aws.sdk.kotlin.services.configservice.model.DeletePendingAggregationRequestRequest
import aws.sdk.kotlin.services.configservice.model.DeletePendingAggregationRequestResponse
import aws.sdk.kotlin.services.configservice.model.DeleteRemediationConfigurationRequest
import aws.sdk.kotlin.services.configservice.model.DeleteRemediationConfigurationResponse
import aws.sdk.kotlin.services.configservice.model.DeleteRemediationExceptionsRequest
import aws.sdk.kotlin.services.configservice.model.DeleteRemediationExceptionsResponse
import aws.sdk.kotlin.services.configservice.model.DeleteResourceConfigRequest
import aws.sdk.kotlin.services.configservice.model.DeleteResourceConfigResponse
import aws.sdk.kotlin.services.configservice.model.DeleteRetentionConfigurationRequest
import aws.sdk.kotlin.services.configservice.model.DeleteRetentionConfigurationResponse
import aws.sdk.kotlin.services.configservice.model.DeleteStoredQueryRequest
import aws.sdk.kotlin.services.configservice.model.DeleteStoredQueryResponse
import aws.sdk.kotlin.services.configservice.model.DeliverConfigSnapshotRequest
import aws.sdk.kotlin.services.configservice.model.DeliverConfigSnapshotResponse
import aws.sdk.kotlin.services.configservice.model.DescribeAggregateComplianceByConfigRulesRequest
import aws.sdk.kotlin.services.configservice.model.DescribeAggregateComplianceByConfigRulesResponse
import aws.sdk.kotlin.services.configservice.model.DescribeAggregateComplianceByConformancePacksRequest
import aws.sdk.kotlin.services.configservice.model.DescribeAggregateComplianceByConformancePacksResponse
import aws.sdk.kotlin.services.configservice.model.DescribeAggregationAuthorizationsRequest
import aws.sdk.kotlin.services.configservice.model.DescribeAggregationAuthorizationsResponse
import aws.sdk.kotlin.services.configservice.model.DescribeComplianceByConfigRuleRequest
import aws.sdk.kotlin.services.configservice.model.DescribeComplianceByConfigRuleResponse
import aws.sdk.kotlin.services.configservice.model.DescribeComplianceByResourceRequest
import aws.sdk.kotlin.services.configservice.model.DescribeComplianceByResourceResponse
import aws.sdk.kotlin.services.configservice.model.DescribeConfigRuleEvaluationStatusRequest
import aws.sdk.kotlin.services.configservice.model.DescribeConfigRuleEvaluationStatusResponse
import aws.sdk.kotlin.services.configservice.model.DescribeConfigRulesRequest
import aws.sdk.kotlin.services.configservice.model.DescribeConfigRulesResponse
import aws.sdk.kotlin.services.configservice.model.DescribeConfigurationAggregatorSourcesStatusRequest
import aws.sdk.kotlin.services.configservice.model.DescribeConfigurationAggregatorSourcesStatusResponse
import aws.sdk.kotlin.services.configservice.model.DescribeConfigurationAggregatorsRequest
import aws.sdk.kotlin.services.configservice.model.DescribeConfigurationAggregatorsResponse
import aws.sdk.kotlin.services.configservice.model.DescribeConfigurationRecorderStatusRequest
import aws.sdk.kotlin.services.configservice.model.DescribeConfigurationRecorderStatusResponse
import aws.sdk.kotlin.services.configservice.model.DescribeConfigurationRecordersRequest
import aws.sdk.kotlin.services.configservice.model.DescribeConfigurationRecordersResponse
import aws.sdk.kotlin.services.configservice.model.DescribeConformancePackComplianceRequest
import aws.sdk.kotlin.services.configservice.model.DescribeConformancePackComplianceResponse
import aws.sdk.kotlin.services.configservice.model.DescribeConformancePackStatusRequest
import aws.sdk.kotlin.services.configservice.model.DescribeConformancePackStatusResponse
import aws.sdk.kotlin.services.configservice.model.DescribeConformancePacksRequest
import aws.sdk.kotlin.services.configservice.model.DescribeConformancePacksResponse
import aws.sdk.kotlin.services.configservice.model.DescribeDeliveryChannelStatusRequest
import aws.sdk.kotlin.services.configservice.model.DescribeDeliveryChannelStatusResponse
import aws.sdk.kotlin.services.configservice.model.DescribeDeliveryChannelsRequest
import aws.sdk.kotlin.services.configservice.model.DescribeDeliveryChannelsResponse
import aws.sdk.kotlin.services.configservice.model.DescribeOrganizationConfigRuleStatusesRequest
import aws.sdk.kotlin.services.configservice.model.DescribeOrganizationConfigRuleStatusesResponse
import aws.sdk.kotlin.services.configservice.model.DescribeOrganizationConfigRulesRequest
import aws.sdk.kotlin.services.configservice.model.DescribeOrganizationConfigRulesResponse
import aws.sdk.kotlin.services.configservice.model.DescribeOrganizationConformancePackStatusesRequest
import aws.sdk.kotlin.services.configservice.model.DescribeOrganizationConformancePackStatusesResponse
import aws.sdk.kotlin.services.configservice.model.DescribeOrganizationConformancePacksRequest
import aws.sdk.kotlin.services.configservice.model.DescribeOrganizationConformancePacksResponse
import aws.sdk.kotlin.services.configservice.model.DescribePendingAggregationRequestsRequest
import aws.sdk.kotlin.services.configservice.model.DescribePendingAggregationRequestsResponse
import aws.sdk.kotlin.services.configservice.model.DescribeRemediationConfigurationsRequest
import aws.sdk.kotlin.services.configservice.model.DescribeRemediationConfigurationsResponse
import aws.sdk.kotlin.services.configservice.model.DescribeRemediationExceptionsRequest
import aws.sdk.kotlin.services.configservice.model.DescribeRemediationExceptionsResponse
import aws.sdk.kotlin.services.configservice.model.DescribeRemediationExecutionStatusRequest
import aws.sdk.kotlin.services.configservice.model.DescribeRemediationExecutionStatusResponse
import aws.sdk.kotlin.services.configservice.model.DescribeRetentionConfigurationsRequest
import aws.sdk.kotlin.services.configservice.model.DescribeRetentionConfigurationsResponse
import aws.sdk.kotlin.services.configservice.model.GetAggregateComplianceDetailsByConfigRuleRequest
import aws.sdk.kotlin.services.configservice.model.GetAggregateComplianceDetailsByConfigRuleResponse
import aws.sdk.kotlin.services.configservice.model.GetAggregateConfigRuleComplianceSummaryRequest
import aws.sdk.kotlin.services.configservice.model.GetAggregateConfigRuleComplianceSummaryResponse
import aws.sdk.kotlin.services.configservice.model.GetAggregateConformancePackComplianceSummaryRequest
import aws.sdk.kotlin.services.configservice.model.GetAggregateConformancePackComplianceSummaryResponse
import aws.sdk.kotlin.services.configservice.model.GetAggregateDiscoveredResourceCountsRequest
import aws.sdk.kotlin.services.configservice.model.GetAggregateDiscoveredResourceCountsResponse
import aws.sdk.kotlin.services.configservice.model.GetAggregateResourceConfigRequest
import aws.sdk.kotlin.services.configservice.model.GetAggregateResourceConfigResponse
import aws.sdk.kotlin.services.configservice.model.GetComplianceDetailsByConfigRuleRequest
import aws.sdk.kotlin.services.configservice.model.GetComplianceDetailsByConfigRuleResponse
import aws.sdk.kotlin.services.configservice.model.GetComplianceDetailsByResourceRequest
import aws.sdk.kotlin.services.configservice.model.GetComplianceDetailsByResourceResponse
import aws.sdk.kotlin.services.configservice.model.GetComplianceSummaryByConfigRuleRequest
import aws.sdk.kotlin.services.configservice.model.GetComplianceSummaryByConfigRuleResponse
import aws.sdk.kotlin.services.configservice.model.GetComplianceSummaryByResourceTypeRequest
import aws.sdk.kotlin.services.configservice.model.GetComplianceSummaryByResourceTypeResponse
import aws.sdk.kotlin.services.configservice.model.GetConformancePackComplianceDetailsRequest
import aws.sdk.kotlin.services.configservice.model.GetConformancePackComplianceDetailsResponse
import aws.sdk.kotlin.services.configservice.model.GetConformancePackComplianceSummaryRequest
import aws.sdk.kotlin.services.configservice.model.GetConformancePackComplianceSummaryResponse
import aws.sdk.kotlin.services.configservice.model.GetCustomRulePolicyRequest
import aws.sdk.kotlin.services.configservice.model.GetCustomRulePolicyResponse
import aws.sdk.kotlin.services.configservice.model.GetDiscoveredResourceCountsRequest
import aws.sdk.kotlin.services.configservice.model.GetDiscoveredResourceCountsResponse
import aws.sdk.kotlin.services.configservice.model.GetOrganizationConfigRuleDetailedStatusRequest
import aws.sdk.kotlin.services.configservice.model.GetOrganizationConfigRuleDetailedStatusResponse
import aws.sdk.kotlin.services.configservice.model.GetOrganizationConformancePackDetailedStatusRequest
import aws.sdk.kotlin.services.configservice.model.GetOrganizationConformancePackDetailedStatusResponse
import aws.sdk.kotlin.services.configservice.model.GetOrganizationCustomRulePolicyRequest
import aws.sdk.kotlin.services.configservice.model.GetOrganizationCustomRulePolicyResponse
import aws.sdk.kotlin.services.configservice.model.GetResourceConfigHistoryRequest
import aws.sdk.kotlin.services.configservice.model.GetResourceConfigHistoryResponse
import aws.sdk.kotlin.services.configservice.model.GetResourceEvaluationSummaryRequest
import aws.sdk.kotlin.services.configservice.model.GetResourceEvaluationSummaryResponse
import aws.sdk.kotlin.services.configservice.model.GetStoredQueryRequest
import aws.sdk.kotlin.services.configservice.model.GetStoredQueryResponse
import aws.sdk.kotlin.services.configservice.model.ListAggregateDiscoveredResourcesRequest
import aws.sdk.kotlin.services.configservice.model.ListAggregateDiscoveredResourcesResponse
import aws.sdk.kotlin.services.configservice.model.ListConformancePackComplianceScoresRequest
import aws.sdk.kotlin.services.configservice.model.ListConformancePackComplianceScoresResponse
import aws.sdk.kotlin.services.configservice.model.ListDiscoveredResourcesRequest
import aws.sdk.kotlin.services.configservice.model.ListDiscoveredResourcesResponse
import aws.sdk.kotlin.services.configservice.model.ListResourceEvaluationsRequest
import aws.sdk.kotlin.services.configservice.model.ListResourceEvaluationsResponse
import aws.sdk.kotlin.services.configservice.model.ListStoredQueriesRequest
import aws.sdk.kotlin.services.configservice.model.ListStoredQueriesResponse
import aws.sdk.kotlin.services.configservice.model.ListTagsForResourceRequest
import aws.sdk.kotlin.services.configservice.model.ListTagsForResourceResponse
import aws.sdk.kotlin.services.configservice.model.PutAggregationAuthorizationRequest
import aws.sdk.kotlin.services.configservice.model.PutAggregationAuthorizationResponse
import aws.sdk.kotlin.services.configservice.model.PutConfigRuleRequest
import aws.sdk.kotlin.services.configservice.model.PutConfigRuleResponse
import aws.sdk.kotlin.services.configservice.model.PutConfigurationAggregatorRequest
import aws.sdk.kotlin.services.configservice.model.PutConfigurationAggregatorResponse
import aws.sdk.kotlin.services.configservice.model.PutConfigurationRecorderRequest
import aws.sdk.kotlin.services.configservice.model.PutConfigurationRecorderResponse
import aws.sdk.kotlin.services.configservice.model.PutConformancePackRequest
import aws.sdk.kotlin.services.configservice.model.PutConformancePackResponse
import aws.sdk.kotlin.services.configservice.model.PutDeliveryChannelRequest
import aws.sdk.kotlin.services.configservice.model.PutDeliveryChannelResponse
import aws.sdk.kotlin.services.configservice.model.PutEvaluationsRequest
import aws.sdk.kotlin.services.configservice.model.PutEvaluationsResponse
import aws.sdk.kotlin.services.configservice.model.PutExternalEvaluationRequest
import aws.sdk.kotlin.services.configservice.model.PutExternalEvaluationResponse
import aws.sdk.kotlin.services.configservice.model.PutOrganizationConfigRuleRequest
import aws.sdk.kotlin.services.configservice.model.PutOrganizationConfigRuleResponse
import aws.sdk.kotlin.services.configservice.model.PutOrganizationConformancePackRequest
import aws.sdk.kotlin.services.configservice.model.PutOrganizationConformancePackResponse
import aws.sdk.kotlin.services.configservice.model.PutRemediationConfigurationsRequest
import aws.sdk.kotlin.services.configservice.model.PutRemediationConfigurationsResponse
import aws.sdk.kotlin.services.configservice.model.PutRemediationExceptionsRequest
import aws.sdk.kotlin.services.configservice.model.PutRemediationExceptionsResponse
import aws.sdk.kotlin.services.configservice.model.PutResourceConfigRequest
import aws.sdk.kotlin.services.configservice.model.PutResourceConfigResponse
import aws.sdk.kotlin.services.configservice.model.PutRetentionConfigurationRequest
import aws.sdk.kotlin.services.configservice.model.PutRetentionConfigurationResponse
import aws.sdk.kotlin.services.configservice.model.PutStoredQueryRequest
import aws.sdk.kotlin.services.configservice.model.PutStoredQueryResponse
import aws.sdk.kotlin.services.configservice.model.SelectAggregateResourceConfigRequest
import aws.sdk.kotlin.services.configservice.model.SelectAggregateResourceConfigResponse
import aws.sdk.kotlin.services.configservice.model.SelectResourceConfigRequest
import aws.sdk.kotlin.services.configservice.model.SelectResourceConfigResponse
import aws.sdk.kotlin.services.configservice.model.StartConfigRulesEvaluationRequest
import aws.sdk.kotlin.services.configservice.model.StartConfigRulesEvaluationResponse
import aws.sdk.kotlin.services.configservice.model.StartConfigurationRecorderRequest
import aws.sdk.kotlin.services.configservice.model.StartConfigurationRecorderResponse
import aws.sdk.kotlin.services.configservice.model.StartRemediationExecutionRequest
import aws.sdk.kotlin.services.configservice.model.StartRemediationExecutionResponse
import aws.sdk.kotlin.services.configservice.model.StartResourceEvaluationRequest
import aws.sdk.kotlin.services.configservice.model.StartResourceEvaluationResponse
import aws.sdk.kotlin.services.configservice.model.StopConfigurationRecorderRequest
import aws.sdk.kotlin.services.configservice.model.StopConfigurationRecorderResponse
import aws.sdk.kotlin.services.configservice.model.TagResourceRequest
import aws.sdk.kotlin.services.configservice.model.TagResourceResponse
import aws.sdk.kotlin.services.configservice.model.UntagResourceRequest
import aws.sdk.kotlin.services.configservice.model.UntagResourceResponse
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProviderConfig
import aws.smithy.kotlin.runtime.awsprotocol.ClockSkewInterceptor
import aws.smithy.kotlin.runtime.client.AbstractSdkClientBuilder
import aws.smithy.kotlin.runtime.client.AbstractSdkClientFactory
import aws.smithy.kotlin.runtime.client.LogMode
import aws.smithy.kotlin.runtime.client.RetryClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfig
import aws.smithy.kotlin.runtime.client.RetryStrategyClientConfigImpl
import aws.smithy.kotlin.runtime.client.SdkClient
import aws.smithy.kotlin.runtime.client.SdkClientConfig
import aws.smithy.kotlin.runtime.http.auth.AuthScheme
import aws.smithy.kotlin.runtime.http.auth.HttpAuthConfig
import aws.smithy.kotlin.runtime.http.config.HttpClientConfig
import aws.smithy.kotlin.runtime.http.config.HttpEngineConfig
import aws.smithy.kotlin.runtime.http.engine.HttpClientEngine
import aws.smithy.kotlin.runtime.http.engine.HttpEngineConfigImpl
import aws.smithy.kotlin.runtime.http.interceptors.HttpInterceptor
import aws.smithy.kotlin.runtime.net.url.Url
import aws.smithy.kotlin.runtime.retries.RetryStrategy
import aws.smithy.kotlin.runtime.retries.policy.RetryPolicy
import aws.smithy.kotlin.runtime.telemetry.Global
import aws.smithy.kotlin.runtime.telemetry.TelemetryConfig
import aws.smithy.kotlin.runtime.telemetry.TelemetryProvider
import aws.smithy.kotlin.runtime.util.LazyAsyncValue
import kotlin.collections.List
import kotlin.jvm.JvmStatic
public const val ServiceId: String = "Config Service"
public const val SdkVersion: String = "1.3.37"
public const val ServiceApiVersion: String = "2014-11-12"
/**
* # 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*.
*/
public interface ConfigClient : SdkClient {
/**
* ConfigClient's configuration
*/
public override val config: Config
public companion object : AbstractAwsSdkClientFactory()
{
@JvmStatic
override fun builder(): Builder = Builder()
override fun finalizeConfig(builder: Builder) {
super.finalizeConfig(builder)
builder.config.interceptors.add(0, ClockSkewInterceptor())
}
override suspend fun finalizeEnvironmentalConfig(builder: Builder, sharedConfig: LazyAsyncValue, activeProfile: LazyAsyncValue) {
super.finalizeEnvironmentalConfig(builder, sharedConfig, activeProfile)
builder.config.endpointUrl = builder.config.endpointUrl ?: resolveEndpointUrl(
sharedConfig,
"Config",
"CONFIG_SERVICE",
"config_service",
)
}
}
public class Builder internal constructor(): AbstractSdkClientBuilder() {
override val config: Config.Builder = Config.Builder()
override fun newClient(config: Config): ConfigClient = DefaultConfigClient(config)
}
public class Config private constructor(builder: Builder) : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig by builder.buildHttpEngineConfig(), RetryClientConfig, RetryStrategyClientConfig by builder.buildRetryStrategyClientConfig(), SdkClientConfig, TelemetryConfig {
override val clientName: String = builder.clientName
override val region: String? = builder.region
override val authSchemes: kotlin.collections.List = builder.authSchemes
override val credentialsProvider: CredentialsProvider = builder.credentialsProvider ?: DefaultChainCredentialsProvider(httpClient = httpClient, region = region).manage()
public val endpointProvider: ConfigEndpointProvider = builder.endpointProvider ?: DefaultConfigEndpointProvider()
public val endpointUrl: Url? = builder.endpointUrl
override val interceptors: kotlin.collections.List = builder.interceptors
override val logMode: LogMode = builder.logMode ?: LogMode.Default
override val retryPolicy: RetryPolicy = builder.retryPolicy ?: AwsRetryPolicy.Default
override val telemetryProvider: TelemetryProvider = builder.telemetryProvider ?: TelemetryProvider.Global
override val useDualStack: Boolean = builder.useDualStack ?: false
override val useFips: Boolean = builder.useFips ?: false
override val applicationId: String? = builder.applicationId
public val authSchemeProvider: ConfigAuthSchemeProvider = builder.authSchemeProvider ?: DefaultConfigAuthSchemeProvider()
public companion object {
public inline operator fun invoke(block: Builder.() -> kotlin.Unit): Config = Builder().apply(block).build()
}
public fun toBuilder(): Builder = Builder().apply {
clientName = [email protected]
region = [email protected]
authSchemes = [email protected]
credentialsProvider = [email protected]
endpointProvider = [email protected]
endpointUrl = [email protected]
httpClient = [email protected]
interceptors = [email protected]()
logMode = [email protected]
retryPolicy = [email protected]
retryStrategy = [email protected]
telemetryProvider = [email protected]
useDualStack = [email protected]
useFips = [email protected]
applicationId = [email protected]
authSchemeProvider = [email protected]
}
public class Builder : AwsSdkClientConfig.Builder, CredentialsProviderConfig.Builder, HttpAuthConfig.Builder, HttpClientConfig.Builder, HttpEngineConfig.Builder by HttpEngineConfigImpl.BuilderImpl(), RetryClientConfig.Builder, RetryStrategyClientConfig.Builder by RetryStrategyClientConfigImpl.BuilderImpl(), SdkClientConfig.Builder, TelemetryConfig.Builder {
/**
* A reader-friendly name for the client.
*/
override var clientName: String = "Config Service"
/**
* The AWS region (e.g. `us-west-2`) to make requests to. See about AWS
* [global infrastructure](https://aws.amazon.com/about-aws/global-infrastructure/regions_az/) for more
* information
*/
override var region: String? = null
/**
* Register new or override default [AuthScheme]s configured for this client. By default, the set
* of auth schemes configured comes from the service model. An auth scheme configured explicitly takes
* precedence over the defaults and can be used to customize identity resolution and signing for specific
* authentication schemes.
*/
override var authSchemes: kotlin.collections.List = emptyList()
/**
* The AWS credentials provider to use for authenticating requests. If not provided a
* [aws.sdk.kotlin.runtime.auth.credentials.DefaultChainCredentialsProvider] instance will be used.
* NOTE: The caller is responsible for managing the lifetime of the provider when set. The SDK
* client will not close it when the client is closed.
*/
override var credentialsProvider: CredentialsProvider? = null
/**
* The endpoint provider used to determine where to make service requests. **This is an advanced config
* option.**
*
* Endpoint resolution occurs as part of the workflow for every request made via the service client.
*
* The inputs to endpoint resolution are defined on a per-service basis (see [EndpointParameters]).
*/
public var endpointProvider: ConfigEndpointProvider? = null
/**
* A custom endpoint to route requests to. The endpoint set here is passed to the configured
* [endpointProvider], which may inspect and modify it as needed.
*
* Setting a custom endpointUrl should generally be preferred to overriding the [endpointProvider] and is
* the recommended way to route requests to development or preview instances of a service.
*
* **This is an advanced config option.**
*/
public var endpointUrl: Url? = null
/**
* Add an [aws.smithy.kotlin.runtime.client.Interceptor] that will have access to read and modify
* the request and response objects as they are processed by the SDK.
* Interceptors added using this method are executed in the order they are configured and are always
* later than any added automatically by the SDK.
*/
override var interceptors: kotlin.collections.MutableList = kotlin.collections.mutableListOf()
/**
* Configure events that will be logged. By default clients will not output
* raw requests or responses. Use this setting to opt-in to additional debug logging.
*
* This can be used to configure logging of requests, responses, retries, etc of SDK clients.
*
* **NOTE**: Logging of raw requests or responses may leak sensitive information! It may also have
* performance considerations when dumping the request/response body. This is primarily a tool for
* debug purposes.
*/
override var logMode: LogMode? = null
/**
* The policy to use for evaluating operation results and determining whether/how to retry.
*/
override var retryPolicy: RetryPolicy? = null
/**
* The telemetry provider used to instrument the SDK operations with. By default, the global telemetry
* provider will be used.
*/
override var telemetryProvider: TelemetryProvider? = null
/**
* Flag to toggle whether to use dual-stack endpoints when making requests.
* See [https://docs.aws.amazon.com/sdkref/latest/guide/feature-endpoints.html] for more information.
* ` Disabled by default.
*/
override var useDualStack: Boolean? = null
/**
* Flag to toggle whether to use [FIPS](https://aws.amazon.com/compliance/fips/) endpoints when making requests.
* ` Disabled by default.
*/
override var useFips: Boolean? = null
/**
* An optional application specific identifier.
* When set it will be appended to the User-Agent header of every request in the form of: `app/{applicationId}`.
* When not explicitly set, the value will be loaded from the following locations:
*
* - JVM System Property: `aws.userAgentAppId`
* - Environment variable: `AWS_SDK_UA_APP_ID`
* - Shared configuration profile attribute: `sdk_ua_app_id`
*
* See [shared configuration settings](https://docs.aws.amazon.com/sdkref/latest/guide/settings-reference.html)
* reference for more information on environment variables and shared config settings.
*/
override var applicationId: String? = null
/**
* Configure the provider used to resolve the authentication scheme to use for a particular operation.
*/
public var authSchemeProvider: ConfigAuthSchemeProvider? = null
override fun build(): Config = Config(this)
}
}
/**
* 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.
*/
public suspend fun batchGetAggregateResourceConfig(input: BatchGetAggregateResourceConfigRequest): BatchGetAggregateResourceConfigResponse
/**
* 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.
*/
public suspend fun batchGetResourceConfig(input: BatchGetResourceConfigRequest): BatchGetResourceConfigResponse
/**
* Deletes the authorization granted to the specified configuration aggregator account in a specified region.
*/
public suspend fun deleteAggregationAuthorization(input: DeleteAggregationAuthorizationRequest): DeleteAggregationAuthorizationResponse
/**
* 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.
*/
public suspend fun deleteConfigRule(input: DeleteConfigRuleRequest): DeleteConfigRuleResponse
/**
* Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
*/
public suspend fun deleteConfigurationAggregator(input: DeleteConfigurationAggregatorRequest): DeleteConfigurationAggregatorResponse
/**
* 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.
*/
public suspend fun deleteConfigurationRecorder(input: DeleteConfigurationRecorderRequest): DeleteConfigurationRecorderResponse
/**
* 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.
*/
public suspend fun deleteConformancePack(input: DeleteConformancePackRequest): DeleteConformancePackResponse
/**
* Deletes the delivery channel.
*
* Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
*/
public suspend fun deleteDeliveryChannel(input: DeleteDeliveryChannelRequest): DeleteDeliveryChannelResponse
/**
* 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.
*/
public suspend fun deleteEvaluationResults(input: DeleteEvaluationResultsRequest): DeleteEvaluationResultsResponse
/**
* 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.
*/
public suspend fun deleteOrganizationConfigRule(input: DeleteOrganizationConfigRuleRequest): DeleteOrganizationConfigRuleResponse
/**
* 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.
*/
public suspend fun deleteOrganizationConformancePack(input: DeleteOrganizationConformancePackRequest): DeleteOrganizationConformancePackResponse
/**
* Deletes pending authorization requests for a specified aggregator account in a specified region.
*/
public suspend fun deletePendingAggregationRequest(input: DeletePendingAggregationRequestRequest): DeletePendingAggregationRequestResponse
/**
* Deletes the remediation configuration.
*/
public suspend fun deleteRemediationConfiguration(input: DeleteRemediationConfigurationRequest): DeleteRemediationConfigurationResponse
/**
* 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.
*/
public suspend fun deleteRemediationExceptions(input: DeleteRemediationExceptionsRequest): DeleteRemediationExceptionsResponse
/**
* 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.
*/
public suspend fun deleteResourceConfig(input: DeleteResourceConfigRequest): DeleteResourceConfigResponse
/**
* Deletes the retention configuration.
*/
public suspend fun deleteRetentionConfiguration(input: DeleteRetentionConfigurationRequest): DeleteRetentionConfigurationResponse
/**
* Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
*/
public suspend fun deleteStoredQuery(input: DeleteStoredQueryRequest): DeleteStoredQueryResponse
/**
* 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.
*/
public suspend fun deliverConfigSnapshot(input: DeliverConfigSnapshotRequest): DeliverConfigSnapshotResponse
/**
* 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.
*/
public suspend fun describeAggregateComplianceByConfigRules(input: DescribeAggregateComplianceByConfigRulesRequest): DescribeAggregateComplianceByConfigRulesResponse
/**
* 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.
*/
public suspend fun describeAggregateComplianceByConformancePacks(input: DescribeAggregateComplianceByConformancePacksRequest): DescribeAggregateComplianceByConformancePacksResponse
/**
* Returns a list of authorizations granted to various aggregator accounts and regions.
*/
public suspend fun describeAggregationAuthorizations(input: DescribeAggregationAuthorizationsRequest = DescribeAggregationAuthorizationsRequest { }): DescribeAggregationAuthorizationsResponse
/**
* 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.
*/
public suspend fun describeComplianceByConfigRule(input: DescribeComplianceByConfigRuleRequest = DescribeComplianceByConfigRuleRequest { }): DescribeComplianceByConfigRuleResponse
/**
* 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.
*/
public suspend fun describeComplianceByResource(input: DescribeComplianceByResourceRequest = DescribeComplianceByResourceRequest { }): DescribeComplianceByResourceResponse
/**
* 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.
*/
public suspend fun describeConfigRuleEvaluationStatus(input: DescribeConfigRuleEvaluationStatusRequest = DescribeConfigRuleEvaluationStatusRequest { }): DescribeConfigRuleEvaluationStatusResponse
/**
* Returns details about your Config rules.
*/
public suspend fun describeConfigRules(input: DescribeConfigRulesRequest = DescribeConfigRulesRequest { }): DescribeConfigRulesResponse
/**
* 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.
*/
public suspend fun describeConfigurationAggregatorSourcesStatus(input: DescribeConfigurationAggregatorSourcesStatusRequest): DescribeConfigurationAggregatorSourcesStatusResponse
/**
* 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.
*/
public suspend fun describeConfigurationAggregators(input: DescribeConfigurationAggregatorsRequest = DescribeConfigurationAggregatorsRequest { }): DescribeConfigurationAggregatorsResponse
/**
* 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.
*/
public suspend fun describeConfigurationRecorderStatus(input: DescribeConfigurationRecorderStatusRequest = DescribeConfigurationRecorderStatusRequest { }): DescribeConfigurationRecorderStatusResponse
/**
* 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.
*/
public suspend fun describeConfigurationRecorders(input: DescribeConfigurationRecordersRequest = DescribeConfigurationRecordersRequest { }): DescribeConfigurationRecordersResponse
/**
* Returns compliance details for each rule in that conformance pack.
*
* You must provide exact rule names.
*/
public suspend fun describeConformancePackCompliance(input: DescribeConformancePackComplianceRequest): DescribeConformancePackComplianceResponse
/**
* Provides one or more conformance packs deployment status.
*
* If there are no conformance packs then you will see an empty result.
*/
public suspend fun describeConformancePackStatus(input: DescribeConformancePackStatusRequest = DescribeConformancePackStatusRequest { }): DescribeConformancePackStatusResponse
/**
* Returns a list of one or more conformance packs.
*/
public suspend fun describeConformancePacks(input: DescribeConformancePacksRequest = DescribeConformancePacksRequest { }): DescribeConformancePacksResponse
/**
* 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.
*/
public suspend fun describeDeliveryChannelStatus(input: DescribeDeliveryChannelStatusRequest = DescribeDeliveryChannelStatusRequest { }): DescribeDeliveryChannelStatusResponse
/**
* 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.
*/
public suspend fun describeDeliveryChannels(input: DescribeDeliveryChannelsRequest = DescribeDeliveryChannelsRequest { }): DescribeDeliveryChannelsResponse
/**
* 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.
*/
public suspend fun describeOrganizationConfigRuleStatuses(input: DescribeOrganizationConfigRuleStatusesRequest = DescribeOrganizationConfigRuleStatusesRequest { }): DescribeOrganizationConfigRuleStatusesResponse
/**
* 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.
*/
public suspend fun describeOrganizationConfigRules(input: DescribeOrganizationConfigRulesRequest = DescribeOrganizationConfigRulesRequest { }): DescribeOrganizationConfigRulesResponse
/**
* 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.
*/
public suspend fun describeOrganizationConformancePackStatuses(input: DescribeOrganizationConformancePackStatusesRequest = DescribeOrganizationConformancePackStatusesRequest { }): DescribeOrganizationConformancePackStatusesResponse
/**
* 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.
*/
public suspend fun describeOrganizationConformancePacks(input: DescribeOrganizationConformancePacksRequest = DescribeOrganizationConformancePacksRequest { }): DescribeOrganizationConformancePacksResponse
/**
* Returns a list of all pending aggregation requests.
*/
public suspend fun describePendingAggregationRequests(input: DescribePendingAggregationRequestsRequest = DescribePendingAggregationRequestsRequest { }): DescribePendingAggregationRequestsResponse
/**
* Returns the details of one or more remediation configurations.
*/
public suspend fun describeRemediationConfigurations(input: DescribeRemediationConfigurationsRequest): DescribeRemediationConfigurationsResponse
/**
* 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.
*/
public suspend fun describeRemediationExceptions(input: DescribeRemediationExceptionsRequest): DescribeRemediationExceptionsResponse
/**
* 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.
*/
public suspend fun describeRemediationExecutionStatus(input: DescribeRemediationExecutionStatusRequest): DescribeRemediationExecutionStatusResponse
/**
* 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.
*/
public suspend fun describeRetentionConfigurations(input: DescribeRetentionConfigurationsRequest = DescribeRetentionConfigurationsRequest { }): DescribeRetentionConfigurationsResponse
/**
* 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.
*/
public suspend fun getAggregateComplianceDetailsByConfigRule(input: GetAggregateComplianceDetailsByConfigRuleRequest): GetAggregateComplianceDetailsByConfigRuleResponse
/**
* 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.
*/
public suspend fun getAggregateConfigRuleComplianceSummary(input: GetAggregateConfigRuleComplianceSummaryRequest): GetAggregateConfigRuleComplianceSummaryResponse
/**
* 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.
*/
public suspend fun getAggregateConformancePackComplianceSummary(input: GetAggregateConformancePackComplianceSummaryRequest): GetAggregateConformancePackComplianceSummaryResponse
/**
* 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.
*/
public suspend fun getAggregateDiscoveredResourceCounts(input: GetAggregateDiscoveredResourceCountsRequest): GetAggregateDiscoveredResourceCountsResponse
/**
* Returns configuration item that is aggregated for your specific resource in a specific source account and region.
*/
public suspend fun getAggregateResourceConfig(input: GetAggregateResourceConfigRequest): GetAggregateResourceConfigResponse
/**
* 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.
*/
public suspend fun getComplianceDetailsByConfigRule(input: GetComplianceDetailsByConfigRuleRequest): GetComplianceDetailsByConfigRuleResponse
/**
* 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.
*/
public suspend fun getComplianceDetailsByResource(input: GetComplianceDetailsByResourceRequest = GetComplianceDetailsByResourceRequest { }): GetComplianceDetailsByResourceResponse
/**
* Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
*/
public suspend fun getComplianceSummaryByConfigRule(input: GetComplianceSummaryByConfigRuleRequest = GetComplianceSummaryByConfigRuleRequest { }): GetComplianceSummaryByConfigRuleResponse
/**
* 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.
*/
public suspend fun getComplianceSummaryByResourceType(input: GetComplianceSummaryByResourceTypeRequest = GetComplianceSummaryByResourceTypeRequest { }): GetComplianceSummaryByResourceTypeResponse
/**
* Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
*/
public suspend fun getConformancePackComplianceDetails(input: GetConformancePackComplianceDetailsRequest): GetConformancePackComplianceDetailsResponse
/**
* Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
*/
public suspend fun getConformancePackComplianceSummary(input: GetConformancePackComplianceSummaryRequest): GetConformancePackComplianceSummaryResponse
/**
* Returns the policy definition containing the logic for your Config Custom Policy rule.
*/
public suspend fun getCustomRulePolicy(input: GetCustomRulePolicyRequest = GetCustomRulePolicyRequest { }): GetCustomRulePolicyResponse
/**
* Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
*
* **Example**
* + Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
* + You make a call to the `GetDiscoveredResourceCounts` action and specify that you want all resource types.
* + Config returns the following:
* + The resource types (EC2 instances, IAM users, and S3 buckets).
* + The number of each resource type (25, 20, and 15).
* + The total number of all resources (60).
*
* The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the `limit` parameter. The response includes a `nextToken` string. To get the next page of results, run the request again and specify the string for the `nextToken` parameter.
*
* 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.
*/
public suspend fun getDiscoveredResourceCounts(input: GetDiscoveredResourceCountsRequest = GetDiscoveredResourceCountsRequest { }): GetDiscoveredResourceCountsResponse
/**
* Returns detailed status for each member account within an organization for a given organization Config rule.
*/
public suspend fun getOrganizationConfigRuleDetailedStatus(input: GetOrganizationConfigRuleDetailedStatusRequest): GetOrganizationConfigRuleDetailedStatusResponse
/**
* Returns detailed status for each member account within an organization for a given organization conformance pack.
*/
public suspend fun getOrganizationConformancePackDetailedStatus(input: GetOrganizationConformancePackDetailedStatusRequest): GetOrganizationConformancePackDetailedStatusResponse
/**
* Returns the policy definition containing the logic for your organization Config Custom Policy rule.
*/
public suspend fun getOrganizationCustomRulePolicy(input: GetOrganizationCustomRulePolicyRequest): GetOrganizationCustomRulePolicyResponse
/**
* 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`.
*/
public suspend fun getResourceConfigHistory(input: GetResourceConfigHistoryRequest): GetResourceConfigHistoryResponse
/**
* 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.
*/
public suspend fun getResourceEvaluationSummary(input: GetResourceEvaluationSummaryRequest): GetResourceEvaluationSummaryResponse
/**
* Returns the details of a specific stored query.
*/
public suspend fun getStoredQuery(input: GetStoredQueryRequest): GetStoredQueryResponse
/**
* 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.
*/
public suspend fun listAggregateDiscoveredResources(input: ListAggregateDiscoveredResourcesRequest): ListAggregateDiscoveredResourcesResponse
/**
* 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`.
*/
public suspend fun listConformancePackComplianceScores(input: ListConformancePackComplianceScoresRequest = ListConformancePackComplianceScoresRequest { }): ListConformancePackComplianceScoresResponse
/**
* 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.
*/
public suspend fun listDiscoveredResources(input: ListDiscoveredResourcesRequest): ListDiscoveredResourcesResponse
/**
* Returns a list of proactive resource evaluations.
*/
public suspend fun listResourceEvaluations(input: ListResourceEvaluationsRequest = ListResourceEvaluationsRequest { }): ListResourceEvaluationsResponse
/**
* Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
*/
public suspend fun listStoredQueries(input: ListStoredQueriesRequest = ListStoredQueriesRequest { }): ListStoredQueriesResponse
/**
* List the tags for Config resource.
*/
public suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse
/**
* 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.
*/
public suspend fun putAggregationAuthorization(input: PutAggregationAuthorizationRequest): PutAggregationAuthorizationResponse
/**
* 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.
*/
public suspend fun putConfigRule(input: PutConfigRuleRequest): PutConfigRuleResponse
/**
* 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.
*/
public suspend fun putConfigurationAggregator(input: PutConfigurationAggregatorRequest): PutConfigurationAggregatorResponse
/**
* 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.
*/
public suspend fun putConfigurationRecorder(input: PutConfigurationRecorderRequest): PutConfigurationRecorderResponse
/**
* 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`.
*/
public suspend fun putConformancePack(input: PutConformancePackRequest): PutConformancePackResponse
/**
* 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.
*/
public suspend fun putDeliveryChannel(input: PutDeliveryChannelRequest): PutDeliveryChannelResponse
/**
* 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.
*/
public suspend fun putEvaluations(input: PutEvaluationsRequest): PutEvaluationsResponse
/**
* 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.
*/
public suspend fun putExternalEvaluation(input: PutExternalEvaluationRequest): PutExternalEvaluationResponse
/**
* 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.
*/
public suspend fun putOrganizationConfigRule(input: PutOrganizationConfigRuleRequest): PutOrganizationConfigRuleResponse
/**
* 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.
*/
public suspend fun putOrganizationConformancePack(input: PutOrganizationConformancePackRequest): PutOrganizationConformancePackResponse
/**
* 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 `assumeRole`field to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.
*
* However, for automatic remediation configuration, the only valid `assumeRole` field value is `AutomationAssumeRole` and you need to provide a value for `AutomationAssumeRole` to remediate your resources.
*
* **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.
*/
public suspend fun putRemediationConfigurations(input: PutRemediationConfigurationsRequest): PutRemediationConfigurationsResponse
/**
* 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.
*/
public suspend fun putRemediationExceptions(input: PutRemediationExceptionsRequest): PutRemediationExceptionsResponse
/**
* 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.
*/
public suspend fun putResourceConfig(input: PutResourceConfigRequest): PutResourceConfigResponse
/**
* 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.
*/
public suspend fun putRetentionConfiguration(input: PutRetentionConfigurationRequest): PutRetentionConfigurationResponse
/**
* 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.
*/
public suspend fun putStoredQuery(input: PutStoredQueryRequest): PutStoredQueryResponse
/**
* 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.
*/
public suspend fun selectAggregateResourceConfig(input: SelectAggregateResourceConfigRequest): SelectAggregateResourceConfigResponse
/**
* 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*.
*/
public suspend fun selectResourceConfig(input: SelectResourceConfigRequest): SelectResourceConfigResponse
/**
* 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:
* + You have a custom rule that evaluates your IAM resources every 24 hours.
* + You update your Lambda function to add additional conditions to your rule.
* + Instead of waiting for the next periodic evaluation, you call the `StartConfigRulesEvaluation` API.
* + Config invokes your Lambda function and evaluates your IAM resources.
* + Your custom rule will still run periodic evaluations every 24 hours.
*/
public suspend fun startConfigRulesEvaluation(input: StartConfigRulesEvaluationRequest = StartConfigRulesEvaluationRequest { }): StartConfigRulesEvaluationResponse
/**
* 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.
*/
public suspend fun startConfigurationRecorder(input: StartConfigurationRecorderRequest): StartConfigurationRecorderResponse
/**
* 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.
*/
public suspend fun startRemediationExecution(input: StartRemediationExecutionRequest): StartRemediationExecutionResponse
/**
* 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.
*/
public suspend fun startResourceEvaluation(input: StartResourceEvaluationRequest): StartResourceEvaluationResponse
/**
* Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
*/
public suspend fun stopConfigurationRecorder(input: StopConfigurationRecorderRequest): StopConfigurationRecorderResponse
/**
* 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.
*/
public suspend fun tagResource(input: TagResourceRequest): TagResourceResponse
/**
* Deletes specified tags from a resource.
*/
public suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse
}
/**
* 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.
*
* Any resources created on your behalf will be shared between clients, and will only be closed when ALL clients using them are closed.
* If you provide a resource (e.g. [HttpClientEngine]) to the SDK, you are responsible for managing the lifetime of that resource.
*/
public fun ConfigClient.withConfig(block: ConfigClient.Config.Builder.() -> Unit): ConfigClient {
val newConfig = config.toBuilder().apply(block).build()
return DefaultConfigClient(newConfig)
}
/**
* 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.
*/
public suspend inline fun ConfigClient.batchGetAggregateResourceConfig(crossinline block: BatchGetAggregateResourceConfigRequest.Builder.() -> Unit): BatchGetAggregateResourceConfigResponse = batchGetAggregateResourceConfig(BatchGetAggregateResourceConfigRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.batchGetResourceConfig(crossinline block: BatchGetResourceConfigRequest.Builder.() -> Unit): BatchGetResourceConfigResponse = batchGetResourceConfig(BatchGetResourceConfigRequest.Builder().apply(block).build())
/**
* Deletes the authorization granted to the specified configuration aggregator account in a specified region.
*/
public suspend inline fun ConfigClient.deleteAggregationAuthorization(crossinline block: DeleteAggregationAuthorizationRequest.Builder.() -> Unit): DeleteAggregationAuthorizationResponse = deleteAggregationAuthorization(DeleteAggregationAuthorizationRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.deleteConfigRule(crossinline block: DeleteConfigRuleRequest.Builder.() -> Unit): DeleteConfigRuleResponse = deleteConfigRule(DeleteConfigRuleRequest.Builder().apply(block).build())
/**
* Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
*/
public suspend inline fun ConfigClient.deleteConfigurationAggregator(crossinline block: DeleteConfigurationAggregatorRequest.Builder.() -> Unit): DeleteConfigurationAggregatorResponse = deleteConfigurationAggregator(DeleteConfigurationAggregatorRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.deleteConfigurationRecorder(crossinline block: DeleteConfigurationRecorderRequest.Builder.() -> Unit): DeleteConfigurationRecorderResponse = deleteConfigurationRecorder(DeleteConfigurationRecorderRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.deleteConformancePack(crossinline block: DeleteConformancePackRequest.Builder.() -> Unit): DeleteConformancePackResponse = deleteConformancePack(DeleteConformancePackRequest.Builder().apply(block).build())
/**
* Deletes the delivery channel.
*
* Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
*/
public suspend inline fun ConfigClient.deleteDeliveryChannel(crossinline block: DeleteDeliveryChannelRequest.Builder.() -> Unit): DeleteDeliveryChannelResponse = deleteDeliveryChannel(DeleteDeliveryChannelRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.deleteEvaluationResults(crossinline block: DeleteEvaluationResultsRequest.Builder.() -> Unit): DeleteEvaluationResultsResponse = deleteEvaluationResults(DeleteEvaluationResultsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.deleteOrganizationConfigRule(crossinline block: DeleteOrganizationConfigRuleRequest.Builder.() -> Unit): DeleteOrganizationConfigRuleResponse = deleteOrganizationConfigRule(DeleteOrganizationConfigRuleRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.deleteOrganizationConformancePack(crossinline block: DeleteOrganizationConformancePackRequest.Builder.() -> Unit): DeleteOrganizationConformancePackResponse = deleteOrganizationConformancePack(DeleteOrganizationConformancePackRequest.Builder().apply(block).build())
/**
* Deletes pending authorization requests for a specified aggregator account in a specified region.
*/
public suspend inline fun ConfigClient.deletePendingAggregationRequest(crossinline block: DeletePendingAggregationRequestRequest.Builder.() -> Unit): DeletePendingAggregationRequestResponse = deletePendingAggregationRequest(DeletePendingAggregationRequestRequest.Builder().apply(block).build())
/**
* Deletes the remediation configuration.
*/
public suspend inline fun ConfigClient.deleteRemediationConfiguration(crossinline block: DeleteRemediationConfigurationRequest.Builder.() -> Unit): DeleteRemediationConfigurationResponse = deleteRemediationConfiguration(DeleteRemediationConfigurationRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.deleteRemediationExceptions(crossinline block: DeleteRemediationExceptionsRequest.Builder.() -> Unit): DeleteRemediationExceptionsResponse = deleteRemediationExceptions(DeleteRemediationExceptionsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.deleteResourceConfig(crossinline block: DeleteResourceConfigRequest.Builder.() -> Unit): DeleteResourceConfigResponse = deleteResourceConfig(DeleteResourceConfigRequest.Builder().apply(block).build())
/**
* Deletes the retention configuration.
*/
public suspend inline fun ConfigClient.deleteRetentionConfiguration(crossinline block: DeleteRetentionConfigurationRequest.Builder.() -> Unit): DeleteRetentionConfigurationResponse = deleteRetentionConfiguration(DeleteRetentionConfigurationRequest.Builder().apply(block).build())
/**
* Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
*/
public suspend inline fun ConfigClient.deleteStoredQuery(crossinline block: DeleteStoredQueryRequest.Builder.() -> Unit): DeleteStoredQueryResponse = deleteStoredQuery(DeleteStoredQueryRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.deliverConfigSnapshot(crossinline block: DeliverConfigSnapshotRequest.Builder.() -> Unit): DeliverConfigSnapshotResponse = deliverConfigSnapshot(DeliverConfigSnapshotRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeAggregateComplianceByConfigRules(crossinline block: DescribeAggregateComplianceByConfigRulesRequest.Builder.() -> Unit): DescribeAggregateComplianceByConfigRulesResponse = describeAggregateComplianceByConfigRules(DescribeAggregateComplianceByConfigRulesRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeAggregateComplianceByConformancePacks(crossinline block: DescribeAggregateComplianceByConformancePacksRequest.Builder.() -> Unit): DescribeAggregateComplianceByConformancePacksResponse = describeAggregateComplianceByConformancePacks(DescribeAggregateComplianceByConformancePacksRequest.Builder().apply(block).build())
/**
* Returns a list of authorizations granted to various aggregator accounts and regions.
*/
public suspend inline fun ConfigClient.describeAggregationAuthorizations(crossinline block: DescribeAggregationAuthorizationsRequest.Builder.() -> Unit): DescribeAggregationAuthorizationsResponse = describeAggregationAuthorizations(DescribeAggregationAuthorizationsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeComplianceByConfigRule(crossinline block: DescribeComplianceByConfigRuleRequest.Builder.() -> Unit): DescribeComplianceByConfigRuleResponse = describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeComplianceByResource(crossinline block: DescribeComplianceByResourceRequest.Builder.() -> Unit): DescribeComplianceByResourceResponse = describeComplianceByResource(DescribeComplianceByResourceRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeConfigRuleEvaluationStatus(crossinline block: DescribeConfigRuleEvaluationStatusRequest.Builder.() -> Unit): DescribeConfigRuleEvaluationStatusResponse = describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest.Builder().apply(block).build())
/**
* Returns details about your Config rules.
*/
public suspend inline fun ConfigClient.describeConfigRules(crossinline block: DescribeConfigRulesRequest.Builder.() -> Unit): DescribeConfigRulesResponse = describeConfigRules(DescribeConfigRulesRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeConfigurationAggregatorSourcesStatus(crossinline block: DescribeConfigurationAggregatorSourcesStatusRequest.Builder.() -> Unit): DescribeConfigurationAggregatorSourcesStatusResponse = describeConfigurationAggregatorSourcesStatus(DescribeConfigurationAggregatorSourcesStatusRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeConfigurationAggregators(crossinline block: DescribeConfigurationAggregatorsRequest.Builder.() -> Unit): DescribeConfigurationAggregatorsResponse = describeConfigurationAggregators(DescribeConfigurationAggregatorsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeConfigurationRecorderStatus(crossinline block: DescribeConfigurationRecorderStatusRequest.Builder.() -> Unit): DescribeConfigurationRecorderStatusResponse = describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeConfigurationRecorders(crossinline block: DescribeConfigurationRecordersRequest.Builder.() -> Unit): DescribeConfigurationRecordersResponse = describeConfigurationRecorders(DescribeConfigurationRecordersRequest.Builder().apply(block).build())
/**
* Returns compliance details for each rule in that conformance pack.
*
* You must provide exact rule names.
*/
public suspend inline fun ConfigClient.describeConformancePackCompliance(crossinline block: DescribeConformancePackComplianceRequest.Builder.() -> Unit): DescribeConformancePackComplianceResponse = describeConformancePackCompliance(DescribeConformancePackComplianceRequest.Builder().apply(block).build())
/**
* Provides one or more conformance packs deployment status.
*
* If there are no conformance packs then you will see an empty result.
*/
public suspend inline fun ConfigClient.describeConformancePackStatus(crossinline block: DescribeConformancePackStatusRequest.Builder.() -> Unit): DescribeConformancePackStatusResponse = describeConformancePackStatus(DescribeConformancePackStatusRequest.Builder().apply(block).build())
/**
* Returns a list of one or more conformance packs.
*/
public suspend inline fun ConfigClient.describeConformancePacks(crossinline block: DescribeConformancePacksRequest.Builder.() -> Unit): DescribeConformancePacksResponse = describeConformancePacks(DescribeConformancePacksRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeDeliveryChannelStatus(crossinline block: DescribeDeliveryChannelStatusRequest.Builder.() -> Unit): DescribeDeliveryChannelStatusResponse = describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeDeliveryChannels(crossinline block: DescribeDeliveryChannelsRequest.Builder.() -> Unit): DescribeDeliveryChannelsResponse = describeDeliveryChannels(DescribeDeliveryChannelsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeOrganizationConfigRuleStatuses(crossinline block: DescribeOrganizationConfigRuleStatusesRequest.Builder.() -> Unit): DescribeOrganizationConfigRuleStatusesResponse = describeOrganizationConfigRuleStatuses(DescribeOrganizationConfigRuleStatusesRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeOrganizationConfigRules(crossinline block: DescribeOrganizationConfigRulesRequest.Builder.() -> Unit): DescribeOrganizationConfigRulesResponse = describeOrganizationConfigRules(DescribeOrganizationConfigRulesRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeOrganizationConformancePackStatuses(crossinline block: DescribeOrganizationConformancePackStatusesRequest.Builder.() -> Unit): DescribeOrganizationConformancePackStatusesResponse = describeOrganizationConformancePackStatuses(DescribeOrganizationConformancePackStatusesRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeOrganizationConformancePacks(crossinline block: DescribeOrganizationConformancePacksRequest.Builder.() -> Unit): DescribeOrganizationConformancePacksResponse = describeOrganizationConformancePacks(DescribeOrganizationConformancePacksRequest.Builder().apply(block).build())
/**
* Returns a list of all pending aggregation requests.
*/
public suspend inline fun ConfigClient.describePendingAggregationRequests(crossinline block: DescribePendingAggregationRequestsRequest.Builder.() -> Unit): DescribePendingAggregationRequestsResponse = describePendingAggregationRequests(DescribePendingAggregationRequestsRequest.Builder().apply(block).build())
/**
* Returns the details of one or more remediation configurations.
*/
public suspend inline fun ConfigClient.describeRemediationConfigurations(crossinline block: DescribeRemediationConfigurationsRequest.Builder.() -> Unit): DescribeRemediationConfigurationsResponse = describeRemediationConfigurations(DescribeRemediationConfigurationsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeRemediationExceptions(crossinline block: DescribeRemediationExceptionsRequest.Builder.() -> Unit): DescribeRemediationExceptionsResponse = describeRemediationExceptions(DescribeRemediationExceptionsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeRemediationExecutionStatus(crossinline block: DescribeRemediationExecutionStatusRequest.Builder.() -> Unit): DescribeRemediationExecutionStatusResponse = describeRemediationExecutionStatus(DescribeRemediationExecutionStatusRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.describeRetentionConfigurations(crossinline block: DescribeRetentionConfigurationsRequest.Builder.() -> Unit): DescribeRetentionConfigurationsResponse = describeRetentionConfigurations(DescribeRetentionConfigurationsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.getAggregateComplianceDetailsByConfigRule(crossinline block: GetAggregateComplianceDetailsByConfigRuleRequest.Builder.() -> Unit): GetAggregateComplianceDetailsByConfigRuleResponse = getAggregateComplianceDetailsByConfigRule(GetAggregateComplianceDetailsByConfigRuleRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.getAggregateConfigRuleComplianceSummary(crossinline block: GetAggregateConfigRuleComplianceSummaryRequest.Builder.() -> Unit): GetAggregateConfigRuleComplianceSummaryResponse = getAggregateConfigRuleComplianceSummary(GetAggregateConfigRuleComplianceSummaryRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.getAggregateConformancePackComplianceSummary(crossinline block: GetAggregateConformancePackComplianceSummaryRequest.Builder.() -> Unit): GetAggregateConformancePackComplianceSummaryResponse = getAggregateConformancePackComplianceSummary(GetAggregateConformancePackComplianceSummaryRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.getAggregateDiscoveredResourceCounts(crossinline block: GetAggregateDiscoveredResourceCountsRequest.Builder.() -> Unit): GetAggregateDiscoveredResourceCountsResponse = getAggregateDiscoveredResourceCounts(GetAggregateDiscoveredResourceCountsRequest.Builder().apply(block).build())
/**
* Returns configuration item that is aggregated for your specific resource in a specific source account and region.
*/
public suspend inline fun ConfigClient.getAggregateResourceConfig(crossinline block: GetAggregateResourceConfigRequest.Builder.() -> Unit): GetAggregateResourceConfigResponse = getAggregateResourceConfig(GetAggregateResourceConfigRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.getComplianceDetailsByConfigRule(crossinline block: GetComplianceDetailsByConfigRuleRequest.Builder.() -> Unit): GetComplianceDetailsByConfigRuleResponse = getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.getComplianceDetailsByResource(crossinline block: GetComplianceDetailsByResourceRequest.Builder.() -> Unit): GetComplianceDetailsByResourceResponse = getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest.Builder().apply(block).build())
/**
* Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
*/
public suspend inline fun ConfigClient.getComplianceSummaryByConfigRule(crossinline block: GetComplianceSummaryByConfigRuleRequest.Builder.() -> Unit): GetComplianceSummaryByConfigRuleResponse = getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.getComplianceSummaryByResourceType(crossinline block: GetComplianceSummaryByResourceTypeRequest.Builder.() -> Unit): GetComplianceSummaryByResourceTypeResponse = getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest.Builder().apply(block).build())
/**
* Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
*/
public suspend inline fun ConfigClient.getConformancePackComplianceDetails(crossinline block: GetConformancePackComplianceDetailsRequest.Builder.() -> Unit): GetConformancePackComplianceDetailsResponse = getConformancePackComplianceDetails(GetConformancePackComplianceDetailsRequest.Builder().apply(block).build())
/**
* Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
*/
public suspend inline fun ConfigClient.getConformancePackComplianceSummary(crossinline block: GetConformancePackComplianceSummaryRequest.Builder.() -> Unit): GetConformancePackComplianceSummaryResponse = getConformancePackComplianceSummary(GetConformancePackComplianceSummaryRequest.Builder().apply(block).build())
/**
* Returns the policy definition containing the logic for your Config Custom Policy rule.
*/
public suspend inline fun ConfigClient.getCustomRulePolicy(crossinline block: GetCustomRulePolicyRequest.Builder.() -> Unit): GetCustomRulePolicyResponse = getCustomRulePolicy(GetCustomRulePolicyRequest.Builder().apply(block).build())
/**
* Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
*
* **Example**
* + Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
* + You make a call to the `GetDiscoveredResourceCounts` action and specify that you want all resource types.
* + Config returns the following:
* + The resource types (EC2 instances, IAM users, and S3 buckets).
* + The number of each resource type (25, 20, and 15).
* + The total number of all resources (60).
*
* The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the `limit` parameter. The response includes a `nextToken` string. To get the next page of results, run the request again and specify the string for the `nextToken` parameter.
*
* 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.
*/
public suspend inline fun ConfigClient.getDiscoveredResourceCounts(crossinline block: GetDiscoveredResourceCountsRequest.Builder.() -> Unit): GetDiscoveredResourceCountsResponse = getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest.Builder().apply(block).build())
/**
* Returns detailed status for each member account within an organization for a given organization Config rule.
*/
public suspend inline fun ConfigClient.getOrganizationConfigRuleDetailedStatus(crossinline block: GetOrganizationConfigRuleDetailedStatusRequest.Builder.() -> Unit): GetOrganizationConfigRuleDetailedStatusResponse = getOrganizationConfigRuleDetailedStatus(GetOrganizationConfigRuleDetailedStatusRequest.Builder().apply(block).build())
/**
* Returns detailed status for each member account within an organization for a given organization conformance pack.
*/
public suspend inline fun ConfigClient.getOrganizationConformancePackDetailedStatus(crossinline block: GetOrganizationConformancePackDetailedStatusRequest.Builder.() -> Unit): GetOrganizationConformancePackDetailedStatusResponse = getOrganizationConformancePackDetailedStatus(GetOrganizationConformancePackDetailedStatusRequest.Builder().apply(block).build())
/**
* Returns the policy definition containing the logic for your organization Config Custom Policy rule.
*/
public suspend inline fun ConfigClient.getOrganizationCustomRulePolicy(crossinline block: GetOrganizationCustomRulePolicyRequest.Builder.() -> Unit): GetOrganizationCustomRulePolicyResponse = getOrganizationCustomRulePolicy(GetOrganizationCustomRulePolicyRequest.Builder().apply(block).build())
/**
* 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`.
*/
public suspend inline fun ConfigClient.getResourceConfigHistory(crossinline block: GetResourceConfigHistoryRequest.Builder.() -> Unit): GetResourceConfigHistoryResponse = getResourceConfigHistory(GetResourceConfigHistoryRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.getResourceEvaluationSummary(crossinline block: GetResourceEvaluationSummaryRequest.Builder.() -> Unit): GetResourceEvaluationSummaryResponse = getResourceEvaluationSummary(GetResourceEvaluationSummaryRequest.Builder().apply(block).build())
/**
* Returns the details of a specific stored query.
*/
public suspend inline fun ConfigClient.getStoredQuery(crossinline block: GetStoredQueryRequest.Builder.() -> Unit): GetStoredQueryResponse = getStoredQuery(GetStoredQueryRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.listAggregateDiscoveredResources(crossinline block: ListAggregateDiscoveredResourcesRequest.Builder.() -> Unit): ListAggregateDiscoveredResourcesResponse = listAggregateDiscoveredResources(ListAggregateDiscoveredResourcesRequest.Builder().apply(block).build())
/**
* 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`.
*/
public suspend inline fun ConfigClient.listConformancePackComplianceScores(crossinline block: ListConformancePackComplianceScoresRequest.Builder.() -> Unit): ListConformancePackComplianceScoresResponse = listConformancePackComplianceScores(ListConformancePackComplianceScoresRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.listDiscoveredResources(crossinline block: ListDiscoveredResourcesRequest.Builder.() -> Unit): ListDiscoveredResourcesResponse = listDiscoveredResources(ListDiscoveredResourcesRequest.Builder().apply(block).build())
/**
* Returns a list of proactive resource evaluations.
*/
public suspend inline fun ConfigClient.listResourceEvaluations(crossinline block: ListResourceEvaluationsRequest.Builder.() -> Unit): ListResourceEvaluationsResponse = listResourceEvaluations(ListResourceEvaluationsRequest.Builder().apply(block).build())
/**
* Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
*/
public suspend inline fun ConfigClient.listStoredQueries(crossinline block: ListStoredQueriesRequest.Builder.() -> Unit): ListStoredQueriesResponse = listStoredQueries(ListStoredQueriesRequest.Builder().apply(block).build())
/**
* List the tags for Config resource.
*/
public suspend inline fun ConfigClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse = listTagsForResource(ListTagsForResourceRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putAggregationAuthorization(crossinline block: PutAggregationAuthorizationRequest.Builder.() -> Unit): PutAggregationAuthorizationResponse = putAggregationAuthorization(PutAggregationAuthorizationRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putConfigRule(crossinline block: PutConfigRuleRequest.Builder.() -> Unit): PutConfigRuleResponse = putConfigRule(PutConfigRuleRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putConfigurationAggregator(crossinline block: PutConfigurationAggregatorRequest.Builder.() -> Unit): PutConfigurationAggregatorResponse = putConfigurationAggregator(PutConfigurationAggregatorRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putConfigurationRecorder(crossinline block: PutConfigurationRecorderRequest.Builder.() -> Unit): PutConfigurationRecorderResponse = putConfigurationRecorder(PutConfigurationRecorderRequest.Builder().apply(block).build())
/**
* 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`.
*/
public suspend inline fun ConfigClient.putConformancePack(crossinline block: PutConformancePackRequest.Builder.() -> Unit): PutConformancePackResponse = putConformancePack(PutConformancePackRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putDeliveryChannel(crossinline block: PutDeliveryChannelRequest.Builder.() -> Unit): PutDeliveryChannelResponse = putDeliveryChannel(PutDeliveryChannelRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putEvaluations(crossinline block: PutEvaluationsRequest.Builder.() -> Unit): PutEvaluationsResponse = putEvaluations(PutEvaluationsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putExternalEvaluation(crossinline block: PutExternalEvaluationRequest.Builder.() -> Unit): PutExternalEvaluationResponse = putExternalEvaluation(PutExternalEvaluationRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putOrganizationConfigRule(crossinline block: PutOrganizationConfigRuleRequest.Builder.() -> Unit): PutOrganizationConfigRuleResponse = putOrganizationConfigRule(PutOrganizationConfigRuleRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putOrganizationConformancePack(crossinline block: PutOrganizationConformancePackRequest.Builder.() -> Unit): PutOrganizationConformancePackResponse = putOrganizationConformancePack(PutOrganizationConformancePackRequest.Builder().apply(block).build())
/**
* 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 `assumeRole`field to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.
*
* However, for automatic remediation configuration, the only valid `assumeRole` field value is `AutomationAssumeRole` and you need to provide a value for `AutomationAssumeRole` to remediate your resources.
*
* **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.
*/
public suspend inline fun ConfigClient.putRemediationConfigurations(crossinline block: PutRemediationConfigurationsRequest.Builder.() -> Unit): PutRemediationConfigurationsResponse = putRemediationConfigurations(PutRemediationConfigurationsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putRemediationExceptions(crossinline block: PutRemediationExceptionsRequest.Builder.() -> Unit): PutRemediationExceptionsResponse = putRemediationExceptions(PutRemediationExceptionsRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putResourceConfig(crossinline block: PutResourceConfigRequest.Builder.() -> Unit): PutResourceConfigResponse = putResourceConfig(PutResourceConfigRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putRetentionConfiguration(crossinline block: PutRetentionConfigurationRequest.Builder.() -> Unit): PutRetentionConfigurationResponse = putRetentionConfiguration(PutRetentionConfigurationRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.putStoredQuery(crossinline block: PutStoredQueryRequest.Builder.() -> Unit): PutStoredQueryResponse = putStoredQuery(PutStoredQueryRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.selectAggregateResourceConfig(crossinline block: SelectAggregateResourceConfigRequest.Builder.() -> Unit): SelectAggregateResourceConfigResponse = selectAggregateResourceConfig(SelectAggregateResourceConfigRequest.Builder().apply(block).build())
/**
* 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*.
*/
public suspend inline fun ConfigClient.selectResourceConfig(crossinline block: SelectResourceConfigRequest.Builder.() -> Unit): SelectResourceConfigResponse = selectResourceConfig(SelectResourceConfigRequest.Builder().apply(block).build())
/**
* 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:
* + You have a custom rule that evaluates your IAM resources every 24 hours.
* + You update your Lambda function to add additional conditions to your rule.
* + Instead of waiting for the next periodic evaluation, you call the `StartConfigRulesEvaluation` API.
* + Config invokes your Lambda function and evaluates your IAM resources.
* + Your custom rule will still run periodic evaluations every 24 hours.
*/
public suspend inline fun ConfigClient.startConfigRulesEvaluation(crossinline block: StartConfigRulesEvaluationRequest.Builder.() -> Unit): StartConfigRulesEvaluationResponse = startConfigRulesEvaluation(StartConfigRulesEvaluationRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.startConfigurationRecorder(crossinline block: StartConfigurationRecorderRequest.Builder.() -> Unit): StartConfigurationRecorderResponse = startConfigurationRecorder(StartConfigurationRecorderRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.startRemediationExecution(crossinline block: StartRemediationExecutionRequest.Builder.() -> Unit): StartRemediationExecutionResponse = startRemediationExecution(StartRemediationExecutionRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.startResourceEvaluation(crossinline block: StartResourceEvaluationRequest.Builder.() -> Unit): StartResourceEvaluationResponse = startResourceEvaluation(StartResourceEvaluationRequest.Builder().apply(block).build())
/**
* Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
*/
public suspend inline fun ConfigClient.stopConfigurationRecorder(crossinline block: StopConfigurationRecorderRequest.Builder.() -> Unit): StopConfigurationRecorderResponse = stopConfigurationRecorder(StopConfigurationRecorderRequest.Builder().apply(block).build())
/**
* 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.
*/
public suspend inline fun ConfigClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse = tagResource(TagResourceRequest.Builder().apply(block).build())
/**
* Deletes specified tags from a resource.
*/
public suspend inline fun ConfigClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse = untagResource(UntagResourceRequest.Builder().apply(block).build())