Package software.amazon.awssdk.services.config

Interface ConfigClient

All Superinterfaces:

AutoCloseable

@Generated("software.amazon.awssdk:codegen")
public interface ConfigClient
extends AutoCloseable

Service client for accessing Config Service. This can be created using the static builder() method. AWS Config

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.

Field Summary

Fields

Modifier and Type	Field	Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method	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(DeleteConfigRuleRequest deleteConfigRuleRequest)	Deletes the specified AWS Config rule and all of its evaluation results.
default DeleteConfigurationRecorderResponse	deleteConfigurationRecorder(DeleteConfigurationRecorderRequest deleteConfigurationRecorderRequest)	Deletes the configuration recorder.
default DeleteDeliveryChannelResponse	deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest)	Deletes the delivery channel.
default DeleteEvaluationResultsResponse	deleteEvaluationResults(DeleteEvaluationResultsRequest deleteEvaluationResultsRequest)	Deletes the evaluation results for the specified Config rule.
default DeliverConfigSnapshotResponse	deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest)	Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
default DescribeComplianceByConfigRuleResponse	describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest)	Indicates whether the specified AWS Config rules are compliant.
default DescribeComplianceByResourceResponse	describeComplianceByResource(DescribeComplianceByResourceRequest describeComplianceByResourceRequest)	Indicates whether the specified AWS resources are compliant.
default DescribeConfigRuleEvaluationStatusResponse	describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest)	Returns status information for each of your AWS managed Config rules.
default DescribeConfigRulesResponse	describeConfigRules(DescribeConfigRulesRequest describeConfigRulesRequest)	Returns details about your AWS Config rules.
default DescribeConfigurationRecordersResponse	describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest)	Returns the details for the specified configuration recorders.
default DescribeConfigurationRecorderStatusResponse	describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest)	Returns the current status of the specified configuration recorder.
default DescribeDeliveryChannelsResponse	describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest)	Returns details about the specified delivery channel.
default DescribeDeliveryChannelStatusResponse	describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest)	Returns the current status of the specified delivery channel.
default GetComplianceDetailsByConfigRuleResponse	getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest)	Returns the evaluation results for the specified AWS Config rule.
default GetComplianceDetailsByResourceResponse	getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest)	Returns the evaluation results for the specified AWS resource.
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(GetComplianceSummaryByResourceTypeRequest getComplianceSummaryByResourceTypeRequest)	Returns the number of resources that are compliant and the number that are noncompliant.
default GetResourceConfigHistoryResponse	getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)	Returns a list of configuration items for the specified resource.
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(PutConfigRuleRequest putConfigRuleRequest)	Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
default PutConfigurationRecorderResponse	putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest)	Creates a new configuration recorder to record the selected resource configurations.
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(PutEvaluationsRequest putEvaluationsRequest)	Used by an AWS Lambda function to deliver evaluation results to AWS Config.
static ServiceMetadata	serviceMetadata()
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(StartConfigurationRecorderRequest startConfigurationRecorderRequest)	Starts 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.

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static ConfigClient create()

Create a ConfigClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ConfigClientBuilder builder()

Create a builder that can be used to configure and create a ConfigClient.

deleteConfigRule

default DeleteConfigRuleResponse deleteConfigRule(DeleteConfigRuleRequest deleteConfigRuleRequest)
                                           throws NoSuchConfigRuleException,
                                                  ResourceInUseException,
                                                  SdkBaseException,
                                                  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.

Parameters:

deleteConfigRuleRequest -

Returns:

Result of the DeleteConfigRule operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteConfigurationRecorder

default DeleteConfigurationRecorderResponse deleteConfigurationRecorder(DeleteConfigurationRecorderRequest deleteConfigurationRecorderRequest)
                                                                 throws NoSuchConfigurationRecorderException,
                                                                        SdkBaseException,
                                                                        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.

Parameters:

deleteConfigurationRecorderRequest - The request object for the DeleteConfigurationRecorder action.

Returns:

Result of the DeleteConfigurationRecorder operation returned by the service.

Throws:

NoSuchConfigurationRecorderException - You have specified a configuration recorder that does not exist.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteDeliveryChannel

default DeleteDeliveryChannelResponse deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest)
                                                     throws NoSuchDeliveryChannelException,
                                                            LastDeliveryChannelDeleteFailedException,
                                                            SdkBaseException,
                                                            SdkClientException,
                                                            ConfigException

Deletes the delivery channel.

Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

Parameters:

deleteDeliveryChannelRequest - The input for the DeleteDeliveryChannel action. The action accepts the following data in JSON format.

Returns:

Result of the DeleteDeliveryChannel operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deleteEvaluationResults

default DeleteEvaluationResultsResponse deleteEvaluationResults(DeleteEvaluationResultsRequest deleteEvaluationResultsRequest)
                                                         throws NoSuchConfigRuleException,
                                                                ResourceInUseException,
                                                                SdkBaseException,
                                                                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.

Parameters:

deleteEvaluationResultsRequest -

Returns:

Result of the DeleteEvaluationResults operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

deliverConfigSnapshot

default DeliverConfigSnapshotResponse deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest)
                                                     throws NoSuchDeliveryChannelException,
                                                            NoAvailableConfigurationRecorderException,
                                                            NoRunningConfigurationRecorderException,
                                                            SdkBaseException,
                                                            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.

Parameters:

deliverConfigSnapshotRequest - The input for the DeliverConfigSnapshot action.

Returns:

Result of the DeliverConfigSnapshot operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeComplianceByConfigRule

default DescribeComplianceByConfigRuleResponse describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest)
                                                                       throws InvalidParameterValueException,
                                                                              NoSuchConfigRuleException,
                                                                              InvalidNextTokenException,
                                                                              SdkBaseException,
                                                                              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.

Parameters:

describeComplianceByConfigRuleRequest -

Returns:

Result of the DescribeComplianceByConfigRule operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeComplianceByResource

default DescribeComplianceByResourceResponse describeComplianceByResource(DescribeComplianceByResourceRequest describeComplianceByResourceRequest)
                                                                   throws InvalidParameterValueException,
                                                                          InvalidNextTokenException,
                                                                          SdkBaseException,
                                                                          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.

Parameters:

describeComplianceByResourceRequest -

Returns:

Result of the DescribeComplianceByResource operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeConfigRuleEvaluationStatus

default DescribeConfigRuleEvaluationStatusResponse describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest)
                                                                               throws NoSuchConfigRuleException,
                                                                                      InvalidParameterValueException,
                                                                                      InvalidNextTokenException,
                                                                                      SdkBaseException,
                                                                                      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.

Parameters:

describeConfigRuleEvaluationStatusRequest -

Returns:

Result of the DescribeConfigRuleEvaluationStatus operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeConfigRules

default DescribeConfigRulesResponse describeConfigRules(DescribeConfigRulesRequest describeConfigRulesRequest)
                                                 throws NoSuchConfigRuleException,
                                                        InvalidNextTokenException,
                                                        SdkBaseException,
                                                        SdkClientException,
                                                        ConfigException

Returns details about your AWS Config rules.

Parameters:

describeConfigRulesRequest -

Returns:

Result of the DescribeConfigRules operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeConfigurationRecorderStatus

default DescribeConfigurationRecorderStatusResponse describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest)
                                                                                 throws NoSuchConfigurationRecorderException,
                                                                                        SdkBaseException,
                                                                                        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.

Parameters:

describeConfigurationRecorderStatusRequest - The input for the DescribeConfigurationRecorderStatus action.

Returns:

Result of the DescribeConfigurationRecorderStatus operation returned by the service.

Throws:

NoSuchConfigurationRecorderException - You have specified a configuration recorder that does not exist.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeConfigurationRecorders

default DescribeConfigurationRecordersResponse describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest)
                                                                       throws NoSuchConfigurationRecorderException,
                                                                              SdkBaseException,
                                                                              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.

Parameters:

describeConfigurationRecordersRequest - The input for the DescribeConfigurationRecorders action.

Returns:

Result of the DescribeConfigurationRecorders operation returned by the service.

Throws:

NoSuchConfigurationRecorderException - You have specified a configuration recorder that does not exist.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeDeliveryChannelStatus

default DescribeDeliveryChannelStatusResponse describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest)
                                                                     throws NoSuchDeliveryChannelException,
                                                                            SdkBaseException,
                                                                            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.

Parameters:

describeDeliveryChannelStatusRequest - The input for the DeliveryChannelStatus action.

Returns:

Result of the DescribeDeliveryChannelStatus operation returned by the service.

Throws:

NoSuchDeliveryChannelException - You have specified a delivery channel that does not exist.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

describeDeliveryChannels

default DescribeDeliveryChannelsResponse describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest)
                                                           throws NoSuchDeliveryChannelException,
                                                                  SdkBaseException,
                                                                  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.

Parameters:

describeDeliveryChannelsRequest - The input for the DescribeDeliveryChannels action.

Returns:

Result of the DescribeDeliveryChannels operation returned by the service.

Throws:

NoSuchDeliveryChannelException - You have specified a delivery channel that does not exist.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getComplianceDetailsByConfigRule

default GetComplianceDetailsByConfigRuleResponse getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest)
                                                                           throws InvalidParameterValueException,
                                                                                  InvalidNextTokenException,
                                                                                  NoSuchConfigRuleException,
                                                                                  SdkBaseException,
                                                                                  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.

Parameters:

getComplianceDetailsByConfigRuleRequest -

Returns:

Result of the GetComplianceDetailsByConfigRule operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getComplianceDetailsByResource

default GetComplianceDetailsByResourceResponse getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest)
                                                                       throws InvalidParameterValueException,
                                                                              SdkBaseException,
                                                                              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.

Parameters:

getComplianceDetailsByResourceRequest -

Returns:

Result of the GetComplianceDetailsByResource operation returned by the service.

Throws:

InvalidParameterValueException - One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getComplianceSummaryByConfigRule

default GetComplianceSummaryByConfigRuleResponse getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest getComplianceSummaryByConfigRuleRequest)
                                                                           throws SdkBaseException,
                                                                                  SdkClientException,
                                                                                  ConfigException

Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.

Parameters:

getComplianceSummaryByConfigRuleRequest -

Returns:

Result of the GetComplianceSummaryByConfigRule operation returned by the service.

Throws:

SdkBaseException

SdkClientException

ConfigException

See Also:

AWS API Documentation

getComplianceSummaryByResourceType

default GetComplianceSummaryByResourceTypeResponse getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest getComplianceSummaryByResourceTypeRequest)
                                                                               throws InvalidParameterValueException,
                                                                                      SdkBaseException,
                                                                                      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.

Parameters:

getComplianceSummaryByResourceTypeRequest -

Returns:

Result of the GetComplianceSummaryByResourceType operation returned by the service.

Throws:

InvalidParameterValueException - One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

getResourceConfigHistory

default GetResourceConfigHistoryResponse getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)
                                                           throws ValidationException,
                                                                  InvalidTimeRangeException,
                                                                  InvalidLimitException,
                                                                  InvalidNextTokenException,
                                                                  NoAvailableConfigurationRecorderException,
                                                                  ResourceNotDiscoveredException,
                                                                  SdkBaseException,
                                                                  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, and 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, and to get the next page of results, run the request again and enter this 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.

Parameters:

getResourceConfigHistoryRequest - The input for the GetResourceConfigHistory action.

Returns:

Result of the GetResourceConfigHistory operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

listDiscoveredResources

default ListDiscoveredResourcesResponse listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
                                                         throws ValidationException,
                                                                InvalidLimitException,
                                                                InvalidNextTokenException,
                                                                NoAvailableConfigurationRecorderException,
                                                                SdkBaseException,
                                                                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, and 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, and to get the next page of results, run the request again and enter this string for the nextToken parameter.

Parameters:

listDiscoveredResourcesRequest -

Returns:

Result of the ListDiscoveredResources operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

putConfigRule

default PutConfigRuleResponse putConfigRule(PutConfigRuleRequest putConfigRuleRequest)
                                     throws InvalidParameterValueException,
                                            MaxNumberOfConfigRulesExceededException,
                                            ResourceInUseException,
                                            InsufficientPermissionsException,
                                            NoAvailableConfigurationRecorderException,
                                            SdkBaseException,
                                            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.

Parameters:

putConfigRuleRequest -

Returns:

Result of the PutConfigRule operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

putConfigurationRecorder

default PutConfigurationRecorderResponse putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest)
                                                           throws MaxNumberOfConfigurationRecordersExceededException,
                                                                  InvalidConfigurationRecorderNameException,
                                                                  InvalidRoleException,
                                                                  InvalidRecordingGroupException,
                                                                  SdkBaseException,
                                                                  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.

Parameters:

putConfigurationRecorderRequest - The input for the PutConfigurationRecorder action.

Returns:

Result of the PutConfigurationRecorder operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

putDeliveryChannel

default PutDeliveryChannelResponse putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest)
                                               throws MaxNumberOfDeliveryChannelsExceededException,
                                                      NoAvailableConfigurationRecorderException,
                                                      InvalidDeliveryChannelNameException,
                                                      NoSuchBucketException,
                                                      InvalidS3KeyPrefixException,
                                                      InvalidSNSTopicARNException,
                                                      InsufficientDeliveryPolicyException,
                                                      SdkBaseException,
                                                      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.

Parameters:

putDeliveryChannelRequest - The input for the PutDeliveryChannel action.

Returns:

Result of the PutDeliveryChannel operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

putEvaluations

default PutEvaluationsResponse putEvaluations(PutEvaluationsRequest putEvaluationsRequest)
                                       throws InvalidParameterValueException,
                                              InvalidResultTokenException,
                                              NoSuchConfigRuleException,
                                              SdkBaseException,
                                              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.

Parameters:

putEvaluationsRequest -

Returns:

Result of the PutEvaluations operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

startConfigRulesEvaluation

default StartConfigRulesEvaluationResponse startConfigRulesEvaluation(StartConfigRulesEvaluationRequest startConfigRulesEvaluationRequest)
                                                               throws NoSuchConfigRuleException,
                                                                      LimitExceededException,
                                                                      ResourceInUseException,
                                                                      InvalidParameterValueException,
                                                                      SdkBaseException,
                                                                      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:

1. You have a custom rule that evaluates your IAM resources every 24 hours.

2. You update your Lambda function to add additional conditions to your rule.

3. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API.

4. AWS Config invokes your Lambda function and evaluates your IAM resources.

5. Your custom rule will still run periodic evaluations every 24 hours.

Parameters:

startConfigRulesEvaluationRequest -

Returns:

Result of the StartConfigRulesEvaluation operation returned by the service.

Throws:

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.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

startConfigurationRecorder

default StartConfigurationRecorderResponse startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest)
                                                               throws NoSuchConfigurationRecorderException,
                                                                      NoAvailableDeliveryChannelException,
                                                                      SdkBaseException,
                                                                      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.

Parameters:

startConfigurationRecorderRequest - The input for the StartConfigurationRecorder action.

Returns:

Result of the StartConfigurationRecorder operation returned by the service.

Throws:

NoSuchConfigurationRecorderException - You have specified a configuration recorder that does not exist.

NoAvailableDeliveryChannelException - There is no delivery channel available to record configurations.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

stopConfigurationRecorder

default StopConfigurationRecorderResponse stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest)
                                                             throws NoSuchConfigurationRecorderException,
                                                                    SdkBaseException,
                                                                    SdkClientException,
                                                                    ConfigException

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Parameters:

stopConfigurationRecorderRequest - The input for the StopConfigurationRecorder action.

Returns:

Result of the StopConfigurationRecorder operation returned by the service.

Throws:

NoSuchConfigurationRecorderException - You have specified a configuration recorder that does not exist.

SdkBaseException - 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 exception for all service exceptions. Unknown exceptions will be thrown as an instance of this type

See Also:

AWS API Documentation

serviceMetadata

static ServiceMetadata serviceMetadata()