Data retrieval APIs for AWS Config - AWS Online Register of Data Formats

Data retrieval APIs for AWS Config

AWS Config provides the following APIs for data retrieval.

Actions Description Access level
BatchGetAggregateResourceConfigReturn the current configuration items for resources that are present in your AWS Config aggregatorRead
BatchGetResourceConfigReturn the current configuration for one or more requested resourcesRead
DeliverConfigSnapshotSchedule delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channelRead
DescribeAggregateComplianceByConfigRulesReturn a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rulesRead
DescribeAggregateComplianceByConformancePacksReturn a list of compliant and noncompliant conformance packs along with count of compliant, non-compliant and total rules within each conformance packRead
DescribeAggregationAuthorizationsReturn a list of authorizations granted to various aggregator accounts and regionsList
DescribeComplianceByConfigRuleIndicate whether the specified AWS Config rules are compliantRead
DescribeComplianceByResourceIndicate whether the specified AWS resources are compliantRead
DescribeConfigRuleEvaluationStatusReturn status information for each of your AWS managed Config rulesRead
DescribeConfigRulesReturn details about your AWS Config rulesList
DescribeConfigurationAggregatorSourcesStatusReturn status information for sources within an aggregatorRead
DescribeConfigurationAggregatorsReturn the details of one or more configuration aggregatorsList
DescribeConfigurationRecorderStatusReturn the current status of the specified configuration recorderRead
DescribeConfigurationRecordersReturn the names of one or more specified configuration recordersRead
DescribeConformancePackComplianceReturn compliance information for each rule in that conformance packRead
DescribeConformancePackStatusProvide one or more conformance packs deployment statusRead
DescribeConformancePacksReturn a list of one or more conformance packsList
DescribeDeliveryChannelStatusReturn the current status of the specified delivery channelRead
DescribeDeliveryChannelsReturn details about the specified delivery channelList
DescribeOrganizationConfigRuleStatusesProvide organization config rule deployment status for an organizationRead
DescribeOrganizationConfigRulesReturn a list of organization config rulesList
DescribeOrganizationConformancePackStatusesProvide organization conformance pack deployment status for an organizationRead
DescribeOrganizationConformancePacksReturn a list of organization conformance packsList
DescribePendingAggregationRequestsReturn a list of all pending aggregation requestsList
DescribeRemediationConfigurationsReturn the details of one or more remediation configurationsList
DescribeRemediationExceptionsReturn the details of one or more remediation exceptionsList
DescribeRemediationExecutionStatusProvide a detailed view of a Remediation Execution for a set of resources including state, timestamps and any error messages for steps that have failedRead
DescribeRetentionConfigurationsReturn the details of one or more retention configurationsList
GetAggregateComplianceDetailsByConfigRuleReturn the evaluation results for the specified AWS Config rule for a specific resource in a ruleRead
GetAggregateConfigRuleComplianceSummaryReturn the number of compliant and noncompliant rules for one or more accounts and regions in an aggregatorRead
GetAggregateConformancePackComplianceSummaryReturn the number of compliant and noncompliant conformance packs for one or more accounts and regions in an aggregatorRead
GetAggregateDiscoveredResourceCountsReturn the resource counts across accounts and regions that are present in your AWS Config aggregatorRead
GetAggregateResourceConfigReturn configuration item that is aggregated for your specific resource in a specific source account and regionRead
GetComplianceDetailsByConfigRuleReturn the evaluation results for the specified AWS Config ruleRead
GetComplianceDetailsByResourceReturn the evaluation results for the specified AWS resourceRead
GetComplianceSummaryByConfigRuleReturn the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for eachRead
GetComplianceSummaryByResourceTypeReturn the number of resources that are compliant and the number that are noncompliantRead
GetConformancePackComplianceDetailsReturn compliance details of a conformance pack for all AWS resources that are monitered by conformance packRead
GetConformancePackComplianceSummaryProvide compliance summary for one or more conformance packsRead
GetCustomRulePolicyReturn the policy definition containing the logic for your AWS Config Custom Policy ruleRead
GetDiscoveredResourceCountsReturn the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS accountRead
GetOrganizationConfigRuleDetailedStatusReturn detailed status for each member account within an organization for a given organization config ruleRead
GetOrganizationConformancePackDetailedStatusReturn detailed status for each member account within an organization for a given organization conformance packRead
GetOrganizationCustomRulePolicyReturn the policy definition containing the logic for your organization AWS Config Custom Policy ruleRead
GetResourceConfigHistoryReturn a list of configuration items for the specified resourceRead
GetResourceEvaluationSummaryReturn the summary of resource evaluations for a specific resource evaluation IDRead
GetStoredQueryReturn the details of a specific stored queryRead
ListAggregateDiscoveredResourcesAccept a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regionsList
ListConfigurationRecordersList the configuration recorder summaries for an AWS account in an AWS RegionList
ListConformancePackComplianceScoresReturn the percentage of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinationsList
ListDiscoveredResourcesAccept a resource type and returns a list of resource identifiers for the resources of that typeList
ListResourceEvaluationsList the resource evaluation summaries for an AWS account in an AWS RegionList
ListStoredQueriesList the stored queries for an AWS account in an AWS RegionList
ListTagsForResourceList the tags for AWS Config resourceRead
SelectAggregateResourceConfigAccept a structured query language (SQL) SELECT command and an aggregator to query configuration state of AWS resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the propertiesRead
SelectResourceConfigAccept a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the propertiesRead