public class AmazonConfigClient extends AmazonWebServiceClient implements AmazonConfig
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 |
---|---|
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> |
jsonErrorUnmarshallers
List of exception unmarshallers for all Config Service exceptions.
|
client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset
Constructor and Description |
---|
AmazonConfigClient()
Constructs a new client to invoke service methods on Config Service.
|
AmazonConfigClient(AWSCredentials awsCredentials)
Constructs a new client to invoke service methods on Config Service using
the specified AWS account credentials.
|
AmazonConfigClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Config Service using
the specified AWS account credentials and client configuration options.
|
AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider)
Constructs a new client to invoke service methods on Config Service using
the specified AWS account credentials provider.
|
AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Config Service using
the specified AWS account credentials provider and client configuration
options.
|
AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
Constructs a new client to invoke service methods on Config Service using
the specified AWS account credentials provider, client configuration
options, and request metric collector.
|
AmazonConfigClient(ClientConfiguration clientConfiguration)
Constructs a new client to invoke service methods on Config Service.
|
Modifier and Type | Method and Description |
---|---|
void |
deleteConfigRule(DeleteConfigRuleRequest deleteConfigRuleRequest)
Deletes the specified AWS Config rule and all of its evaluation results.
|
void |
deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest)
Deletes the specified delivery channel.
|
DeliverConfigSnapshotResult |
deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest)
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in
the specified delivery channel.
|
DescribeComplianceByConfigRuleResult |
describeComplianceByConfigRule()
Simplified method form for invoking the DescribeComplianceByConfigRule
operation.
|
DescribeComplianceByConfigRuleResult |
describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest)
Indicates whether the specified AWS Config rules are compliant.
|
DescribeComplianceByResourceResult |
describeComplianceByResource()
Simplified method form for invoking the DescribeComplianceByResource
operation.
|
DescribeComplianceByResourceResult |
describeComplianceByResource(DescribeComplianceByResourceRequest describeComplianceByResourceRequest)
Indicates whether the specified AWS resources are compliant.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus()
Simplified method form for invoking the
DescribeConfigRuleEvaluationStatus operation.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest)
Returns status information for each of your AWS managed Config rules.
|
DescribeConfigRulesResult |
describeConfigRules()
Simplified method form for invoking the DescribeConfigRules operation.
|
DescribeConfigRulesResult |
describeConfigRules(DescribeConfigRulesRequest describeConfigRulesRequest)
Returns details about your AWS Config rules.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders()
Simplified method form for invoking the DescribeConfigurationRecorders
operation.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest)
Returns the name of one or more specified configuration recorders.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus()
Simplified method form for invoking the
DescribeConfigurationRecorderStatus operation.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest)
Returns the current status of the specified configuration recorder.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels()
Simplified method form for invoking the DescribeDeliveryChannels
operation.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest)
Returns details about the specified delivery channel.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus()
Simplified method form for invoking the DescribeDeliveryChannelStatus
operation.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest)
Returns the current status of the specified delivery channel.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful,
request, typically used for debugging issues where a service isn't acting
as expected.
|
GetComplianceDetailsByConfigRuleResult |
getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest)
Returns the evaluation results for the specified AWS Config rule.
|
GetComplianceDetailsByResourceResult |
getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest)
Returns the evaluation results for the specified AWS resource.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule()
Simplified method form for invoking the GetComplianceSummaryByConfigRule
operation.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest getComplianceSummaryByConfigRuleRequest)
Returns the number of AWS Config rules that are compliant and
noncompliant, up to a maximum of 25 for each.
|
GetComplianceSummaryByResourceTypeResult |
getComplianceSummaryByResourceType()
Simplified method form for invoking the
GetComplianceSummaryByResourceType operation.
|
GetComplianceSummaryByResourceTypeResult |
getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest getComplianceSummaryByResourceTypeRequest)
Returns the number of resources that are compliant and the number that
are noncompliant.
|
GetResourceConfigHistoryResult |
getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)
Returns a list of configuration items for the specified resource.
|
ListDiscoveredResourcesResult |
listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
Accepts a resource type and returns a list of resource identifiers for
the resources of that type.
|
void |
putConfigRule(PutConfigRuleRequest putConfigRuleRequest)
Adds or updates an AWS Config rule for evaluating whether your AWS
resources comply with your desired configurations.
|
void |
putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest)
Creates a new configuration recorder to record the selected resource
configurations.
|
void |
putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest)
Creates a new delivery channel object to deliver the configuration
information to an Amazon S3 bucket, and to an Amazon SNS topic.
|
PutEvaluationsResult |
putEvaluations(PutEvaluationsRequest putEvaluationsRequest)
Used by an AWS Lambda function to deliver evaluation results to AWS
Config.
|
void |
startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest)
Starts recording configurations of the AWS resources you have selected to
record in your AWS account.
|
void |
stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest)
Stops recording configurations of the AWS resources you have selected to
record in your AWS account.
|
addRequestHandler, addRequestHandler, beforeMarshalling, configSigner, configSigner, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
protected List<com.amazonaws.transform.JsonErrorUnmarshallerV2> jsonErrorUnmarshallers
public AmazonConfigClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
public AmazonConfigClient(ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
clientConfiguration
- The client configuration options controlling how this client
connects to Config Service (ex: proxy settings, retry counts,
etc.).DefaultAWSCredentialsProviderChain
public AmazonConfigClient(AWSCredentials awsCredentials)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.public AmazonConfigClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentials
- The AWS credentials (access key ID and secret key) to use when
authenticating with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Config Service (ex: proxy settings, retry counts,
etc.).public AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.public AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Config Service (ex: proxy settings, retry counts,
etc.).public AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
All service calls made using this new client object are blocking, and will not return until the service call completes.
awsCredentialsProvider
- The AWS credentials provider which will provide credentials to
authenticate requests with AWS services.clientConfiguration
- The client configuration options controlling how this client
connects to Config Service (ex: proxy settings, retry counts,
etc.).requestMetricCollector
- optional request metric collectorpublic void deleteConfigRule(DeleteConfigRuleRequest deleteConfigRuleRequest)
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
request for the rule, you will
receive a ResourceInUseException
.
You can check the state of a rule by using the
DescribeConfigRules
request.
deleteConfigRule
in interface AmazonConfig
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. Wait for a while and try
again.public void deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest)
Deletes the specified delivery channel.
The delivery channel cannot be deleted if it is the only delivery channel and the configuration recorder is still running. To delete the delivery channel, stop the running configuration recorder using the StopConfigurationRecorder action.
deleteDeliveryChannel
in interface AmazonConfig
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.public DeliverConfigSnapshotResult deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest)
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.
deliverConfigSnapshot
in interface AmazonConfig
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.public DescribeComplianceByConfigRuleResult describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest)
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
InsufficientData
. This result might indicate one of the
following conditions:
DescribeConfigRuleEvaluationStatus
action to get the LastSuccessfulInvocationTime
and
LastFailedInvocationTime
.config:PutEvaluations
permission. If the rule is a customer managed rule, verify that the AWS
Lambda execution role includes the config:PutEvaluations
permission.NOT_APPLICABLE
for all evaluation results. This can occur if
the resources were deleted or removed from the rule's scope.describeComplianceByConfigRule
in interface AmazonConfig
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.public DescribeComplianceByConfigRuleResult describeComplianceByConfigRule()
AmazonConfig
describeComplianceByConfigRule
in interface AmazonConfig
AmazonConfig.describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest)
public DescribeComplianceByResourceResult describeComplianceByResource(DescribeComplianceByResourceRequest describeComplianceByResourceRequest)
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 InsufficientData
. This result might indicate one of
the following conditions about the rules that evaluate the resource:
DescribeConfigRuleEvaluationStatus
action to get the LastSuccessfulInvocationTime
and
LastFailedInvocationTime
.config:PutEvaluations
permission. If the rule is a customer managed rule, verify that the AWS
Lambda execution role includes the config:PutEvaluations
permission.NOT_APPLICABLE
for all evaluation results. This can occur if
the resources were deleted or removed from the rule's scope.describeComplianceByResource
in interface AmazonConfig
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.public DescribeComplianceByResourceResult describeComplianceByResource()
AmazonConfig
describeComplianceByResource
in interface AmazonConfig
AmazonConfig.describeComplianceByResource(DescribeComplianceByResourceRequest)
public DescribeConfigRuleEvaluationStatusResult describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest)
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.
describeConfigRuleEvaluationStatus
in interface AmazonConfig
describeConfigRuleEvaluationStatusRequest
- NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify
that the rule names are correct and try again.public DescribeConfigRuleEvaluationStatusResult describeConfigRuleEvaluationStatus()
AmazonConfig
describeConfigRuleEvaluationStatus
in interface AmazonConfig
AmazonConfig.describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest)
public DescribeConfigRulesResult describeConfigRules(DescribeConfigRulesRequest describeConfigRulesRequest)
Returns details about your AWS Config rules.
describeConfigRules
in interface AmazonConfig
describeConfigRulesRequest
- NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify
that the rule names are correct and try again.public DescribeConfigRulesResult describeConfigRules()
AmazonConfig
describeConfigRules
in interface AmazonConfig
AmazonConfig.describeConfigRules(DescribeConfigRulesRequest)
public DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest)
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.
describeConfigurationRecorderStatus
in interface AmazonConfig
describeConfigurationRecorderStatusRequest
- The input for the DescribeConfigurationRecorderStatus
action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.public DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus()
AmazonConfig
describeConfigurationRecorderStatus
in interface AmazonConfig
AmazonConfig.describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest)
public DescribeConfigurationRecordersResult describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest)
Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.
Currently, you can specify only one configuration recorder per account.
describeConfigurationRecorders
in interface AmazonConfig
describeConfigurationRecordersRequest
- The input for the DescribeConfigurationRecorders action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.public DescribeConfigurationRecordersResult describeConfigurationRecorders()
AmazonConfig
describeConfigurationRecorders
in interface AmazonConfig
AmazonConfig.describeConfigurationRecorders(DescribeConfigurationRecordersRequest)
public DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest)
Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
describeDeliveryChannelStatus
in interface AmazonConfig
describeDeliveryChannelStatusRequest
- The input for the DeliveryChannelStatus action.NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.public DescribeDeliveryChannelStatusResult describeDeliveryChannelStatus()
AmazonConfig
describeDeliveryChannelStatus
in interface AmazonConfig
AmazonConfig.describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest)
public DescribeDeliveryChannelsResult describeDeliveryChannels(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest)
Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
Currently, you can specify only one delivery channel per account.
describeDeliveryChannels
in interface AmazonConfig
describeDeliveryChannelsRequest
- The input for the DescribeDeliveryChannels action.NoSuchDeliveryChannelException
- You have specified a delivery channel that does not exist.public DescribeDeliveryChannelsResult describeDeliveryChannels()
AmazonConfig
describeDeliveryChannels
in interface AmazonConfig
AmazonConfig.describeDeliveryChannels(DescribeDeliveryChannelsRequest)
public GetComplianceDetailsByConfigRuleResult getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest)
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.
getComplianceDetailsByConfigRule
in interface AmazonConfig
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.public GetComplianceDetailsByResourceResult getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest)
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.
getComplianceDetailsByResource
in interface AmazonConfig
getComplianceDetailsByResourceRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that
your parameters are valid and try again.public GetComplianceSummaryByConfigRuleResult getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest getComplianceSummaryByConfigRuleRequest)
Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
getComplianceSummaryByConfigRule
in interface AmazonConfig
getComplianceSummaryByConfigRuleRequest
- public GetComplianceSummaryByConfigRuleResult getComplianceSummaryByConfigRule()
AmazonConfig
getComplianceSummaryByConfigRule
in interface AmazonConfig
AmazonConfig.getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest)
public GetComplianceSummaryByResourceTypeResult getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest getComplianceSummaryByResourceTypeRequest)
Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.
getComplianceSummaryByResourceType
in interface AmazonConfig
getComplianceSummaryByResourceTypeRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that
your parameters are valid and try again.public GetComplianceSummaryByResourceTypeResult getComplianceSummaryByResourceType()
AmazonConfig
getComplianceSummaryByResourceType
in interface AmazonConfig
AmazonConfig.getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest)
public GetResourceConfigHistoryResult getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)
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
.
getResourceConfigHistory
in interface AmazonConfig
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.public ListDiscoveredResourcesResult listDiscoveredResources(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that 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.
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.
listDiscoveredResources
in interface AmazonConfig
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.public void putConfigRule(PutConfigRuleRequest putConfigRuleRequest)
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
You can use this action for customer managed Config rules and AWS managed Config rules. A customer managed Config rule is a custom rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that is provided by AWS Config.
If you are adding a new customer managed 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 a new AWS managed Config rule, specify the rule's
identifier for the SourceIdentifier
key. To reference AWS
managed Config rule identifiers, see Using 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 have added previously, specify the
rule's 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 25.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
putConfigRule
in interface AmazonConfig
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 25 rules. Consider deleting any
deactivated rules before adding new rules.ResourceInUseException
- The rule is currently being deleted. Wait for a while and try
again.InsufficientPermissionsException
- Indicates one of the following errors:
public void putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest)
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 account.
If ConfigurationRecorder
does not have the
recordingGroup parameter specified, the default is to record all
supported resource types.
putConfigurationRecorder
in interface AmazonConfig
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.public void putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest)
Creates a new delivery channel object to deliver the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.
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.
Currently, you can specify only one delivery channel per account.
putDeliveryChannel
in interface AmazonConfig
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.public PutEvaluationsResult putEvaluations(PutEvaluationsRequest putEvaluationsRequest)
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.
putEvaluations
in interface AmazonConfig
putEvaluationsRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that
your parameters are valid and try again.InvalidResultTokenException
- The result token is invalid.NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify
that the rule names are correct and try again.public void startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest)
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.
startConfigurationRecorder
in interface AmazonConfig
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.public void stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest)
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
stopConfigurationRecorder
in interface AmazonConfig
stopConfigurationRecorderRequest
- The input for the StopConfigurationRecorder action.
NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.
getCachedResponseMetadata
in interface AmazonConfig
request
- The originally executed requestCopyright © 2016. All rights reserved.