- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
ConfigServiceClient
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 .
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 . 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 in the Config Developer Guide.
Installation
npm install @aws-sdk/client-config-service
yarn add @aws-sdk/client-config-service
pnpm add @aws-sdk/client-config-service
ConfigServiceClient Operations
Command | Summary |
---|
Command | Summary |
---|---|
AssociateResourceTypesCommand | Adds all resource types specified in the For this operation, the specified configuration recorder must use a RecordingStrategy that is either |
BatchGetAggregateResourceConfigCommand | 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
|
BatchGetResourceConfigCommand | Returns the
|
DeleteAggregationAuthorizationCommand | Deletes the authorization granted to the specified configuration aggregator account in a specified region. |
DeleteConfigRuleCommand | Deletes the specified Config rule and all of its evaluation results. Config sets the state of a rule to You can check the state of a rule by using the Recommendation: Stop recording resource compliance before deleting rules It is highly recommended that you stop recording for the Best practice:
|
DeleteConfigurationAggregatorCommand | Deletes the specified configuration aggregator and the aggregated data associated with the aggregator. |
DeleteConfigurationRecorderCommand | Deletes the customer managed configuration recorder. This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new customer managed configuration recorder. |
DeleteConformancePackCommand | 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 |
DeleteDeliveryChannelCommand | Deletes the delivery channel. Before you can delete the delivery channel, you must stop the customer managed configuration recorder. You can use the StopConfigurationRecorder operation to stop the customer managed configuration recorder. |
DeleteEvaluationResultsCommand | 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. |
DeleteOrganizationConfigRuleCommand | 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 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. |
DeleteOrganizationConformancePackCommand | 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 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. |
DeletePendingAggregationRequestCommand | Deletes pending authorization requests for a specified aggregator account in a specified region. |
DeleteRemediationConfigurationCommand | Deletes the remediation configuration. |
DeleteRemediationExceptionsCommand | 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. |
DeleteResourceConfigCommand | 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. |
DeleteRetentionConfigurationCommand | Deletes the retention configuration. |
DeleteServiceLinkedConfigurationRecorderCommand | Deletes an existing service-linked configuration recorder. This operation does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory operation, but you will not be able to access this information in the Config console until you have created a new service-linked configuration recorder for the same service. The recording scope determines if you receive configuration items The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel. |
DeleteStoredQueryCommand | Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region. |
DeliverConfigSnapshotCommand | 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.
|
DescribeAggregateComplianceByConfigRulesCommand | 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 |
DescribeAggregateComplianceByConformancePacksCommand | Returns a list of the existing and deleted conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data. The results can return an empty result page, but if you have a |
DescribeAggregationAuthorizationsCommand | Returns a list of authorizations granted to various aggregator accounts and regions. |
DescribeComplianceByConfigRuleCommand | Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this operation returns the number of Amazon Web Services resources that do not comply with the rule. 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
|
DescribeComplianceByResourceCommand | Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this operation returns the number of Config rules that the resource does not comply with. 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
|
DescribeConfigRuleEvaluationStatusCommand | 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. |
DescribeConfigRulesCommand | Returns details about your Config rules. |
DescribeConfigurationAggregatorSourcesStatusCommand | 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. |
DescribeConfigurationAggregatorsCommand | Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this operation returns the details for all the configuration aggregators associated with the account. |
DescribeConfigurationRecorderStatusCommand | Returns the current status of the configuration recorder you specify as well as the status of the last recording event for the configuration recorders. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics. If a configuration recorder is not specified, this operation returns the status for the customer managed configuration recorder configured for the account, if applicable. When making a request to this operation, you can only specify one configuration recorder. |
DescribeConfigurationRecordersCommand | Returns details for the configuration recorder you specify. If a configuration recorder is not specified, this operation returns details for the customer managed configuration recorder configured for the account, if applicable. When making a request to this operation, you can only specify one configuration recorder. |
DescribeConformancePackComplianceCommand | Returns compliance details for each rule in that conformance pack. You must provide exact rule names. |
DescribeConformancePackStatusCommand | Provides one or more conformance packs deployment status. If there are no conformance packs then you will see an empty result. |
DescribeConformancePacksCommand | Returns a list of one or more conformance packs. |
DescribeDeliveryChannelStatusCommand | Returns the current status of the specified delivery channel. If a delivery channel is not specified, this operation returns the current status of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account. |
DescribeDeliveryChannelsCommand | Returns details about the specified delivery channel. If a delivery channel is not specified, this operation returns the details of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account. |
DescribeOrganizationConfigRuleStatusesCommand | 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. |
DescribeOrganizationConfigRulesCommand | 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 |
DescribeOrganizationConformancePackStatusesCommand | 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. |
DescribeOrganizationConformancePacksCommand | 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 |
DescribePendingAggregationRequestsCommand | Returns a list of all pending aggregation requests. |
DescribeRemediationConfigurationsCommand | Returns the details of one or more remediation configurations. |
DescribeRemediationExceptionsCommand | 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. |
DescribeRemediationExecutionStatusCommand | 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. |
DescribeRetentionConfigurationsCommand | Returns the details of one or more retention configurations. If the retention configuration name is not specified, this operation returns the details for all the retention configurations for that account. Currently, Config supports only one retention configuration per region in your account. |
DisassociateResourceTypesCommand | Removes all resource types specified in the For this operation, the configuration recorder must use a RecordingStrategy that is either |
GetAggregateComplianceDetailsByConfigRuleCommand | 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 |
GetAggregateConfigRuleComplianceSummaryCommand | 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. |
GetAggregateConformancePackComplianceSummaryCommand | 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. |
GetAggregateDiscoveredResourceCountsCommand | 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. |
GetAggregateResourceConfigCommand | Returns configuration item that is aggregated for your specific resource in a specific source account and region. The API does not return results for deleted resources. |
GetComplianceDetailsByConfigRuleCommand | 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. |
GetComplianceDetailsByResourceCommand | 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. |
GetComplianceSummaryByConfigRuleCommand | Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each. |
GetComplianceSummaryByResourceTypeCommand | 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. |
GetConformancePackComplianceDetailsCommand | Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack. |
GetConformancePackComplianceSummaryCommand | Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack. |
GetCustomRulePolicyCommand | Returns the policy definition containing the logic for your Config Custom Policy rule. |
GetDiscoveredResourceCountsCommand | 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
The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can customize this number with the If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action. |
GetOrganizationConfigRuleDetailedStatusCommand | Returns detailed status for each member account within an organization for a given organization Config rule. |
GetOrganizationConformancePackDetailedStatusCommand | Returns detailed status for each member account within an organization for a given organization conformance pack. |
GetOrganizationCustomRulePolicyCommand | Returns the policy definition containing the logic for your organization Config Custom Policy rule. |
GetResourceConfigHistoryCommand | For accurate reporting on the compliance status, you must record the Returns a list of The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the 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 |
GetResourceEvaluationSummaryCommand | 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 API. For more information, see the Examples section. |
GetStoredQueryCommand | Returns the details of a specific stored query. |
ListAggregateDiscoveredResourcesCommand | 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 |
ListConfigurationRecordersCommand | Returns a list of configuration recorders depending on the filters you specify. |
ListConformancePackComplianceScoresCommand | 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 |
ListDiscoveredResourcesCommand | 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 |
ListResourceEvaluationsCommand | Returns a list of proactive resource evaluations. |
ListStoredQueriesCommand | Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100. |
ListTagsForResourceCommand | List the tags for Config resource. |
PutAggregationAuthorizationCommand | Authorizes the aggregator account and region to collect data from the source account and region. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation. |
PutConfigRuleCommand | Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide. There are two types of rules: Config Managed Rules and Config Custom Rules. You can use Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules . If you are adding an Config managed rule, you must specify the rule's identifier for the 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 ) and with Guard (Guard GitHub Repository ), 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 For any new Config rule that you add, specify the If you are updating a rule that you added previously, you can specify the rule by For more information about developing and using Config rules, see Evaluating Resources with Config Rules in the Config Developer Guide. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation. |
PutConfigurationAggregatorCommand | Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization. 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 To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation. |
PutConfigurationRecorderCommand | Creates or updates the customer managed configuration recorder. You can use this operation to create a new customer managed configuration recorder or to update the To start the customer managed configuration recorder and begin recording configuration changes for the resource types you specify, use the StartConfigurationRecorder operation. For more information, see Working with the Configuration Recorder in the Config Developer Guide. One customer managed configuration recorder per account per Region You can create only one customer managed configuration recorder for each account for each Amazon Web Services Region. Default is to record all supported resource types, excluding the global IAM resource types If you have not specified values for the Tags are added at creation and cannot be updated Use TagResource and UntagResource to update tags after creation. |
PutConformancePackCommand | Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide. This API creates a service-linked role You must specify only one of the follow parameters: |
PutDeliveryChannelCommand | Creates or updates a delivery channel to deliver configuration information and other compliance information. You can use this operation to create a new delivery channel or to update the Amazon S3 bucket and the Amazon SNS topic of an existing delivery channel. For more information, see Working with the Delivery Channel in the Config Developer Guide. One delivery channel per account per Region You can have only one delivery channel for each account for each Amazon Web Services Region. |
PutEvaluationsCommand | Used by an Lambda function to deliver evaluation results to Config. This operation is required in every Lambda function that is invoked by an Config rule. |
PutExternalEvaluationCommand | 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. |
PutOrganizationConfigRuleCommand | Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide. 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 This API enables organization service access through the To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization There are two types of rules: Config Managed Rules and Config Custom Rules. You can use Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules . If you are adding an Config managed rule, you must specify the rule's identifier for the 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 ) and with Guard (Guard GitHub Repository ), 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 Prerequisite: Ensure you call Make sure to specify one of either |
PutOrganizationConformancePackCommand | Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide. Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations This API enables organization service access for Prerequisite: Ensure you call You must specify either the 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. |
PutRemediationConfigurationsCommand | Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the 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 However, for automatic remediation configuration, the only valid Auto remediation can be initiated even for compliant resources If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations 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. |
PutRemediationExceptionsCommand | 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 Exceptions can only be performed on non-compliant resources Placing an exception can only be performed on resources that are Exceptions cannot be placed on service-linked remediation actions You cannot place an exception on service-linked remediation actions, such as remediation actions put by an organizational conformance pack. Auto remediation can be initiated even for compliant resources If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations 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. |
PutResourceConfigCommand | 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. |
PutRetentionConfigurationCommand | Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the Currently, Config supports only one retention configuration per region in your account. |
PutServiceLinkedConfigurationRecorderCommand | Creates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the The configuration recorder's For more information, see Working with the Configuration Recorder in the Config Developer Guide. This API creates a service-linked role The recording scope determines if you receive configuration items The recording scope is set by the service that is linked to the configuration recorder and determines whether you receive configuration items (CIs) in the delivery channel. If the recording scope is internal, you will not receive CIs in the delivery channel. Tags are added at creation and cannot be updated with this operation Use TagResource and UntagResource to update tags after creation. |
PutStoredQueryCommand | Saves a new query or updates an existing saved query. The Tags are added at creation and cannot be updated |
SelectAggregateResourceConfigCommand | 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 section in the Config Developer Guide. If you run an aggregation query (i.e., using If you run a non-aggregation query (i.e., not using |
SelectResourceConfigCommand | Accepts a structured query language (SQL) For more information about query components, see the Query Components section in the Config Developer Guide. |
StartConfigRulesEvaluationCommand | Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use You can specify up to 25 Config rules per request. An existing You don't need to call the The
|
StartConfigurationRecorderCommand | Starts the customer managed configuration recorder. The customer managed configuration recorder will begin recording configuration changes for the resource types you specify. You must have created a delivery channel to successfully start the customer managed configuration recorder. You can use the PutDeliveryChannel operation to create a delivery channel. |
StartRemediationExecutionCommand | 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. |
StartResourceEvaluationCommand | 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 You can find the Resource type schema in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand: For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide. |
StopConfigurationRecorderCommand | Stops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified. |
TagResourceCommand | Associates the specified tags to a resource with the specified |
UntagResourceCommand | Deletes specified tags from a resource. |
ConfigServiceClient Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: ConfigServiceClientConfig