Config

Implementation details for API config

Coverage Overview

Config is supported by LocalStack in the community image.

AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
BatchGetAggregateResourceConfig✔️community
BatchGetResourceConfig✔️community
DeleteAggregationAuthorization✔️community✔️
DeleteConfigRule✔️community✔️✔️
DeleteConfigurationAggregator✔️community✔️✔️
DeleteConfigurationRecorder✔️community✔️✔️✔️Show Tests
DeleteConformancePack
DeleteDeliveryChannel✔️community✔️✔️✔️Show Tests
DeleteEvaluationResults
DeleteOrganizationConfigRule
DeleteOrganizationConformancePack✔️community✔️
DeletePendingAggregationRequest
DeleteRemediationConfiguration
DeleteRemediationExceptions
DeleteResourceConfig
DeleteRetentionConfiguration✔️community✔️
DeleteStoredQuery
DeliverConfigSnapshot
DescribeAggregateComplianceByConfigRules
DescribeAggregateComplianceByConformancePacks
DescribeAggregationAuthorizations✔️community✔️
DescribeComplianceByConfigRule
DescribeComplianceByResource
DescribeConfigRuleEvaluationStatus
DescribeConfigRules✔️community✔️✔️
DescribeConfigurationAggregatorSourcesStatus
DescribeConfigurationAggregators✔️community✔️✔️
DescribeConfigurationRecorderStatus✔️community✔️
DescribeConfigurationRecorders✔️community✔️✔️✔️Show Tests
DescribeConformancePackCompliance
DescribeConformancePackStatus
DescribeConformancePacks
DescribeDeliveryChannelStatus
DescribeDeliveryChannels✔️community✔️✔️✔️Show Tests
DescribeOrganizationConfigRuleStatuses
DescribeOrganizationConfigRules
DescribeOrganizationConformancePackStatuses✔️community✔️
DescribeOrganizationConformancePacks✔️community✔️
DescribePendingAggregationRequests
DescribeRemediationConfigurations
DescribeRemediationExceptions
DescribeRemediationExecutionStatus
DescribeRetentionConfigurations✔️community✔️
GetAggregateComplianceDetailsByConfigRule
GetAggregateConfigRuleComplianceSummary
GetAggregateConformancePackComplianceSummary
GetAggregateDiscoveredResourceCounts
GetAggregateResourceConfig
GetComplianceDetailsByConfigRule
GetComplianceDetailsByResource
GetComplianceSummaryByConfigRule
GetComplianceSummaryByResourceType
GetConformancePackComplianceDetails
GetConformancePackComplianceSummary
GetCustomRulePolicy
GetDiscoveredResourceCounts
GetOrganizationConfigRuleDetailedStatus
GetOrganizationConformancePackDetailedStatus✔️community✔️
GetOrganizationCustomRulePolicy
GetResourceConfigHistory✔️community
GetResourceEvaluationSummary
GetStoredQuery
ListAggregateDiscoveredResources✔️community
ListConformancePackComplianceScores
ListDiscoveredResources✔️community
ListResourceEvaluations
ListStoredQueries
ListTagsForResource✔️community✔️✔️
PutAggregationAuthorization✔️community✔️
PutConfigRule✔️community✔️✔️
PutConfigurationAggregator✔️community✔️✔️
PutConfigurationRecorder✔️community✔️✔️✔️Show Tests
PutConformancePack
PutDeliveryChannel✔️community✔️✔️✔️Show Tests
PutEvaluations✔️community
PutExternalEvaluation
PutOrganizationConfigRule
PutOrganizationConformancePack✔️community✔️
PutRemediationConfigurations
PutRemediationExceptions
PutResourceConfig
PutRetentionConfiguration✔️community✔️
PutStoredQuery
SelectAggregateResourceConfig
SelectResourceConfig
StartConfigRulesEvaluation
StartConfigurationRecorder✔️community✔️
StartRemediationExecution
StartResourceEvaluation
StopConfigurationRecorder✔️community✔️
TagResource✔️community✔️✔️
UntagResource✔️community✔️✔️

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


DeleteConfigurationRecorder

Parameters: ConfigurationRecorderName
  • LocalStack Community
    • test_put_configuration_recorder LocalStack Community: tests/integration/test_config_service.py::TestConfigService::test_put_configuration_recorder HTTP Status Code: 200
    • test_put_delivery_channel LocalStack Community: tests/integration/test_config_service.py::TestConfigService::test_put_delivery_channel HTTP Status Code: 200

DeleteDeliveryChannel

Parameters: DeliveryChannelName
  • LocalStack Community
    • test_put_delivery_channel LocalStack Community: tests/integration/test_config_service.py::TestConfigService::test_put_delivery_channel HTTP Status Code: 200

DescribeConfigurationRecorders

Parameters: - (without any parameters)
  • LocalStack Community
    • test_put_configuration_recorder LocalStack Community: tests/integration/test_config_service.py::TestConfigService::test_put_configuration_recorder HTTP Status Code: 200

DescribeDeliveryChannels

Parameters: - (without any parameters)
  • LocalStack Community
    • test_put_delivery_channel LocalStack Community: tests/integration/test_config_service.py::TestConfigService::test_put_delivery_channel HTTP Status Code: 200

PutConfigurationRecorder

Parameters: ConfigurationRecorder
  • LocalStack Community
    • test_put_configuration_recorder LocalStack Community: tests/integration/test_config_service.py::TestConfigService::test_put_configuration_recorder HTTP Status Code: 200
    • test_put_delivery_channel LocalStack Community: tests/integration/test_config_service.py::TestConfigService::test_put_delivery_channel HTTP Status Code: 200

PutDeliveryChannel

Parameters: DeliveryChannel
  • LocalStack Community
    • test_put_delivery_channel LocalStack Community: tests/integration/test_config_service.py::TestConfigService::test_put_delivery_channel HTTP Status Code: 200

Last modified March 20, 2023: improve Coverage Docs (#505) (46f2fb0c0)