@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") 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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
Constructor and Description |
---|
AmazonConfigClient()
Deprecated.
|
AmazonConfigClient(AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AmazonConfigClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AmazonConfigClient(AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AmazonConfigClient(ClientConfiguration clientConfiguration)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
BatchGetAggregateResourceConfigResult |
batchGetAggregateResourceConfig(BatchGetAggregateResourceConfigRequest request)
Returns the current configuration items for resources that are present in your AWS Config aggregator.
|
BatchGetResourceConfigResult |
batchGetResourceConfig(BatchGetResourceConfigRequest request)
Returns the current configuration for one or more requested resources.
|
static AmazonConfigClientBuilder |
builder() |
DeleteAggregationAuthorizationResult |
deleteAggregationAuthorization(DeleteAggregationAuthorizationRequest request)
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
|
DeleteConfigRuleResult |
deleteConfigRule(DeleteConfigRuleRequest request)
Deletes the specified AWS Config rule and all of its evaluation results.
|
DeleteConfigurationAggregatorResult |
deleteConfigurationAggregator(DeleteConfigurationAggregatorRequest request)
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
|
DeleteConfigurationRecorderResult |
deleteConfigurationRecorder(DeleteConfigurationRecorderRequest request)
Deletes the configuration recorder.
|
DeleteDeliveryChannelResult |
deleteDeliveryChannel(DeleteDeliveryChannelRequest request)
Deletes the delivery channel.
|
DeleteEvaluationResultsResult |
deleteEvaluationResults(DeleteEvaluationResultsRequest request)
Deletes the evaluation results for the specified AWS Config rule.
|
DeleteOrganizationConfigRuleResult |
deleteOrganizationConfigRule(DeleteOrganizationConfigRuleRequest request) |
DeletePendingAggregationRequestResult |
deletePendingAggregationRequest(DeletePendingAggregationRequestRequest request)
Deletes pending authorization requests for a specified aggregator account in a specified region.
|
DeleteRemediationConfigurationResult |
deleteRemediationConfiguration(DeleteRemediationConfigurationRequest request)
Deletes the remediation configuration.
|
DeleteRetentionConfigurationResult |
deleteRetentionConfiguration(DeleteRetentionConfigurationRequest request)
Deletes the retention configuration.
|
DeliverConfigSnapshotResult |
deliverConfigSnapshot(DeliverConfigSnapshotRequest request)
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.
|
DescribeAggregateComplianceByConfigRulesResult |
describeAggregateComplianceByConfigRules(DescribeAggregateComplianceByConfigRulesRequest request)
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant
rules.
|
DescribeAggregationAuthorizationsResult |
describeAggregationAuthorizations(DescribeAggregationAuthorizationsRequest request)
Returns a list of authorizations granted to various aggregator accounts and regions.
|
DescribeComplianceByConfigRuleResult |
describeComplianceByConfigRule()
Simplified method form for invoking the DescribeComplianceByConfigRule operation.
|
DescribeComplianceByConfigRuleResult |
describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest request)
Indicates whether the specified AWS Config rules are compliant.
|
DescribeComplianceByResourceResult |
describeComplianceByResource()
Simplified method form for invoking the DescribeComplianceByResource operation.
|
DescribeComplianceByResourceResult |
describeComplianceByResource(DescribeComplianceByResourceRequest request)
Indicates whether the specified AWS resources are compliant.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus()
Simplified method form for invoking the DescribeConfigRuleEvaluationStatus operation.
|
DescribeConfigRuleEvaluationStatusResult |
describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest request)
Returns status information for each of your AWS managed Config rules.
|
DescribeConfigRulesResult |
describeConfigRules()
Simplified method form for invoking the DescribeConfigRules operation.
|
DescribeConfigRulesResult |
describeConfigRules(DescribeConfigRulesRequest request)
Returns details about your AWS Config rules.
|
DescribeConfigurationAggregatorsResult |
describeConfigurationAggregators(DescribeConfigurationAggregatorsRequest request)
Returns the details of one or more configuration aggregators.
|
DescribeConfigurationAggregatorSourcesStatusResult |
describeConfigurationAggregatorSourcesStatus(DescribeConfigurationAggregatorSourcesStatusRequest request)
Returns status information for sources within an aggregator.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders()
Simplified method form for invoking the DescribeConfigurationRecorders operation.
|
DescribeConfigurationRecordersResult |
describeConfigurationRecorders(DescribeConfigurationRecordersRequest request)
Returns the details for the specified configuration recorders.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus()
Simplified method form for invoking the DescribeConfigurationRecorderStatus operation.
|
DescribeConfigurationRecorderStatusResult |
describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest request)
Returns the current status of the specified configuration recorder.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels()
Simplified method form for invoking the DescribeDeliveryChannels operation.
|
DescribeDeliveryChannelsResult |
describeDeliveryChannels(DescribeDeliveryChannelsRequest request)
Returns details about the specified delivery channel.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus()
Simplified method form for invoking the DescribeDeliveryChannelStatus operation.
|
DescribeDeliveryChannelStatusResult |
describeDeliveryChannelStatus(DescribeDeliveryChannelStatusRequest request)
Returns the current status of the specified delivery channel.
|
DescribeOrganizationConfigRulesResult |
describeOrganizationConfigRules(DescribeOrganizationConfigRulesRequest request) |
DescribeOrganizationConfigRuleStatusesResult |
describeOrganizationConfigRuleStatuses(DescribeOrganizationConfigRuleStatusesRequest request) |
DescribePendingAggregationRequestsResult |
describePendingAggregationRequests(DescribePendingAggregationRequestsRequest request)
Returns a list of all pending aggregation requests.
|
DescribeRemediationConfigurationsResult |
describeRemediationConfigurations(DescribeRemediationConfigurationsRequest request)
Returns the details of one or more remediation configurations.
|
DescribeRemediationExecutionStatusResult |
describeRemediationExecutionStatus(DescribeRemediationExecutionStatusRequest request)
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when
steps for the remediation execution occur, and any error messages for steps that have failed.
|
DescribeRetentionConfigurationsResult |
describeRetentionConfigurations(DescribeRetentionConfigurationsRequest request)
Returns the details of one or more retention configurations.
|
GetAggregateComplianceDetailsByConfigRuleResult |
getAggregateComplianceDetailsByConfigRule(GetAggregateComplianceDetailsByConfigRuleRequest request)
Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule.
|
GetAggregateConfigRuleComplianceSummaryResult |
getAggregateConfigRuleComplianceSummary(GetAggregateConfigRuleComplianceSummaryRequest request)
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
|
GetAggregateDiscoveredResourceCountsResult |
getAggregateDiscoveredResourceCounts(GetAggregateDiscoveredResourceCountsRequest request)
Returns the resource counts across accounts and regions that are present in your AWS Config aggregator.
|
GetAggregateResourceConfigResult |
getAggregateResourceConfig(GetAggregateResourceConfigRequest request)
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful, request, typically used for debugging issues
where a service isn't acting as expected.
|
GetComplianceDetailsByConfigRuleResult |
getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest request)
Returns the evaluation results for the specified AWS Config rule.
|
GetComplianceDetailsByResourceResult |
getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest request)
Returns the evaluation results for the specified AWS resource.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule()
Simplified method form for invoking the GetComplianceSummaryByConfigRule operation.
|
GetComplianceSummaryByConfigRuleResult |
getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest request)
Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
|
GetComplianceSummaryByResourceTypeResult |
getComplianceSummaryByResourceType()
Simplified method form for invoking the GetComplianceSummaryByResourceType operation.
|
GetComplianceSummaryByResourceTypeResult |
getComplianceSummaryByResourceType(GetComplianceSummaryByResourceTypeRequest request)
Returns the number of resources that are compliant and the number that are noncompliant.
|
GetDiscoveredResourceCountsResult |
getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest request)
Returns the resource types, the number of each resource type, and the total number of resources that AWS Config
is recording in this region for your AWS account.
|
GetOrganizationConfigRuleDetailedStatusResult |
getOrganizationConfigRuleDetailedStatus(GetOrganizationConfigRuleDetailedStatusRequest request) |
GetResourceConfigHistoryResult |
getResourceConfigHistory(GetResourceConfigHistoryRequest request)
Returns a list of configuration items for the specified resource.
|
ListAggregateDiscoveredResourcesResult |
listAggregateDiscoveredResources(ListAggregateDiscoveredResourcesRequest request)
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource
type across accounts and regions.
|
ListDiscoveredResourcesResult |
listDiscoveredResources(ListDiscoveredResourcesRequest request)
Accepts a resource type and returns a list of resource identifiers for the resources of that type.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
List the tags for AWS Config resource.
|
PutAggregationAuthorizationResult |
putAggregationAuthorization(PutAggregationAuthorizationRequest request)
Authorizes the aggregator account and region to collect data from the source account and region.
|
PutConfigRuleResult |
putConfigRule(PutConfigRuleRequest request)
Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired
configurations.
|
PutConfigurationAggregatorResult |
putConfigurationAggregator(PutConfigurationAggregatorRequest request)
Creates and updates the configuration aggregator with the selected source accounts and regions.
|
PutConfigurationRecorderResult |
putConfigurationRecorder(PutConfigurationRecorderRequest request)
Creates a new configuration recorder to record the selected resource configurations.
|
PutDeliveryChannelResult |
putDeliveryChannel(PutDeliveryChannelRequest request)
Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS
topic.
|
PutEvaluationsResult |
putEvaluations(PutEvaluationsRequest request)
Used by an AWS Lambda function to deliver evaluation results to AWS Config.
|
PutOrganizationConfigRuleResult |
putOrganizationConfigRule(PutOrganizationConfigRuleRequest request) |
PutRemediationConfigurationsResult |
putRemediationConfigurations(PutRemediationConfigurationsRequest request)
Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action.
|
PutRetentionConfigurationResult |
putRetentionConfiguration(PutRetentionConfigurationRequest request)
Creates and updates the retention configuration with details about retention period (number of days) that AWS
Config stores your historical information.
|
SelectResourceConfigResult |
selectResourceConfig(SelectResourceConfigRequest request)
Accepts a structured query language (SQL)
SELECT command, performs the corresponding search, and
returns resource configurations matching the properties. |
StartConfigRulesEvaluationResult |
startConfigRulesEvaluation(StartConfigRulesEvaluationRequest request)
Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the
resources.
|
StartConfigurationRecorderResult |
startConfigurationRecorder(StartConfigurationRecorderRequest request)
Starts recording configurations of the AWS resources you have selected to record in your AWS account.
|
StartRemediationExecutionResult |
startRemediationExecution(StartRemediationExecutionRequest request)
Runs an on-demand remediation for the specified AWS Config rules against the last known remediation
configuration.
|
StopConfigurationRecorderResult |
stopConfigurationRecorder(StopConfigurationRecorderRequest request)
Stops recording configurations of the AWS resources you have selected to record in your AWS account.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Associates the specified tags to a resource with the specified resourceArn.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Deletes specified tags from a resource.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withEndpoint, withRegion, withRegion, withTimeOffset
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
setEndpoint, setRegion, shutdown
@Deprecated public AmazonConfigClient()
AmazonConfigClientBuilder.defaultClient()
All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain
@Deprecated public AmazonConfigClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(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
@Deprecated public AmazonConfigClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
for example:
AmazonConfigClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();
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.@Deprecated public AmazonConfigClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(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.@Deprecated public AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(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.).@Deprecated public AmazonConfigClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider)
and
AwsClientBuilder.withClientConfiguration(ClientConfiguration)
and
AwsClientBuilder.withMetricsCollector(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 static AmazonConfigClientBuilder builder()
public BatchGetAggregateResourceConfigResult batchGetAggregateResourceConfig(BatchGetAggregateResourceConfigRequest request)
Returns the current configuration items for resources that are present in your AWS Config aggregator. The
operation also returns a list of resources that are not processed in the current request. If there are no
unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers
list.
The API does not return results for deleted resources.
The API does not return tags and relationships.
batchGetAggregateResourceConfig
in interface AmazonConfig
batchGetAggregateResourceConfigRequest
- ValidationException
- The requested action is not valid.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.public BatchGetResourceConfigResult batchGetResourceConfig(BatchGetResourceConfigRequest request)
Returns the current configuration for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list.
The API does not return results for deleted resources.
The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.
batchGetResourceConfig
in interface AmazonConfig
batchGetResourceConfigRequest
- ValidationException
- The requested action is not valid.NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.public DeleteAggregationAuthorizationResult deleteAggregationAuthorization(DeleteAggregationAuthorizationRequest request)
Deletes the authorization granted to the specified configuration aggregator account in a specified region.
deleteAggregationAuthorization
in interface AmazonConfig
deleteAggregationAuthorizationRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.public DeleteConfigRuleResult deleteConfigRule(DeleteConfigRuleRequest request)
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.
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 or the rule is deleting your evaluation results. Try your request
again later.public DeleteConfigurationAggregatorResult deleteConfigurationAggregator(DeleteConfigurationAggregatorRequest request)
Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
deleteConfigurationAggregator
in interface AmazonConfig
deleteConfigurationAggregatorRequest
- NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.public DeleteConfigurationRecorderResult deleteConfigurationRecorder(DeleteConfigurationRecorderRequest request)
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.
deleteConfigurationRecorder
in interface AmazonConfig
deleteConfigurationRecorderRequest
- The request object for the DeleteConfigurationRecorder
action.NoSuchConfigurationRecorderException
- You have specified a configuration recorder that does not exist.public DeleteDeliveryChannelResult deleteDeliveryChannel(DeleteDeliveryChannelRequest request)
Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by 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 DeleteEvaluationResultsResult deleteEvaluationResults(DeleteEvaluationResultsRequest request)
Deletes the evaluation results for the specified AWS Config rule. You can specify one AWS Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule.
deleteEvaluationResults
in interface AmazonConfig
deleteEvaluationResultsRequest
- NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.public DeleteOrganizationConfigRuleResult deleteOrganizationConfigRule(DeleteOrganizationConfigRuleRequest request)
deleteOrganizationConfigRule
in interface AmazonConfig
deleteOrganizationConfigRuleRequest
- NoSuchOrganizationConfigRuleException
ResourceInUseException
- The rule is currently being deleted or the rule is deleting your evaluation results. Try your request
again later.OrganizationAccessDeniedException
- No permission to call the EnableAWSServiceAccess API.public DeletePendingAggregationRequestResult deletePendingAggregationRequest(DeletePendingAggregationRequestRequest request)
Deletes pending authorization requests for a specified aggregator account in a specified region.
deletePendingAggregationRequest
in interface AmazonConfig
deletePendingAggregationRequestRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.public DeleteRemediationConfigurationResult deleteRemediationConfiguration(DeleteRemediationConfigurationRequest request)
Deletes the remediation configuration.
deleteRemediationConfiguration
in interface AmazonConfig
deleteRemediationConfigurationRequest
- NoSuchRemediationConfigurationException
- You specified an AWS Config rule without a remediation configuration.RemediationInProgressException
public DeleteRetentionConfigurationResult deleteRetentionConfiguration(DeleteRetentionConfigurationRequest request)
Deletes the retention configuration.
deleteRetentionConfiguration
in interface AmazonConfig
deleteRetentionConfigurationRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.NoSuchRetentionConfigurationException
- You have specified a retention configuration that does not exist.public DeliverConfigSnapshotResult deliverConfigSnapshot(DeliverConfigSnapshotRequest request)
Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends the following notifications using an Amazon SNS topic that you have specified.
Notification of the start of the delivery.
Notification of the completion of the delivery, if the delivery was successfully completed.
Notification of delivery failure, if the delivery failed.
deliverConfigSnapshot
in interface 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 DescribeAggregateComplianceByConfigRulesResult describeAggregateComplianceByConfigRules(DescribeAggregateComplianceByConfigRulesRequest request)
Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
describeAggregateComplianceByConfigRules
in interface AmazonConfig
describeAggregateComplianceByConfigRulesRequest
- 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.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.public DescribeAggregationAuthorizationsResult describeAggregationAuthorizations(DescribeAggregationAuthorizationsRequest request)
Returns a list of authorizations granted to various aggregator accounts and regions.
describeAggregationAuthorizations
in interface AmazonConfig
describeAggregationAuthorizationsRequest
- 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.InvalidLimitException
- The specified limit is outside the allowable range.public DescribeComplianceByConfigRuleResult describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest request)
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. It is noncompliant if any of these resources do not comply.
If AWS Config has no current evaluation results for the rule, it returns INSUFFICIENT_DATA
. This
result might indicate one of the following conditions:
AWS Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get the LastSuccessfulInvocationTime
and
LastFailedInvocationTime
.
The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role you
assigned to your configuration recorder includes the config:PutEvaluations
permission. If the rule
is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations
permission.
The rule's AWS Lambda function has returned NOT_APPLICABLE
for all evaluation results. This can
occur if the resources were deleted or removed from the rule's scope.
describeComplianceByConfigRule
in interface 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.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 DescribeComplianceByConfigRuleResult describeComplianceByConfigRule()
AmazonConfig
describeComplianceByConfigRule
in interface AmazonConfig
AmazonConfig.describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest)
public DescribeComplianceByResourceResult describeComplianceByResource(DescribeComplianceByResourceRequest request)
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.
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 request)
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.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 DescribeConfigRuleEvaluationStatusResult describeConfigRuleEvaluationStatus()
AmazonConfig
describeConfigRuleEvaluationStatus
in interface AmazonConfig
AmazonConfig.describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest)
public DescribeConfigRulesResult describeConfigRules(DescribeConfigRulesRequest request)
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.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 DescribeConfigRulesResult describeConfigRules()
AmazonConfig
describeConfigRules
in interface AmazonConfig
AmazonConfig.describeConfigRules(DescribeConfigRulesRequest)
public DescribeConfigurationAggregatorSourcesStatusResult describeConfigurationAggregatorSourcesStatus(DescribeConfigurationAggregatorSourcesStatusRequest request)
Returns status information for sources within an aggregator. The status includes information about the last time AWS Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.
describeConfigurationAggregatorSourcesStatus
in interface AmazonConfig
describeConfigurationAggregatorSourcesStatusRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.InvalidNextTokenException
- The specified next token is invalid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidLimitException
- The specified limit is outside the allowable range.public DescribeConfigurationAggregatorsResult describeConfigurationAggregators(DescribeConfigurationAggregatorsRequest request)
Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.
describeConfigurationAggregators
in interface AmazonConfig
describeConfigurationAggregatorsRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.InvalidNextTokenException
- The specified next token is invalid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.InvalidLimitException
- The specified limit is outside the allowable range.public DescribeConfigurationRecorderStatusResult describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest request)
Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
Currently, you can specify only one configuration recorder per region in your account.
describeConfigurationRecorderStatus
in interface 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 request)
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.
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 request)
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.
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 request)
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.
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 DescribeOrganizationConfigRuleStatusesResult describeOrganizationConfigRuleStatuses(DescribeOrganizationConfigRuleStatusesRequest request)
describeOrganizationConfigRuleStatuses
in interface AmazonConfig
describeOrganizationConfigRuleStatusesRequest
- NoSuchOrganizationConfigRuleException
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.OrganizationAccessDeniedException
- No permission to call the EnableAWSServiceAccess API.public DescribeOrganizationConfigRulesResult describeOrganizationConfigRules(DescribeOrganizationConfigRulesRequest request)
describeOrganizationConfigRules
in interface AmazonConfig
describeOrganizationConfigRulesRequest
- NoSuchOrganizationConfigRuleException
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.InvalidLimitException
- The specified limit is outside the allowable range.OrganizationAccessDeniedException
- No permission to call the EnableAWSServiceAccess API.public DescribePendingAggregationRequestsResult describePendingAggregationRequests(DescribePendingAggregationRequestsRequest request)
Returns a list of all pending aggregation requests.
describePendingAggregationRequests
in interface AmazonConfig
describePendingAggregationRequestsRequest
- 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.InvalidLimitException
- The specified limit is outside the allowable range.public DescribeRemediationConfigurationsResult describeRemediationConfigurations(DescribeRemediationConfigurationsRequest request)
Returns the details of one or more remediation configurations.
describeRemediationConfigurations
in interface AmazonConfig
describeRemediationConfigurationsRequest
- public DescribeRemediationExecutionStatusResult describeRemediationExecutionStatus(DescribeRemediationExecutionStatusRequest request)
Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.
describeRemediationExecutionStatus
in interface AmazonConfig
describeRemediationExecutionStatusRequest
- NoSuchRemediationConfigurationException
- You specified an AWS Config rule without a remediation configuration.public DescribeRetentionConfigurationsResult describeRetentionConfigurations(DescribeRetentionConfigurationsRequest request)
Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account.
Currently, AWS Config supports only one retention configuration per region in your account.
describeRetentionConfigurations
in interface AmazonConfig
describeRetentionConfigurationsRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.NoSuchRetentionConfigurationException
- You have specified a retention configuration that does not exist.InvalidNextTokenException
- The specified next token is invalid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.public GetAggregateComplianceDetailsByConfigRuleResult getAggregateComplianceDetailsByConfigRule(GetAggregateComplianceDetailsByConfigRuleRequest request)
Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.
getAggregateComplianceDetailsByConfigRule
in interface AmazonConfig
getAggregateComplianceDetailsByConfigRuleRequest
- 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.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.public GetAggregateConfigRuleComplianceSummaryResult getAggregateConfigRuleComplianceSummary(GetAggregateConfigRuleComplianceSummaryRequest request)
Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
getAggregateConfigRuleComplianceSummary
in interface AmazonConfig
getAggregateConfigRuleComplianceSummaryRequest
- 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.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.public GetAggregateDiscoveredResourceCountsResult getAggregateDiscoveredResourceCounts(GetAggregateDiscoveredResourceCountsRequest request)
Returns the resource counts across accounts and regions that are present in your AWS Config aggregator. You can request the resource counts by providing filters and GroupByKey.
For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.
getAggregateDiscoveredResourceCounts
in interface AmazonConfig
getAggregateDiscoveredResourceCountsRequest
- 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.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.public GetAggregateResourceConfigResult getAggregateResourceConfig(GetAggregateResourceConfigRequest request)
Returns configuration item that is aggregated for your specific resource in a specific source account and region.
getAggregateResourceConfig
in interface AmazonConfig
getAggregateResourceConfigRequest
- ValidationException
- The requested action is not valid.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.OversizedConfigurationItemException
- The configuration item size is outside the allowable range.ResourceNotDiscoveredException
- You have specified a resource that is either unknown or has not been discovered.public GetComplianceDetailsByConfigRuleResult getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest request)
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 request)
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 request)
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 request)
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 GetDiscoveredResourceCountsResult getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest request)
Returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account.
Example
AWS Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets.
You make a call to the GetDiscoveredResourceCounts
action and specify that you want all resource
types.
AWS Config returns the following:
The resource types (EC2 instances, IAM users, and S3 buckets).
The number of each resource type (25, 20, and 15).
The total number of all resources (60).
The response is paginated. By default, AWS Config lists 100 ResourceCount objects on each page. You can
customize this number with the limit
parameter. The response includes a nextToken
string. To get the next page of results, run the request again and specify the string for the
nextToken
parameter.
If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:
You are a new AWS Config customer.
You just enabled resource recording.
It might take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
getDiscoveredResourceCounts
in interface AmazonConfig
getDiscoveredResourceCountsRequest
- ValidationException
- The requested action is not valid.InvalidLimitException
- The specified limit is outside the allowable range.InvalidNextTokenException
- The specified next token is invalid. Specify the nextToken
string that was returned in the
previous response to get the next page of results.public GetOrganizationConfigRuleDetailedStatusResult getOrganizationConfigRuleDetailedStatus(GetOrganizationConfigRuleDetailedStatusRequest request)
getOrganizationConfigRuleDetailedStatus
in interface AmazonConfig
getOrganizationConfigRuleDetailedStatusRequest
- NoSuchOrganizationConfigRuleException
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.OrganizationAccessDeniedException
- No permission to call the EnableAWSServiceAccess API.public GetResourceConfigHistoryResult getResourceConfigHistory(GetResourceConfigHistoryRequest request)
Returns a list of configuration items for the specified resource. The list contains details about each state of
the resource during the specified time interval. If you specified a retention period to retain your
ConfigurationItems
between a minimum of 30 days and a maximum of 7 years (2557 days), AWS Config
returns the ConfigurationItems
for the specified retention period.
The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can
customize this number with the limit
parameter. The response includes a nextToken
string. To get the next page of results, run the request again and specify the string for the
nextToken
parameter.
Each call to the API is limited to span a duration of seven days. It is likely that the number of records
returned is smaller than the specified limit
. In such cases, you can make another call, using the
nextToken
.
getResourceConfigHistory
in interface 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 ListAggregateDiscoveredResourcesResult listAggregateDiscoveredResources(ListAggregateDiscoveredResourcesRequest request)
Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region.
For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type
AWS::EC2::Instance
then the API returns all the EC2 instance identifiers of accountID 12345678910
and region us-east-1.
listAggregateDiscoveredResources
in interface AmazonConfig
listAggregateDiscoveredResourcesRequest
- 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.NoSuchConfigurationAggregatorException
- You have specified a configuration aggregator that does not exist.public ListDiscoveredResourcesResult listDiscoveredResources(ListDiscoveredResourcesRequest request)
Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
You can specify either resource IDs or a resource name, but not both, in the same request.
The response is paginated. By default, AWS Config lists 100 resource identifiers on each page. You can customize
this number with the limit
parameter. The response includes a nextToken
string. To get
the next page of results, run the request again and specify the string for the nextToken
parameter.
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 ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
List the tags for AWS Config resource.
listTagsForResource
in interface AmazonConfig
listTagsForResourceRequest
- ResourceNotFoundException
- You have specified a resource that does not exist.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.public PutAggregationAuthorizationResult putAggregationAuthorization(PutAggregationAuthorizationRequest request)
Authorizes the aggregator account and region to collect data from the source account and region.
putAggregationAuthorization
in interface AmazonConfig
putAggregationAuthorizationRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.public PutConfigRuleResult putConfigRule(PutConfigRuleRequest request)
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 AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.
If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule
invokes to evaluate your resources. When you use the PutConfigRule
action to add the rule to AWS
Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN
for the SourceIdentifier
key. This key is part of the Source
object, which is part of
the ConfigRule
object.
If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier
key. To reference AWS managed Config rule identifiers, see About AWS
Managed Config Rules.
For any new rule that you add, specify the ConfigRuleName
in the ConfigRule
object. Do
not specify the ConfigRuleArn
or the ConfigRuleId
. These values are generated by AWS
Config for new rules.
If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName
,
ConfigRuleId
, or ConfigRuleArn
in the ConfigRule
data type that you use in
this request.
The maximum number of rules that AWS Config supports is 150.
For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide.
For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.
putConfigRule
in interface 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 150 rules.
Consider deleting any deactivated rules before you add 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.public PutConfigurationAggregatorResult putConfigurationAggregator(PutConfigurationAggregatorRequest request)
Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
AWS Config should be enabled in source accounts and regions you want to aggregate.
If your source type is an organization, you must be signed in to the master account and all features must be
enabled in your organization. AWS Config calls EnableAwsServiceAccess
API to enable integration
between AWS Config and AWS Organizations.
putConfigurationAggregator
in interface AmazonConfig
putConfigurationAggregatorRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.LimitExceededException
- For StartConfigRulesEvaluation
API, this exception is thrown if an evaluation is in progress
or if you call the StartConfigRulesEvaluation API more than once per minute.
For PutConfigurationAggregator
API, this exception is thrown if the number of accounts and
aggregators exceeds the limit.
InvalidRoleException
- You have provided a null or empty role ARN.OrganizationAccessDeniedException
- No permission to call the EnableAWSServiceAccess API.NoAvailableOrganizationException
- Organization does is no longer available.OrganizationAllFeaturesNotEnabledException
- The configuration aggregator cannot be created because organization does not have all features enabled.public PutConfigurationRecorderResult putConfigurationRecorder(PutConfigurationRecorderRequest request)
Creates a new configuration recorder to record the selected resource configurations.
You can use this action to change the role roleARN
or the recordingGroup
of an existing
recorder. To change the role, call the action on the existing configuration recorder and specify a role.
Currently, you can specify only one configuration recorder per region in your account.
If ConfigurationRecorder
does not have the recordingGroup parameter specified, the default is
to record all supported resource types.
putConfigurationRecorder
in interface AmazonConfig
putConfigurationRecorderRequest
- The input for the PutConfigurationRecorder action.MaxNumberOfConfigurationRecordersExceededException
- You have reached the limit of 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 might also be incorrectly formatted.public PutDeliveryChannelResult putDeliveryChannel(PutDeliveryChannelRequest request)
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.
putDeliveryChannel
in interface AmazonConfig
putDeliveryChannelRequest
- The input for the PutDeliveryChannel action.MaxNumberOfDeliveryChannelsExceededException
- You have reached the limit of the number of delivery channels you can create.NoAvailableConfigurationRecorderException
- There are no configuration recorders available to provide the role needed to describe your resources.
Create a configuration recorder.InvalidDeliveryChannelNameException
- The specified delivery channel name is not valid.NoSuchBucketException
- The specified Amazon S3 bucket does not exist.InvalidS3KeyPrefixException
- The specified Amazon S3 key prefix is not valid.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 request)
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 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.public PutOrganizationConfigRuleResult putOrganizationConfigRule(PutOrganizationConfigRuleRequest request)
putOrganizationConfigRule
in interface AmazonConfig
putOrganizationConfigRuleRequest
- MaxNumberOfOrganizationConfigRulesExceededException
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.ValidationException
- The requested action is not valid.OrganizationAccessDeniedException
- No permission to call the EnableAWSServiceAccess API.NoAvailableOrganizationException
- Organization does is no longer available.OrganizationAllFeaturesNotEnabledException
- The configuration aggregator cannot be created because organization does not have all features enabled.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.
public PutRemediationConfigurationsResult putRemediationConfigurations(PutRemediationConfigurationsRequest request)
Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action.
The API creates the RemediationConfiguration
object for the AWS Config rule. The AWS Config rule
must already exist for you to add a remediation configuration. The target (SSM document) must exist and have
permissions to use the target.
putRemediationConfigurations
in interface AmazonConfig
putRemediationConfigurationsRequest
- 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.
InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.public PutRetentionConfigurationResult putRetentionConfiguration(PutRetentionConfigurationRequest request)
Creates and updates the retention configuration with details about retention period (number of days) that AWS
Config stores your historical information. The API creates the RetentionConfiguration
object and
names the object as default. When you have a RetentionConfiguration
object named
default, calling the API modifies the default object.
Currently, AWS Config supports only one retention configuration per region in your account.
putRetentionConfiguration
in interface AmazonConfig
putRetentionConfigurationRequest
- InvalidParameterValueException
- One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.MaxNumberOfRetentionConfigurationsExceededException
- Failed to add the retention configuration because a retention configuration with that name already
exists.public SelectResourceConfigResult selectResourceConfig(SelectResourceConfigRequest request)
Accepts a structured query language (SQL) SELECT
command, performs the corresponding search, and
returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the AWS Config Developer Guide.
selectResourceConfig
in interface AmazonConfig
selectResourceConfigRequest
- InvalidExpressionException
- The syntax of the query is incorrect.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.public StartConfigRulesEvaluationResult startConfigRulesEvaluation(StartConfigRulesEvaluationRequest request)
Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the
resources. Use StartConfigRulesEvaluation
when you want to test that a rule you updated is working
as expected. StartConfigRulesEvaluation
does not re-record the latest configuration state for your
resources. It re-runs an evaluation against the last known state of your resources.
You can specify up to 25 AWS Config rules per request.
An existing StartConfigRulesEvaluation
call for the specified rules must complete before you can
call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a
ConfigRuleEvaluationStarted
notification when the evaluation starts.
You don't need to call the StartConfigRulesEvaluation
API to run an evaluation for a new rule. When
you create a rule, AWS Config evaluates your resources against the rule automatically.
The StartConfigRulesEvaluation
API is useful if you want to run on-demand evaluations, such as the
following example:
You have a custom rule that evaluates your IAM resources every 24 hours.
You update your Lambda function to add additional conditions to your rule.
Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation
API.
AWS Config invokes your Lambda function and evaluates your IAM resources.
Your custom rule will still run periodic evaluations every 24 hours.
startConfigRulesEvaluation
in interface AmazonConfig
startConfigRulesEvaluationRequest
- NoSuchConfigRuleException
- One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try
again.LimitExceededException
- For StartConfigRulesEvaluation
API, this exception is thrown if an evaluation is in progress
or if you call the StartConfigRulesEvaluation API more than once per minute.
For PutConfigurationAggregator
API, this exception is thrown if the number of accounts and
aggregators exceeds the limit.
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.public StartConfigurationRecorderResult startConfigurationRecorder(StartConfigurationRecorderRequest request)
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 StartRemediationExecutionResult startRemediationExecution(StartRemediationExecutionRequest request)
Runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous.
You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.
startRemediationExecution
in interface AmazonConfig
startRemediationExecutionRequest
- 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.
NoSuchRemediationConfigurationException
- You specified an AWS Config rule without a remediation configuration.public StopConfigurationRecorderResult stopConfigurationRecorder(StopConfigurationRecorderRequest request)
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 TagResourceResult tagResource(TagResourceRequest request)
Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.
tagResource
in interface AmazonConfig
tagResourceRequest
- ValidationException
- The requested action is not valid.ResourceNotFoundException
- You have specified a resource that does not exist.TooManyTagsException
- You have reached the limit of the number of tags you can use. You have more than 50 tags.public UntagResourceResult untagResource(UntagResourceRequest request)
Deletes specified tags from a resource.
untagResource
in interface AmazonConfig
untagResourceRequest
- ValidationException
- The requested action is not valid.ResourceNotFoundException
- You have specified a resource 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 © 2013 Amazon Web Services, Inc. All Rights Reserved.