@Generated(value="software.amazon.awssdk:codegen") public interface ConfigClient extends SdkClient
builder()
method.
AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS 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 AWS Config, see Supported AWS Resources.
You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config
This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config.
The AWS 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 AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see What Is AWS Config? in the AWS Config Developer Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
static ConfigClientBuilder |
builder()
Create a builder that can be used to configure and create a
ConfigClient . |
static ConfigClient |
create()
Create a
ConfigClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default DeleteConfigRuleResponse |
deleteConfigRule(Consumer<DeleteConfigRuleRequest.Builder> deleteConfigRuleRequest)
Deletes the specified AWS Config rule and all of its evaluation results.
|
default DeleteConfigRuleResponse |
deleteConfigRule(DeleteConfigRuleRequest deleteConfigRuleRequest)
Deletes the specified AWS Config rule and all of its evaluation results.
|
default DeleteConfigurationRecorderResponse |
deleteConfigurationRecorder(Consumer<DeleteConfigurationRecorderRequest.Builder> deleteConfigurationRecorderRequest)
Deletes the configuration recorder.
|
default DeleteConfigurationRecorderResponse |
deleteConfigurationRecorder(DeleteConfigurationRecorderRequest deleteConfigurationRecorderRequest)
Deletes the configuration recorder.
|
default DeleteDeliveryChannelResponse |
deleteDeliveryChannel(Consumer<DeleteDeliveryChannelRequest.Builder> deleteDeliveryChannelRequest)
Deletes the delivery channel.
|
default DeleteDeliveryChannelResponse |
deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest)
Deletes the delivery channel.
|
default DeleteEvaluationResultsResponse |
deleteEvaluationResults(Consumer<DeleteEvaluationResultsRequest.Builder> deleteEvaluationResultsRequest)
Deletes the evaluation results for the specified Config rule.
|
default DeleteEvaluationResultsResponse |
deleteEvaluationResults(DeleteEvaluationResultsRequest deleteEvaluationResultsRequest)
Deletes the evaluation results for the specified Config rule.
|
default DeliverConfigSnapshotResponse |
deliverConfigSnapshot(Consumer<DeliverConfigSnapshotRequest.Builder> deliverConfigSnapshotRequest)
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
|
default DeliverConfigSnapshotResponse |
deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest)
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
|
default DescribeComplianceByConfigRuleResponse |
describeComplianceByConfigRule()
Indicates whether the specified AWS Config rules are compliant.
|
default DescribeComplianceByConfigRuleResponse |
describeComplianceByConfigRule(Consumer<DescribeComplianceByConfigRuleRequest.Builder> describeComplianceByConfigRuleRequest)
Indicates whether the specified AWS Config rules are compliant.
|
default DescribeComplianceByConfigRuleResponse |
describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest)
Indicates whether the specified AWS Config rules are compliant.
|
default DescribeComplianceByResourceResponse |
describeComplianceByResource()
Indicates whether the specified AWS resources are compliant.
|
default DescribeComplianceByResourceResponse |
describeComplianceByResource(Consumer<DescribeComplianceByResourceRequest.Builder> describeComplianceByResourceRequest)
Indicates whether the specified AWS resources are compliant.
|
default DescribeComplianceByResourceResponse |
describeComplianceByResource(DescribeComplianceByResourceRequest describeComplianceByResourceRequest)
Indicates whether the specified AWS resources are compliant.
|
default DescribeConfigRuleEvaluationStatusResponse |
describeConfigRuleEvaluationStatus()
Returns status information for each of your AWS managed Config rules.
|
default DescribeConfigRuleEvaluationStatusResponse |
describeConfigRuleEvaluationStatus(Consumer<DescribeConfigRuleEvaluationStatusRequest.Builder> describeConfigRuleEvaluationStatusRequest)
Returns status information for each of your AWS managed Config rules.
|
default DescribeConfigRuleEvaluationStatusResponse |
describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest)
Returns status information for each of your AWS managed Config rules.
|
default DescribeConfigRulesResponse |
describeConfigRules()
Returns details about your AWS Config rules.
|
default DescribeConfigRulesResponse |
describeConfigRules(Consumer<DescribeConfigRulesRequest.Builder> describeConfigRulesRequest)
Returns details about your AWS Config rules.
|
default DescribeConfigRulesResponse |
describeConfigRules(DescribeConfigRulesRequest describeConfigRulesRequest)
Returns details about your AWS Config rules.
|
default DescribeConfigurationRecordersResponse |
describeConfigurationRecorders()
Returns the details for the specified configuration recorders.
|
default DescribeConfigurationRecordersResponse |
describeConfigurationRecorders(Consumer<DescribeConfigurationRecordersRequest.Builder> describeConfigurationRecordersRequest)
Returns the details for the specified configuration recorders.
|
default DescribeConfigurationRecordersResponse |
describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest)
Returns the details for the specified configuration recorders.
|
default DescribeConfigurationRecorderStatusResponse |
describeConfigurationRecorderStatus()
Returns the current status of the specified configuration recorder.
|
default DescribeConfigurationRecorderStatusResponse |
describeConfigurationRecorderStatus(Consumer<DescribeConfigurationRecorderStatusRequest.Builder> describeConfigurationRecorderStatusRequest)
Returns the current status of the specified configuration recorder.
|
default DescribeConfigurationRecorderStatusResponse |
describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest)
Returns the current status of the specified configuration recorder.
|
default DescribeDeliveryChannelsResponse |
describeDeliveryChannels()
Returns details about the specified delivery channel.
|
default DescribeDeliveryChannelsResponse |
describeDeliveryChannels(Consumer<DescribeDeliveryChannelsRequest.Builder> describeDeliveryChannelsRequest)
Returns details about the specified delivery channel.
|
default DescribeDeliveryChannelsResponse |
describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest)
Returns details about the specified delivery channel.
|
default DescribeDeliveryChannelStatusResponse |
describeDeliveryChannelStatus()
Returns the current status of the specified delivery channel.
|
default DescribeDeliveryChannelStatusResponse |
describeDeliveryChannelStatus(Consumer<DescribeDeliveryChannelStatusRequest.Builder> describeDeliveryChannelStatusRequest)
Returns the current status of the specified delivery channel.
|
default DescribeDeliveryChannelStatusResponse |
describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest)
Returns the current status of the specified delivery channel.
|
default GetComplianceDetailsByConfigRuleResponse |
getComplianceDetailsByConfigRule(Consumer<GetComplianceDetailsByConfigRuleRequest.Builder> getComplianceDetailsByConfigRuleRequest)
Returns the evaluation results for the specified AWS Config rule.
|
default GetComplianceDetailsByConfigRuleResponse |
getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest)
Returns the evaluation results for the specified AWS Config rule.
|
default GetComplianceDetailsByResourceResponse |
getComplianceDetailsByResource(Consumer<GetComplianceDetailsByResourceRequest.Builder> getComplianceDetailsByResourceRequest)
Returns the evaluation results for the specified AWS resource.
|
default GetComplianceDetailsByResourceResponse |
getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest)
Returns the evaluation results for the specified AWS resource.
|
default GetComplianceSummaryByConfigRuleResponse |
getComplianceSummaryByConfigRule()
Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
|
default GetComplianceSummaryByConfigRuleResponse |
getComplianceSummaryByConfigRule(Consumer<GetComplianceSummaryByConfigRuleRequest.Builder> getComplianceSummaryByConfigRuleRequest)
Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
|
default GetComplianceSummaryByConfigRuleResponse |
getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest getComplianceSummaryByConfigRuleRequest)
Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
|
default GetComplianceSummaryByResourceTypeResponse |
getComplianceSummaryByResourceType()
Returns the number of resources that are compliant and the number that are noncompliant.
|
default GetComplianceSummaryByResourceTypeResponse |
getComplianceSummaryByResourceType(Consumer<GetComplianceSummaryByResourceTypeRequest.Builder> getComplianceSummaryByResourceTypeRequest)
Returns the number of resources that are compliant and the number that are noncompliant.
|
default GetComplianceSummaryByResourceTypeResponse |
getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest getComplianceSummaryByResourceTypeRequest)
Returns the number of resources that are compliant and the number that are noncompliant.
|
default GetDiscoveredResourceCountsResponse |
getDiscoveredResourceCounts()
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.
|
default GetDiscoveredResourceCountsResponse |
getDiscoveredResourceCounts(Consumer<GetDiscoveredResourceCountsRequest.Builder> getDiscoveredResourceCountsRequest)
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.
|
default GetDiscoveredResourceCountsResponse |
getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest)
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.
|
default GetResourceConfigHistoryResponse |
getResourceConfigHistory(Consumer<GetResourceConfigHistoryRequest.Builder> getResourceConfigHistoryRequest)
Returns a list of configuration items for the specified resource.
|
default GetResourceConfigHistoryResponse |
getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)
Returns a list of configuration items for the specified resource.
|
default GetResourceConfigHistoryIterable |
getResourceConfigHistoryPaginator(Consumer<GetResourceConfigHistoryRequest.Builder> getResourceConfigHistoryRequest)
Returns a list of configuration items for the specified resource.
|
default GetResourceConfigHistoryIterable |
getResourceConfigHistoryPaginator(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)
Returns a list of configuration items for the specified resource.
|
default ListDiscoveredResourcesResponse |
listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest)
Accepts a resource type and returns a list of resource identifiers for the resources of that type.
|
default ListDiscoveredResourcesResponse |
listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
Accepts a resource type and returns a list of resource identifiers for the resources of that type.
|
default PutConfigRuleResponse |
putConfigRule(Consumer<PutConfigRuleRequest.Builder> putConfigRuleRequest)
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired
configurations.
|
default PutConfigRuleResponse |
putConfigRule(PutConfigRuleRequest putConfigRuleRequest)
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired
configurations.
|
default PutConfigurationRecorderResponse |
putConfigurationRecorder(Consumer<PutConfigurationRecorderRequest.Builder> putConfigurationRecorderRequest)
Creates a new configuration recorder to record the selected resource configurations.
|
default PutConfigurationRecorderResponse |
putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest)
Creates a new configuration recorder to record the selected resource configurations.
|
default PutDeliveryChannelResponse |
putDeliveryChannel(Consumer<PutDeliveryChannelRequest.Builder> putDeliveryChannelRequest)
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS
topic.
|
default PutDeliveryChannelResponse |
putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest)
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS
topic.
|
default PutEvaluationsResponse |
putEvaluations(Consumer<PutEvaluationsRequest.Builder> putEvaluationsRequest)
Used by an AWS Lambda function to deliver evaluation results to AWS Config.
|
default PutEvaluationsResponse |
putEvaluations(PutEvaluationsRequest putEvaluationsRequest)
Used by an AWS Lambda function to deliver evaluation results to AWS Config.
|
static ServiceMetadata |
serviceMetadata() |
default StartConfigRulesEvaluationResponse |
startConfigRulesEvaluation(Consumer<StartConfigRulesEvaluationRequest.Builder> startConfigRulesEvaluationRequest)
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the
resources.
|
default StartConfigRulesEvaluationResponse |
startConfigRulesEvaluation(StartConfigRulesEvaluationRequest startConfigRulesEvaluationRequest)
Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the
resources.
|
default StartConfigurationRecorderResponse |
startConfigurationRecorder(Consumer<StartConfigurationRecorderRequest.Builder> startConfigurationRecorderRequest)
Starts recording configurations of the AWS resources you have selected to record in your AWS account.
|
default StartConfigurationRecorderResponse |
startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest)
Starts recording configurations of the AWS resources you have selected to record in your AWS account.
|
default StopConfigurationRecorderResponse |
stopConfigurationRecorder(Consumer<StopConfigurationRecorderRequest.Builder> stopConfigurationRecorderRequest)
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
|
default StopConfigurationRecorderResponse |
stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest)
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
|
serviceName
close
static final String SERVICE_NAME
static ConfigClient create()
ConfigClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static ConfigClientBuilder builder()
ConfigClient
.default DeleteConfigRuleResponse deleteConfigRule(DeleteConfigRuleRequest deleteConfigRuleRequest) throws NoSuchConfigRuleException, ResourceInUseException, AwsServiceException, SdkClientException, ConfigException
Deletes 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.
deleteConfigRuleRequest
- NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteConfigRuleResponse deleteConfigRule(Consumer<DeleteConfigRuleRequest.Builder> deleteConfigRuleRequest) throws NoSuchConfigRuleException, ResourceInUseException, AwsServiceException, SdkClientException, ConfigException
Deletes 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.
This is a convenience which creates an instance of the DeleteConfigRuleRequest.Builder
avoiding the need
to create one manually via DeleteConfigRuleRequest.builder()
deleteConfigRuleRequest
- A Consumer
that will call methods on DeleteConfigRuleRequest.Builder
to create a request.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteConfigurationRecorderResponse deleteConfigurationRecorder(DeleteConfigurationRecorderRequest deleteConfigurationRecorderRequest) throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Deletes 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.
deleteConfigurationRecorderRequest
- The request object for the DeleteConfigurationRecorder
action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteConfigurationRecorderResponse deleteConfigurationRecorder(Consumer<DeleteConfigurationRecorderRequest.Builder> deleteConfigurationRecorderRequest) throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Deletes 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.
This is a convenience which creates an instance of the DeleteConfigurationRecorderRequest.Builder
avoiding the need to create one manually via DeleteConfigurationRecorderRequest.builder()
deleteConfigurationRecorderRequest
- A Consumer
that will call methods on DeleteConfigurationRecorderRequest.Builder
to create
a request. The request object for the DeleteConfigurationRecorder
action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDeliveryChannelResponse deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest) throws NoSuchDeliveryChannelException, LastDeliveryChannelDeleteFailedException, AwsServiceException, SdkClientException, ConfigException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteDeliveryChannelResponse deleteDeliveryChannel(Consumer<DeleteDeliveryChannelRequest.Builder> deleteDeliveryChannelRequest) throws NoSuchDeliveryChannelException, LastDeliveryChannelDeleteFailedException, AwsServiceException, SdkClientException, ConfigException
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
This is a convenience which creates an instance of the DeleteDeliveryChannelRequest.Builder
avoiding the
need to create one manually via DeleteDeliveryChannelRequest.builder()
deleteDeliveryChannelRequest
- A Consumer
that will call methods on DeleteDeliveryChannelRequest.Builder
to create a
request. 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEvaluationResultsResponse deleteEvaluationResults(DeleteEvaluationResultsRequest deleteEvaluationResultsRequest) throws NoSuchConfigRuleException, ResourceInUseException, AwsServiceException, SdkClientException, ConfigException
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 AWS resources against the rule.
deleteEvaluationResultsRequest
- NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeleteEvaluationResultsResponse deleteEvaluationResults(Consumer<DeleteEvaluationResultsRequest.Builder> deleteEvaluationResultsRequest) throws NoSuchConfigRuleException, ResourceInUseException, AwsServiceException, SdkClientException, ConfigException
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 AWS resources against the rule.
This is a convenience which creates an instance of the DeleteEvaluationResultsRequest.Builder
avoiding
the need to create one manually via DeleteEvaluationResultsRequest.builder()
deleteEvaluationResultsRequest
- A Consumer
that will call methods on DeleteEvaluationResultsRequest.Builder
to create a
request.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeliverConfigSnapshotResponse deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest) throws NoSuchDeliveryChannelException, NoAvailableConfigurationRecorderException, NoRunningConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.
Notification of starting the delivery.
Notification of delivery completed, if the delivery was successfully completed.
Notification of delivery failure, if the delivery failed to complete.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DeliverConfigSnapshotResponse deliverConfigSnapshot(Consumer<DeliverConfigSnapshotRequest.Builder> deliverConfigSnapshotRequest) throws NoSuchDeliveryChannelException, NoAvailableConfigurationRecorderException, NoRunningConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.
Notification of starting the delivery.
Notification of delivery completed, if the delivery was successfully completed.
Notification of delivery failure, if the delivery failed to complete.
This is a convenience which creates an instance of the DeliverConfigSnapshotRequest.Builder
avoiding the
need to create one manually via DeliverConfigSnapshotRequest.builder()
deliverConfigSnapshotRequest
- A Consumer
that will call methods on DeliverConfigSnapshotRequest.Builder
to create a
request. 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeComplianceByConfigRuleResponse describeComplianceByConfigRule() throws InvalidParameterValueException, NoSuchConfigRuleException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Indicates 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, and 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 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.
InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest)
,
AWS API Documentationdefault DescribeComplianceByConfigRuleResponse describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest) throws InvalidParameterValueException, NoSuchConfigRuleException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Indicates 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, and 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 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.
describeComplianceByConfigRuleRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeComplianceByConfigRuleResponse describeComplianceByConfigRule(Consumer<DescribeComplianceByConfigRuleRequest.Builder> describeComplianceByConfigRuleRequest) throws InvalidParameterValueException, NoSuchConfigRuleException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Indicates 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, and 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 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.
This is a convenience which creates an instance of the DescribeComplianceByConfigRuleRequest.Builder
avoiding the need to create one manually via DescribeComplianceByConfigRuleRequest.builder()
describeComplianceByConfigRuleRequest
- A Consumer
that will call methods on DescribeComplianceByConfigRuleRequest.Builder
to
create a request.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeComplianceByResourceResponse describeComplianceByResource() throws InvalidParameterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Indicates 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.
InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeComplianceByResource(DescribeComplianceByResourceRequest)
,
AWS API Documentationdefault DescribeComplianceByResourceResponse describeComplianceByResource(DescribeComplianceByResourceRequest describeComplianceByResourceRequest) throws InvalidParameterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Indicates 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.
describeComplianceByResourceRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeComplianceByResourceResponse describeComplianceByResource(Consumer<DescribeComplianceByResourceRequest.Builder> describeComplianceByResourceRequest) throws InvalidParameterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Indicates 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.
This is a convenience which creates an instance of the DescribeComplianceByResourceRequest.Builder
avoiding the need to create one manually via DescribeComplianceByResourceRequest.builder()
describeComplianceByResourceRequest
- A Consumer
that will call methods on DescribeComplianceByResourceRequest.Builder
to create
a request.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeConfigRuleEvaluationStatusResponse describeConfigRuleEvaluationStatus() throws NoSuchConfigRuleException, InvalidParameterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Returns 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.
NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest)
,
AWS API Documentationdefault DescribeConfigRuleEvaluationStatusResponse describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest) throws NoSuchConfigRuleException, InvalidParameterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Returns 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.
describeConfigRuleEvaluationStatusRequest
- NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeConfigRuleEvaluationStatusResponse describeConfigRuleEvaluationStatus(Consumer<DescribeConfigRuleEvaluationStatusRequest.Builder> describeConfigRuleEvaluationStatusRequest) throws NoSuchConfigRuleException, InvalidParameterValueException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Returns 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.
This is a convenience which creates an instance of the DescribeConfigRuleEvaluationStatusRequest.Builder
avoiding the need to create one manually via DescribeConfigRuleEvaluationStatusRequest.builder()
describeConfigRuleEvaluationStatusRequest
- A Consumer
that will call methods on DescribeConfigRuleEvaluationStatusRequest.Builder
to
create a request.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeConfigRulesResponse describeConfigRules() throws NoSuchConfigRuleException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Returns details about your AWS Config rules.
NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeConfigRules(DescribeConfigRulesRequest)
,
AWS API
Documentationdefault DescribeConfigRulesResponse describeConfigRules(DescribeConfigRulesRequest describeConfigRulesRequest) throws NoSuchConfigRuleException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Returns details about your AWS Config rules.
describeConfigRulesRequest
- NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeConfigRulesResponse describeConfigRules(Consumer<DescribeConfigRulesRequest.Builder> describeConfigRulesRequest) throws NoSuchConfigRuleException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
Returns details about your AWS Config rules.
This is a convenience which creates an instance of the DescribeConfigRulesRequest.Builder
avoiding the
need to create one manually via DescribeConfigRulesRequest.builder()
describeConfigRulesRequest
- A Consumer
that will call methods on DescribeConfigRulesRequest.Builder
to create a
request.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeConfigurationRecorderStatusResponse describeConfigurationRecorderStatus() throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.
Currently, you can specify only one configuration recorder per region in your account.
NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest)
,
AWS API Documentationdefault DescribeConfigurationRecorderStatusResponse describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest) throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.
Currently, you can specify only one configuration recorder per region in your account.
describeConfigurationRecorderStatusRequest
- The input for the DescribeConfigurationRecorderStatus action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeConfigurationRecorderStatusResponse describeConfigurationRecorderStatus(Consumer<DescribeConfigurationRecorderStatusRequest.Builder> describeConfigurationRecorderStatusRequest) throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.
Currently, you can specify only one configuration recorder per region in your account.
This is a convenience which creates an instance of the DescribeConfigurationRecorderStatusRequest.Builder
avoiding the need to create one manually via DescribeConfigurationRecorderStatusRequest.builder()
describeConfigurationRecorderStatusRequest
- A Consumer
that will call methods on DescribeConfigurationRecorderStatusRequest.Builder
to
create a request. The input for the DescribeConfigurationRecorderStatus action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeConfigurationRecordersResponse describeConfigurationRecorders() throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
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.
Currently, you can specify only one configuration recorder per region in your account.
NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeConfigurationRecorders(DescribeConfigurationRecordersRequest)
,
AWS API Documentationdefault DescribeConfigurationRecordersResponse describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest) throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
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.
Currently, you can specify only one configuration recorder per region in your account.
describeConfigurationRecordersRequest
- The input for the DescribeConfigurationRecorders action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeConfigurationRecordersResponse describeConfigurationRecorders(Consumer<DescribeConfigurationRecordersRequest.Builder> describeConfigurationRecordersRequest) throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
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.
Currently, you can specify only one configuration recorder per region in your account.
This is a convenience which creates an instance of the DescribeConfigurationRecordersRequest.Builder
avoiding the need to create one manually via DescribeConfigurationRecordersRequest.builder()
describeConfigurationRecordersRequest
- A Consumer
that will call methods on DescribeConfigurationRecordersRequest.Builder
to
create a request. The input for the DescribeConfigurationRecorders action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDeliveryChannelStatusResponse describeDeliveryChannelStatus() throws NoSuchDeliveryChannelException, AwsServiceException, SdkClientException, ConfigException
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.
NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest)
,
AWS API Documentationdefault DescribeDeliveryChannelStatusResponse describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest) throws NoSuchDeliveryChannelException, AwsServiceException, SdkClientException, ConfigException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDeliveryChannelStatusResponse describeDeliveryChannelStatus(Consumer<DescribeDeliveryChannelStatusRequest.Builder> describeDeliveryChannelStatusRequest) throws NoSuchDeliveryChannelException, AwsServiceException, SdkClientException, ConfigException
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.
This is a convenience which creates an instance of the DescribeDeliveryChannelStatusRequest.Builder
avoiding the need to create one manually via DescribeDeliveryChannelStatusRequest.builder()
describeDeliveryChannelStatusRequest
- A Consumer
that will call methods on DescribeDeliveryChannelStatusRequest.Builder
to
create a request. The input for the DeliveryChannelStatus action.NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDeliveryChannelsResponse describeDeliveryChannels() throws NoSuchDeliveryChannelException, AwsServiceException, SdkClientException, ConfigException
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.
NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
describeDeliveryChannels(DescribeDeliveryChannelsRequest)
,
AWS API Documentationdefault DescribeDeliveryChannelsResponse describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest) throws NoSuchDeliveryChannelException, AwsServiceException, SdkClientException, ConfigException
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DescribeDeliveryChannelsResponse describeDeliveryChannels(Consumer<DescribeDeliveryChannelsRequest.Builder> describeDeliveryChannelsRequest) throws NoSuchDeliveryChannelException, AwsServiceException, SdkClientException, ConfigException
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.
This is a convenience which creates an instance of the DescribeDeliveryChannelsRequest.Builder
avoiding
the need to create one manually via DescribeDeliveryChannelsRequest.builder()
describeDeliveryChannelsRequest
- A Consumer
that will call methods on DescribeDeliveryChannelsRequest.Builder
to create a
request. The input for the DescribeDeliveryChannels action.NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceDetailsByConfigRuleResponse getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest) throws InvalidParameterValueException, InvalidNextTokenException, NoSuchConfigRuleException, AwsServiceException, SdkClientException, ConfigException
Returns 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.
getComplianceDetailsByConfigRuleRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceDetailsByConfigRuleResponse getComplianceDetailsByConfigRule(Consumer<GetComplianceDetailsByConfigRuleRequest.Builder> getComplianceDetailsByConfigRuleRequest) throws InvalidParameterValueException, InvalidNextTokenException, NoSuchConfigRuleException, AwsServiceException, SdkClientException, ConfigException
Returns 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.
This is a convenience which creates an instance of the GetComplianceDetailsByConfigRuleRequest.Builder
avoiding the need to create one manually via GetComplianceDetailsByConfigRuleRequest.builder()
getComplianceDetailsByConfigRuleRequest
- A Consumer
that will call methods on GetComplianceDetailsByConfigRuleRequest.Builder
to
create a request.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceDetailsByResourceResponse getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest) throws InvalidParameterValueException, AwsServiceException, SdkClientException, ConfigException
Returns 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.
getComplianceDetailsByResourceRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceDetailsByResourceResponse getComplianceDetailsByResource(Consumer<GetComplianceDetailsByResourceRequest.Builder> getComplianceDetailsByResourceRequest) throws InvalidParameterValueException, AwsServiceException, SdkClientException, ConfigException
Returns 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.
This is a convenience which creates an instance of the GetComplianceDetailsByResourceRequest.Builder
avoiding the need to create one manually via GetComplianceDetailsByResourceRequest.builder()
getComplianceDetailsByResourceRequest
- A Consumer
that will call methods on GetComplianceDetailsByResourceRequest.Builder
to
create a request.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceSummaryByConfigRuleResponse getComplianceSummaryByConfigRule() throws AwsServiceException, SdkClientException, ConfigException
Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest)
,
AWS API Documentationdefault GetComplianceSummaryByConfigRuleResponse getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest getComplianceSummaryByConfigRuleRequest) throws AwsServiceException, SdkClientException, ConfigException
Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
getComplianceSummaryByConfigRuleRequest
- SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceSummaryByConfigRuleResponse getComplianceSummaryByConfigRule(Consumer<GetComplianceSummaryByConfigRuleRequest.Builder> getComplianceSummaryByConfigRuleRequest) throws AwsServiceException, SdkClientException, ConfigException
Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
This is a convenience which creates an instance of the GetComplianceSummaryByConfigRuleRequest.Builder
avoiding the need to create one manually via GetComplianceSummaryByConfigRuleRequest.builder()
getComplianceSummaryByConfigRuleRequest
- A Consumer
that will call methods on GetComplianceSummaryByConfigRuleRequest.Builder
to
create a request.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceSummaryByResourceTypeResponse getComplianceSummaryByResourceType() throws InvalidParameterValueException, AwsServiceException, SdkClientException, ConfigException
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.
InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest)
,
AWS API Documentationdefault GetComplianceSummaryByResourceTypeResponse getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest getComplianceSummaryByResourceTypeRequest) throws InvalidParameterValueException, AwsServiceException, SdkClientException, ConfigException
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 invalid. Verify that your parameters are valid and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetComplianceSummaryByResourceTypeResponse getComplianceSummaryByResourceType(Consumer<GetComplianceSummaryByResourceTypeRequest.Builder> getComplianceSummaryByResourceTypeRequest) throws InvalidParameterValueException, AwsServiceException, SdkClientException, ConfigException
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.
This is a convenience which creates an instance of the GetComplianceSummaryByResourceTypeRequest.Builder
avoiding the need to create one manually via GetComplianceSummaryByResourceTypeRequest.builder()
getComplianceSummaryByResourceTypeRequest
- A Consumer
that will call methods on GetComplianceSummaryByResourceTypeRequest.Builder
to
create a request.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDiscoveredResourceCountsResponse getDiscoveredResourceCounts() throws ValidationException, InvalidLimitException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
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.
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 may not immediately receive resource counts in the following situations:
You are a new AWS Config customer
You just enabled resource recording
It may take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
ValidationException
- The requested action is not valid.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest)
,
AWS API Documentationdefault GetDiscoveredResourceCountsResponse getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest) throws ValidationException, InvalidLimitException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
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.
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 may not immediately receive resource counts in the following situations:
You are a new AWS Config customer
You just enabled resource recording
It may take a few minutes for AWS 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.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDiscoveredResourceCountsResponse getDiscoveredResourceCounts(Consumer<GetDiscoveredResourceCountsRequest.Builder> getDiscoveredResourceCountsRequest) throws ValidationException, InvalidLimitException, InvalidNextTokenException, AwsServiceException, SdkClientException, ConfigException
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.
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 may not immediately receive resource counts in the following situations:
You are a new AWS Config customer
You just enabled resource recording
It may take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
This is a convenience which creates an instance of the GetDiscoveredResourceCountsRequest.Builder
avoiding the need to create one manually via GetDiscoveredResourceCountsRequest.builder()
getDiscoveredResourceCountsRequest
- A Consumer
that will call methods on GetDiscoveredResourceCountsRequest.Builder
to create
a request.ValidationException
- The requested action is not valid.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is invalid. Specify the NextToken
string that was returned in the
previous response to get the next page of results.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetResourceConfigHistoryResponse getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest) throws ValidationException, InvalidTimeRangeException, InvalidLimitException, InvalidNextTokenException, NoAvailableConfigurationRecorderException, ResourceNotDiscoveredException, AwsServiceException, SdkClientException, ConfigException
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.
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
.
getResourceConfigHistoryRequest
- The input for the GetResourceConfigHistory action.ValidationException
- The requested action is not valid.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 invalid. 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetResourceConfigHistoryResponse getResourceConfigHistory(Consumer<GetResourceConfigHistoryRequest.Builder> getResourceConfigHistoryRequest) throws ValidationException, InvalidTimeRangeException, InvalidLimitException, InvalidNextTokenException, NoAvailableConfigurationRecorderException, ResourceNotDiscoveredException, AwsServiceException, SdkClientException, ConfigException
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.
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
.
This is a convenience which creates an instance of the GetResourceConfigHistoryRequest.Builder
avoiding
the need to create one manually via GetResourceConfigHistoryRequest.builder()
getResourceConfigHistoryRequest
- A Consumer
that will call methods on GetResourceConfigHistoryRequest.Builder
to create a
request. The input for the GetResourceConfigHistory action.ValidationException
- The requested action is not valid.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 invalid. 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetResourceConfigHistoryIterable getResourceConfigHistoryPaginator(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest) throws ValidationException, InvalidTimeRangeException, InvalidLimitException, InvalidNextTokenException, NoAvailableConfigurationRecorderException, ResourceNotDiscoveredException, AwsServiceException, SdkClientException, ConfigException
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.
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
.
This is a variant of
getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client.getResourceConfigHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client .getResourceConfigHistoryPaginator(request); for (software.amazon.awssdk.services.config.model.GetResourceConfigHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client.getResourceConfigHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation.
getResourceConfigHistoryRequest
- The input for the GetResourceConfigHistory action.ValidationException
- The requested action is not valid.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 invalid. 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetResourceConfigHistoryIterable getResourceConfigHistoryPaginator(Consumer<GetResourceConfigHistoryRequest.Builder> getResourceConfigHistoryRequest) throws ValidationException, InvalidTimeRangeException, InvalidLimitException, InvalidNextTokenException, NoAvailableConfigurationRecorderException, ResourceNotDiscoveredException, AwsServiceException, SdkClientException, ConfigException
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.
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
.
This is a variant of
getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client.getResourceConfigHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @code software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client .getResourceConfigHistoryPaginator(request); for (software.amazon.awssdk.services.config.model.GetResourceConfigHistoryResponse response : responses) { // do something; } }3) Use iterator directly
software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client.getResourceConfigHistoryPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation.
This is a convenience which creates an instance of the GetResourceConfigHistoryRequest.Builder
avoiding
the need to create one manually via GetResourceConfigHistoryRequest.builder()
getResourceConfigHistoryRequest
- A Consumer
that will call methods on GetResourceConfigHistoryRequest.Builder
to create a
request. The input for the GetResourceConfigHistory action.ValidationException
- The requested action is not valid.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 invalid. 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDiscoveredResourcesResponse listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) throws ValidationException, InvalidLimitException, InvalidNextTokenException, NoAvailableConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
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 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.
listDiscoveredResourcesRequest
- ValidationException
- The requested action is not valid.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is invalid. 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDiscoveredResourcesResponse listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) throws ValidationException, InvalidLimitException, InvalidNextTokenException, NoAvailableConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
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 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.
This is a convenience which creates an instance of the ListDiscoveredResourcesRequest.Builder
avoiding
the need to create one manually via ListDiscoveredResourcesRequest.builder()
listDiscoveredResourcesRequest
- A Consumer
that will call methods on ListDiscoveredResourcesRequest.Builder
to create a
request.ValidationException
- The requested action is not valid.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is invalid. 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutConfigRuleResponse putConfigRule(PutConfigRuleRequest putConfigRuleRequest) throws InvalidParameterValueException, MaxNumberOfConfigRulesExceededException, ResourceInUseException, InsufficientPermissionsException, NoAvailableConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
You can use this action for custom Config rules and AWS managed Config rules. A custom 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 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 more 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.
putConfigRuleRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.MaxNumberOfConfigRulesExceededException
- Failed to add the AWS Config rule because the account already contains the maximum number of 50 rules.
Consider deleting any deactivated rules before adding new rules.ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.InsufficientPermissionsException
- Indicates one of the following errors:
The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.
The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutConfigRuleResponse putConfigRule(Consumer<PutConfigRuleRequest.Builder> putConfigRuleRequest) throws InvalidParameterValueException, MaxNumberOfConfigRulesExceededException, ResourceInUseException, InsufficientPermissionsException, NoAvailableConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
You can use this action for custom Config rules and AWS managed Config rules. A custom 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 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 more 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.
This is a convenience which creates an instance of the PutConfigRuleRequest.Builder
avoiding the need to
create one manually via PutConfigRuleRequest.builder()
putConfigRuleRequest
- A Consumer
that will call methods on PutConfigRuleRequest.Builder
to create a request.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.MaxNumberOfConfigRulesExceededException
- Failed to add the AWS Config rule because the account already contains the maximum number of 50 rules.
Consider deleting any deactivated rules before adding new rules.ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.InsufficientPermissionsException
- Indicates one of the following errors:
The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.
The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutConfigurationRecorderResponse putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest) throws MaxNumberOfConfigurationRecordersExceededException, InvalidConfigurationRecorderNameException, InvalidRoleException, InvalidRecordingGroupException, AwsServiceException, SdkClientException, ConfigException
Creates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN
and/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.
putConfigurationRecorderRequest
- The input for the PutConfigurationRecorder action.MaxNumberOfConfigurationRecordersExceededException
- You have reached the limit on the number of recorders you can create.InvalidConfigurationRecorderNameException
- You have provided a configuration recorder name that is not valid.InvalidRoleException
- You have provided a null or empty role ARN.InvalidRecordingGroupException
- AWS Config throws an exception if the recording group does not contain a valid list of resource types.
Invalid values could also be incorrectly formatted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutConfigurationRecorderResponse putConfigurationRecorder(Consumer<PutConfigurationRecorderRequest.Builder> putConfigurationRecorderRequest) throws MaxNumberOfConfigurationRecordersExceededException, InvalidConfigurationRecorderNameException, InvalidRoleException, InvalidRecordingGroupException, AwsServiceException, SdkClientException, ConfigException
Creates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN
and/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.
This is a convenience which creates an instance of the PutConfigurationRecorderRequest.Builder
avoiding
the need to create one manually via PutConfigurationRecorderRequest.builder()
putConfigurationRecorderRequest
- A Consumer
that will call methods on PutConfigurationRecorderRequest.Builder
to create a
request. The input for the PutConfigurationRecorder action.MaxNumberOfConfigurationRecordersExceededException
- You have reached the limit on the number of recorders you can create.InvalidConfigurationRecorderNameException
- You have provided a configuration recorder name that is not valid.InvalidRoleException
- You have provided a null or empty role ARN.InvalidRecordingGroupException
- AWS Config throws an exception if the recording group does not contain a valid list of resource types.
Invalid values could also be incorrectly formatted.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutDeliveryChannelResponse putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest) throws MaxNumberOfDeliveryChannelsExceededException, NoAvailableConfigurationRecorderException, InvalidDeliveryChannelNameException, NoSuchBucketException, InvalidS3KeyPrefixException, InvalidSnsTopicArnException, InsufficientDeliveryPolicyException, AwsServiceException, SdkClientException, ConfigException
Creates 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.
putDeliveryChannelRequest
- The input for the PutDeliveryChannel action.MaxNumberOfDeliveryChannelsExceededException
- You have reached the limit on 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.InvalidSnsTopicArnException
- The specified Amazon SNS topic does not exist.InsufficientDeliveryPolicyException
- Your Amazon S3 bucket policy does not permit AWS Config to write to it.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutDeliveryChannelResponse putDeliveryChannel(Consumer<PutDeliveryChannelRequest.Builder> putDeliveryChannelRequest) throws MaxNumberOfDeliveryChannelsExceededException, NoAvailableConfigurationRecorderException, InvalidDeliveryChannelNameException, NoSuchBucketException, InvalidS3KeyPrefixException, InvalidSnsTopicArnException, InsufficientDeliveryPolicyException, AwsServiceException, SdkClientException, ConfigException
Creates 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.
This is a convenience which creates an instance of the PutDeliveryChannelRequest.Builder
avoiding the
need to create one manually via PutDeliveryChannelRequest.builder()
putDeliveryChannelRequest
- A Consumer
that will call methods on PutDeliveryChannelRequest.Builder
to create a
request. The input for the PutDeliveryChannel action.MaxNumberOfDeliveryChannelsExceededException
- You have reached the limit on 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.InvalidSnsTopicArnException
- The specified Amazon SNS topic does not exist.InsufficientDeliveryPolicyException
- Your Amazon S3 bucket policy does not permit AWS Config to write to it.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutEvaluationsResponse putEvaluations(PutEvaluationsRequest putEvaluationsRequest) throws InvalidParameterValueException, InvalidResultTokenException, NoSuchConfigRuleException, AwsServiceException, SdkClientException, ConfigException
Used 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.
putEvaluationsRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidResultTokenException
- The specified ResultToken
is invalid.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PutEvaluationsResponse putEvaluations(Consumer<PutEvaluationsRequest.Builder> putEvaluationsRequest) throws InvalidParameterValueException, InvalidResultTokenException, NoSuchConfigRuleException, AwsServiceException, SdkClientException, ConfigException
Used 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.
This is a convenience which creates an instance of the PutEvaluationsRequest.Builder
avoiding the need to
create one manually via PutEvaluationsRequest.builder()
putEvaluationsRequest
- A Consumer
that will call methods on PutEvaluationsRequest.Builder
to create a request.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.InvalidResultTokenException
- The specified ResultToken
is invalid.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartConfigRulesEvaluationResponse startConfigRulesEvaluation(StartConfigRulesEvaluationRequest startConfigRulesEvaluationRequest) throws NoSuchConfigRuleException, LimitExceededException, ResourceInUseException, InvalidParameterValueException, AwsServiceException, SdkClientException, ConfigException
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 a rule that 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 must complete for the specified rules 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 new rule, AWS Config automatically evaluates your resources against the rule.
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.
startConfigRulesEvaluationRequest
- NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.LimitExceededException
- This exception is thrown if an evaluation is in progress or if you call the
StartConfigRulesEvaluation API more than once per minute.ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartConfigRulesEvaluationResponse startConfigRulesEvaluation(Consumer<StartConfigRulesEvaluationRequest.Builder> startConfigRulesEvaluationRequest) throws NoSuchConfigRuleException, LimitExceededException, ResourceInUseException, InvalidParameterValueException, AwsServiceException, SdkClientException, ConfigException
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 a rule that 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 must complete for the specified rules 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 new rule, AWS Config automatically evaluates your resources against the rule.
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.
This is a convenience which creates an instance of the StartConfigRulesEvaluationRequest.Builder
avoiding
the need to create one manually via StartConfigRulesEvaluationRequest.builder()
startConfigRulesEvaluationRequest
- A Consumer
that will call methods on StartConfigRulesEvaluationRequest.Builder
to create a
request.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.LimitExceededException
- This exception is thrown if an evaluation is in progress or if you call the
StartConfigRulesEvaluation API more than once per minute.ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartConfigurationRecorderResponse startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest) throws NoSuchConfigurationRecorderException, NoAvailableDeliveryChannelException, AwsServiceException, SdkClientException, ConfigException
Starts 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.
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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StartConfigurationRecorderResponse startConfigurationRecorder(Consumer<StartConfigurationRecorderRequest.Builder> startConfigurationRecorderRequest) throws NoSuchConfigurationRecorderException, NoAvailableDeliveryChannelException, AwsServiceException, SdkClientException, ConfigException
Starts 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.
This is a convenience which creates an instance of the StartConfigurationRecorderRequest.Builder
avoiding
the need to create one manually via StartConfigurationRecorderRequest.builder()
startConfigurationRecorderRequest
- A Consumer
that will call methods on StartConfigurationRecorderRequest.Builder
to create a
request. 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.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopConfigurationRecorderResponse stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest) throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
stopConfigurationRecorderRequest
- The input for the StopConfigurationRecorder action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default StopConfigurationRecorderResponse stopConfigurationRecorder(Consumer<StopConfigurationRecorderRequest.Builder> stopConfigurationRecorderRequest) throws NoSuchConfigurationRecorderException, AwsServiceException, SdkClientException, ConfigException
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
This is a convenience which creates an instance of the StopConfigurationRecorderRequest.Builder
avoiding
the need to create one manually via StopConfigurationRecorderRequest.builder()
stopConfigurationRecorderRequest
- A Consumer
that will call methods on StopConfigurationRecorderRequest.Builder
to create a
request. The input for the StopConfigurationRecorder action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.ConfigException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.