@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConfig
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonConfig
instead.
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.
Modifier and Type | Field and Description |
---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
Modifier and Type | Method and Description |
---|---|
BatchGetAggregateResourceConfigResult |
batchGetAggregateResourceConfig(BatchGetAggregateResourceConfigRequest batchGetAggregateResourceConfigRequest)
Returns the current configuration items for resources that are present in your Config aggregator.
|
BatchGetResourceConfigResult |
batchGetResourceConfig(BatchGetResourceConfigRequest batchGetResourceConfigRequest)
Returns the
BaseConfigurationItem for one or more requested resources. |
DeleteAggregationAuthorizationResult |
deleteAggregationAuthorization(DeleteAggregationAuthorizationRequest deleteAggregationAuthorizationRequest)
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
|
DeleteConfigRuleResult |
deleteConfigRule(DeleteConfigRuleRequest deleteConfigRuleRequest)
Deletes the specified Config rule and all of its evaluation results.
|
DeleteConfigurationAggregatorResult |
deleteConfigurationAggregator(DeleteConfigurationAggregatorRequest deleteConfigurationAggregatorRequest)
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
|
DeleteConfigurationRecorderResult |
deleteConfigurationRecorder(DeleteConfigurationRecorderRequest deleteConfigurationRecorderRequest)
Deletes the configuration recorder.
|
DeleteConformancePackResult |
deleteConformancePack(DeleteConformancePackRequest deleteConformancePackRequest)
Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results
within that conformance pack.
|
DeleteDeliveryChannelResult |
deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest)
Deletes the delivery channel.
|
DeleteEvaluationResultsResult |
deleteEvaluationResults(DeleteEvaluationResultsRequest deleteEvaluationResultsRequest)
Deletes the evaluation results for the specified Config rule.
|
DeleteOrganizationConfigRuleResult |
deleteOrganizationConfigRule(DeleteOrganizationConfigRuleRequest deleteOrganizationConfigRuleRequest)
Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that
organization.
|
DeleteOrganizationConformancePackResult |
deleteOrganizationConformancePack(DeleteOrganizationConformancePackRequest deleteOrganizationConformancePackRequest)
Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all
member accounts in that organization.
|
DeletePendingAggregationRequestResult |
deletePendingAggregationRequest(DeletePendingAggregationRequestRequest deletePendingAggregationRequestRequest)
Deletes pending authorization requests for a specified aggregator account in a specified region.
|
DeleteRemediationConfigurationResult |
deleteRemediationConfiguration(DeleteRemediationConfigurationRequest deleteRemediationConfigurationRequest)
Deletes the remediation configuration.
|
DeleteRemediationExceptionsResult |
deleteRemediationExceptions(DeleteRemediationExceptionsRequest deleteRemediationExceptionsRequest)
Deletes one or more remediation exceptions mentioned in the resource keys.
|
DeleteResourceConfigResult |
deleteResourceConfig(DeleteResourceConfigRequest deleteResourceConfigRequest)
Records the configuration state for a custom resource that has been deleted.
|
DeleteRetentionConfigurationResult |
deleteRetentionConfiguration(DeleteRetentionConfigurationRequest deleteRetentionConfigurationRequest)
Deletes the retention configuration.
|
DeleteStoredQueryResult |
deleteStoredQuery(DeleteStoredQueryRequest deleteStoredQueryRequest)
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
|
DeliverConfigSnapshotResult |
deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest)
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
|
DescribeAggregateComplianceByConfigRulesResult |
describeAggregateComplianceByConfigRules(DescribeAggregateComplianceByConfigRulesRequest describeAggregateComplianceByConfigRulesRequest)
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant
rules.
|
DescribeAggregateComplianceByConformancePacksResult |
describeAggregateComplianceByConformancePacks(DescribeAggregateComplianceByConformancePacksRequest describeAggregateComplianceByConformancePacksRequest)
Returns a list of the conformance packs and their associated compliance status with the count of compliant and
noncompliant Config rules within each conformance pack.
|
DescribeAggregationAuthorizationsResult |
describeAggregationAuthorizations(DescribeAggregationAuthorizationsRequest describeAggregationAuthorizationsRequest)
Returns a list of authorizations granted to various aggregator accounts and regions.
|
DescribeComplianceByConfigRuleResult |
describeComplianceByConfigRule()
Simplified method form for invoking the DescribeComplianceByConfigRule operation.
|
DescribeComplianceByConfigRuleResult |
describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest)
Indicates whether the specified Config rules are compliant.
|
DescribeComplianceByResourceResult |
describeComplianceByResource()
Simplified method form for invoking the DescribeComplianceByResource operation.
|
DescribeComplianceByResourceResult |
describeComplianceByResource(DescribeComplianceByResourceRequest describeComplianceByResourceRequest)
Indicates whether the specified Amazon Web Services resources are compliant.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus()
Simplified method form for invoking the DescribeConfigRuleEvaluationStatus operation.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest)
Returns status information for each of your Config managed rules.
|
DescribeConfigRulesResult |
describeConfigRules()
Simplified method form for invoking the DescribeConfigRules operation.
|
DescribeConfigRulesResult |
describeConfigRules(DescribeConfigRulesRequest describeConfigRulesRequest)
Returns details about your Config rules.
|
DescribeConfigurationAggregatorsResult |
describeConfigurationAggregators(DescribeConfigurationAggregatorsRequest describeConfigurationAggregatorsRequest)
Returns the details of one or more configuration aggregators.
|
DescribeConfigurationAggregatorSourcesStatusResult |
describeConfigurationAggregatorSourcesStatus(DescribeConfigurationAggregatorSourcesStatusRequest describeConfigurationAggregatorSourcesStatusRequest)
Returns status information for sources within an aggregator.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders()
Simplified method form for invoking the DescribeConfigurationRecorders operation.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest)
Returns the details for the specified configuration recorders.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus()
Simplified method form for invoking the DescribeConfigurationRecorderStatus operation.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest)
Returns the current status of the specified configuration recorder as well as the status of the last recording
event for the recorder.
|
DescribeConformancePackComplianceResult |
describeConformancePackCompliance(DescribeConformancePackComplianceRequest describeConformancePackComplianceRequest)
Returns compliance details for each rule in that conformance pack.
|
DescribeConformancePacksResult |
describeConformancePacks(DescribeConformancePacksRequest describeConformancePacksRequest)
Returns a list of one or more conformance packs.
|
DescribeConformancePackStatusResult |
describeConformancePackStatus(DescribeConformancePackStatusRequest describeConformancePackStatusRequest)
Provides one or more conformance packs deployment status.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels()
Simplified method form for invoking the DescribeDeliveryChannels operation.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest)
Returns details about the specified delivery channel.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus()
Simplified method form for invoking the DescribeDeliveryChannelStatus operation.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest)
Returns the current status of the specified delivery channel.
|
DescribeOrganizationConfigRulesResult |
describeOrganizationConfigRules(DescribeOrganizationConfigRulesRequest describeOrganizationConfigRulesRequest)
Returns a list of organization Config rules.
|
DescribeOrganizationConfigRuleStatusesResult |
describeOrganizationConfigRuleStatuses(DescribeOrganizationConfigRuleStatusesRequest describeOrganizationConfigRuleStatusesRequest)
Provides organization Config rule deployment status for an organization.
|
DescribeOrganizationConformancePacksResult |
describeOrganizationConformancePacks(DescribeOrganizationConformancePacksRequest describeOrganizationConformancePacksRequest)
Returns a list of organization conformance packs.
|
DescribeOrganizationConformancePackStatusesResult |
describeOrganizationConformancePackStatuses(DescribeOrganizationConformancePackStatusesRequest describeOrganizationConformancePackStatusesRequest)
Provides organization conformance pack deployment status for an organization.
|
DescribePendingAggregationRequestsResult |
describePendingAggregationRequests(DescribePendingAggregationRequestsRequest describePendingAggregationRequestsRequest)
Returns a list of all pending aggregation requests.
|
DescribeRemediationConfigurationsResult |
describeRemediationConfigurations(DescribeRemediationConfigurationsRequest describeRemediationConfigurationsRequest)
Returns the details of one or more remediation configurations.
|
DescribeRemediationExceptionsResult |
describeRemediationExceptions(DescribeRemediationExceptionsRequest describeRemediationExceptionsRequest)
Returns the details of one or more remediation exceptions.
|
DescribeRemediationExecutionStatusResult |
describeRemediationExecutionStatus(DescribeRemediationExecutionStatusRequest describeRemediationExecutionStatusRequest)
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.
|
DescribeRetentionConfigurationsResult |
describeRetentionConfigurations(DescribeRetentionConfigurationsRequest describeRetentionConfigurationsRequest)
Returns the details of one or more retention configurations.
|
GetAggregateComplianceDetailsByConfigRuleResult |
getAggregateComplianceDetailsByConfigRule(GetAggregateComplianceDetailsByConfigRuleRequest getAggregateComplianceDetailsByConfigRuleRequest)
Returns the evaluation results for the specified Config rule for a specific resource in a rule.
|
GetAggregateConfigRuleComplianceSummaryResult |
getAggregateConfigRuleComplianceSummary(GetAggregateConfigRuleComplianceSummaryRequest getAggregateConfigRuleComplianceSummaryRequest)
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
|
GetAggregateConformancePackComplianceSummaryResult |
getAggregateConformancePackComplianceSummary(GetAggregateConformancePackComplianceSummaryRequest getAggregateConformancePackComplianceSummaryRequest)
Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and
Amazon Web Services Regions in an aggregator.
|
GetAggregateDiscoveredResourceCountsResult |
getAggregateDiscoveredResourceCounts(GetAggregateDiscoveredResourceCountsRequest getAggregateDiscoveredResourceCountsRequest)
Returns the resource counts across accounts and regions that are present in your Config aggregator.
|
GetAggregateResourceConfigResult |
getAggregateResourceConfig(GetAggregateResourceConfigRequest getAggregateResourceConfigRequest)
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetComplianceDetailsByConfigRuleResult |
getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest)
Returns the evaluation results for the specified Config rule.
|
GetComplianceDetailsByResourceResult |
getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest)
Returns the evaluation results for the specified Amazon Web Services resource.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule()
Simplified method form for invoking the GetComplianceSummaryByConfigRule operation.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest getComplianceSummaryByConfigRuleRequest)
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
|
GetComplianceSummaryByResourceTypeResult |
getComplianceSummaryByResourceType()
Simplified method form for invoking the GetComplianceSummaryByResourceType operation.
|
GetComplianceSummaryByResourceTypeResult |
getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest getComplianceSummaryByResourceTypeRequest)
Returns the number of resources that are compliant and the number that are noncompliant.
|
GetConformancePackComplianceDetailsResult |
getConformancePackComplianceDetails(GetConformancePackComplianceDetailsRequest getConformancePackComplianceDetailsRequest)
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by
conformance pack.
|
GetConformancePackComplianceSummaryResult |
getConformancePackComplianceSummary(GetConformancePackComplianceSummaryRequest getConformancePackComplianceSummaryRequest)
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules
in that conformance pack.
|
GetCustomRulePolicyResult |
getCustomRulePolicy(GetCustomRulePolicyRequest getCustomRulePolicyRequest)
Returns the policy definition containing the logic for your Config Custom Policy rule.
|
GetDiscoveredResourceCountsResult |
getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest)
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.
|
GetOrganizationConfigRuleDetailedStatusResult |
getOrganizationConfigRuleDetailedStatus(GetOrganizationConfigRuleDetailedStatusRequest getOrganizationConfigRuleDetailedStatusRequest)
Returns detailed status for each member account within an organization for a given organization Config rule.
|
GetOrganizationConformancePackDetailedStatusResult |
getOrganizationConformancePackDetailedStatus(GetOrganizationConformancePackDetailedStatusRequest getOrganizationConformancePackDetailedStatusRequest)
Returns detailed status for each member account within an organization for a given organization conformance pack.
|
GetOrganizationCustomRulePolicyResult |
getOrganizationCustomRulePolicy(GetOrganizationCustomRulePolicyRequest getOrganizationCustomRulePolicyRequest)
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
|
GetResourceConfigHistoryResult |
getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)
|
GetResourceEvaluationSummaryResult |
getResourceEvaluationSummary(GetResourceEvaluationSummaryRequest getResourceEvaluationSummaryRequest)
Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that
were run.
|
GetStoredQueryResult |
getStoredQuery(GetStoredQueryRequest getStoredQueryRequest)
Returns the details of a specific stored query.
|
ListAggregateDiscoveredResourcesResult |
listAggregateDiscoveredResources(ListAggregateDiscoveredResourcesRequest listAggregateDiscoveredResourcesRequest)
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource
type across accounts and regions.
|
ListConformancePackComplianceScoresResult |
listConformancePackComplianceScores(ListConformancePackComplianceScoresRequest listConformancePackComplianceScoresRequest)
Returns a list of conformance pack compliance scores.
|
ListDiscoveredResourcesResult |
listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
Accepts a resource type and returns a list of resource identifiers for the resources of that type.
|
ListResourceEvaluationsResult |
listResourceEvaluations(ListResourceEvaluationsRequest listResourceEvaluationsRequest)
Returns a list of proactive resource evaluations.
|
ListStoredQueriesResult |
listStoredQueries(ListStoredQueriesRequest listStoredQueriesRequest)
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for Config resource.
|
PutAggregationAuthorizationResult |
putAggregationAuthorization(PutAggregationAuthorizationRequest putAggregationAuthorizationRequest)
Authorizes the aggregator account and region to collect data from the source account and region.
|
PutConfigRuleResult |
putConfigRule(PutConfigRuleRequest putConfigRuleRequest)
Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired
configurations.
|
PutConfigurationAggregatorResult |
putConfigurationAggregator(PutConfigurationAggregatorRequest putConfigurationAggregatorRequest)
Creates and updates the configuration aggregator with the selected source accounts and regions.
|
PutConfigurationRecorderResult |
putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest)
Creates a new configuration recorder to record configuration changes for specified resource types.
|
PutConformancePackResult |
putConformancePack(PutConformancePackRequest putConformancePackRequest)
Creates or updates a conformance pack.
|
PutDeliveryChannelResult |
putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest)
Creates a delivery channel object to deliver configuration information and other compliance information to an
Amazon S3 bucket and Amazon SNS topic.
|
PutEvaluationsResult |
putEvaluations(PutEvaluationsRequest putEvaluationsRequest)
Used by an Lambda function to deliver evaluation results to Config.
|
PutExternalEvaluationResult |
putExternalEvaluation(PutExternalEvaluationRequest putExternalEvaluationRequest)
Add or updates the evaluations for process checks.
|
PutOrganizationConfigRuleResult |
putOrganizationConfigRule(PutOrganizationConfigRuleRequest putOrganizationConfigRuleRequest)
Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources
comply with your desired configurations.
|
PutOrganizationConformancePackResult |
putOrganizationConformancePack(PutOrganizationConformancePackRequest putOrganizationConformancePackRequest)
Deploys conformance packs across member accounts in an Amazon Web Services Organization.
|
PutRemediationConfigurationsResult |
putRemediationConfigurations(PutRemediationConfigurationsRequest putRemediationConfigurationsRequest)
Adds or updates the remediation configuration with a specific Config rule with the selected target or action.
|
PutRemediationExceptionsResult |
putRemediationExceptions(PutRemediationExceptionsRequest putRemediationExceptionsRequest)
A remediation exception is when a specified resource is no longer considered for auto-remediation.
|
PutResourceConfigResult |
putResourceConfig(PutResourceConfigRequest putResourceConfigRequest)
Records the configuration state for the resource provided in the request.
|
PutRetentionConfigurationResult |
putRetentionConfiguration(PutRetentionConfigurationRequest putRetentionConfigurationRequest)
Creates and updates the retention configuration with details about retention period (number of days) that Config
stores your historical information.
|
PutStoredQueryResult |
putStoredQuery(PutStoredQueryRequest putStoredQueryRequest)
Saves a new query or updates an existing saved query.
|
SelectAggregateResourceConfigResult |
selectAggregateResourceConfig(SelectAggregateResourceConfigRequest selectAggregateResourceConfigRequest)
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.
|
SelectResourceConfigResult |
selectResourceConfig(SelectResourceConfigRequest selectResourceConfigRequest)
Accepts a structured query language (SQL)
SELECT command, performs the corresponding search, and
returns resource configurations matching the properties. |
void |
setEndpoint(String endpoint)
Deprecated.
use
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion)); |
void |
setRegion(Region region)
Deprecated.
use
AwsClientBuilder#setRegion(String) |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartConfigRulesEvaluationResult |
startConfigRulesEvaluation(StartConfigRulesEvaluationRequest startConfigRulesEvaluationRequest)
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the
resources.
|
StartConfigurationRecorderResult |
startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest)
Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon
Web Services account.
|
StartRemediationExecutionResult |
startRemediationExecution(StartRemediationExecutionRequest startRemediationExecutionRequest)
Runs an on-demand remediation for the specified Config rules against the last known remediation configuration.
|
StartResourceEvaluationResult |
startResourceEvaluation(StartResourceEvaluationRequest startResourceEvaluationRequest)
Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply
with configured Config rules.
|
StopConfigurationRecorderResult |
stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest)
Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon
Web Services account.
|
TagResourceResult |
tagResource(TagResourceRequest tagResourceRequest)
Associates the specified tags to a resource with the specified resourceArn.
|
UntagResourceResult |
untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
|
static final String ENDPOINT_PREFIX
@Deprecated void setEndpoint(String endpoint)
AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)
for
example:
builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
Callers can pass in just the endpoint (ex: "config.us-east-1.amazonaws.com/") or a full URL, including the
protocol (ex: "config.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol
from this client's ClientConfiguration
will be used, which by default is HTTPS.
For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
endpoint
- The endpoint (ex: "config.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex:
"config.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.@Deprecated void setRegion(Region region)
AwsClientBuilder#setRegion(String)
setEndpoint(String)
, sets the regional endpoint for this client's service
calls. Callers can use this method to control which AWS region they want to work with.
By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.
This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
region
- The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
BatchGetAggregateResourceConfigResult batchGetAggregateResourceConfig(BatchGetAggregateResourceConfigRequest batchGetAggregateResourceConfigRequest)
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 unprocessedResourceIdentifiers
list.
The API does not return results for deleted resources.
The API does not return tags and relationships.
batchGetAggregateResourceConfigRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.BatchGetResourceConfigResult batchGetResourceConfig(BatchGetResourceConfigRequest batchGetResourceConfigRequest)
Returns 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 for deleted resources.
The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.
batchGetResourceConfigRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.DeleteAggregationAuthorizationResult deleteAggregationAuthorization(DeleteAggregationAuthorizationRequest deleteAggregationAuthorizationRequest)
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
deleteAggregationAuthorizationRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.DeleteConfigRuleResult deleteConfigRule(DeleteConfigRuleRequest deleteConfigRuleRequest)
Deletes 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 ResourceInUseException
.
You can check the state of a rule by using the DescribeConfigRules
request.
deleteConfigRuleRequest
- NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
DeleteConfigurationAggregatorResult deleteConfigurationAggregator(DeleteConfigurationAggregatorRequest deleteConfigurationAggregatorRequest)
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
deleteConfigurationAggregatorRequest
- NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.DeleteConfigurationRecorderResult deleteConfigurationRecorder(DeleteConfigurationRecorderRequest deleteConfigurationRecorderRequest)
Deletes the configuration recorder.
After the configuration recorder is deleted, Config will not record resource configuration changes until you create a new configuration recorder.
This action does not delete the configuration information that was previously recorded. You will be able to
access the previously recorded information by using the GetResourceConfigHistory
action, but you
will not be able to access this information in the Config console until you create a new configuration recorder.
deleteConfigurationRecorderRequest
- The request object for the DeleteConfigurationRecorder
action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.DeleteConformancePackResult deleteConformancePack(DeleteConformancePackRequest deleteConformancePackRequest)
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 DELETE_IN_PROGRESS
until the deletion is complete. You cannot
update a conformance pack while it is in this state.
deleteConformancePackRequest
- NoSuchConformancePackException
- You specified one or more conformance packs that do not exist.ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
DeleteDeliveryChannelResult deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest)
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
deleteDeliveryChannelRequest
- The input for the DeleteDeliveryChannel action. The action accepts the following data, in JSON
format.NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.LastDeliveryChannelDeleteFailedException
- You cannot delete the delivery channel you specified because the configuration recorder is running.DeleteEvaluationResultsResult deleteEvaluationResults(DeleteEvaluationResultsRequest deleteEvaluationResultsRequest)
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.
deleteEvaluationResultsRequest
- NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
DeleteOrganizationConfigRuleResult deleteOrganizationConfigRule(DeleteOrganizationConfigRuleRequest deleteOrganizationConfigRuleRequest)
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
ListDelegatedAdministrator
permissions are added.
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.
deleteOrganizationConfigRuleRequest
- NoSuchOrganizationConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check
rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying
again.ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following
reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
DeleteOrganizationConformancePackResult deleteOrganizationConformancePack(DeleteOrganizationConformancePackRequest deleteOrganizationConformancePackRequest)
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
ListDelegatedAdministrator
permissions are added.
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.
deleteOrganizationConformancePackRequest
- NoSuchOrganizationConformancePackException
- Config organization conformance pack that you passed in the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following
reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
DeletePendingAggregationRequestResult deletePendingAggregationRequest(DeletePendingAggregationRequestRequest deletePendingAggregationRequestRequest)
Deletes pending authorization requests for a specified aggregator account in a specified region.
deletePendingAggregationRequestRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.DeleteRemediationConfigurationResult deleteRemediationConfiguration(DeleteRemediationConfigurationRequest deleteRemediationConfigurationRequest)
Deletes the remediation configuration.
deleteRemediationConfigurationRequest
- NoSuchRemediationConfigurationException
- You specified an Config rule without a remediation configuration.RemediationInProgressException
- Remediation action is in progress. You can either cancel execution in Amazon Web Services Systems Manager
or wait and try again later.InsufficientPermissionsException
- Indicates one of the following errors:
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have
permissions to call IAM GetRole
action or create a service-linked role.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
You do not have permission to call IAM GetRole
action or create a service-linked role.
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.DeleteRemediationExceptionsResult deleteRemediationExceptions(DeleteRemediationExceptionsRequest deleteRemediationExceptionsRequest)
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.
deleteRemediationExceptionsRequest
- NoSuchRemediationExceptionException
- You tried to delete a remediation exception that does not exist.DeleteResourceConfigResult deleteResourceConfig(DeleteResourceConfigRequest deleteResourceConfigRequest)
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.
deleteResourceConfigRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
NoRunningConfigurationRecorderException
- There is no configuration recorder running.DeleteRetentionConfigurationResult deleteRetentionConfiguration(DeleteRetentionConfigurationRequest deleteRetentionConfigurationRequest)
Deletes the retention configuration.
deleteRetentionConfigurationRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.NoSuchRetentionConfigurationException
- You have specified a retention configuration that does not exist.DeleteStoredQueryResult deleteStoredQuery(DeleteStoredQueryRequest deleteStoredQueryRequest)
Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
deleteStoredQueryRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
ResourceNotFoundException
- You have specified a resource that does not exist.DeliverConfigSnapshotResult deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest)
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.
Notification of the start of the delivery.
Notification of the completion of the delivery, if the delivery was successfully completed.
Notification of delivery failure, if the delivery failed.
deliverConfigSnapshotRequest
- The input for the DeliverConfigSnapshot action.NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.NoRunningConfigurationRecorderException
- There is no configuration recorder running.DescribeAggregateComplianceByConfigRulesResult describeAggregateComplianceByConfigRules(DescribeAggregateComplianceByConfigRulesRequest describeAggregateComplianceByConfigRulesRequest)
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 nextToken
, the results are displayed
on the next page.
describeAggregateComplianceByConfigRulesRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.DescribeAggregateComplianceByConformancePacksResult describeAggregateComplianceByConformancePacks(DescribeAggregateComplianceByConformancePacksRequest describeAggregateComplianceByConformancePacksRequest)
Returns a list of the 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 nextToken
, the results are displayed
on the next page.
describeAggregateComplianceByConformancePacksRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.DescribeAggregationAuthorizationsResult describeAggregationAuthorizations(DescribeAggregationAuthorizationsRequest describeAggregationAuthorizationsRequest)
Returns a list of authorizations granted to various aggregator accounts and regions.
describeAggregationAuthorizationsRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidLimitException
- The specified limit is outside the allowable range.DescribeComplianceByConfigRuleResult describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest)
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action 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 INSUFFICIENT_DATA
. This result
might indicate one of the following conditions:
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get the LastSuccessfulInvocationTime
and
LastFailedInvocationTime
.
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role you assigned to
your configuration recorder includes the config:PutEvaluations
permission. If the rule is a custom
rule, verify that the Lambda execution role includes the config:PutEvaluations
permission.
The rule's Lambda function has returned NOT_APPLICABLE
for all evaluation results. This can occur if
the resources were deleted or removed from the rule's scope.
describeComplianceByConfigRuleRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.DescribeComplianceByConfigRuleResult describeComplianceByConfigRule()
DescribeComplianceByResourceResult describeComplianceByResource(DescribeComplianceByResourceRequest describeComplianceByResourceRequest)
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action 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 INSUFFICIENT_DATA
. This
result might indicate one of the following conditions about the rules that evaluate the resource:
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get the LastSuccessfulInvocationTime
and
LastFailedInvocationTime
.
The rule's Lambda function is failing to send evaluation results to Config. Verify that the role that you
assigned to your configuration recorder includes the config:PutEvaluations
permission. If the rule
is a custom rule, verify that the Lambda execution role includes the config:PutEvaluations
permission.
The rule's Lambda function has returned NOT_APPLICABLE
for all evaluation results. This can occur if
the resources were deleted or removed from the rule's scope.
describeComplianceByResourceRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.DescribeComplianceByResourceResult describeComplianceByResource()
DescribeConfigRuleEvaluationStatusResult describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest)
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.
describeConfigRuleEvaluationStatusRequest
- NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.DescribeConfigRuleEvaluationStatusResult describeConfigRuleEvaluationStatus()
DescribeConfigRulesResult describeConfigRules(DescribeConfigRulesRequest describeConfigRulesRequest)
Returns details about your Config rules.
describeConfigRulesRequest
- NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.DescribeConfigRulesResult describeConfigRules()
DescribeConfigurationAggregatorSourcesStatusResult describeConfigurationAggregatorSourcesStatus(DescribeConfigurationAggregatorSourcesStatusRequest describeConfigurationAggregatorSourcesStatusRequest)
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.
describeConfigurationAggregatorSourcesStatusRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidLimitException
- The specified limit is outside the allowable range.DescribeConfigurationAggregatorsResult describeConfigurationAggregators(DescribeConfigurationAggregatorsRequest describeConfigurationAggregatorsRequest)
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.
describeConfigurationAggregatorsRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidLimitException
- The specified limit is outside the allowable range.DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest)
Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
describeConfigurationRecorderStatusRequest
- The input for the DescribeConfigurationRecorderStatus action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus()
DescribeConfigurationRecordersResult describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest)
Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
describeConfigurationRecordersRequest
- The input for the DescribeConfigurationRecorders action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.DescribeConfigurationRecordersResult describeConfigurationRecorders()
DescribeConformancePackComplianceResult describeConformancePackCompliance(DescribeConformancePackComplianceRequest describeConformancePackComplianceRequest)
Returns compliance details for each rule in that conformance pack.
You must provide exact rule names.
describeConformancePackComplianceRequest
- InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.NoSuchConfigRuleInConformancePackException
- Config rule that you passed in the filter does not exist.NoSuchConformancePackException
- You specified one or more conformance packs that do not exist.DescribeConformancePackStatusResult describeConformancePackStatus(DescribeConformancePackStatusRequest describeConformancePackStatusRequest)
Provides one or more conformance packs deployment status.
If there are no conformance packs then you will see an empty result.
describeConformancePackStatusRequest
- InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.DescribeConformancePacksResult describeConformancePacks(DescribeConformancePacksRequest describeConformancePacksRequest)
Returns a list of one or more conformance packs.
describeConformancePacksRequest
- NoSuchConformancePackException
- You specified one or more conformance packs that do not exist.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest)
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action 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.
describeDeliveryChannelStatusRequest
- The input for the DeliveryChannelStatus action.NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus()
DescribeDeliveryChannelsResult describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest)
Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
Currently, you can specify only one delivery channel per region in your account.
describeDeliveryChannelsRequest
- The input for the DescribeDeliveryChannels action.NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.DescribeDeliveryChannelsResult describeDeliveryChannels()
DescribeOrganizationConfigRuleStatusesResult describeOrganizationConfigRuleStatuses(DescribeOrganizationConfigRuleStatusesRequest describeOrganizationConfigRuleStatusesRequest)
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.
describeOrganizationConfigRuleStatusesRequest
- NoSuchOrganizationConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check
rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying
again.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following
reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
DescribeOrganizationConfigRulesResult describeOrganizationConfigRules(DescribeOrganizationConfigRulesRequest describeOrganizationConfigRulesRequest)
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
DescribeOrganizationConfigRules
and DescribeOrganizationConformancePacks
APIs can only
see and interact with the organization-related resource that were deployed from within the account calling those
APIs.
describeOrganizationConfigRulesRequest
- NoSuchOrganizationConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check
rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying
again.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidLimitException
- The specified limit is outside the allowable range.OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following
reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
DescribeOrganizationConformancePackStatusesResult describeOrganizationConformancePackStatuses(DescribeOrganizationConformancePackStatusesRequest describeOrganizationConformancePackStatusesRequest)
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.
describeOrganizationConformancePackStatusesRequest
- NoSuchOrganizationConformancePackException
- Config organization conformance pack that you passed in the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
DescribeOrganizationConformancePacksResult describeOrganizationConformancePacks(DescribeOrganizationConformancePacksRequest describeOrganizationConformancePacksRequest)
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
DescribeOrganizationConfigRules
and DescribeOrganizationConformancePacks
APIs can only
see and interact with the organization-related resource that were deployed from within the account calling those
APIs.
describeOrganizationConformancePacksRequest
- NoSuchOrganizationConformancePackException
- Config organization conformance pack that you passed in the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidLimitException
- The specified limit is outside the allowable range.OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
DescribePendingAggregationRequestsResult describePendingAggregationRequests(DescribePendingAggregationRequestsRequest describePendingAggregationRequestsRequest)
Returns a list of all pending aggregation requests.
describePendingAggregationRequestsRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidLimitException
- The specified limit is outside the allowable range.DescribeRemediationConfigurationsResult describeRemediationConfigurations(DescribeRemediationConfigurationsRequest describeRemediationConfigurationsRequest)
Returns the details of one or more remediation configurations.
describeRemediationConfigurationsRequest
- DescribeRemediationExceptionsResult describeRemediationExceptions(DescribeRemediationExceptionsRequest describeRemediationExceptionsRequest)
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.
describeRemediationExceptionsRequest
- InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.DescribeRemediationExecutionStatusResult describeRemediationExecutionStatus(DescribeRemediationExecutionStatusRequest describeRemediationExecutionStatusRequest)
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.
describeRemediationExecutionStatusRequest
- NoSuchRemediationConfigurationException
- You specified an Config rule without a remediation configuration.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.DescribeRetentionConfigurationsResult describeRetentionConfigurations(DescribeRetentionConfigurationsRequest describeRetentionConfigurationsRequest)
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
Currently, Config supports only one retention configuration per region in your account.
describeRetentionConfigurationsRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.NoSuchRetentionConfigurationException
- You have specified a retention configuration that does not exist.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.GetAggregateComplianceDetailsByConfigRuleResult getAggregateComplianceDetailsByConfigRule(GetAggregateComplianceDetailsByConfigRuleRequest getAggregateComplianceDetailsByConfigRuleRequest)
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 nextToken
, the results are displayed
on the next page.
getAggregateComplianceDetailsByConfigRuleRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.GetAggregateConfigRuleComplianceSummaryResult getAggregateConfigRuleComplianceSummary(GetAggregateConfigRuleComplianceSummaryRequest getAggregateConfigRuleComplianceSummaryRequest)
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.
getAggregateConfigRuleComplianceSummaryRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.GetAggregateConformancePackComplianceSummaryResult getAggregateConformancePackComplianceSummary(GetAggregateConformancePackComplianceSummaryRequest getAggregateConformancePackComplianceSummaryRequest)
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.
getAggregateConformancePackComplianceSummaryRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.GetAggregateDiscoveredResourceCountsResult getAggregateDiscoveredResourceCounts(GetAggregateDiscoveredResourceCountsRequest getAggregateDiscoveredResourceCountsRequest)
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.
getAggregateDiscoveredResourceCountsRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.GetAggregateResourceConfigResult getAggregateResourceConfig(GetAggregateResourceConfigRequest getAggregateResourceConfigRequest)
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
getAggregateResourceConfigRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.OversizedConfigurationItemException
- The configuration item size is outside the allowable range.ResourceNotDiscoveredException
- You have specified a resource that is either unknown or has not been discovered.GetComplianceDetailsByConfigRuleResult getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest)
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.
getComplianceDetailsByConfigRuleRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.GetComplianceDetailsByResourceResult getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest)
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.
getComplianceDetailsByResourceRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.GetComplianceSummaryByConfigRuleResult getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest getComplianceSummaryByConfigRuleRequest)
Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
getComplianceSummaryByConfigRuleRequest
- GetComplianceSummaryByConfigRuleResult getComplianceSummaryByConfigRule()
GetComplianceSummaryByResourceTypeResult getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest getComplianceSummaryByResourceTypeRequest)
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.
getComplianceSummaryByResourceTypeRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.GetComplianceSummaryByResourceTypeResult getComplianceSummaryByResourceType()
GetConformancePackComplianceDetailsResult getConformancePackComplianceDetails(GetConformancePackComplianceDetailsRequest getConformancePackComplianceDetailsRequest)
Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
getConformancePackComplianceDetailsRequest
- InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoSuchConformancePackException
- You specified one or more conformance packs that do not exist.NoSuchConfigRuleInConformancePackException
- Config rule that you passed in the filter does not exist.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.GetConformancePackComplianceSummaryResult getConformancePackComplianceSummary(GetConformancePackComplianceSummaryRequest getConformancePackComplianceSummaryRequest)
Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
getConformancePackComplianceSummaryRequest
- NoSuchConformancePackException
- You specified one or more conformance packs that do not exist.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.GetCustomRulePolicyResult getCustomRulePolicy(GetCustomRulePolicyRequest getCustomRulePolicyRequest)
Returns the policy definition containing the logic for your Config Custom Policy rule.
getCustomRulePolicyRequest
- NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.GetDiscoveredResourceCountsResult getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest)
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
Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
You make a call to the GetDiscoveredResourceCounts
action and specify that you want all resource
types.
Config returns the following:
The resource types (EC2 instances, IAM users, and S3 buckets).
The number of each resource type (25, 20, and 15).
The total number of all resources (60).
The response is paginated. By default, Config lists 100 ResourceCount objects on each page. You can
customize this number with the limit
parameter. The response includes a nextToken
string. To get the next page of results, run the request again and specify the string for the
nextToken
parameter.
If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
You are a new Config customer.
You just enabled resource recording.
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
getDiscoveredResourceCountsRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.GetOrganizationConfigRuleDetailedStatusResult getOrganizationConfigRuleDetailedStatus(GetOrganizationConfigRuleDetailedStatusRequest getOrganizationConfigRuleDetailedStatusRequest)
Returns detailed status for each member account within an organization for a given organization Config rule.
getOrganizationConfigRuleDetailedStatusRequest
- NoSuchOrganizationConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check
rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying
again.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following
reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
GetOrganizationConformancePackDetailedStatusResult getOrganizationConformancePackDetailedStatus(GetOrganizationConformancePackDetailedStatusRequest getOrganizationConformancePackDetailedStatusRequest)
Returns detailed status for each member account within an organization for a given organization conformance pack.
getOrganizationConformancePackDetailedStatusRequest
- NoSuchOrganizationConformancePackException
- Config organization conformance pack that you passed in the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
GetOrganizationCustomRulePolicyResult getOrganizationCustomRulePolicy(GetOrganizationCustomRulePolicyRequest getOrganizationCustomRulePolicyRequest)
Returns the policy definition containing the logic for your organization Config Custom Policy rule.
getOrganizationCustomRulePolicyRequest
- NoSuchOrganizationConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check
rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying
again.OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following
reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
GetResourceConfigHistoryResult getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)
For accurate reporting on the compliance status, you must record the AWS::Config::ResourceCompliance
resource type. For more information, see Selecting Which Resources
Config Records.
Returns a list of ConfigurationItems
for the specified resource. The list contains details about
each state of the resource during the specified time interval. If you specified a retention period to retain your
ConfigurationItems
between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns
the ConfigurationItems
for the specified retention period.
The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can
customize this number with the limit
parameter. The response includes a nextToken
string. To get the next page of results, run the request again and specify the string for the
nextToken
parameter.
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 limit
. In such cases, you can make another call, using the
nextToken
.
getResourceConfigHistoryRequest
- The input for the GetResourceConfigHistory action.ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidTimeRangeException
- The specified time range is not valid. The earlier time is not chronologically before the later time.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.ResourceNotDiscoveredException
- You have specified a resource that is either unknown or has not been discovered.GetResourceEvaluationSummaryResult getResourceEvaluationSummary(GetResourceEvaluationSummaryRequest getResourceEvaluationSummaryRequest)
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.
getResourceEvaluationSummaryRequest
- ResourceNotFoundException
- You have specified a resource that does not exist.GetStoredQueryResult getStoredQuery(GetStoredQueryRequest getStoredQueryRequest)
Returns the details of a specific stored query.
getStoredQueryRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
ResourceNotFoundException
- You have specified a resource that does not exist.ListAggregateDiscoveredResourcesResult listAggregateDiscoveredResources(ListAggregateDiscoveredResourcesRequest listAggregateDiscoveredResourcesRequest)
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
AWS::EC2::Instance
then the API returns all the EC2 instance identifiers of accountID 12345678910
and region us-east-1.
listAggregateDiscoveredResourcesRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.ListConformancePackComplianceScoresResult listConformancePackComplianceScores(ListConformancePackComplianceScoresRequest listConformancePackComplianceScoresRequest)
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 INSUFFICIENT_DATA
.
listConformancePackComplianceScoresRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.ListDiscoveredResourcesResult listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
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 limit
parameter. The response includes a nextToken
string. To get the
next page of results, run the request again and specify the string for the nextToken
parameter.
listDiscoveredResourcesRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.ListResourceEvaluationsResult listResourceEvaluations(ListResourceEvaluationsRequest listResourceEvaluationsRequest)
Returns a list of proactive resource evaluations.
listResourceEvaluationsRequest
- InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InvalidTimeRangeException
- The specified time range is not valid. The earlier time is not chronologically before the later time.ListStoredQueriesResult listStoredQueries(ListStoredQueriesRequest listStoredQueriesRequest)
Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
listStoredQueriesRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
List the tags for Config resource.
listTagsForResourceRequest
- ResourceNotFoundException
- You have specified a resource that does not exist.ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.PutAggregationAuthorizationResult putAggregationAuthorization(PutAggregationAuthorizationRequest putAggregationAuthorizationRequest)
Authorizes the aggregator account and region to collect data from the source account and region.
PutAggregationAuthorization
is an idempotent API. Subsequent requests won’t create a duplicate
resource if one was already created. If a following request has different tags
values, Config will
ignore these differences and treat it as an idempotent request of the previous. In this case, tags
will not be updated, even if they are different.
putAggregationAuthorizationRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.PutConfigRuleResult putConfigRule(PutConfigRuleRequest putConfigRuleRequest)
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
PutConfigRule
to create both Config Managed Rules and Config Custom Rules.
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
SourceIdentifier
key.
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 PutConfigRule
to add a Custom Lambda rule to
Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. You specify the ARN
in the SourceIdentifier
key. This key is part of the Source
object, which is part of
the ConfigRule
object.
For any new Config rule that you add, specify the ConfigRuleName
in the ConfigRule
object. Do not specify the ConfigRuleArn
or the ConfigRuleId
. These values are
generated by Config for new rules.
If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName
,
ConfigRuleId
, or ConfigRuleArn
in the ConfigRule
data type that you use in
this request.
For more information about developing and using Config rules, see Evaluating Resources with Config Rules in the Config Developer Guide.
PutConfigRule
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was
already created. If a following request has different tags
values, Config will ignore these
differences and treat it as an idempotent request of the previous. In this case, tags
will not be
updated, even if they are different.
putConfigRuleRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.MaxNumberOfConfigRulesExceededException
- Failed to add the Config rule because the account already contains the maximum number of 1000 rules.
Consider deleting any deactivated rules before you add new rules.ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
InsufficientPermissionsException
- Indicates one of the following errors:
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have
permissions to call IAM GetRole
action or create a service-linked role.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
You do not have permission to call IAM GetRole
action or create a service-linked role.
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.PutConfigurationAggregatorResult putConfigurationAggregator(PutConfigurationAggregatorRequest putConfigurationAggregatorRequest)
Creates 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 DescribeConfigurationAggregators
to get the previous accounts and
then append new ones.
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 EnableAwsServiceAccess
API to enable integration between Config and Organizations. If
the caller is a registered delegated administrator, Config calls ListDelegatedAdministrators
API to
verify whether the caller is a valid delegated administrator.
To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.
PutConfigurationAggregator
is an idempotent API. Subsequent requests won’t create a duplicate
resource if one was already created. If a following request has different tags
values, Config will
ignore these differences and treat it as an idempotent request of the previous. In this case, tags
will not be updated, even if they are different.
putConfigurationAggregatorRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.LimitExceededException
- For StartConfigRulesEvaluation
API, this exception is thrown if an evaluation is in progress
or if you call the StartConfigRulesEvaluation API more than once per minute.
For PutConfigurationAggregator
API, this exception is thrown if the number of accounts and
aggregators exceeds the limit.
InvalidRoleException
- You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by Config and used
by the configuration recorder.OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
NoAvailableOrganizationException
- Organization is no longer available.OrganizationAllFeaturesNotEnabledException
- Config resource cannot be created because your organization does not have all features enabled.PutConfigurationRecorderResult putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest)
Creates a new configuration recorder to record configuration changes for specified resource types.
You can also use this action to change the roleARN
or the recordingGroup
of an existing
recorder. For more information, see Managing the
Configuration Recorder in the Config Developer Guide.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
If the configuration recorder does not have the recordingGroup
field specified, the default is to
record all supported resource types.
putConfigurationRecorderRequest
- The input for the PutConfigurationRecorder action.MaxNumberOfConfigurationRecordersExceededException
- You have reached the limit of the number of configuration recorders you can create.ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InvalidConfigurationRecorderNameException
- You have provided a name for the configuration recorder that is not valid.InvalidRoleException
- You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by Config and used
by the configuration recorder.InvalidRecordingGroupException
- Indicates one of the following errors:
You have provided a combination of parameter values that is not valid. For example:
Setting the allSupported
field of RecordingGroup
to true
, but providing a non-empty list for the resourceTypes
field of RecordingGroup.
Setting the allSupported
field of RecordingGroup
to true
, but also setting the useOnly
field of RecordingStrategy to EXCLUSION_BY_RESOURCE_TYPES
.
Every parameter is either null, false, or empty.
You have reached the limit of the number of resource types you can provide for the recording group.
You have provided resource types or a recording strategy that are not valid.
PutConformancePackResult putConformancePack(PutConformancePackRequest putConformancePackRequest)
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 AWSServiceRoleForConfigConforms
in your account. The
service-linked role is created only when the role does not exist in your account.
You must specify only one of the follow parameters: TemplateS3Uri
, TemplateBody
or
TemplateSSMDocumentDetails
.
putConformancePackRequest
- InsufficientPermissionsException
- Indicates one of the following errors:
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have
permissions to call IAM GetRole
action or create a service-linked role.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
You do not have permission to call IAM GetRole
action or create a service-linked role.
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
ConformancePackTemplateValidationException
- You have specified a template that is not valid or supported.ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.MaxNumberOfConformancePacksExceededException
- You have reached the limit of the number of conformance packs you can create in an account. For more
information, see
Service Limits in the Config Developer Guide.PutDeliveryChannelResult putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest)
Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic. For more information, see Notifications that Config Sends to an Amazon SNS topic.
Before you can create a delivery channel, you must create a configuration recorder.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
You can have only one delivery channel per region in your account.
putDeliveryChannelRequest
- The input for the PutDeliveryChannel action.MaxNumberOfDeliveryChannelsExceededException
- You have reached the limit of the number of delivery channels you can create.NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.InvalidDeliveryChannelNameException
- The specified delivery channel name is not valid.NoSuchBucketException
- The specified Amazon S3 bucket does not exist.InvalidS3KeyPrefixException
- The specified Amazon S3 key prefix is not valid.InvalidS3KmsKeyArnException
- The specified Amazon KMS Key ARN is not valid.InvalidSNSTopicARNException
- The specified Amazon SNS topic does not exist.InsufficientDeliveryPolicyException
- Your Amazon S3 bucket policy does not permit Config to write to it.PutEvaluationsResult putEvaluations(PutEvaluationsRequest putEvaluationsRequest)
Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.
putEvaluationsRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InvalidResultTokenException
- The specified ResultToken
is not valid.NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.PutExternalEvaluationResult putExternalEvaluation(PutExternalEvaluationRequest putExternalEvaluationRequest)
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.
putExternalEvaluationRequest
- NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.PutOrganizationConfigRuleResult putOrganizationConfigRule(PutOrganizationConfigRuleRequest putOrganizationConfigRuleRequest)
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
ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated
administrators.
This API enables organization service access through the EnableAWSServiceAccess
action and creates a
service-linked role AWSServiceRoleForConfigMultiAccountSetup
in the management or delegated
administrator account of your organization. The service-linked role is created only when the role does not exist
in the caller account. Config verifies the existence of role with GetRole
action.
To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services
Organization register-delegated-administrator
for
config-multiaccountsetup.amazonaws.com
.
There are two types of rules: Config Managed Rules and Config Custom Rules. You can use
PutOrganizationConfigRule
to create both Config Managed Rules and Config Custom Rules.
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
RuleIdentifier
key.
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
PutOrganizationConfigRule
to add a Custom Lambda rule to Config, you must specify the Amazon
Resource Name (ARN) that Lambda assigns to the function.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
Make sure to specify one of either OrganizationCustomPolicyRuleMetadata
for Custom Policy rules,
OrganizationCustomRuleMetadata
for Custom Lambda rules, or
OrganizationManagedRuleMetadata
for managed rules.
putOrganizationConfigRuleRequest
- MaxNumberOfOrganizationConfigRulesExceededException
- You have reached the limit of the number of organization Config rules you can create. For more
information, see see Service Limits
in the Config Developer Guide.ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
NoAvailableOrganizationException
- Organization is no longer available.OrganizationAllFeaturesNotEnabledException
- Config resource cannot be created because your organization does not have all features enabled.InsufficientPermissionsException
- Indicates one of the following errors:
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have
permissions to call IAM GetRole
action or create a service-linked role.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
You do not have permission to call IAM GetRole
action or create a service-linked role.
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
PutOrganizationConformancePackResult putOrganizationConformancePack(PutOrganizationConformancePackRequest putOrganizationConformancePackRequest)
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 ListDelegatedAdministrator
permissions are added. An
organization can have up to 3 delegated administrators.
This API enables organization service access for config-multiaccountsetup.amazonaws.com
through the
EnableAWSServiceAccess
action and creates a service-linked role
AWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of
your organization. The service-linked role is created only when the role does not exist in the caller account. To
use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services
Organization register-delegate-admin
for config-multiaccountsetup.amazonaws.com
.
Prerequisite: Ensure you call EnableAllFeatures
API to enable all features in an organization.
You must specify either the TemplateS3Uri
or the TemplateBody
parameter, but not both.
If you provide both Config uses the TemplateS3Uri
parameter and ignores the
TemplateBody
parameter.
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.
putOrganizationConformancePackRequest
- MaxNumberOfOrganizationConformancePacksExceededException
- You have reached the limit of the number of organization conformance packs you can create in an account.
For more information, see Service Limits
in the Config Developer Guide.ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
OrganizationAccessDeniedException
- For PutConfigurationAggregator
API, you can see this exception for the following reasons:
No permission to call EnableAWSServiceAccess
API
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated
administrator for Config service principle name before the delegated administrator creates an aggregator.
For all OrganizationConfigRule
and OrganizationConformancePack
APIs, Config
throws an exception if APIs are called from member accounts. All APIs must be called from organization
management account.
InsufficientPermissionsException
- Indicates one of the following errors:
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have
permissions to call IAM GetRole
action or create a service-linked role.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
You do not have permission to call IAM GetRole
action or create a service-linked role.
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
OrganizationConformancePackTemplateValidationException
- You have specified a template that is not valid or supported.OrganizationAllFeaturesNotEnabledException
- Config resource cannot be created because your organization does not have all features enabled.NoAvailableOrganizationException
- Organization is no longer available.PutRemediationConfigurationsResult putRemediationConfigurations(PutRemediationConfigurationsRequest putRemediationConfigurationsRequest)
Adds 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 and have permissions to
use the target.
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 automationAssumeRole
or use a
value in the assumeRole
field to remediate your resources. The SSM automation document can use either
as long as it maps to a valid parameter.
However, for automatic remediation configuration, the only valid assumeRole
field value is
AutomationAssumeRole
and you need to provide a value for AutomationAssumeRole
to
remediate your resources.
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.
putRemediationConfigurationsRequest
- InsufficientPermissionsException
- Indicates one of the following errors:
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have
permissions to call IAM GetRole
action or create a service-linked role.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
You do not have permission to call IAM GetRole
action or create a service-linked role.
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.PutRemediationExceptionsResult putRemediationExceptions(PutRemediationExceptionsRequest putRemediationExceptionsRequest)
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
NON_COMPLIANT
. Once the resource has been evaluated as NON_COMPLIANT
, you can add
remediation exceptions and change the remediation type back from Manual to Auto if you want to use
auto-remediation. Otherwise, using auto-remediation before a NON_COMPLIANT
evaluation result can
delete resources before the exception is applied.
Exceptions can only be performed on non-compliant resources
Placing an exception can only be performed on resources that are NON_COMPLIANT
. If you use this API
for COMPLIANT
resources or resources that are NOT_APPLICABLE
, a remediation exception
will not be generated. For more information on the conditions that initiate the possible Config evaluation
results, see Concepts |
Config Rules in the Config Developer Guide.
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.
putRemediationExceptionsRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InsufficientPermissionsException
- Indicates one of the following errors:
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have
permissions to call IAM GetRole
action or create a service-linked role.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
You do not have permission to call IAM GetRole
action or create a service-linked role.
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
PutResourceConfigResult putResourceConfig(PutResourceConfigRequest putResourceConfigRequest)
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.
putResourceConfigRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
InsufficientPermissionsException
- Indicates one of the following errors:
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have
permissions to call IAM GetRole
action or create a service-linked role.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
You do not have permission to call IAM GetRole
action or create a service-linked role.
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
NoRunningConfigurationRecorderException
- There is no configuration recorder running.MaxActiveResourcesExceededException
- You have reached the limit of active custom resource types in your account. There is a limit of 100,000.
Delete unused resources using DeleteResourceConfig
.PutRetentionConfigurationResult putRetentionConfiguration(PutRetentionConfigurationRequest putRetentionConfigurationRequest)
Creates 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 the API modifies the default object.
Currently, Config supports only one retention configuration per region in your account.
putRetentionConfigurationRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.MaxNumberOfRetentionConfigurationsExceededException
- Failed to add the retention configuration because a retention configuration with that name already
exists.PutStoredQueryResult putStoredQuery(PutStoredQueryRequest putStoredQueryRequest)
Saves 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.
PutStoredQuery
is an idempotent API. Subsequent requests won’t create a duplicate resource if one
was already created. If a following request has different tags
values, Config will ignore these
differences and treat it as an idempotent request of the previous. In this case, tags
will not be
updated, even if they are different.
putStoredQueryRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
TooManyTagsException
- You have reached the limit of the number of tags you can use. For more information, see Service Limits
in the Config Developer Guide.ResourceConcurrentModificationException
- Two users are trying to modify the same query at the same time. Wait for a moment and try again.SelectAggregateResourceConfigResult selectAggregateResourceConfig(SelectAggregateResourceConfigRequest selectAggregateResourceConfigRequest)
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 GROUP BY
or using aggregate functions such as
COUNT
; e.g.,
SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId
) and do not
specify the MaxResults
or the Limit
query parameters, the default page size is set to
500.
If you run a non-aggregation query (i.e., not using GROUP BY
or aggregate function; e.g.,
SELECT * WHERE resourceType = 'AWS::IAM::Role'
) and do not specify the MaxResults
or
the Limit
query parameters, the default page size is set to 25.
selectAggregateResourceConfigRequest
- InvalidExpressionException
- The syntax of the query is incorrect.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.SelectResourceConfigResult selectResourceConfig(SelectResourceConfigRequest selectResourceConfigRequest)
Accepts 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.
selectResourceConfigRequest
- InvalidExpressionException
- The syntax of the query is incorrect.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is not valid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.StartConfigRulesEvaluationResult startConfigRulesEvaluation(StartConfigRulesEvaluationRequest startConfigRulesEvaluationRequest)
Runs 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 for your
resources. It re-runs an evaluation against the last known state of your resources.
You can specify up to 25 Config rules per request.
An existing StartConfigRulesEvaluation
call for the specified rules must complete before you can
call the API again. If you chose to have Config stream to an Amazon SNS topic, you will receive a
ConfigRuleEvaluationStarted
notification when the evaluation starts.
You don't need to call the StartConfigRulesEvaluation
API to run an evaluation for a new rule. When
you create a rule, Config evaluates your resources against the rule automatically.
The StartConfigRulesEvaluation
API is useful if you want to run on-demand evaluations, such as the
following example:
You have a custom rule that evaluates your IAM resources every 24 hours.
You update your Lambda function to add additional conditions to your rule.
Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation
API.
Config invokes your Lambda function and evaluates your IAM resources.
Your custom rule will still run periodic evaluations every 24 hours.
startConfigRulesEvaluationRequest
- NoSuchConfigRuleException
- The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that
the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.LimitExceededException
- For StartConfigRulesEvaluation
API, this exception is thrown if an evaluation is in progress
or if you call the StartConfigRulesEvaluation API more than once per minute.
For PutConfigurationAggregator
API, this exception is thrown if the number of accounts and
aggregators exceeds the limit.
ResourceInUseException
- You see this exception in the following cases:
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.StartConfigurationRecorderResult startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest)
Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
You must have created at least one delivery channel to successfully start the configuration recorder.
startConfigurationRecorderRequest
- The input for the StartConfigurationRecorder action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.NoAvailableDeliveryChannelException
- There is no delivery channel available to record configurations.StartRemediationExecutionResult startRemediationExecution(StartRemediationExecutionRequest startRemediationExecutionRequest)
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.
startRemediationExecutionRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.InsufficientPermissionsException
- Indicates one of the following errors:
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have
permissions to call IAM GetRole
action or create a service-linked role.
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
You do not have permission to call IAM GetRole
action or create a service-linked role.
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
NoSuchRemediationConfigurationException
- You specified an Config rule without a remediation configuration.StartResourceEvaluationResult startResourceEvaluation(StartResourceEvaluationRequest startResourceEvaluationRequest)
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 cloudformation:DescribeType
role setup to validate the resource type schema.
You can find the Resource type
schema in "Amazon Web Services public extensions" within the CloudFormation registry or with the
following CLI commmand:
aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE
.
For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.
startResourceEvaluationRequest
- InvalidParameterValueException
- One or more of the specified parameters are not valid. Verify that your parameters are valid and try
again.IdempotentParameterMismatchException
- Using the same client token with one or more different parameters. Specify a new client token with the
parameter changes and try again.StopConfigurationRecorderResult stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest)
Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
stopConfigurationRecorderRequest
- The input for the StopConfigurationRecorder action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
Associates 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 with that resource are deleted as well.
tagResourceRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
ResourceNotFoundException
- You have specified a resource that does not exist.TooManyTagsException
- You have reached the limit of the number of tags you can use. For more information, see Service Limits
in the Config Developer Guide.UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
Deletes specified tags from a resource.
untagResourceRequest
- ValidationException
- The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
ResourceNotFoundException
- You have specified a resource that does not exist.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request
- The originally executed request.