@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAmazonConfig extends Object implements AmazonConfig
AmazonConfig. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException.ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
BatchGetAggregateResourceConfigResult |
batchGetAggregateResourceConfig(BatchGetAggregateResourceConfigRequest request)
Returns the current configuration items for resources that are present in your AWS Config aggregator.
|
BatchGetResourceConfigResult |
batchGetResourceConfig(BatchGetResourceConfigRequest request)
Returns the current configuration for one or more requested resources.
|
DeleteAggregationAuthorizationResult |
deleteAggregationAuthorization(DeleteAggregationAuthorizationRequest request)
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
|
DeleteConfigRuleResult |
deleteConfigRule(DeleteConfigRuleRequest request)
Deletes the specified AWS Config rule and all of its evaluation results.
|
DeleteConfigurationAggregatorResult |
deleteConfigurationAggregator(DeleteConfigurationAggregatorRequest request)
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
|
DeleteConfigurationRecorderResult |
deleteConfigurationRecorder(DeleteConfigurationRecorderRequest request)
Deletes the configuration recorder.
|
DeleteDeliveryChannelResult |
deleteDeliveryChannel(DeleteDeliveryChannelRequest request)
Deletes the delivery channel.
|
DeleteEvaluationResultsResult |
deleteEvaluationResults(DeleteEvaluationResultsRequest request)
Deletes the evaluation results for the specified AWS Config rule.
|
DeletePendingAggregationRequestResult |
deletePendingAggregationRequest(DeletePendingAggregationRequestRequest request)
Deletes pending authorization requests for a specified aggregator account in a specified region.
|
DeleteRetentionConfigurationResult |
deleteRetentionConfiguration(DeleteRetentionConfigurationRequest request)
Deletes the retention configuration.
|
DeliverConfigSnapshotResult |
deliverConfigSnapshot(DeliverConfigSnapshotRequest request)
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
|
DescribeAggregateComplianceByConfigRulesResult |
describeAggregateComplianceByConfigRules(DescribeAggregateComplianceByConfigRulesRequest request)
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant
rules.
|
DescribeAggregationAuthorizationsResult |
describeAggregationAuthorizations(DescribeAggregationAuthorizationsRequest request)
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 request)
Indicates whether the specified AWS Config rules are compliant.
|
DescribeComplianceByResourceResult |
describeComplianceByResource()
Simplified method form for invoking the DescribeComplianceByResource operation.
|
DescribeComplianceByResourceResult |
describeComplianceByResource(DescribeComplianceByResourceRequest request)
Indicates whether the specified AWS resources are compliant.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus()
Simplified method form for invoking the DescribeConfigRuleEvaluationStatus operation.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest request)
Returns status information for each of your AWS managed Config rules.
|
DescribeConfigRulesResult |
describeConfigRules()
Simplified method form for invoking the DescribeConfigRules operation.
|
DescribeConfigRulesResult |
describeConfigRules(DescribeConfigRulesRequest request)
Returns details about your AWS Config rules.
|
DescribeConfigurationAggregatorsResult |
describeConfigurationAggregators(DescribeConfigurationAggregatorsRequest request)
Returns the details of one or more configuration aggregators.
|
DescribeConfigurationAggregatorSourcesStatusResult |
describeConfigurationAggregatorSourcesStatus(DescribeConfigurationAggregatorSourcesStatusRequest request)
Returns status information for sources within an aggregator.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders()
Simplified method form for invoking the DescribeConfigurationRecorders operation.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders(DescribeConfigurationRecordersRequest request)
Returns the details for the specified configuration recorders.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus()
Simplified method form for invoking the DescribeConfigurationRecorderStatus operation.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest request)
Returns the current status of the specified configuration recorder.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels()
Simplified method form for invoking the DescribeDeliveryChannels operation.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels(DescribeDeliveryChannelsRequest request)
Returns details about the specified delivery channel.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus()
Simplified method form for invoking the DescribeDeliveryChannelStatus operation.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest request)
Returns the current status of the specified delivery channel.
|
DescribePendingAggregationRequestsResult |
describePendingAggregationRequests(DescribePendingAggregationRequestsRequest request)
Returns a list of all pending aggregation requests.
|
DescribeRetentionConfigurationsResult |
describeRetentionConfigurations(DescribeRetentionConfigurationsRequest request)
Returns the details of one or more retention configurations.
|
GetAggregateComplianceDetailsByConfigRuleResult |
getAggregateComplianceDetailsByConfigRule(GetAggregateComplianceDetailsByConfigRuleRequest request)
Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule.
|
GetAggregateConfigRuleComplianceSummaryResult |
getAggregateConfigRuleComplianceSummary(GetAggregateConfigRuleComplianceSummaryRequest request)
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
|
GetAggregateDiscoveredResourceCountsResult |
getAggregateDiscoveredResourceCounts(GetAggregateDiscoveredResourceCountsRequest request)
Returns the resource counts across accounts and regions that are present in your AWS Config aggregator.
|
GetAggregateResourceConfigResult |
getAggregateResourceConfig(GetAggregateResourceConfigRequest request)
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 request)
Returns the evaluation results for the specified AWS Config rule.
|
GetComplianceDetailsByResourceResult |
getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest request)
Returns the evaluation results for the specified AWS resource.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule()
Simplified method form for invoking the GetComplianceSummaryByConfigRule operation.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest request)
Returns the number of AWS 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 request)
Returns the number of resources that are compliant and the number that are noncompliant.
|
GetDiscoveredResourceCountsResult |
getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest request)
Returns the resource types, the number of each resource type, and the total number of resources that AWS Config
is recording in this region for your AWS account.
|
GetResourceConfigHistoryResult |
getResourceConfigHistory(GetResourceConfigHistoryRequest request)
Returns a list of configuration items for the specified resource.
|
ListAggregateDiscoveredResourcesResult |
listAggregateDiscoveredResources(ListAggregateDiscoveredResourcesRequest request)
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource
type across accounts and regions.
|
ListDiscoveredResourcesResult |
listDiscoveredResources(ListDiscoveredResourcesRequest request)
Accepts a resource type and returns a list of resource identifiers for the resources of that type.
|
PutAggregationAuthorizationResult |
putAggregationAuthorization(PutAggregationAuthorizationRequest request)
Authorizes the aggregator account and region to collect data from the source account and region.
|
PutConfigRuleResult |
putConfigRule(PutConfigRuleRequest request)
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired
configurations.
|
PutConfigurationAggregatorResult |
putConfigurationAggregator(PutConfigurationAggregatorRequest request)
Creates and updates the configuration aggregator with the selected source accounts and regions.
|
PutConfigurationRecorderResult |
putConfigurationRecorder(PutConfigurationRecorderRequest request)
Creates a new configuration recorder to record the selected resource configurations.
|
PutDeliveryChannelResult |
putDeliveryChannel(PutDeliveryChannelRequest request)
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS
topic.
|
PutEvaluationsResult |
putEvaluations(PutEvaluationsRequest request)
Used by an AWS Lambda function to deliver evaluation results to AWS Config.
|
PutRetentionConfigurationResult |
putRetentionConfiguration(PutRetentionConfigurationRequest request)
Creates and updates the retention configuration with details about retention period (number of days) that AWS
Config stores your historical information.
|
void |
setEndpoint(String endpoint)
Overrides the default endpoint for this client ("config.us-east-1.amazonaws.com/").
|
void |
setRegion(Region region)
An alternative to
AmazonConfig.setEndpoint(String), sets the regional endpoint for this client's service
calls. |
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartConfigRulesEvaluationResult |
startConfigRulesEvaluation(StartConfigRulesEvaluationRequest request)
Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the
resources.
|
StartConfigurationRecorderResult |
startConfigurationRecorder(StartConfigurationRecorderRequest request)
Starts recording configurations of the AWS resources you have selected to record in your AWS account.
|
StopConfigurationRecorderResult |
stopConfigurationRecorder(StopConfigurationRecorderRequest request)
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
|
public void setEndpoint(String endpoint)
AmazonConfig
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.
setEndpoint in interface AmazonConfigendpoint - 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.public void setRegion(Region region)
AmazonConfigAmazonConfig.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.
setRegion in interface AmazonConfigregion - 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)public BatchGetAggregateResourceConfigResult batchGetAggregateResourceConfig(BatchGetAggregateResourceConfigRequest request)
AmazonConfig
Returns the current configuration items for resources that are present in your AWS 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.
batchGetAggregateResourceConfig in interface AmazonConfigpublic BatchGetResourceConfigResult batchGetResourceConfig(BatchGetResourceConfigRequest request)
AmazonConfigReturns the current configuration 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.
batchGetResourceConfig in interface AmazonConfigpublic DeleteAggregationAuthorizationResult deleteAggregationAuthorization(DeleteAggregationAuthorizationRequest request)
AmazonConfigDeletes the authorization granted to the specified configuration aggregator account in a specified region.
deleteAggregationAuthorization in interface AmazonConfigpublic DeleteConfigRuleResult deleteConfigRule(DeleteConfigRuleRequest request)
AmazonConfigDeletes the specified AWS Config rule and all of its evaluation results.
AWS 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.
deleteConfigRule in interface AmazonConfigpublic DeleteConfigurationAggregatorResult deleteConfigurationAggregator(DeleteConfigurationAggregatorRequest request)
AmazonConfigDeletes the specified configuration aggregator and the aggregated data associated with the aggregator.
deleteConfigurationAggregator in interface AmazonConfigpublic DeleteConfigurationRecorderResult deleteConfigurationRecorder(DeleteConfigurationRecorderRequest request)
AmazonConfigDeletes the configuration recorder.
After the configuration recorder is deleted, AWS 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 AWS Config console until you create a new configuration
recorder.
deleteConfigurationRecorder in interface AmazonConfigrequest - The request object for the DeleteConfigurationRecorder action.public DeleteDeliveryChannelResult deleteDeliveryChannel(DeleteDeliveryChannelRequest request)
AmazonConfigDeletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
deleteDeliveryChannel in interface AmazonConfigrequest - The input for the DeleteDeliveryChannel action. The action accepts the following data, in JSON
format.public DeleteEvaluationResultsResult deleteEvaluationResults(DeleteEvaluationResultsRequest request)
AmazonConfigDeletes the evaluation results for the specified AWS Config rule. You can specify one AWS Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule.
deleteEvaluationResults in interface AmazonConfigpublic DeletePendingAggregationRequestResult deletePendingAggregationRequest(DeletePendingAggregationRequestRequest request)
AmazonConfigDeletes pending authorization requests for a specified aggregator account in a specified region.
deletePendingAggregationRequest in interface AmazonConfigpublic DeleteRetentionConfigurationResult deleteRetentionConfiguration(DeleteRetentionConfigurationRequest request)
AmazonConfigDeletes the retention configuration.
deleteRetentionConfiguration in interface AmazonConfigpublic DeliverConfigSnapshotResult deliverConfigSnapshot(DeliverConfigSnapshotRequest request)
AmazonConfigSchedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS 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.
deliverConfigSnapshot in interface AmazonConfigrequest - The input for the DeliverConfigSnapshot action.public DescribeAggregateComplianceByConfigRulesResult describeAggregateComplianceByConfigRules(DescribeAggregateComplianceByConfigRulesRequest request)
AmazonConfigReturns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
describeAggregateComplianceByConfigRules in interface AmazonConfigpublic DescribeAggregationAuthorizationsResult describeAggregationAuthorizations(DescribeAggregationAuthorizationsRequest request)
AmazonConfigReturns a list of authorizations granted to various aggregator accounts and regions.
describeAggregationAuthorizations in interface AmazonConfigpublic DescribeComplianceByConfigRuleResult describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest request)
AmazonConfigIndicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS 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 AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA. This
result might indicate one of the following conditions:
AWS 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 AWS Lambda function is failing to send evaluation results to AWS 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 AWS Lambda execution role includes the config:PutEvaluations
permission.
The rule's AWS 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.
describeComplianceByConfigRule in interface AmazonConfigpublic DescribeComplianceByConfigRuleResult describeComplianceByConfigRule()
AmazonConfigdescribeComplianceByConfigRule in interface AmazonConfigAmazonConfig.describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest)public DescribeComplianceByResourceResult describeComplianceByResource(DescribeComplianceByResourceRequest request)
AmazonConfigIndicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with.
A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If AWS 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:
AWS 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 AWS Lambda function is failing to send evaluation results to AWS 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 AWS Lambda execution role includes the config:PutEvaluations
permission.
The rule's AWS 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.
describeComplianceByResource in interface AmazonConfigpublic DescribeComplianceByResourceResult describeComplianceByResource()
AmazonConfigdescribeComplianceByResource in interface AmazonConfigAmazonConfig.describeComplianceByResource(DescribeComplianceByResourceRequest)public DescribeConfigRuleEvaluationStatusResult describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest request)
AmazonConfigReturns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.
describeConfigRuleEvaluationStatus in interface AmazonConfigpublic DescribeConfigRuleEvaluationStatusResult describeConfigRuleEvaluationStatus()
AmazonConfigdescribeConfigRuleEvaluationStatus in interface AmazonConfigAmazonConfig.describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest)public DescribeConfigRulesResult describeConfigRules(DescribeConfigRulesRequest request)
AmazonConfigReturns details about your AWS Config rules.
describeConfigRules in interface AmazonConfigpublic DescribeConfigRulesResult describeConfigRules()
AmazonConfigdescribeConfigRules in interface AmazonConfigAmazonConfig.describeConfigRules(DescribeConfigRulesRequest)public DescribeConfigurationAggregatorSourcesStatusResult describeConfigurationAggregatorSourcesStatus(DescribeConfigurationAggregatorSourcesStatusRequest request)
AmazonConfigReturns status information for sources within an aggregator. The status includes information about the last time AWS Config aggregated data from source accounts or AWS Config failed to aggregate data from source accounts with the related error code or message.
describeConfigurationAggregatorSourcesStatus in interface AmazonConfigpublic DescribeConfigurationAggregatorsResult describeConfigurationAggregators(DescribeConfigurationAggregatorsRequest request)
AmazonConfigReturns 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.
describeConfigurationAggregators in interface AmazonConfigpublic DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest request)
AmazonConfigReturns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
Currently, you can specify only one configuration recorder per region in your account.
describeConfigurationRecorderStatus in interface AmazonConfigrequest - The input for the DescribeConfigurationRecorderStatus action.public DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus()
AmazonConfigdescribeConfigurationRecorderStatus in interface AmazonConfigAmazonConfig.describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest)public DescribeConfigurationRecordersResult describeConfigurationRecorders(DescribeConfigurationRecordersRequest request)
AmazonConfigReturns 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.
Currently, you can specify only one configuration recorder per region in your account.
describeConfigurationRecorders in interface AmazonConfigrequest - The input for the DescribeConfigurationRecorders action.public DescribeConfigurationRecordersResult describeConfigurationRecorders()
AmazonConfigdescribeConfigurationRecorders in interface AmazonConfigAmazonConfig.describeConfigurationRecorders(DescribeConfigurationRecordersRequest)public DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest request)
AmazonConfigReturns 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.
describeDeliveryChannelStatus in interface AmazonConfigrequest - The input for the DeliveryChannelStatus action.public DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus()
AmazonConfigdescribeDeliveryChannelStatus in interface AmazonConfigAmazonConfig.describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest)public DescribeDeliveryChannelsResult describeDeliveryChannels(DescribeDeliveryChannelsRequest request)
AmazonConfigReturns 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.
describeDeliveryChannels in interface AmazonConfigrequest - The input for the DescribeDeliveryChannels action.public DescribeDeliveryChannelsResult describeDeliveryChannels()
AmazonConfigdescribeDeliveryChannels in interface AmazonConfigAmazonConfig.describeDeliveryChannels(DescribeDeliveryChannelsRequest)public DescribePendingAggregationRequestsResult describePendingAggregationRequests(DescribePendingAggregationRequestsRequest request)
AmazonConfigReturns a list of all pending aggregation requests.
describePendingAggregationRequests in interface AmazonConfigpublic DescribeRetentionConfigurationsResult describeRetentionConfigurations(DescribeRetentionConfigurationsRequest request)
AmazonConfigReturns 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, AWS Config supports only one retention configuration per region in your account.
describeRetentionConfigurations in interface AmazonConfigpublic GetAggregateComplianceDetailsByConfigRuleResult getAggregateComplianceDetailsByConfigRule(GetAggregateComplianceDetailsByConfigRuleRequest request)
AmazonConfigReturns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS 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.
getAggregateComplianceDetailsByConfigRule in interface AmazonConfigpublic GetAggregateConfigRuleComplianceSummaryResult getAggregateConfigRuleComplianceSummary(GetAggregateConfigRuleComplianceSummaryRequest request)
AmazonConfigReturns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
getAggregateConfigRuleComplianceSummary in interface AmazonConfigpublic GetAggregateDiscoveredResourceCountsResult getAggregateDiscoveredResourceCounts(GetAggregateDiscoveredResourceCountsRequest request)
AmazonConfigReturns the resource counts across accounts and regions that are present in your AWS 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.
getAggregateDiscoveredResourceCounts in interface AmazonConfigpublic GetAggregateResourceConfigResult getAggregateResourceConfig(GetAggregateResourceConfigRequest request)
AmazonConfigReturns configuration item that is aggregated for your specific resource in a specific source account and region.
getAggregateResourceConfig in interface AmazonConfigpublic GetComplianceDetailsByConfigRuleResult getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest request)
AmazonConfigReturns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
getComplianceDetailsByConfigRule in interface AmazonConfigpublic GetComplianceDetailsByResourceResult getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest request)
AmazonConfigReturns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.
getComplianceDetailsByResource in interface AmazonConfigpublic GetComplianceSummaryByConfigRuleResult getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest request)
AmazonConfigReturns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
getComplianceSummaryByConfigRule in interface AmazonConfigpublic GetComplianceSummaryByConfigRuleResult getComplianceSummaryByConfigRule()
AmazonConfiggetComplianceSummaryByConfigRule in interface AmazonConfigAmazonConfig.getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest)public GetComplianceSummaryByResourceTypeResult getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest request)
AmazonConfigReturns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.
getComplianceSummaryByResourceType in interface AmazonConfigpublic GetComplianceSummaryByResourceTypeResult getComplianceSummaryByResourceType()
AmazonConfiggetComplianceSummaryByResourceType in interface AmazonConfigAmazonConfig.getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest)public GetDiscoveredResourceCountsResult getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest request)
AmazonConfigReturns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account.
Example
AWS 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.
AWS 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, AWS 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 AWS Config customer.
You just enabled resource recording.
It might take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
getDiscoveredResourceCounts in interface AmazonConfigpublic GetResourceConfigHistoryResult getResourceConfigHistory(GetResourceConfigHistoryRequest request)
AmazonConfig
Returns a list of configuration items 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), AWS Config
returns the ConfigurationItems for the specified retention period.
The response is paginated. By default, AWS 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.
getResourceConfigHistory in interface AmazonConfigrequest - The input for the GetResourceConfigHistory action.public ListAggregateDiscoveredResourcesResult listAggregateDiscoveredResources(ListAggregateDiscoveredResourcesRequest request)
AmazonConfigAccepts 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.
listAggregateDiscoveredResources in interface AmazonConfigpublic ListDiscoveredResourcesResult listDiscoveredResources(ListDiscoveredResourcesRequest request)
AmazonConfigAccepts 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 AWS Config has discovered, including those that AWS 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, AWS 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.
listDiscoveredResources in interface AmazonConfigpublic PutAggregationAuthorizationResult putAggregationAuthorization(PutAggregationAuthorizationRequest request)
AmazonConfigAuthorizes the aggregator account and region to collect data from the source account and region.
putAggregationAuthorization in interface AmazonConfigpublic PutConfigRuleResult putConfigRule(PutConfigRuleRequest request)
AmazonConfigAdds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.
If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule
invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS
Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN
for the SourceIdentifier key. This key is part of the Source object, which is part of
the ConfigRule object.
If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier
key. To reference AWS managed Config rule identifiers, see About AWS
Managed Config Rules.
For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do
not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS
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.
The maximum number of rules that AWS Config supports is 50.
For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
putConfigRule in interface AmazonConfigpublic PutConfigurationAggregatorResult putConfigurationAggregator(PutConfigurationAggregatorRequest request)
AmazonConfigCreates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
AWS 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 master account and all features must be
enabled in your organization. AWS Config calls EnableAwsServiceAccess API to enable integration
between AWS Config and AWS Organizations.
putConfigurationAggregator in interface AmazonConfigpublic PutConfigurationRecorderResult putConfigurationRecorder(PutConfigurationRecorderRequest request)
AmazonConfigCreates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN or the recordingGroup of an existing
recorder. To change the role, call the action on the existing configuration recorder and specify a role.
Currently, you can specify only one configuration recorder per region in your account.
If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is
to record all supported resource types.
putConfigurationRecorder in interface AmazonConfigrequest - The input for the PutConfigurationRecorder action.public PutDeliveryChannelResult putDeliveryChannel(PutDeliveryChannelRequest request)
AmazonConfigCreates a delivery channel object to deliver configuration information to an Amazon S3 bucket and 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.
putDeliveryChannel in interface AmazonConfigrequest - The input for the PutDeliveryChannel action.public PutEvaluationsResult putEvaluations(PutEvaluationsRequest request)
AmazonConfigUsed by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.
putEvaluations in interface AmazonConfigpublic PutRetentionConfigurationResult putRetentionConfiguration(PutRetentionConfigurationRequest request)
AmazonConfig
Creates and updates the retention configuration with details about retention period (number of days) that AWS
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, AWS Config supports only one retention configuration per region in your account.
putRetentionConfiguration in interface AmazonConfigpublic StartConfigRulesEvaluationResult startConfigRulesEvaluation(StartConfigRulesEvaluationRequest request)
AmazonConfig
Runs an on-demand evaluation for the specified AWS 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 AWS 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 AWS 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, AWS 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.
AWS Config invokes your Lambda function and evaluates your IAM resources.
Your custom rule will still run periodic evaluations every 24 hours.
startConfigRulesEvaluation in interface AmazonConfigpublic StartConfigurationRecorderResult startConfigurationRecorder(StartConfigurationRecorderRequest request)
AmazonConfigStarts recording configurations of the AWS resources you have selected to record in your AWS account.
You must have created at least one delivery channel to successfully start the configuration recorder.
startConfigurationRecorder in interface AmazonConfigrequest - The input for the StartConfigurationRecorder action.public StopConfigurationRecorderResult stopConfigurationRecorder(StopConfigurationRecorderRequest request)
AmazonConfigStops recording configurations of the AWS resources you have selected to record in your AWS account.
stopConfigurationRecorder in interface AmazonConfigrequest - The input for the StopConfigurationRecorder action.public void shutdown()
AmazonConfigshutdown in interface AmazonConfigpublic ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AmazonConfigResponse 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.
getCachedResponseMetadata in interface AmazonConfigrequest - The originally executed request.Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.