AWS Config
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.…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
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 .
Endpoints 102
- POSTAssociate resource types
/#X-Amz-Target=StarlingDoveService.AssociateResourceTypesAdds all resource types specified in the ResourceTypes list to the RecordingGroup of specified configuration recorder and includes those resource types when… - POSTBatch get aggregate resource config
/#X-Amz-Target=StarlingDoveService.BatchGetAggregateResourceConfigReturns the current configuration items for resources that are present in your Config aggregator. The operation also returns a list of resources that are not… - POSTBatch get resource config
/#X-Amz-Target=StarlingDoveService.BatchGetResourceConfigReturns the BaseConfigurationItem for one or more requested resources. The operation also returns a list of resources that are not processed in the current… - POSTDelete aggregation authorization
/#X-Amz-Target=StarlingDoveService.DeleteAggregationAuthorizationDeletes the authorization granted to the specified configuration aggregator account in a specified region. - POSTDelete config rule
/#X-Amz-Target=StarlingDoveService.DeleteConfigRuleDeletes 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… - POSTDelete configuration aggregator
/#X-Amz-Target=StarlingDoveService.DeleteConfigurationAggregatorDeletes the specified configuration aggregator and the aggregated data associated with the aggregator. - POSTDelete configuration recorder
/#X-Amz-Target=StarlingDoveService.DeleteConfigurationRecorderDeletes the customer managed configuration recorder. This operation does not delete the configuration information that was previously recorded. You will be… - POSTDelete conformance pack
/#X-Amz-Target=StarlingDoveService.DeleteConformancePackDeletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack. Config sets the… - POSTDelete connector
/#X-Amz-Target=StarlingDoveService.DeleteConnectorDeletes the specified connector. - POSTDelete delivery channel
/#X-Amz-Target=StarlingDoveService.DeleteDeliveryChannelDeletes the delivery channel. Before you can delete the delivery channel, you must stop the customer managed configuration recorder. You can use the… - POSTDelete evaluation results
/#X-Amz-Target=StarlingDoveService.DeleteEvaluationResultsDeletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can… - POSTDelete organization config rule
/#X-Amz-Target=StarlingDoveService.DeleteOrganizationConfigRuleDeletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization. Only a management account and… - POSTDelete organization conformance pack
/#X-Amz-Target=StarlingDoveService.DeleteOrganizationConformancePackDeletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization. Only a… - POSTDelete pending aggregation request
/#X-Amz-Target=StarlingDoveService.DeletePendingAggregationRequestDeletes pending authorization requests for a specified aggregator account in a specified region. - POSTDelete remediation configuration
/#X-Amz-Target=StarlingDoveService.DeleteRemediationConfigurationDeletes the remediation configuration. - POSTDelete remediation exceptions
/#X-Amz-Target=StarlingDoveService.DeleteRemediationExceptionsDeletes one or more remediation exceptions mentioned in the resource keys. Config generates a remediation exception when a problem occurs executing a… - POSTDelete resource config
/#X-Amz-Target=StarlingDoveService.DeleteResourceConfigRecords the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can… - POSTDelete retention configuration
/#X-Amz-Target=StarlingDoveService.DeleteRetentionConfigurationDeletes the retention configuration. - POSTDelete service linked configuration recorder
/#X-Amz-Target=StarlingDoveService.DeleteServiceLinkedConfigurationRecorderDeletes an existing service-linked configuration recorder. This operation does not delete the configuration information that was previously recorded. You will… - POSTDelete stored query
/#X-Amz-Target=StarlingDoveService.DeleteStoredQueryDeletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region. - POSTDeliver config snapshot
/#X-Amz-Target=StarlingDoveService.DeliverConfigSnapshotSchedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, Config sends the… - POSTDescribe aggregate compliance by config rules
/#X-Amz-Target=StarlingDoveService.DescribeAggregateComplianceByConfigRulesReturns 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… - POSTDescribe aggregate compliance by conformance packs
/#X-Amz-Target=StarlingDoveService.DescribeAggregateComplianceByConformancePacksReturns a list of the existing and deleted conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules… - POSTDescribe aggregation authorizations
/#X-Amz-Target=StarlingDoveService.DescribeAggregationAuthorizationsReturns a list of authorizations granted to various aggregator accounts and regions. - POSTDescribe compliance by config rule
/#X-Amz-Target=StarlingDoveService.DescribeComplianceByConfigRuleIndicates whether the specified Config rules are compliant. If a rule is noncompliant, this operation returns the number of Amazon Web Services resources that… - POSTDescribe compliance by resource
/#X-Amz-Target=StarlingDoveService.DescribeComplianceByResourceIndicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this operation returns the number of Config rules… - POSTDescribe config rule evaluation status
/#X-Amz-Target=StarlingDoveService.DescribeConfigRuleEvaluationStatusReturns 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… - POSTDescribe config rules
/#X-Amz-Target=StarlingDoveService.DescribeConfigRulesReturns details about your Config rules. - POSTDescribe configuration aggregator sources status
/#X-Amz-Target=StarlingDoveService.DescribeConfigurationAggregatorSourcesStatusReturns status information for sources within an aggregator. The status includes information about the last time Config verified authorization between the… - POSTDescribe configuration aggregators
/#X-Amz-Target=StarlingDoveService.DescribeConfigurationAggregatorsReturns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this operation returns the details for all the… - POSTDescribe configuration recorder status
/#X-Amz-Target=StarlingDoveService.DescribeConfigurationRecorderStatusReturns 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… - POSTDescribe configuration recorders
/#X-Amz-Target=StarlingDoveService.DescribeConfigurationRecordersReturns details for the configuration recorder you specify. If a configuration recorder is not specified, this operation returns details for the customer… - POSTDescribe conformance pack compliance
/#X-Amz-Target=StarlingDoveService.DescribeConformancePackComplianceReturns compliance details for each rule in that conformance pack. You must provide exact rule names. - POSTDescribe conformance pack status
/#X-Amz-Target=StarlingDoveService.DescribeConformancePackStatusProvides one or more conformance packs deployment status. If there are no conformance packs then you will see an empty result. - POSTDescribe conformance packs
/#X-Amz-Target=StarlingDoveService.DescribeConformancePacksReturns a list of one or more conformance packs. - POSTDescribe delivery channel status
/#X-Amz-Target=StarlingDoveService.DescribeDeliveryChannelStatusReturns the current status of the specified delivery channel. If a delivery channel is not specified, this operation returns the current status of all… - POSTDescribe delivery channels
/#X-Amz-Target=StarlingDoveService.DescribeDeliveryChannelsReturns details about the specified delivery channel. If a delivery channel is not specified, this operation returns the details of all delivery channels… - POSTDescribe organization config rule statuses
/#X-Amz-Target=StarlingDoveService.DescribeOrganizationConfigRuleStatusesProvides organization Config rule deployment status for an organization. The status is not considered successful until organization Config rule is… - POSTDescribe organization config rules
/#X-Amz-Target=StarlingDoveService.DescribeOrganizationConfigRulesReturns 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… - POSTDescribe organization conformance pack statuses
/#X-Amz-Target=StarlingDoveService.DescribeOrganizationConformancePackStatusesProvides organization conformance pack deployment status for an organization. The status is not considered successful until organization conformance pack is… - POSTDescribe organization conformance packs
/#X-Amz-Target=StarlingDoveService.DescribeOrganizationConformancePacksReturns 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… - POSTDescribe pending aggregation requests
/#X-Amz-Target=StarlingDoveService.DescribePendingAggregationRequestsReturns a list of all pending aggregation requests. - POSTDescribe remediation configurations
/#X-Amz-Target=StarlingDoveService.DescribeRemediationConfigurationsReturns the details of one or more remediation configurations. - POSTDescribe remediation exceptions
/#X-Amz-Target=StarlingDoveService.DescribeRemediationExceptionsReturns 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… - POSTDescribe remediation execution status
/#X-Amz-Target=StarlingDoveService.DescribeRemediationExecutionStatusProvides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and… - POSTDescribe retention configurations
/#X-Amz-Target=StarlingDoveService.DescribeRetentionConfigurationsReturns the details of one or more retention configurations. If the retention configuration name is not specified, this operation returns the details for all… - POSTDisassociate resource types
/#X-Amz-Target=StarlingDoveService.DisassociateResourceTypesRemoves all resource types specified in the ResourceTypes list from the RecordingGroup of configuration recorder and excludes these resource types when… - POSTGet aggregate compliance details by config rule
/#X-Amz-Target=StarlingDoveService.GetAggregateComplianceDetailsByConfigRuleReturns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services resources were… - POSTGet aggregate config rule compliance summary
/#X-Amz-Target=StarlingDoveService.GetAggregateConfigRuleComplianceSummaryReturns 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… - POSTGet aggregate conformance pack compliance summary
/#X-Amz-Target=StarlingDoveService.GetAggregateConformancePackComplianceSummaryReturns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.… - POSTGet aggregate discovered resource counts
/#X-Amz-Target=StarlingDoveService.GetAggregateDiscoveredResourceCountsReturns the resource counts across accounts and regions that are present in your Config aggregator. You can request the resource counts by providing filters… - POSTGet aggregate resource config
/#X-Amz-Target=StarlingDoveService.GetAggregateResourceConfigReturns configuration item that is aggregated for your specific resource in a specific source account and region. The API does not return results for deleted… - POSTGet compliance details by config rule
/#X-Amz-Target=StarlingDoveService.GetComplianceDetailsByConfigRuleReturns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each… - POSTGet compliance details by resource
/#X-Amz-Target=StarlingDoveService.GetComplianceDetailsByResourceReturns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource,… - POSTGet compliance summary by config rule
/#X-Amz-Target=StarlingDoveService.GetComplianceSummaryByConfigRuleReturns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each. - POSTGet compliance summary by resource type
/#X-Amz-Target=StarlingDoveService.GetComplianceSummaryByResourceTypeReturns 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… - POSTGet conformance pack compliance details
/#X-Amz-Target=StarlingDoveService.GetConformancePackComplianceDetailsReturns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack. - POSTGet conformance pack compliance summary
/#X-Amz-Target=StarlingDoveService.GetConformancePackComplianceSummaryReturns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack. - POSTGet connector
/#X-Amz-Target=StarlingDoveService.GetConnectorReturns the details of the specified connector. - POSTGet custom rule policy
/#X-Amz-Target=StarlingDoveService.GetCustomRulePolicyReturns the policy definition containing the logic for your Config Custom Policy rule. - POSTGet discovered resource counts
/#X-Amz-Target=StarlingDoveService.GetDiscoveredResourceCountsReturns 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… - POSTGet organization config rule detailed status
/#X-Amz-Target=StarlingDoveService.GetOrganizationConfigRuleDetailedStatusReturns detailed status for each member account within an organization for a given organization Config rule. - POSTGet organization conformance pack detailed status
/#X-Amz-Target=StarlingDoveService.GetOrganizationConformancePackDetailedStatusReturns detailed status for each member account within an organization for a given organization conformance pack. - POSTGet organization custom rule policy
/#X-Amz-Target=StarlingDoveService.GetOrganizationCustomRulePolicyReturns the policy definition containing the logic for your organization Config Custom Policy rule. - POSTGet resource config history
/#X-Amz-Target=StarlingDoveService.GetResourceConfigHistoryFor accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance resource type. For more information, see Recording Amazon… - POSTGet resource evaluation summary
/#X-Amz-Target=StarlingDoveService.GetResourceEvaluationSummaryReturns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which… - POSTGet stored query
/#X-Amz-Target=StarlingDoveService.GetStoredQueryReturns the details of a specific stored query. - POSTList aggregate discovered resources
/#X-Amz-Target=StarlingDoveService.ListAggregateDiscoveredResourcesAccepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource… - POSTList configuration recorders
/#X-Amz-Target=StarlingDoveService.ListConfigurationRecordersReturns a list of configuration recorders depending on the filters you specify. - POSTList conformance pack compliance scores
/#X-Amz-Target=StarlingDoveService.ListConformancePackComplianceScoresReturns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a… - POSTList connectors
/#X-Amz-Target=StarlingDoveService.ListConnectorsReturns a list of connectors depending on the filters you specify. - POSTList discovered resources
/#X-Amz-Target=StarlingDoveService.ListDiscoveredResourcesReturns a list of resource resource identifiers for the specified resource types for the resources of that type. A resource identifier includes the resource… - POSTList resource evaluations
/#X-Amz-Target=StarlingDoveService.ListResourceEvaluationsReturns a list of proactive resource evaluations. - POSTList stored queries
/#X-Amz-Target=StarlingDoveService.ListStoredQueriesLists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100. - POSTList tags for resource
/#X-Amz-Target=StarlingDoveService.ListTagsForResourceList the tags for Config resource. - POSTPut aggregation authorization
/#X-Amz-Target=StarlingDoveService.PutAggregationAuthorizationAuthorizes 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… - POSTPut config rule
/#X-Amz-Target=StarlingDoveService.PutConfigRuleAdds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config… - POSTPut configuration aggregator
/#X-Amz-Target=StarlingDoveService.PutConfigurationAggregatorCreates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an… - POSTPut configuration recorder
/#X-Amz-Target=StarlingDoveService.PutConfigurationRecorderCreates or updates the customer managed configuration recorder. You can use this operation to create a new customer managed configuration recorder or to… - POSTPut conformance pack
/#X-Amz-Target=StarlingDoveService.PutConformancePackCreates 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… - POSTPut connector
/#X-Amz-Target=StarlingDoveService.PutConnectorCreates a connector that specifies the connection between a third-party cloud service provider and Config. A connector is required to create a service-linked… - POSTPut delivery channel
/#X-Amz-Target=StarlingDoveService.PutDeliveryChannelCreates or updates a delivery channel to deliver configuration information and other compliance information. You can use this operation to create a new… - POSTPut evaluations
/#X-Amz-Target=StarlingDoveService.PutEvaluationsUsed 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. - POSTPut external evaluation
/#X-Amz-Target=StarlingDoveService.PutExternalEvaluationAdd 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. - POSTPut organization config rule
/#X-Amz-Target=StarlingDoveService.PutOrganizationConfigRuleAdds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For… - POSTPut organization conformance pack
/#X-Amz-Target=StarlingDoveService.PutOrganizationConformancePackDeploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how… - POSTPut remediation configurations
/#X-Amz-Target=StarlingDoveService.PutRemediationConfigurationsAdds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the RemediationConfiguration… - POSTPut remediation exceptions
/#X-Amz-Target=StarlingDoveService.PutRemediationExceptionsA remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing… - POSTPut resource config
/#X-Amz-Target=StarlingDoveService.PutResourceConfigRecords the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration… - POSTPut retention configuration
/#X-Amz-Target=StarlingDoveService.PutRetentionConfigurationCreates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API… - POSTPut service linked configuration recorder
/#X-Amz-Target=StarlingDoveService.PutServiceLinkedConfigurationRecorderCreates a service-linked configuration recorder that is linked to a specific Amazon Web Services service based on the ServicePrincipal you specify. The… - POSTPut stored query
/#X-Amz-Target=StarlingDoveService.PutStoredQuerySaves 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… - POSTPut third party service linked configuration recorder
/#X-Amz-Target=StarlingDoveService.PutThirdPartyServiceLinkedConfigurationRecorderCreates or updates a service-linked configuration recorder that is linked to a third-party cloud service provider based on the ConnectorArn you specify. The… - POSTSelect aggregate resource config
/#X-Amz-Target=StarlingDoveService.SelectAggregateResourceConfigAccepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple… - POSTSelect resource config
/#X-Amz-Target=StarlingDoveService.SelectResourceConfigAccepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties. For… - POSTStart config rules evaluation
/#X-Amz-Target=StarlingDoveService.StartConfigRulesEvaluationRuns an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when… - POSTStart configuration recorder
/#X-Amz-Target=StarlingDoveService.StartConfigurationRecorderStarts the customer managed configuration recorder. The customer managed configuration recorder will begin recording configuration changes for the resource… - POSTStart remediation execution
/#X-Amz-Target=StarlingDoveService.StartRemediationExecutionRuns an on-demand remediation for the specified Config rules against the last known remediation configuration. It runs an execution against the current state… - POSTStart resource evaluation
/#X-Amz-Target=StarlingDoveService.StartResourceEvaluationRuns an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use… - POSTStop configuration recorder
/#X-Amz-Target=StarlingDoveService.StopConfigurationRecorderStops the customer managed configuration recorder. The customer managed configuration recorder will stop recording configuration changes for the resource… - POSTTag resource
/#X-Amz-Target=StarlingDoveService.TagResourceAssociates the specified tags to a resource with the specified ResourceArn . If existing tags on a resource are not specified in the request parameters, they… - POSTUntag resource
/#X-Amz-Target=StarlingDoveService.UntagResourceDeletes specified tags from a resource.
API details
- Base URL
https://config.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 102 operations on 102 pathsPOST 102
- Description format
- AWS Smithy model, API version
2014-11-12 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the AWS Config in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS Config collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Associate resource types” (POST /#X-Amz-Target=StarlingDoveService.AssociateResourceTypes), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS Config?
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.… It is listed under Developer tools and has 102 endpoints.
Who publishes the AWS Config?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS Config?
Requests go to https://config.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the AWS Config?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the AWS Config have?
102 operations on 102 paths (102 POST).
Is forking the AWS Config free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.