aws config97 CLI commands available for AWS Config.
| Command | API Operation | Sample |
|---|---|---|
associate-resource-typesAdds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when recording. For this operation, the specified configuration recorder must use a RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES or | AssociateResourceTypes | |
batch-get-aggregate-resource-configReturns 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. | BatchGetAggregateResourceConfig | |
batch-get-resource-configReturns 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 | BatchGetResourceConfig | |
delete-aggregation-authorizationDeletes the authorization granted to the specified configuration aggregator account in a specified region. | DeleteAggregationAuthorization | |
delete-config-ruleDeletes 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 ResourceInUseE | DeleteConfigRule | |
delete-configuration-aggregatorDeletes the specified configuration aggregator and the aggregated data associated with the aggregator. | DeleteConfigurationAggregator | |
delete-configuration-recorderDeletes 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 info | DeleteConfigurationRecorder | |
delete-conformance-packDeletes 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. Reco | DeleteConformancePack | |
delete-delivery-channelDeletes 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. | DeleteDeliveryChannel | |
delete-evaluation-resultsDeletes 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. | DeleteEvaluationResults | |
delete-organization-config-ruleDeletes 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 ensu | DeleteOrganizationConfigRule | |
delete-organization-conformance-packDeletes 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 | DeleteOrganizationConformancePack | |
delete-pending-aggregation-requestDeletes pending authorization requests for a specified aggregator account in a specified region. | DeletePendingAggregationRequest | |
delete-remediation-configurationDeletes the remediation configuration. | DeleteRemediationConfiguration | |
delete-remediation-exceptionsDeletes 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. | DeleteRemediationExceptions | |
delete-resource-configRecords 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. | DeleteResourceConfig | |
delete-retention-configurationDeletes the retention configuration. | DeleteRetentionConfiguration | |
delete-service-linked-configuration-recorderDeletes 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 thi | DeleteServiceLinkedConfigurationRecorder | |
delete-stored-queryDeletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region. | DeleteStoredQuery | |
deliver-config-snapshotSchedules 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 com | DeliverConfigSnapshot | |
describe-aggregate-compliance-by-config-rulesReturns 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. | DescribeAggregateComplianceByConfigRules | |
describe-aggregate-compliance-by-conformance-packsReturns 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 e | DescribeAggregateComplianceByConformancePacks | |
describe-aggregation-authorizationsReturns a list of authorizations granted to various aggregator accounts and regions. | DescribeAggregationAuthorizations | |
describe-compliance-by-config-ruleIndicates 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 resourc | DescribeComplianceByConfigRule | |
describe-compliance-by-resourceIndicates 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 | DescribeComplianceByResource | |
describe-config-rule-evaluation-statusReturns 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. | DescribeConfigRuleEvaluationStatus | |
describe-config-rulesReturns details about your Config rules. | DescribeConfigRules | |
describe-configuration-aggregator-sources-statusReturns 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. | DescribeConfigurationAggregatorSourcesStatus | |
describe-configuration-aggregatorsReturns 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. | DescribeConfigurationAggregators | |
describe-configuration-recorder-statusReturns 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 configurat | DescribeConfigurationRecorderStatus | |
describe-configuration-recordersReturns 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 confi | DescribeConfigurationRecorders | |
describe-conformance-pack-complianceReturns compliance details for each rule in that conformance pack. You must provide exact rule names. | DescribeConformancePackCompliance | |
describe-conformance-pack-statusProvides one or more conformance packs deployment status. If there are no conformance packs then you will see an empty result. | DescribeConformancePackStatus | |
describe-conformance-packsReturns a list of one or more conformance packs. | DescribeConformancePacks | |
describe-delivery-channel-statusReturns 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. | DescribeDeliveryChannelStatus | |
describe-delivery-channelsReturns 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. | DescribeDeliveryChannels | |
describe-organization-config-rule-statusesProvides 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 pa | DescribeOrganizationConfigRuleStatuses | |
describe-organization-config-rulesReturns 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 accou | DescribeOrganizationConfigRules | |
describe-organization-conformance-pack-statusesProvides 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 r | DescribeOrganizationConformancePackStatuses | |
describe-organization-conformance-packsReturns 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 conforman | DescribeOrganizationConformancePacks | |
describe-pending-aggregation-requestsReturns a list of all pending aggregation requests. | DescribePendingAggregationRequests | |
describe-remediation-configurationsReturns the details of one or more remediation configurations. | DescribeRemediationConfigurations | |
describe-remediation-exceptionsReturns 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. | DescribeRemediationExceptions | |
describe-remediation-execution-statusProvides 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. | DescribeRemediationExecutionStatus | |
describe-retention-configurationsReturns 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. | DescribeRetentionConfigurations | |
disassociate-resource-typesRemoves all resource types specified in the ResourceTypes list from the RecordingGroup of configuration recorder and excludes these resource types when recording. For this operation, the configuration recorder must use a RecordingStrategy that is either INCLUSION_BY_RESOURCE_TYPES or EXCLUSION_BY_RE | DisassociateResourceTypes | |
get-aggregate-compliance-details-by-config-ruleReturns 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 em | GetAggregateComplianceDetailsByConfigRule | |
get-aggregate-config-rule-compliance-summaryReturns 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. | GetAggregateConfigRuleComplianceSummary | |
get-aggregate-conformance-pack-compliance-summaryReturns 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 h | GetAggregateConformancePackComplianceSummary | |
get-aggregate-discovered-resource-countsReturns 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 resource | GetAggregateDiscoveredResourceCounts | |
get-aggregate-resource-configReturns 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. | GetAggregateResourceConfig | |
get-compliance-details-by-config-ruleReturns 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. | GetComplianceDetailsByConfigRule | |
get-compliance-details-by-resourceReturns 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. | GetComplianceDetailsByResource | |
get-compliance-summary-by-config-ruleReturns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each. | GetComplianceSummaryByConfigRule | |
get-compliance-summary-by-resource-typeReturns 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. | GetComplianceSummaryByResourceType | |
get-conformance-pack-compliance-detailsReturns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack. | GetConformancePackComplianceDetails | |
get-conformance-pack-compliance-summaryReturns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack. | GetConformancePackComplianceSummary | |
get-custom-rule-policyReturns the policy definition containing the logic for your Config Custom Policy rule. | GetCustomRulePolicy | |
get-discovered-resource-countsReturns 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 | GetDiscoveredResourceCounts | |
get-organization-config-rule-detailed-statusReturns detailed status for each member account within an organization for a given organization Config rule. | GetOrganizationConfigRuleDetailedStatus | |
get-organization-conformance-pack-detailed-statusReturns detailed status for each member account within an organization for a given organization conformance pack. | GetOrganizationConformancePackDetailedStatus | |
get-organization-custom-rule-policyReturns the policy definition containing the logic for your organization Config Custom Policy rule. | GetOrganizationCustomRulePolicy | |
get-resource-config-historyFor accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type. For more information, see Recording Amazon Web Services Resources in the Config Resources Developer Guide. Returns a list of configurations items (CIs) for the specified resource. C | GetResourceConfigHistory | |
get-resource-evaluation-summaryReturns 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 de | GetResourceEvaluationSummary | |
get-stored-queryReturns the details of a specific stored query. | GetStoredQuery | |
list-aggregate-discovered-resourcesAccepts 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 result | ListAggregateDiscoveredResources | |
list-configuration-recordersReturns a list of configuration recorders depending on the filters you specify. | ListConfigurationRecorders | |
list-conformance-pack-compliance-scoresReturns 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-lev | ListConformancePackComplianceScores | |
list-discovered-resourcesReturns a list of resource resource identifiers for the specified resource types 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 | ListDiscoveredResources | |
list-resource-evaluationsReturns a list of proactive resource evaluations. | ListResourceEvaluations | |
list-stored-queriesLists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100. | ListStoredQueries | |
list-tags-for-resourceList the tags for Config resource. | ListTagsForResource | |
put-aggregation-authorizationAuthorizes 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 PutAggregationAuthorization is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already create | PutAggregationAuthorization | |
put-config-ruleAdds 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 Conf | PutConfigRule | |
put-configuration-aggregatorCreates 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 De | PutConfigurationAggregator | |
put-configuration-recorderCreates or updates the customer managed configuration recorder. You can use this operation to create a new customer managed configuration recorder or to update the roleARN and the recordingGroup for an existing customer managed configuration recorder. To start the customer managed configuration reco | PutConfigurationRecorder | |
put-conformance-packCreates 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. Wh | PutConformancePack | |
put-delivery-channelCreates 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 | PutDeliveryChannel | |
put-evaluationsUsed 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. | PutEvaluations | |
put-external-evaluationAdd 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. | PutExternalEvaluation | |
put-organization-config-ruleAdds 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 managemen | PutOrganizationConfigRule | |
put-organization-conformance-packDeploys 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 admini | PutOrganizationConformancePack | |
put-remediation-configurationsAdds 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 a | PutRemediationConfigurations | |
put-remediation-exceptionsA 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 | PutRemediationExceptions | |
put-resource-configRecords 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 | PutResourceConfig | |
put-retention-configurationCreates 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 | PutRetentionConfiguration | |
put-service-linked-configuration-recorderCreates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify. The configuration recorder's name, recordingGroup, recordingMode, and recordingScope is set by the service that is linked to the configuration recorder. | PutServiceLinkedConfigurationRecorder | |
put-stored-querySaves 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. Tags are added at cr | PutStoredQuery | |
select-aggregate-resource-configAccepts 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 qu | SelectAggregateResourceConfig | |
select-resource-configAccepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties. For more information about query components, see the Query Components section in the Config Developer Guide. | SelectResourceConfig | |
start-config-rules-evaluationRuns 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 f | StartConfigRulesEvaluation | |
start-configuration-recorderStarts 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 P | StartConfigurationRecorder | |
start-remediation-executionRuns 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 StartRemediationExe | StartRemediationExecution | |
start-resource-evaluationRuns 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 Co | StartResourceEvaluation | |
stop-configuration-recorderStops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource types you have specified. | StopConfigurationRecorder | |
tag-resourceAssociates 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 wi | TagResource | |
untag-resourceDeletes specified tags from a resource. | UntagResource |
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterOur bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterConfig Service