Interface ConfigAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any
invalid reference
SdkAsyncHttpClient
Config provides a way to keep track of the configurations of all the Amazon Web Services resources associated with your Amazon Web Services account. You can use Config to get the current and historical configurations of each Amazon Web Services resource and also to get information about the relationship between the resources. An Amazon Web Services 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 Config, see Supported Amazon Web Services resources.
You can access and manage Config through the Amazon Web Services Management Console, the Amazon Web Services Command Line Interface (Amazon Web Services CLI), the Config API, or the Amazon Web Services SDKs for Config. This reference guide contains documentation for the Config API and the Amazon Web Services CLI commands that you can use to manage Config. The 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 Config features and their associated actions or commands, as well as how to work with Amazon Web Services Management Console, see What Is Config in the Config Developer Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbatchGetAggregateResourceConfig
(Consumer<BatchGetAggregateResourceConfigRequest.Builder> batchGetAggregateResourceConfigRequest) Returns the current configuration items for resources that are present in your Config aggregator.batchGetAggregateResourceConfig
(BatchGetAggregateResourceConfigRequest batchGetAggregateResourceConfigRequest) Returns the current configuration items for resources that are present in your Config aggregator.batchGetResourceConfig
(Consumer<BatchGetResourceConfigRequest.Builder> batchGetResourceConfigRequest) Returns theBaseConfigurationItem
for one or more requested resources.batchGetResourceConfig
(BatchGetResourceConfigRequest batchGetResourceConfigRequest) Returns theBaseConfigurationItem
for one or more requested resources.static ConfigAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aConfigAsyncClient
.static ConfigAsyncClient
create()
Create aConfigAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.deleteAggregationAuthorization
(Consumer<DeleteAggregationAuthorizationRequest.Builder> deleteAggregationAuthorizationRequest) Deletes the authorization granted to the specified configuration aggregator account in a specified region.deleteAggregationAuthorization
(DeleteAggregationAuthorizationRequest deleteAggregationAuthorizationRequest) Deletes the authorization granted to the specified configuration aggregator account in a specified region.deleteConfigRule
(Consumer<DeleteConfigRuleRequest.Builder> deleteConfigRuleRequest) Deletes the specified Config rule and all of its evaluation results.deleteConfigRule
(DeleteConfigRuleRequest deleteConfigRuleRequest) Deletes the specified Config rule and all of its evaluation results.deleteConfigurationAggregator
(Consumer<DeleteConfigurationAggregatorRequest.Builder> deleteConfigurationAggregatorRequest) Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.deleteConfigurationAggregator
(DeleteConfigurationAggregatorRequest deleteConfigurationAggregatorRequest) Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.deleteConfigurationRecorder
(Consumer<DeleteConfigurationRecorderRequest.Builder> deleteConfigurationRecorderRequest) Deletes the configuration recorder.deleteConfigurationRecorder
(DeleteConfigurationRecorderRequest deleteConfigurationRecorderRequest) Deletes the configuration recorder.deleteConformancePack
(Consumer<DeleteConformancePackRequest.Builder> deleteConformancePackRequest) Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.deleteConformancePack
(DeleteConformancePackRequest deleteConformancePackRequest) Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.deleteDeliveryChannel
(Consumer<DeleteDeliveryChannelRequest.Builder> deleteDeliveryChannelRequest) Deletes the delivery channel.deleteDeliveryChannel
(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest) Deletes the delivery channel.deleteEvaluationResults
(Consumer<DeleteEvaluationResultsRequest.Builder> deleteEvaluationResultsRequest) Deletes the evaluation results for the specified Config rule.deleteEvaluationResults
(DeleteEvaluationResultsRequest deleteEvaluationResultsRequest) Deletes the evaluation results for the specified Config rule.deleteOrganizationConfigRule
(Consumer<DeleteOrganizationConfigRuleRequest.Builder> deleteOrganizationConfigRuleRequest) Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.deleteOrganizationConfigRule
(DeleteOrganizationConfigRuleRequest deleteOrganizationConfigRuleRequest) Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.deleteOrganizationConformancePack
(Consumer<DeleteOrganizationConformancePackRequest.Builder> deleteOrganizationConformancePackRequest) Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.deleteOrganizationConformancePack
(DeleteOrganizationConformancePackRequest deleteOrganizationConformancePackRequest) Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.deletePendingAggregationRequest
(Consumer<DeletePendingAggregationRequestRequest.Builder> deletePendingAggregationRequestRequest) Deletes pending authorization requests for a specified aggregator account in a specified region.deletePendingAggregationRequest
(DeletePendingAggregationRequestRequest deletePendingAggregationRequestRequest) Deletes pending authorization requests for a specified aggregator account in a specified region.deleteRemediationConfiguration
(Consumer<DeleteRemediationConfigurationRequest.Builder> deleteRemediationConfigurationRequest) Deletes the remediation configuration.deleteRemediationConfiguration
(DeleteRemediationConfigurationRequest deleteRemediationConfigurationRequest) Deletes the remediation configuration.deleteRemediationExceptions
(Consumer<DeleteRemediationExceptionsRequest.Builder> deleteRemediationExceptionsRequest) Deletes one or more remediation exceptions mentioned in the resource keys.deleteRemediationExceptions
(DeleteRemediationExceptionsRequest deleteRemediationExceptionsRequest) Deletes one or more remediation exceptions mentioned in the resource keys.deleteResourceConfig
(Consumer<DeleteResourceConfigRequest.Builder> deleteResourceConfigRequest) Records the configuration state for a custom resource that has been deleted.deleteResourceConfig
(DeleteResourceConfigRequest deleteResourceConfigRequest) Records the configuration state for a custom resource that has been deleted.deleteRetentionConfiguration
(Consumer<DeleteRetentionConfigurationRequest.Builder> deleteRetentionConfigurationRequest) Deletes the retention configuration.deleteRetentionConfiguration
(DeleteRetentionConfigurationRequest deleteRetentionConfigurationRequest) Deletes the retention configuration.deleteStoredQuery
(Consumer<DeleteStoredQueryRequest.Builder> deleteStoredQueryRequest) Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.deleteStoredQuery
(DeleteStoredQueryRequest deleteStoredQueryRequest) Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.deliverConfigSnapshot
(Consumer<DeliverConfigSnapshotRequest.Builder> deliverConfigSnapshotRequest) Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.deliverConfigSnapshot
(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest) Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel.describeAggregateComplianceByConfigRules
(Consumer<DescribeAggregateComplianceByConfigRulesRequest.Builder> describeAggregateComplianceByConfigRulesRequest) Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.describeAggregateComplianceByConfigRules
(DescribeAggregateComplianceByConfigRulesRequest describeAggregateComplianceByConfigRulesRequest) Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules.describeAggregateComplianceByConfigRulesPaginator
(Consumer<DescribeAggregateComplianceByConfigRulesRequest.Builder> describeAggregateComplianceByConfigRulesRequest) describeAggregateComplianceByConfigRulesPaginator
(DescribeAggregateComplianceByConfigRulesRequest describeAggregateComplianceByConfigRulesRequest) describeAggregateComplianceByConformancePacks
(Consumer<DescribeAggregateComplianceByConformancePacksRequest.Builder> describeAggregateComplianceByConformancePacksRequest) Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.describeAggregateComplianceByConformancePacks
(DescribeAggregateComplianceByConformancePacksRequest describeAggregateComplianceByConformancePacksRequest) Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack.describeAggregateComplianceByConformancePacksPaginator
(Consumer<DescribeAggregateComplianceByConformancePacksRequest.Builder> describeAggregateComplianceByConformancePacksRequest) describeAggregateComplianceByConformancePacksPaginator
(DescribeAggregateComplianceByConformancePacksRequest describeAggregateComplianceByConformancePacksRequest) Returns a list of authorizations granted to various aggregator accounts and regions.describeAggregationAuthorizations
(Consumer<DescribeAggregationAuthorizationsRequest.Builder> describeAggregationAuthorizationsRequest) Returns a list of authorizations granted to various aggregator accounts and regions.describeAggregationAuthorizations
(DescribeAggregationAuthorizationsRequest describeAggregationAuthorizationsRequest) Returns a list of authorizations granted to various aggregator accounts and regions.This is a variant ofdescribeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest)
operation.describeAggregationAuthorizationsPaginator
(Consumer<DescribeAggregationAuthorizationsRequest.Builder> describeAggregationAuthorizationsRequest) This is a variant ofdescribeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest)
operation.describeAggregationAuthorizationsPaginator
(DescribeAggregationAuthorizationsRequest describeAggregationAuthorizationsRequest) This is a variant ofdescribeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest)
operation.Indicates whether the specified Config rules are compliant.describeComplianceByConfigRule
(Consumer<DescribeComplianceByConfigRuleRequest.Builder> describeComplianceByConfigRuleRequest) Indicates whether the specified Config rules are compliant.describeComplianceByConfigRule
(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest) Indicates whether the specified Config rules are compliant.This is a variant ofdescribeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest)
operation.describeComplianceByConfigRulePaginator
(Consumer<DescribeComplianceByConfigRuleRequest.Builder> describeComplianceByConfigRuleRequest) This is a variant ofdescribeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest)
operation.describeComplianceByConfigRulePaginator
(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest) This is a variant ofdescribeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest)
operation.Indicates whether the specified Amazon Web Services resources are compliant.describeComplianceByResource
(Consumer<DescribeComplianceByResourceRequest.Builder> describeComplianceByResourceRequest) Indicates whether the specified Amazon Web Services resources are compliant.describeComplianceByResource
(DescribeComplianceByResourceRequest describeComplianceByResourceRequest) Indicates whether the specified Amazon Web Services resources are compliant.This is a variant ofdescribeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest)
operation.describeComplianceByResourcePaginator
(Consumer<DescribeComplianceByResourceRequest.Builder> describeComplianceByResourceRequest) This is a variant ofdescribeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest)
operation.describeComplianceByResourcePaginator
(DescribeComplianceByResourceRequest describeComplianceByResourceRequest) This is a variant ofdescribeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest)
operation.Returns status information for each of your Config managed rules.describeConfigRuleEvaluationStatus
(Consumer<DescribeConfigRuleEvaluationStatusRequest.Builder> describeConfigRuleEvaluationStatusRequest) Returns status information for each of your Config managed rules.describeConfigRuleEvaluationStatus
(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest) Returns status information for each of your Config managed rules.This is a variant ofdescribeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest)
operation.describeConfigRuleEvaluationStatusPaginator
(Consumer<DescribeConfigRuleEvaluationStatusRequest.Builder> describeConfigRuleEvaluationStatusRequest) This is a variant ofdescribeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest)
operation.describeConfigRuleEvaluationStatusPaginator
(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest) This is a variant ofdescribeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest)
operation.Returns details about your Config rules.describeConfigRules
(Consumer<DescribeConfigRulesRequest.Builder> describeConfigRulesRequest) Returns details about your Config rules.describeConfigRules
(DescribeConfigRulesRequest describeConfigRulesRequest) Returns details about your Config rules.default DescribeConfigRulesPublisher
This is a variant ofdescribeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest)
operation.default DescribeConfigRulesPublisher
describeConfigRulesPaginator
(Consumer<DescribeConfigRulesRequest.Builder> describeConfigRulesRequest) This is a variant ofdescribeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest)
operation.default DescribeConfigRulesPublisher
describeConfigRulesPaginator
(DescribeConfigRulesRequest describeConfigRulesRequest) This is a variant ofdescribeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest)
operation.Returns the details of one or more configuration aggregators.describeConfigurationAggregators
(Consumer<DescribeConfigurationAggregatorsRequest.Builder> describeConfigurationAggregatorsRequest) Returns the details of one or more configuration aggregators.describeConfigurationAggregators
(DescribeConfigurationAggregatorsRequest describeConfigurationAggregatorsRequest) Returns the details of one or more configuration aggregators.describeConfigurationAggregatorSourcesStatus
(Consumer<DescribeConfigurationAggregatorSourcesStatusRequest.Builder> describeConfigurationAggregatorSourcesStatusRequest) Returns status information for sources within an aggregator.describeConfigurationAggregatorSourcesStatus
(DescribeConfigurationAggregatorSourcesStatusRequest describeConfigurationAggregatorSourcesStatusRequest) Returns status information for sources within an aggregator.describeConfigurationAggregatorSourcesStatusPaginator
(Consumer<DescribeConfigurationAggregatorSourcesStatusRequest.Builder> describeConfigurationAggregatorSourcesStatusRequest) describeConfigurationAggregatorSourcesStatusPaginator
(DescribeConfigurationAggregatorSourcesStatusRequest describeConfigurationAggregatorSourcesStatusRequest) This is a variant ofdescribeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest)
operation.describeConfigurationAggregatorsPaginator
(Consumer<DescribeConfigurationAggregatorsRequest.Builder> describeConfigurationAggregatorsRequest) This is a variant ofdescribeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest)
operation.describeConfigurationAggregatorsPaginator
(DescribeConfigurationAggregatorsRequest describeConfigurationAggregatorsRequest) This is a variant ofdescribeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest)
operation.Returns the details for the specified configuration recorders.describeConfigurationRecorders
(Consumer<DescribeConfigurationRecordersRequest.Builder> describeConfigurationRecordersRequest) Returns the details for the specified configuration recorders.describeConfigurationRecorders
(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest) Returns the details for the specified configuration recorders.Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder.describeConfigurationRecorderStatus
(Consumer<DescribeConfigurationRecorderStatusRequest.Builder> describeConfigurationRecorderStatusRequest) Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder.describeConfigurationRecorderStatus
(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest) Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder.describeConformancePackCompliance
(Consumer<DescribeConformancePackComplianceRequest.Builder> describeConformancePackComplianceRequest) Returns compliance details for each rule in that conformance pack.describeConformancePackCompliance
(DescribeConformancePackComplianceRequest describeConformancePackComplianceRequest) Returns compliance details for each rule in that conformance pack.describeConformancePackCompliancePaginator
(Consumer<DescribeConformancePackComplianceRequest.Builder> describeConformancePackComplianceRequest) This is a variant ofdescribeConformancePackCompliance(software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceRequest)
operation.describeConformancePackCompliancePaginator
(DescribeConformancePackComplianceRequest describeConformancePackComplianceRequest) This is a variant ofdescribeConformancePackCompliance(software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceRequest)
operation.describeConformancePacks
(Consumer<DescribeConformancePacksRequest.Builder> describeConformancePacksRequest) Returns a list of one or more conformance packs.describeConformancePacks
(DescribeConformancePacksRequest describeConformancePacksRequest) Returns a list of one or more conformance packs.describeConformancePacksPaginator
(Consumer<DescribeConformancePacksRequest.Builder> describeConformancePacksRequest) This is a variant ofdescribeConformancePacks(software.amazon.awssdk.services.config.model.DescribeConformancePacksRequest)
operation.describeConformancePacksPaginator
(DescribeConformancePacksRequest describeConformancePacksRequest) This is a variant ofdescribeConformancePacks(software.amazon.awssdk.services.config.model.DescribeConformancePacksRequest)
operation.describeConformancePackStatus
(Consumer<DescribeConformancePackStatusRequest.Builder> describeConformancePackStatusRequest) Provides one or more conformance packs deployment status.describeConformancePackStatus
(DescribeConformancePackStatusRequest describeConformancePackStatusRequest) Provides one or more conformance packs deployment status.describeConformancePackStatusPaginator
(Consumer<DescribeConformancePackStatusRequest.Builder> describeConformancePackStatusRequest) This is a variant ofdescribeConformancePackStatus(software.amazon.awssdk.services.config.model.DescribeConformancePackStatusRequest)
operation.describeConformancePackStatusPaginator
(DescribeConformancePackStatusRequest describeConformancePackStatusRequest) This is a variant ofdescribeConformancePackStatus(software.amazon.awssdk.services.config.model.DescribeConformancePackStatusRequest)
operation.Returns details about the specified delivery channel.describeDeliveryChannels
(Consumer<DescribeDeliveryChannelsRequest.Builder> describeDeliveryChannelsRequest) Returns details about the specified delivery channel.describeDeliveryChannels
(DescribeDeliveryChannelsRequest describeDeliveryChannelsRequest) Returns details about the specified delivery channel.Returns the current status of the specified delivery channel.describeDeliveryChannelStatus
(Consumer<DescribeDeliveryChannelStatusRequest.Builder> describeDeliveryChannelStatusRequest) Returns the current status of the specified delivery channel.describeDeliveryChannelStatus
(DescribeDeliveryChannelStatusRequest describeDeliveryChannelStatusRequest) Returns the current status of the specified delivery channel.describeOrganizationConfigRules
(Consumer<DescribeOrganizationConfigRulesRequest.Builder> describeOrganizationConfigRulesRequest) Returns a list of organization Config rules.describeOrganizationConfigRules
(DescribeOrganizationConfigRulesRequest describeOrganizationConfigRulesRequest) Returns a list of organization Config rules.describeOrganizationConfigRulesPaginator
(Consumer<DescribeOrganizationConfigRulesRequest.Builder> describeOrganizationConfigRulesRequest) This is a variant ofdescribeOrganizationConfigRules(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesRequest)
operation.describeOrganizationConfigRulesPaginator
(DescribeOrganizationConfigRulesRequest describeOrganizationConfigRulesRequest) This is a variant ofdescribeOrganizationConfigRules(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesRequest)
operation.describeOrganizationConfigRuleStatuses
(Consumer<DescribeOrganizationConfigRuleStatusesRequest.Builder> describeOrganizationConfigRuleStatusesRequest) Provides organization Config rule deployment status for an organization.describeOrganizationConfigRuleStatuses
(DescribeOrganizationConfigRuleStatusesRequest describeOrganizationConfigRuleStatusesRequest) Provides organization Config rule deployment status for an organization.describeOrganizationConfigRuleStatusesPaginator
(Consumer<DescribeOrganizationConfigRuleStatusesRequest.Builder> describeOrganizationConfigRuleStatusesRequest) describeOrganizationConfigRuleStatusesPaginator
(DescribeOrganizationConfigRuleStatusesRequest describeOrganizationConfigRuleStatusesRequest) describeOrganizationConformancePacks
(Consumer<DescribeOrganizationConformancePacksRequest.Builder> describeOrganizationConformancePacksRequest) Returns a list of organization conformance packs.describeOrganizationConformancePacks
(DescribeOrganizationConformancePacksRequest describeOrganizationConformancePacksRequest) Returns a list of organization conformance packs.describeOrganizationConformancePacksPaginator
(Consumer<DescribeOrganizationConformancePacksRequest.Builder> describeOrganizationConformancePacksRequest) This is a variant ofdescribeOrganizationConformancePacks(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksRequest)
operation.describeOrganizationConformancePacksPaginator
(DescribeOrganizationConformancePacksRequest describeOrganizationConformancePacksRequest) This is a variant ofdescribeOrganizationConformancePacks(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksRequest)
operation.describeOrganizationConformancePackStatuses
(Consumer<DescribeOrganizationConformancePackStatusesRequest.Builder> describeOrganizationConformancePackStatusesRequest) Provides organization conformance pack deployment status for an organization.describeOrganizationConformancePackStatuses
(DescribeOrganizationConformancePackStatusesRequest describeOrganizationConformancePackStatusesRequest) Provides organization conformance pack deployment status for an organization.describeOrganizationConformancePackStatusesPaginator
(Consumer<DescribeOrganizationConformancePackStatusesRequest.Builder> describeOrganizationConformancePackStatusesRequest) describeOrganizationConformancePackStatusesPaginator
(DescribeOrganizationConformancePackStatusesRequest describeOrganizationConformancePackStatusesRequest) Returns a list of all pending aggregation requests.describePendingAggregationRequests
(Consumer<DescribePendingAggregationRequestsRequest.Builder> describePendingAggregationRequestsRequest) Returns a list of all pending aggregation requests.describePendingAggregationRequests
(DescribePendingAggregationRequestsRequest describePendingAggregationRequestsRequest) Returns a list of all pending aggregation requests.This is a variant ofdescribePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest)
operation.describePendingAggregationRequestsPaginator
(Consumer<DescribePendingAggregationRequestsRequest.Builder> describePendingAggregationRequestsRequest) This is a variant ofdescribePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest)
operation.describePendingAggregationRequestsPaginator
(DescribePendingAggregationRequestsRequest describePendingAggregationRequestsRequest) This is a variant ofdescribePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest)
operation.describeRemediationConfigurations
(Consumer<DescribeRemediationConfigurationsRequest.Builder> describeRemediationConfigurationsRequest) Returns the details of one or more remediation configurations.describeRemediationConfigurations
(DescribeRemediationConfigurationsRequest describeRemediationConfigurationsRequest) Returns the details of one or more remediation configurations.describeRemediationExceptions
(Consumer<DescribeRemediationExceptionsRequest.Builder> describeRemediationExceptionsRequest) Returns the details of one or more remediation exceptions.describeRemediationExceptions
(DescribeRemediationExceptionsRequest describeRemediationExceptionsRequest) Returns the details of one or more remediation exceptions.describeRemediationExceptionsPaginator
(Consumer<DescribeRemediationExceptionsRequest.Builder> describeRemediationExceptionsRequest) This is a variant ofdescribeRemediationExceptions(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsRequest)
operation.describeRemediationExceptionsPaginator
(DescribeRemediationExceptionsRequest describeRemediationExceptionsRequest) This is a variant ofdescribeRemediationExceptions(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsRequest)
operation.describeRemediationExecutionStatus
(Consumer<DescribeRemediationExecutionStatusRequest.Builder> describeRemediationExecutionStatusRequest) 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.describeRemediationExecutionStatus
(DescribeRemediationExecutionStatusRequest describeRemediationExecutionStatusRequest) 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.describeRemediationExecutionStatusPaginator
(Consumer<DescribeRemediationExecutionStatusRequest.Builder> describeRemediationExecutionStatusRequest) This is a variant ofdescribeRemediationExecutionStatus(software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusRequest)
operation.describeRemediationExecutionStatusPaginator
(DescribeRemediationExecutionStatusRequest describeRemediationExecutionStatusRequest) This is a variant ofdescribeRemediationExecutionStatus(software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusRequest)
operation.Returns the details of one or more retention configurations.describeRetentionConfigurations
(Consumer<DescribeRetentionConfigurationsRequest.Builder> describeRetentionConfigurationsRequest) Returns the details of one or more retention configurations.describeRetentionConfigurations
(DescribeRetentionConfigurationsRequest describeRetentionConfigurationsRequest) Returns the details of one or more retention configurations.This is a variant ofdescribeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest)
operation.describeRetentionConfigurationsPaginator
(Consumer<DescribeRetentionConfigurationsRequest.Builder> describeRetentionConfigurationsRequest) This is a variant ofdescribeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest)
operation.describeRetentionConfigurationsPaginator
(DescribeRetentionConfigurationsRequest describeRetentionConfigurationsRequest) This is a variant ofdescribeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest)
operation.getAggregateComplianceDetailsByConfigRule
(Consumer<GetAggregateComplianceDetailsByConfigRuleRequest.Builder> getAggregateComplianceDetailsByConfigRuleRequest) Returns the evaluation results for the specified Config rule for a specific resource in a rule.getAggregateComplianceDetailsByConfigRule
(GetAggregateComplianceDetailsByConfigRuleRequest getAggregateComplianceDetailsByConfigRuleRequest) Returns the evaluation results for the specified Config rule for a specific resource in a rule.getAggregateComplianceDetailsByConfigRulePaginator
(Consumer<GetAggregateComplianceDetailsByConfigRuleRequest.Builder> getAggregateComplianceDetailsByConfigRuleRequest) getAggregateComplianceDetailsByConfigRulePaginator
(GetAggregateComplianceDetailsByConfigRuleRequest getAggregateComplianceDetailsByConfigRuleRequest) getAggregateConfigRuleComplianceSummary
(Consumer<GetAggregateConfigRuleComplianceSummaryRequest.Builder> getAggregateConfigRuleComplianceSummaryRequest) Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.getAggregateConfigRuleComplianceSummary
(GetAggregateConfigRuleComplianceSummaryRequest getAggregateConfigRuleComplianceSummaryRequest) Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator.getAggregateConfigRuleComplianceSummaryPaginator
(Consumer<GetAggregateConfigRuleComplianceSummaryRequest.Builder> getAggregateConfigRuleComplianceSummaryRequest) getAggregateConfigRuleComplianceSummaryPaginator
(GetAggregateConfigRuleComplianceSummaryRequest getAggregateConfigRuleComplianceSummaryRequest) getAggregateConformancePackComplianceSummary
(Consumer<GetAggregateConformancePackComplianceSummaryRequest.Builder> getAggregateConformancePackComplianceSummaryRequest) Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.getAggregateConformancePackComplianceSummary
(GetAggregateConformancePackComplianceSummaryRequest getAggregateConformancePackComplianceSummaryRequest) Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator.getAggregateConformancePackComplianceSummaryPaginator
(Consumer<GetAggregateConformancePackComplianceSummaryRequest.Builder> getAggregateConformancePackComplianceSummaryRequest) getAggregateConformancePackComplianceSummaryPaginator
(GetAggregateConformancePackComplianceSummaryRequest getAggregateConformancePackComplianceSummaryRequest) getAggregateDiscoveredResourceCounts
(Consumer<GetAggregateDiscoveredResourceCountsRequest.Builder> getAggregateDiscoveredResourceCountsRequest) Returns the resource counts across accounts and regions that are present in your Config aggregator.getAggregateDiscoveredResourceCounts
(GetAggregateDiscoveredResourceCountsRequest getAggregateDiscoveredResourceCountsRequest) Returns the resource counts across accounts and regions that are present in your Config aggregator.getAggregateDiscoveredResourceCountsPaginator
(Consumer<GetAggregateDiscoveredResourceCountsRequest.Builder> getAggregateDiscoveredResourceCountsRequest) This is a variant ofgetAggregateDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsRequest)
operation.getAggregateDiscoveredResourceCountsPaginator
(GetAggregateDiscoveredResourceCountsRequest getAggregateDiscoveredResourceCountsRequest) This is a variant ofgetAggregateDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsRequest)
operation.getAggregateResourceConfig
(Consumer<GetAggregateResourceConfigRequest.Builder> getAggregateResourceConfigRequest) Returns configuration item that is aggregated for your specific resource in a specific source account and region.getAggregateResourceConfig
(GetAggregateResourceConfigRequest getAggregateResourceConfigRequest) Returns configuration item that is aggregated for your specific resource in a specific source account and region.getComplianceDetailsByConfigRule
(Consumer<GetComplianceDetailsByConfigRuleRequest.Builder> getComplianceDetailsByConfigRuleRequest) Returns the evaluation results for the specified Config rule.getComplianceDetailsByConfigRule
(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest) Returns the evaluation results for the specified Config rule.getComplianceDetailsByConfigRulePaginator
(Consumer<GetComplianceDetailsByConfigRuleRequest.Builder> getComplianceDetailsByConfigRuleRequest) This is a variant ofgetComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleRequest)
operation.getComplianceDetailsByConfigRulePaginator
(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest) This is a variant ofgetComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleRequest)
operation.getComplianceDetailsByResource
(Consumer<GetComplianceDetailsByResourceRequest.Builder> getComplianceDetailsByResourceRequest) Returns the evaluation results for the specified Amazon Web Services resource.getComplianceDetailsByResource
(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest) Returns the evaluation results for the specified Amazon Web Services resource.getComplianceDetailsByResourcePaginator
(Consumer<GetComplianceDetailsByResourceRequest.Builder> getComplianceDetailsByResourceRequest) This is a variant ofgetComplianceDetailsByResource(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceRequest)
operation.getComplianceDetailsByResourcePaginator
(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest) This is a variant ofgetComplianceDetailsByResource(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceRequest)
operation.Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.getComplianceSummaryByConfigRule
(Consumer<GetComplianceSummaryByConfigRuleRequest.Builder> getComplianceSummaryByConfigRuleRequest) Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.getComplianceSummaryByConfigRule
(GetComplianceSummaryByConfigRuleRequest getComplianceSummaryByConfigRuleRequest) Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.Returns the number of resources that are compliant and the number that are noncompliant.getComplianceSummaryByResourceType
(Consumer<GetComplianceSummaryByResourceTypeRequest.Builder> getComplianceSummaryByResourceTypeRequest) Returns the number of resources that are compliant and the number that are noncompliant.getComplianceSummaryByResourceType
(GetComplianceSummaryByResourceTypeRequest getComplianceSummaryByResourceTypeRequest) Returns the number of resources that are compliant and the number that are noncompliant.getConformancePackComplianceDetails
(Consumer<GetConformancePackComplianceDetailsRequest.Builder> getConformancePackComplianceDetailsRequest) Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.getConformancePackComplianceDetails
(GetConformancePackComplianceDetailsRequest getConformancePackComplianceDetailsRequest) Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.getConformancePackComplianceDetailsPaginator
(Consumer<GetConformancePackComplianceDetailsRequest.Builder> getConformancePackComplianceDetailsRequest) This is a variant ofgetConformancePackComplianceDetails(software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsRequest)
operation.getConformancePackComplianceDetailsPaginator
(GetConformancePackComplianceDetailsRequest getConformancePackComplianceDetailsRequest) This is a variant ofgetConformancePackComplianceDetails(software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsRequest)
operation.getConformancePackComplianceSummary
(Consumer<GetConformancePackComplianceSummaryRequest.Builder> getConformancePackComplianceSummaryRequest) Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.getConformancePackComplianceSummary
(GetConformancePackComplianceSummaryRequest getConformancePackComplianceSummaryRequest) Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.getConformancePackComplianceSummaryPaginator
(Consumer<GetConformancePackComplianceSummaryRequest.Builder> getConformancePackComplianceSummaryRequest) This is a variant ofgetConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryRequest)
operation.getConformancePackComplianceSummaryPaginator
(GetConformancePackComplianceSummaryRequest getConformancePackComplianceSummaryRequest) This is a variant ofgetConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryRequest)
operation.getCustomRulePolicy
(Consumer<GetCustomRulePolicyRequest.Builder> getCustomRulePolicyRequest) Returns the policy definition containing the logic for your Config Custom Policy rule.getCustomRulePolicy
(GetCustomRulePolicyRequest getCustomRulePolicyRequest) Returns the policy definition containing the logic for your Config Custom Policy rule.Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.getDiscoveredResourceCounts
(Consumer<GetDiscoveredResourceCountsRequest.Builder> getDiscoveredResourceCountsRequest) Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.getDiscoveredResourceCounts
(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest) Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.This is a variant ofgetDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest)
operation.getDiscoveredResourceCountsPaginator
(Consumer<GetDiscoveredResourceCountsRequest.Builder> getDiscoveredResourceCountsRequest) This is a variant ofgetDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest)
operation.getDiscoveredResourceCountsPaginator
(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest) This is a variant ofgetDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest)
operation.getOrganizationConfigRuleDetailedStatus
(Consumer<GetOrganizationConfigRuleDetailedStatusRequest.Builder> getOrganizationConfigRuleDetailedStatusRequest) Returns detailed status for each member account within an organization for a given organization Config rule.getOrganizationConfigRuleDetailedStatus
(GetOrganizationConfigRuleDetailedStatusRequest getOrganizationConfigRuleDetailedStatusRequest) Returns detailed status for each member account within an organization for a given organization Config rule.getOrganizationConfigRuleDetailedStatusPaginator
(Consumer<GetOrganizationConfigRuleDetailedStatusRequest.Builder> getOrganizationConfigRuleDetailedStatusRequest) getOrganizationConfigRuleDetailedStatusPaginator
(GetOrganizationConfigRuleDetailedStatusRequest getOrganizationConfigRuleDetailedStatusRequest) getOrganizationConformancePackDetailedStatus
(Consumer<GetOrganizationConformancePackDetailedStatusRequest.Builder> getOrganizationConformancePackDetailedStatusRequest) Returns detailed status for each member account within an organization for a given organization conformance pack.getOrganizationConformancePackDetailedStatus
(GetOrganizationConformancePackDetailedStatusRequest getOrganizationConformancePackDetailedStatusRequest) Returns detailed status for each member account within an organization for a given organization conformance pack.getOrganizationConformancePackDetailedStatusPaginator
(Consumer<GetOrganizationConformancePackDetailedStatusRequest.Builder> getOrganizationConformancePackDetailedStatusRequest) getOrganizationConformancePackDetailedStatusPaginator
(GetOrganizationConformancePackDetailedStatusRequest getOrganizationConformancePackDetailedStatusRequest) getOrganizationCustomRulePolicy
(Consumer<GetOrganizationCustomRulePolicyRequest.Builder> getOrganizationCustomRulePolicyRequest) Returns the policy definition containing the logic for your organization Config Custom Policy rule.getOrganizationCustomRulePolicy
(GetOrganizationCustomRulePolicyRequest getOrganizationCustomRulePolicyRequest) Returns the policy definition containing the logic for your organization Config Custom Policy rule.getResourceConfigHistory
(Consumer<GetResourceConfigHistoryRequest.Builder> getResourceConfigHistoryRequest) getResourceConfigHistory
(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest) getResourceConfigHistoryPaginator
(Consumer<GetResourceConfigHistoryRequest.Builder> getResourceConfigHistoryRequest) This is a variant ofgetResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation.getResourceConfigHistoryPaginator
(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest) This is a variant ofgetResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation.getResourceEvaluationSummary
(Consumer<GetResourceEvaluationSummaryRequest.Builder> getResourceEvaluationSummaryRequest) Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run.getResourceEvaluationSummary
(GetResourceEvaluationSummaryRequest getResourceEvaluationSummaryRequest) Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run.default CompletableFuture
<GetStoredQueryResponse> getStoredQuery
(Consumer<GetStoredQueryRequest.Builder> getStoredQueryRequest) Returns the details of a specific stored query.default CompletableFuture
<GetStoredQueryResponse> getStoredQuery
(GetStoredQueryRequest getStoredQueryRequest) Returns the details of a specific stored query.listAggregateDiscoveredResources
(Consumer<ListAggregateDiscoveredResourcesRequest.Builder> listAggregateDiscoveredResourcesRequest) Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.listAggregateDiscoveredResources
(ListAggregateDiscoveredResourcesRequest listAggregateDiscoveredResourcesRequest) Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions.listAggregateDiscoveredResourcesPaginator
(Consumer<ListAggregateDiscoveredResourcesRequest.Builder> listAggregateDiscoveredResourcesRequest) This is a variant oflistAggregateDiscoveredResources(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesRequest)
operation.listAggregateDiscoveredResourcesPaginator
(ListAggregateDiscoveredResourcesRequest listAggregateDiscoveredResourcesRequest) This is a variant oflistAggregateDiscoveredResources(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesRequest)
operation.listConformancePackComplianceScores
(Consumer<ListConformancePackComplianceScoresRequest.Builder> listConformancePackComplianceScoresRequest) Returns a list of conformance pack compliance scores.listConformancePackComplianceScores
(ListConformancePackComplianceScoresRequest listConformancePackComplianceScoresRequest) Returns a list of conformance pack compliance scores.listConformancePackComplianceScoresPaginator
(Consumer<ListConformancePackComplianceScoresRequest.Builder> listConformancePackComplianceScoresRequest) This is a variant oflistConformancePackComplianceScores(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresRequest)
operation.listConformancePackComplianceScoresPaginator
(ListConformancePackComplianceScoresRequest listConformancePackComplianceScoresRequest) This is a variant oflistConformancePackComplianceScores(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresRequest)
operation.listDiscoveredResources
(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) Accepts a resource type and returns a list of resource identifiers for the resources of that type.listDiscoveredResources
(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) Accepts a resource type and returns a list of resource identifiers for the resources of that type.default ListDiscoveredResourcesPublisher
listDiscoveredResourcesPaginator
(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) This is a variant oflistDiscoveredResources(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesRequest)
operation.default ListDiscoveredResourcesPublisher
listDiscoveredResourcesPaginator
(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) This is a variant oflistDiscoveredResources(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesRequest)
operation.listResourceEvaluations
(Consumer<ListResourceEvaluationsRequest.Builder> listResourceEvaluationsRequest) Returns a list of proactive resource evaluations.listResourceEvaluations
(ListResourceEvaluationsRequest listResourceEvaluationsRequest) Returns a list of proactive resource evaluations.default ListResourceEvaluationsPublisher
listResourceEvaluationsPaginator
(Consumer<ListResourceEvaluationsRequest.Builder> listResourceEvaluationsRequest) This is a variant oflistResourceEvaluations(software.amazon.awssdk.services.config.model.ListResourceEvaluationsRequest)
operation.default ListResourceEvaluationsPublisher
listResourceEvaluationsPaginator
(ListResourceEvaluationsRequest listResourceEvaluationsRequest) This is a variant oflistResourceEvaluations(software.amazon.awssdk.services.config.model.ListResourceEvaluationsRequest)
operation.listStoredQueries
(Consumer<ListStoredQueriesRequest.Builder> listStoredQueriesRequest) Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region.listStoredQueries
(ListStoredQueriesRequest listStoredQueriesRequest) Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region.default ListStoredQueriesPublisher
listStoredQueriesPaginator
(Consumer<ListStoredQueriesRequest.Builder> listStoredQueriesRequest) This is a variant oflistStoredQueries(software.amazon.awssdk.services.config.model.ListStoredQueriesRequest)
operation.default ListStoredQueriesPublisher
listStoredQueriesPaginator
(ListStoredQueriesRequest listStoredQueriesRequest) This is a variant oflistStoredQueries(software.amazon.awssdk.services.config.model.ListStoredQueriesRequest)
operation.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for Config resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for Config resource.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.config.model.ListTagsForResourceRequest)
operation.default ListTagsForResourcePublisher
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.config.model.ListTagsForResourceRequest)
operation.putAggregationAuthorization
(Consumer<PutAggregationAuthorizationRequest.Builder> putAggregationAuthorizationRequest) Authorizes the aggregator account and region to collect data from the source account and region.putAggregationAuthorization
(PutAggregationAuthorizationRequest putAggregationAuthorizationRequest) Authorizes the aggregator account and region to collect data from the source account and region.default CompletableFuture
<PutConfigRuleResponse> putConfigRule
(Consumer<PutConfigRuleRequest.Builder> putConfigRuleRequest) Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations.default CompletableFuture
<PutConfigRuleResponse> putConfigRule
(PutConfigRuleRequest putConfigRuleRequest) Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations.putConfigurationAggregator
(Consumer<PutConfigurationAggregatorRequest.Builder> putConfigurationAggregatorRequest) Creates and updates the configuration aggregator with the selected source accounts and regions.putConfigurationAggregator
(PutConfigurationAggregatorRequest putConfigurationAggregatorRequest) Creates and updates the configuration aggregator with the selected source accounts and regions.putConfigurationRecorder
(Consumer<PutConfigurationRecorderRequest.Builder> putConfigurationRecorderRequest) Creates a new configuration recorder to record configuration changes for specified resource types.putConfigurationRecorder
(PutConfigurationRecorderRequest putConfigurationRecorderRequest) Creates a new configuration recorder to record configuration changes for specified resource types.putConformancePack
(Consumer<PutConformancePackRequest.Builder> putConformancePackRequest) Creates or updates a conformance pack.putConformancePack
(PutConformancePackRequest putConformancePackRequest) Creates or updates a conformance pack.putDeliveryChannel
(Consumer<PutDeliveryChannelRequest.Builder> putDeliveryChannelRequest) Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic.putDeliveryChannel
(PutDeliveryChannelRequest putDeliveryChannelRequest) Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic.default CompletableFuture
<PutEvaluationsResponse> putEvaluations
(Consumer<PutEvaluationsRequest.Builder> putEvaluationsRequest) Used by an Lambda function to deliver evaluation results to Config.default CompletableFuture
<PutEvaluationsResponse> putEvaluations
(PutEvaluationsRequest putEvaluationsRequest) Used by an Lambda function to deliver evaluation results to Config.putExternalEvaluation
(Consumer<PutExternalEvaluationRequest.Builder> putExternalEvaluationRequest) Add or updates the evaluations for process checks.putExternalEvaluation
(PutExternalEvaluationRequest putExternalEvaluationRequest) Add or updates the evaluations for process checks.putOrganizationConfigRule
(Consumer<PutOrganizationConfigRuleRequest.Builder> putOrganizationConfigRuleRequest) Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations.putOrganizationConfigRule
(PutOrganizationConfigRuleRequest putOrganizationConfigRuleRequest) Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations.putOrganizationConformancePack
(Consumer<PutOrganizationConformancePackRequest.Builder> putOrganizationConformancePackRequest) Deploys conformance packs across member accounts in an Amazon Web Services Organization.putOrganizationConformancePack
(PutOrganizationConformancePackRequest putOrganizationConformancePackRequest) Deploys conformance packs across member accounts in an Amazon Web Services Organization.putRemediationConfigurations
(Consumer<PutRemediationConfigurationsRequest.Builder> putRemediationConfigurationsRequest) Adds or updates the remediation configuration with a specific Config rule with the selected target or action.putRemediationConfigurations
(PutRemediationConfigurationsRequest putRemediationConfigurationsRequest) Adds or updates the remediation configuration with a specific Config rule with the selected target or action.putRemediationExceptions
(Consumer<PutRemediationExceptionsRequest.Builder> putRemediationExceptionsRequest) A remediation exception is when a specified resource is no longer considered for auto-remediation.putRemediationExceptions
(PutRemediationExceptionsRequest putRemediationExceptionsRequest) A remediation exception is when a specified resource is no longer considered for auto-remediation.putResourceConfig
(Consumer<PutResourceConfigRequest.Builder> putResourceConfigRequest) Records the configuration state for the resource provided in the request.putResourceConfig
(PutResourceConfigRequest putResourceConfigRequest) Records the configuration state for the resource provided in the request.putRetentionConfiguration
(Consumer<PutRetentionConfigurationRequest.Builder> putRetentionConfigurationRequest) Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information.putRetentionConfiguration
(PutRetentionConfigurationRequest putRetentionConfigurationRequest) Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information.default CompletableFuture
<PutStoredQueryResponse> putStoredQuery
(Consumer<PutStoredQueryRequest.Builder> putStoredQueryRequest) Saves a new query or updates an existing saved query.default CompletableFuture
<PutStoredQueryResponse> putStoredQuery
(PutStoredQueryRequest putStoredQueryRequest) Saves a new query or updates an existing saved query.selectAggregateResourceConfig
(Consumer<SelectAggregateResourceConfigRequest.Builder> selectAggregateResourceConfigRequest) Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.selectAggregateResourceConfig
(SelectAggregateResourceConfigRequest selectAggregateResourceConfigRequest) Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.selectAggregateResourceConfigPaginator
(Consumer<SelectAggregateResourceConfigRequest.Builder> selectAggregateResourceConfigRequest) This is a variant ofselectAggregateResourceConfig(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigRequest)
operation.selectAggregateResourceConfigPaginator
(SelectAggregateResourceConfigRequest selectAggregateResourceConfigRequest) This is a variant ofselectAggregateResourceConfig(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigRequest)
operation.selectResourceConfig
(Consumer<SelectResourceConfigRequest.Builder> selectResourceConfigRequest) Accepts a structured query language (SQL)SELECT
command, performs the corresponding search, and returns resource configurations matching the properties.selectResourceConfig
(SelectResourceConfigRequest selectResourceConfigRequest) Accepts a structured query language (SQL)SELECT
command, performs the corresponding search, and returns resource configurations matching the properties.default SelectResourceConfigPublisher
selectResourceConfigPaginator
(Consumer<SelectResourceConfigRequest.Builder> selectResourceConfigRequest) This is a variant ofselectResourceConfig(software.amazon.awssdk.services.config.model.SelectResourceConfigRequest)
operation.default SelectResourceConfigPublisher
selectResourceConfigPaginator
(SelectResourceConfigRequest selectResourceConfigRequest) This is a variant ofselectResourceConfig(software.amazon.awssdk.services.config.model.SelectResourceConfigRequest)
operation.default ConfigServiceClientConfiguration
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartConfigRulesEvaluation
(Consumer<StartConfigRulesEvaluationRequest.Builder> startConfigRulesEvaluationRequest) Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources.startConfigRulesEvaluation
(StartConfigRulesEvaluationRequest startConfigRulesEvaluationRequest) Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources.startConfigurationRecorder
(Consumer<StartConfigurationRecorderRequest.Builder> startConfigurationRecorderRequest) Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.startConfigurationRecorder
(StartConfigurationRecorderRequest startConfigurationRecorderRequest) Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.startRemediationExecution
(Consumer<StartRemediationExecutionRequest.Builder> startRemediationExecutionRequest) Runs an on-demand remediation for the specified Config rules against the last known remediation configuration.startRemediationExecution
(StartRemediationExecutionRequest startRemediationExecutionRequest) Runs an on-demand remediation for the specified Config rules against the last known remediation configuration.startResourceEvaluation
(Consumer<StartResourceEvaluationRequest.Builder> startResourceEvaluationRequest) Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules.startResourceEvaluation
(StartResourceEvaluationRequest startResourceEvaluationRequest) Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules.stopConfigurationRecorder
(Consumer<StopConfigurationRecorderRequest.Builder> stopConfigurationRecorderRequest) Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.stopConfigurationRecorder
(StopConfigurationRecorderRequest stopConfigurationRecorderRequest) Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.default CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Associates the specified tags to a resource with the specified resourceArn.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Associates the specified tags to a resource with the specified resourceArn.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
batchGetAggregateResourceConfig
default CompletableFuture<BatchGetAggregateResourceConfigResponse> batchGetAggregateResourceConfig(BatchGetAggregateResourceConfigRequest batchGetAggregateResourceConfigRequest) Returns the current configuration items for resources that are present in your 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.
- Parameters:
batchGetAggregateResourceConfigRequest
-- Returns:
- A Java Future containing the result of the BatchGetAggregateResourceConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoSuchConfigurationAggregatorException You have specified a configuration aggregator that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
-
batchGetAggregateResourceConfig
default CompletableFuture<BatchGetAggregateResourceConfigResponse> batchGetAggregateResourceConfig(Consumer<BatchGetAggregateResourceConfigRequest.Builder> batchGetAggregateResourceConfigRequest) Returns the current configuration items for resources that are present in your 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.
This is a convenience which creates an instance of the
BatchGetAggregateResourceConfigRequest.Builder
avoiding the need to create one manually viaBatchGetAggregateResourceConfigRequest.builder()
- Parameters:
batchGetAggregateResourceConfigRequest
- AConsumer
that will call methods onBatchGetAggregateResourceConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetAggregateResourceConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoSuchConfigurationAggregatorException You have specified a configuration aggregator that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
-
batchGetResourceConfig
default CompletableFuture<BatchGetResourceConfigResponse> batchGetResourceConfig(BatchGetResourceConfigRequest batchGetResourceConfigRequest) Returns the
BaseConfigurationItem
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.
- Parameters:
batchGetResourceConfigRequest
-- Returns:
- A Java Future containing the result of the BatchGetResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
-
batchGetResourceConfig
default CompletableFuture<BatchGetResourceConfigResponse> batchGetResourceConfig(Consumer<BatchGetResourceConfigRequest.Builder> batchGetResourceConfigRequest) Returns the
BaseConfigurationItem
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.
This is a convenience which creates an instance of the
BatchGetResourceConfigRequest.Builder
avoiding the need to create one manually viaBatchGetResourceConfigRequest.builder()
- Parameters:
batchGetResourceConfigRequest
- AConsumer
that will call methods onBatchGetResourceConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the BatchGetResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
-
deleteAggregationAuthorization
default CompletableFuture<DeleteAggregationAuthorizationResponse> deleteAggregationAuthorization(DeleteAggregationAuthorizationRequest deleteAggregationAuthorizationRequest) Deletes the authorization granted to the specified configuration aggregator account in a specified region.
- Parameters:
deleteAggregationAuthorizationRequest
-- Returns:
- A Java Future containing the result of the DeleteAggregationAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteAggregationAuthorization
default CompletableFuture<DeleteAggregationAuthorizationResponse> deleteAggregationAuthorization(Consumer<DeleteAggregationAuthorizationRequest.Builder> deleteAggregationAuthorizationRequest) Deletes the authorization granted to the specified configuration aggregator account in a specified region.
This is a convenience which creates an instance of the
DeleteAggregationAuthorizationRequest.Builder
avoiding the need to create one manually viaDeleteAggregationAuthorizationRequest.builder()
- Parameters:
deleteAggregationAuthorizationRequest
- AConsumer
that will call methods onDeleteAggregationAuthorizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteAggregationAuthorization operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigRule
default CompletableFuture<DeleteConfigRuleResponse> deleteConfigRule(DeleteConfigRuleRequest deleteConfigRuleRequest) Deletes the specified Config rule and all of its evaluation results.
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 aPutConfigRule
orDeleteConfigRule
request for the rule, you will receive aResourceInUseException
.You can check the state of a rule by using the
DescribeConfigRules
request.- Parameters:
deleteConfigRuleRequest
-- Returns:
- A Java Future containing the result of the DeleteConfigRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigRule
default CompletableFuture<DeleteConfigRuleResponse> deleteConfigRule(Consumer<DeleteConfigRuleRequest.Builder> deleteConfigRuleRequest) Deletes the specified Config rule and all of its evaluation results.
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 aPutConfigRule
orDeleteConfigRule
request for the rule, you will receive aResourceInUseException
.You can check the state of a rule by using the
DescribeConfigRules
request.
This is a convenience which creates an instance of the
DeleteConfigRuleRequest.Builder
avoiding the need to create one manually viaDeleteConfigRuleRequest.builder()
- Parameters:
deleteConfigRuleRequest
- AConsumer
that will call methods onDeleteConfigRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConfigRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationAggregator
default CompletableFuture<DeleteConfigurationAggregatorResponse> deleteConfigurationAggregator(DeleteConfigurationAggregatorRequest deleteConfigurationAggregatorRequest) Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
- Parameters:
deleteConfigurationAggregatorRequest
-- Returns:
- A Java Future containing the result of the DeleteConfigurationAggregator operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationAggregatorException You have specified a configuration aggregator that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationAggregator
default CompletableFuture<DeleteConfigurationAggregatorResponse> deleteConfigurationAggregator(Consumer<DeleteConfigurationAggregatorRequest.Builder> deleteConfigurationAggregatorRequest) Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.
This is a convenience which creates an instance of the
DeleteConfigurationAggregatorRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationAggregatorRequest.builder()
- Parameters:
deleteConfigurationAggregatorRequest
- AConsumer
that will call methods onDeleteConfigurationAggregatorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConfigurationAggregator operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationAggregatorException You have specified a configuration aggregator that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationRecorder
default CompletableFuture<DeleteConfigurationRecorderResponse> deleteConfigurationRecorder(DeleteConfigurationRecorderRequest deleteConfigurationRecorderRequest) Deletes the configuration recorder.
After the configuration recorder is deleted, 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 Config console until you create a new configuration recorder.- Parameters:
deleteConfigurationRecorderRequest
- The request object for theDeleteConfigurationRecorder
action.- Returns:
- A Java Future containing the result of the DeleteConfigurationRecorder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConfigurationRecorder
default CompletableFuture<DeleteConfigurationRecorderResponse> deleteConfigurationRecorder(Consumer<DeleteConfigurationRecorderRequest.Builder> deleteConfigurationRecorderRequest) Deletes the configuration recorder.
After the configuration recorder is deleted, 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 Config console until you create a new configuration recorder.
This is a convenience which creates an instance of the
DeleteConfigurationRecorderRequest.Builder
avoiding the need to create one manually viaDeleteConfigurationRecorderRequest.builder()
- Parameters:
deleteConfigurationRecorderRequest
- AConsumer
that will call methods onDeleteConfigurationRecorderRequest.Builder
to create a request. The request object for theDeleteConfigurationRecorder
action.- Returns:
- A Java Future containing the result of the DeleteConfigurationRecorder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConformancePack
default CompletableFuture<DeleteConformancePackResponse> deleteConformancePack(DeleteConformancePackRequest deleteConformancePackRequest) Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
Config sets the conformance pack to
DELETE_IN_PROGRESS
until the deletion is complete. You cannot update a conformance pack while it is in this state.- Parameters:
deleteConformancePackRequest
-- Returns:
- A Java Future containing the result of the DeleteConformancePack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteConformancePack
default CompletableFuture<DeleteConformancePackResponse> deleteConformancePack(Consumer<DeleteConformancePackRequest.Builder> deleteConformancePackRequest) Deletes the specified conformance pack and all the Config rules, remediation actions, and all evaluation results within that conformance pack.
Config sets the conformance pack to
DELETE_IN_PROGRESS
until the deletion is complete. You cannot update a conformance pack while it is in this state.
This is a convenience which creates an instance of the
DeleteConformancePackRequest.Builder
avoiding the need to create one manually viaDeleteConformancePackRequest.builder()
- Parameters:
deleteConformancePackRequest
- AConsumer
that will call methods onDeleteConformancePackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteConformancePack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDeliveryChannel
default CompletableFuture<DeleteDeliveryChannelResponse> deleteDeliveryChannel(DeleteDeliveryChannelRequest deleteDeliveryChannelRequest) Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
- Parameters:
deleteDeliveryChannelRequest
- The input for the DeleteDeliveryChannel action. The action accepts the following data, in JSON format.- Returns:
- A Java Future containing the result of the DeleteDeliveryChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- LastDeliveryChannelDeleteFailedException You cannot delete the delivery channel you specified because the configuration recorder is running.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDeliveryChannel
default CompletableFuture<DeleteDeliveryChannelResponse> deleteDeliveryChannel(Consumer<DeleteDeliveryChannelRequest.Builder> deleteDeliveryChannelRequest) Deletes the delivery channel.
Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.
This is a convenience which creates an instance of the
DeleteDeliveryChannelRequest.Builder
avoiding the need to create one manually viaDeleteDeliveryChannelRequest.builder()
- Parameters:
deleteDeliveryChannelRequest
- AConsumer
that will call methods onDeleteDeliveryChannelRequest.Builder
to create a request. The input for the DeleteDeliveryChannel action. The action accepts the following data, in JSON format.- Returns:
- A Java Future containing the result of the DeleteDeliveryChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- LastDeliveryChannelDeleteFailedException You cannot delete the delivery channel you specified because the configuration recorder is running.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEvaluationResults
default CompletableFuture<DeleteEvaluationResultsResponse> deleteEvaluationResults(DeleteEvaluationResultsRequest deleteEvaluationResultsRequest) Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.
- Parameters:
deleteEvaluationResultsRequest
-- Returns:
- A Java Future containing the result of the DeleteEvaluationResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEvaluationResults
default CompletableFuture<DeleteEvaluationResultsResponse> deleteEvaluationResults(Consumer<DeleteEvaluationResultsRequest.Builder> deleteEvaluationResultsRequest) Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.
This is a convenience which creates an instance of the
DeleteEvaluationResultsRequest.Builder
avoiding the need to create one manually viaDeleteEvaluationResultsRequest.builder()
- Parameters:
deleteEvaluationResultsRequest
- AConsumer
that will call methods onDeleteEvaluationResultsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEvaluationResults operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOrganizationConfigRule
default CompletableFuture<DeleteOrganizationConfigRuleResponse> deleteOrganizationConfigRule(DeleteOrganizationConfigRuleRequest deleteOrganizationConfigRuleRequest) Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
Only a management account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added.Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.
- Parameters:
deleteOrganizationConfigRuleRequest
-- Returns:
- A Java Future containing the result of the DeleteOrganizationConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOrganizationConfigRule
default CompletableFuture<DeleteOrganizationConfigRuleResponse> deleteOrganizationConfigRule(Consumer<DeleteOrganizationConfigRuleRequest.Builder> deleteOrganizationConfigRuleRequest) Deletes the specified organization Config rule and all of its evaluation results from all member accounts in that organization.
Only a management account and a delegated administrator account can delete an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added.Config sets the state of a rule to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a rule while it is in this state.
This is a convenience which creates an instance of the
DeleteOrganizationConfigRuleRequest.Builder
avoiding the need to create one manually viaDeleteOrganizationConfigRuleRequest.builder()
- Parameters:
deleteOrganizationConfigRuleRequest
- AConsumer
that will call methods onDeleteOrganizationConfigRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOrganizationConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteOrganizationConformancePack
default CompletableFuture<DeleteOrganizationConformancePackResponse> deleteOrganizationConformancePack(DeleteOrganizationConformancePackRequest deleteOrganizationConformancePackRequest) Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
Only a management account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added.Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
- Parameters:
deleteOrganizationConformancePackRequest
-- Returns:
- A Java Future containing the result of the DeleteOrganizationConformancePack operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
deleteOrganizationConformancePack
default CompletableFuture<DeleteOrganizationConformancePackResponse> deleteOrganizationConformancePack(Consumer<DeleteOrganizationConformancePackRequest.Builder> deleteOrganizationConformancePackRequest) Deletes the specified organization conformance pack and all of the Config rules and remediation actions from all member accounts in that organization.
Only a management account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added.Config sets the state of a conformance pack to DELETE_IN_PROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.
This is a convenience which creates an instance of the
DeleteOrganizationConformancePackRequest.Builder
avoiding the need to create one manually viaDeleteOrganizationConformancePackRequest.builder()
- Parameters:
deleteOrganizationConformancePackRequest
- AConsumer
that will call methods onDeleteOrganizationConformancePackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteOrganizationConformancePack operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
deletePendingAggregationRequest
default CompletableFuture<DeletePendingAggregationRequestResponse> deletePendingAggregationRequest(DeletePendingAggregationRequestRequest deletePendingAggregationRequestRequest) Deletes pending authorization requests for a specified aggregator account in a specified region.
- Parameters:
deletePendingAggregationRequestRequest
-- Returns:
- A Java Future containing the result of the DeletePendingAggregationRequest operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePendingAggregationRequest
default CompletableFuture<DeletePendingAggregationRequestResponse> deletePendingAggregationRequest(Consumer<DeletePendingAggregationRequestRequest.Builder> deletePendingAggregationRequestRequest) Deletes pending authorization requests for a specified aggregator account in a specified region.
This is a convenience which creates an instance of the
DeletePendingAggregationRequestRequest.Builder
avoiding the need to create one manually viaDeletePendingAggregationRequestRequest.builder()
- Parameters:
deletePendingAggregationRequestRequest
- AConsumer
that will call methods onDeletePendingAggregationRequestRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeletePendingAggregationRequest operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRemediationConfiguration
default CompletableFuture<DeleteRemediationConfigurationResponse> deleteRemediationConfiguration(DeleteRemediationConfigurationRequest deleteRemediationConfigurationRequest) Deletes the remediation configuration.
- Parameters:
deleteRemediationConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteRemediationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchRemediationConfigurationException You specified an Config rule without a remediation configuration.
- RemediationInProgressException Remediation action is in progress. You can either cancel execution in Amazon Web Services Systems Manager or wait and try again later.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRemediationConfiguration
default CompletableFuture<DeleteRemediationConfigurationResponse> deleteRemediationConfiguration(Consumer<DeleteRemediationConfigurationRequest.Builder> deleteRemediationConfigurationRequest) Deletes the remediation configuration.
This is a convenience which creates an instance of the
DeleteRemediationConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteRemediationConfigurationRequest.builder()
- Parameters:
deleteRemediationConfigurationRequest
- AConsumer
that will call methods onDeleteRemediationConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRemediationConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchRemediationConfigurationException You specified an Config rule without a remediation configuration.
- RemediationInProgressException Remediation action is in progress. You can either cancel execution in Amazon Web Services Systems Manager or wait and try again later.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRemediationExceptions
default CompletableFuture<DeleteRemediationExceptionsResponse> deleteRemediationExceptions(DeleteRemediationExceptionsRequest deleteRemediationExceptionsRequest) Deletes one or more remediation exceptions mentioned in the resource keys.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
- Parameters:
deleteRemediationExceptionsRequest
-- Returns:
- A Java Future containing the result of the DeleteRemediationExceptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchRemediationExceptionException You tried to delete a remediation exception that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRemediationExceptions
default CompletableFuture<DeleteRemediationExceptionsResponse> deleteRemediationExceptions(Consumer<DeleteRemediationExceptionsRequest.Builder> deleteRemediationExceptionsRequest) Deletes one or more remediation exceptions mentioned in the resource keys.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
This is a convenience which creates an instance of the
DeleteRemediationExceptionsRequest.Builder
avoiding the need to create one manually viaDeleteRemediationExceptionsRequest.builder()
- Parameters:
deleteRemediationExceptionsRequest
- AConsumer
that will call methods onDeleteRemediationExceptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRemediationExceptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchRemediationExceptionException You tried to delete a remediation exception that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteResourceConfig
default CompletableFuture<DeleteResourceConfigResponse> deleteResourceConfig(DeleteResourceConfigRequest deleteResourceConfigRequest) Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.
- Parameters:
deleteResourceConfigRequest
-- Returns:
- A Java Future containing the result of the DeleteResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoRunningConfigurationRecorderException There is no configuration recorder running.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
deleteResourceConfig
default CompletableFuture<DeleteResourceConfigResponse> deleteResourceConfig(Consumer<DeleteResourceConfigRequest.Builder> deleteResourceConfigRequest) Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your Config History.
This is a convenience which creates an instance of the
DeleteResourceConfigRequest.Builder
avoiding the need to create one manually viaDeleteResourceConfigRequest.builder()
- Parameters:
deleteResourceConfigRequest
- AConsumer
that will call methods onDeleteResourceConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- NoRunningConfigurationRecorderException There is no configuration recorder running.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
deleteRetentionConfiguration
default CompletableFuture<DeleteRetentionConfigurationResponse> deleteRetentionConfiguration(DeleteRetentionConfigurationRequest deleteRetentionConfigurationRequest) Deletes the retention configuration.
- Parameters:
deleteRetentionConfigurationRequest
-- Returns:
- A Java Future containing the result of the DeleteRetentionConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchRetentionConfigurationException You have specified a retention configuration that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteRetentionConfiguration
default CompletableFuture<DeleteRetentionConfigurationResponse> deleteRetentionConfiguration(Consumer<DeleteRetentionConfigurationRequest.Builder> deleteRetentionConfigurationRequest) Deletes the retention configuration.
This is a convenience which creates an instance of the
DeleteRetentionConfigurationRequest.Builder
avoiding the need to create one manually viaDeleteRetentionConfigurationRequest.builder()
- Parameters:
deleteRetentionConfigurationRequest
- AConsumer
that will call methods onDeleteRetentionConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteRetentionConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchRetentionConfigurationException You have specified a retention configuration that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteStoredQuery
default CompletableFuture<DeleteStoredQueryResponse> deleteStoredQuery(DeleteStoredQueryRequest deleteStoredQueryRequest) Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
- Parameters:
deleteStoredQueryRequest
-- Returns:
- A Java Future containing the result of the DeleteStoredQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException You have specified a resource that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
deleteStoredQuery
default CompletableFuture<DeleteStoredQueryResponse> deleteStoredQuery(Consumer<DeleteStoredQueryRequest.Builder> deleteStoredQueryRequest) Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.
This is a convenience which creates an instance of the
DeleteStoredQueryRequest.Builder
avoiding the need to create one manually viaDeleteStoredQueryRequest.builder()
- Parameters:
deleteStoredQueryRequest
- AConsumer
that will call methods onDeleteStoredQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteStoredQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException You have specified a resource that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
deliverConfigSnapshot
default CompletableFuture<DeliverConfigSnapshotResponse> deliverConfigSnapshot(DeliverConfigSnapshotRequest deliverConfigSnapshotRequest) Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, 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.
- Parameters:
deliverConfigSnapshotRequest
- The input for the DeliverConfigSnapshot action.- Returns:
- A Java Future containing the result of the DeliverConfigSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- NoRunningConfigurationRecorderException There is no configuration recorder running.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
deliverConfigSnapshot
default CompletableFuture<DeliverConfigSnapshotResponse> deliverConfigSnapshot(Consumer<DeliverConfigSnapshotRequest.Builder> deliverConfigSnapshotRequest) Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, 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.
This is a convenience which creates an instance of the
DeliverConfigSnapshotRequest.Builder
avoiding the need to create one manually viaDeliverConfigSnapshotRequest.builder()
- Parameters:
deliverConfigSnapshotRequest
- AConsumer
that will call methods onDeliverConfigSnapshotRequest.Builder
to create a request. The input for the DeliverConfigSnapshot action.- Returns:
- A Java Future containing the result of the DeliverConfigSnapshot operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- NoRunningConfigurationRecorderException There is no configuration recorder running.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeAggregateComplianceByConfigRules
default CompletableFuture<DescribeAggregateComplianceByConfigRulesResponse> describeAggregateComplianceByConfigRules(DescribeAggregateComplianceByConfigRulesRequest describeAggregateComplianceByConfigRulesRequest) Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
The results can return an empty result page, but if you have a
nextToken
, the results are displayed on the next page.- Parameters:
describeAggregateComplianceByConfigRulesRequest
-- Returns:
- A Java Future containing the result of the DescribeAggregateComplianceByConfigRules operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
describeAggregateComplianceByConfigRules
default CompletableFuture<DescribeAggregateComplianceByConfigRulesResponse> describeAggregateComplianceByConfigRules(Consumer<DescribeAggregateComplianceByConfigRulesRequest.Builder> describeAggregateComplianceByConfigRulesRequest) Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. Does not display rules that do not have compliance results.
The results can return an empty result page, but if you have a
nextToken
, the results are displayed on the next page.
This is a convenience which creates an instance of the
DescribeAggregateComplianceByConfigRulesRequest.Builder
avoiding the need to create one manually viaDescribeAggregateComplianceByConfigRulesRequest.builder()
- Parameters:
describeAggregateComplianceByConfigRulesRequest
- AConsumer
that will call methods onDescribeAggregateComplianceByConfigRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAggregateComplianceByConfigRules operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
describeAggregateComplianceByConfigRulesPaginator
default DescribeAggregateComplianceByConfigRulesPublisher describeAggregateComplianceByConfigRulesPaginator(DescribeAggregateComplianceByConfigRulesRequest describeAggregateComplianceByConfigRulesRequest) This is a variant of
describeAggregateComplianceByConfigRules(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConfigRulesPublisher publisher = client.describeAggregateComplianceByConfigRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConfigRulesPublisher publisher = client.describeAggregateComplianceByConfigRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAggregateComplianceByConfigRules(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesRequest)
operation.- Parameters:
describeAggregateComplianceByConfigRulesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
describeAggregateComplianceByConfigRulesPaginator
default DescribeAggregateComplianceByConfigRulesPublisher describeAggregateComplianceByConfigRulesPaginator(Consumer<DescribeAggregateComplianceByConfigRulesRequest.Builder> describeAggregateComplianceByConfigRulesRequest) This is a variant of
describeAggregateComplianceByConfigRules(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConfigRulesPublisher publisher = client.describeAggregateComplianceByConfigRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConfigRulesPublisher publisher = client.describeAggregateComplianceByConfigRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAggregateComplianceByConfigRules(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesRequest)
operation.
This is a convenience which creates an instance of the
DescribeAggregateComplianceByConfigRulesRequest.Builder
avoiding the need to create one manually viaDescribeAggregateComplianceByConfigRulesRequest.builder()
- Parameters:
describeAggregateComplianceByConfigRulesRequest
- AConsumer
that will call methods onDescribeAggregateComplianceByConfigRulesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
describeAggregateComplianceByConformancePacks
default CompletableFuture<DescribeAggregateComplianceByConformancePacksResponse> describeAggregateComplianceByConformancePacks(DescribeAggregateComplianceByConformancePacksRequest describeAggregateComplianceByConformancePacksRequest) Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
The results can return an empty result page, but if you have a
nextToken
, the results are displayed on the next page.- Parameters:
describeAggregateComplianceByConformancePacksRequest
-- Returns:
- A Java Future containing the result of the DescribeAggregateComplianceByConformancePacks operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
describeAggregateComplianceByConformancePacks
default CompletableFuture<DescribeAggregateComplianceByConformancePacksResponse> describeAggregateComplianceByConformancePacks(Consumer<DescribeAggregateComplianceByConformancePacksRequest.Builder> describeAggregateComplianceByConformancePacksRequest) Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data.
The results can return an empty result page, but if you have a
nextToken
, the results are displayed on the next page.
This is a convenience which creates an instance of the
DescribeAggregateComplianceByConformancePacksRequest.Builder
avoiding the need to create one manually viaDescribeAggregateComplianceByConformancePacksRequest.builder()
- Parameters:
describeAggregateComplianceByConformancePacksRequest
- AConsumer
that will call methods onDescribeAggregateComplianceByConformancePacksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAggregateComplianceByConformancePacks operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
describeAggregateComplianceByConformancePacksPaginator
default DescribeAggregateComplianceByConformancePacksPublisher describeAggregateComplianceByConformancePacksPaginator(DescribeAggregateComplianceByConformancePacksRequest describeAggregateComplianceByConformancePacksRequest) This is a variant of
describeAggregateComplianceByConformancePacks(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksPublisher publisher = client.describeAggregateComplianceByConformancePacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksPublisher publisher = client.describeAggregateComplianceByConformancePacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAggregateComplianceByConformancePacks(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksRequest)
operation.- Parameters:
describeAggregateComplianceByConformancePacksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
describeAggregateComplianceByConformancePacksPaginator
default DescribeAggregateComplianceByConformancePacksPublisher describeAggregateComplianceByConformancePacksPaginator(Consumer<DescribeAggregateComplianceByConformancePacksRequest.Builder> describeAggregateComplianceByConformancePacksRequest) This is a variant of
describeAggregateComplianceByConformancePacks(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksPublisher publisher = client.describeAggregateComplianceByConformancePacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksPublisher publisher = client.describeAggregateComplianceByConformancePacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAggregateComplianceByConformancePacks(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksRequest)
operation.
This is a convenience which creates an instance of the
DescribeAggregateComplianceByConformancePacksRequest.Builder
avoiding the need to create one manually viaDescribeAggregateComplianceByConformancePacksRequest.builder()
- Parameters:
describeAggregateComplianceByConformancePacksRequest
- AConsumer
that will call methods onDescribeAggregateComplianceByConformancePacksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
describeAggregationAuthorizations
default CompletableFuture<DescribeAggregationAuthorizationsResponse> describeAggregationAuthorizations(DescribeAggregationAuthorizationsRequest describeAggregationAuthorizationsRequest) Returns a list of authorizations granted to various aggregator accounts and regions.
- Parameters:
describeAggregationAuthorizationsRequest
-- Returns:
- A Java Future containing the result of the DescribeAggregationAuthorizations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAggregationAuthorizations
default CompletableFuture<DescribeAggregationAuthorizationsResponse> describeAggregationAuthorizations(Consumer<DescribeAggregationAuthorizationsRequest.Builder> describeAggregationAuthorizationsRequest) Returns a list of authorizations granted to various aggregator accounts and regions.
This is a convenience which creates an instance of the
DescribeAggregationAuthorizationsRequest.Builder
avoiding the need to create one manually viaDescribeAggregationAuthorizationsRequest.builder()
- Parameters:
describeAggregationAuthorizationsRequest
- AConsumer
that will call methods onDescribeAggregationAuthorizationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeAggregationAuthorizations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAggregationAuthorizations
default CompletableFuture<DescribeAggregationAuthorizationsResponse> describeAggregationAuthorizations()Returns a list of authorizations granted to various aggregator accounts and regions.
- Returns:
- A Java Future containing the result of the DescribeAggregationAuthorizations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAggregationAuthorizationsPaginator
This is a variant of
describeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsPublisher publisher = client.describeAggregationAuthorizationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsPublisher publisher = client.describeAggregationAuthorizationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAggregationAuthorizationsPaginator
default DescribeAggregationAuthorizationsPublisher describeAggregationAuthorizationsPaginator(DescribeAggregationAuthorizationsRequest describeAggregationAuthorizationsRequest) This is a variant of
describeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsPublisher publisher = client.describeAggregationAuthorizationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsPublisher publisher = client.describeAggregationAuthorizationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest)
operation.- Parameters:
describeAggregationAuthorizationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeAggregationAuthorizationsPaginator
default DescribeAggregationAuthorizationsPublisher describeAggregationAuthorizationsPaginator(Consumer<DescribeAggregationAuthorizationsRequest.Builder> describeAggregationAuthorizationsRequest) This is a variant of
describeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsPublisher publisher = client.describeAggregationAuthorizationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsPublisher publisher = client.describeAggregationAuthorizationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeAggregationAuthorizationsRequest.Builder
avoiding the need to create one manually viaDescribeAggregationAuthorizationsRequest.builder()
- Parameters:
describeAggregationAuthorizationsRequest
- AConsumer
that will call methods onDescribeAggregationAuthorizationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeComplianceByConfigRule
default CompletableFuture<DescribeComplianceByConfigRuleResponse> describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest) Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services 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 Config has no current evaluation results for the rule, it returns
INSUFFICIENT_DATA
. This result might indicate one of the following conditions:-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to 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 Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
- Parameters:
describeComplianceByConfigRuleRequest
-- Returns:
- A Java Future containing the result of the DescribeComplianceByConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeComplianceByConfigRule
default CompletableFuture<DescribeComplianceByConfigRuleResponse> describeComplianceByConfigRule(Consumer<DescribeComplianceByConfigRuleRequest.Builder> describeComplianceByConfigRuleRequest) Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services 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 Config has no current evaluation results for the rule, it returns
INSUFFICIENT_DATA
. This result might indicate one of the following conditions:-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to 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 Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
This is a convenience which creates an instance of the
DescribeComplianceByConfigRuleRequest.Builder
avoiding the need to create one manually viaDescribeComplianceByConfigRuleRequest.builder()
- Parameters:
describeComplianceByConfigRuleRequest
- AConsumer
that will call methods onDescribeComplianceByConfigRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeComplianceByConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeComplianceByConfigRule
Indicates whether the specified Config rules are compliant. If a rule is noncompliant, this action returns the number of Amazon Web Services 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 Config has no current evaluation results for the rule, it returns
INSUFFICIENT_DATA
. This result might indicate one of the following conditions:-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to 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 Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's 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.
- Returns:
- A Java Future containing the result of the DescribeComplianceByConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeComplianceByConfigRulePaginator
This is a variant of
describeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRulePublisher publisher = client.describeComplianceByConfigRulePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRulePublisher publisher = client.describeComplianceByConfigRulePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeComplianceByConfigRulePaginator
default DescribeComplianceByConfigRulePublisher describeComplianceByConfigRulePaginator(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest) This is a variant of
describeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRulePublisher publisher = client.describeComplianceByConfigRulePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRulePublisher publisher = client.describeComplianceByConfigRulePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest)
operation.- Parameters:
describeComplianceByConfigRuleRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeComplianceByConfigRulePaginator
default DescribeComplianceByConfigRulePublisher describeComplianceByConfigRulePaginator(Consumer<DescribeComplianceByConfigRuleRequest.Builder> describeComplianceByConfigRuleRequest) This is a variant of
describeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRulePublisher publisher = client.describeComplianceByConfigRulePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRulePublisher publisher = client.describeComplianceByConfigRulePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest)
operation.
This is a convenience which creates an instance of the
DescribeComplianceByConfigRuleRequest.Builder
avoiding the need to create one manually viaDescribeComplianceByConfigRuleRequest.builder()
- Parameters:
describeComplianceByConfigRuleRequest
- AConsumer
that will call methods onDescribeComplianceByConfigRuleRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeComplianceByResource
default CompletableFuture<DescribeComplianceByResourceResponse> describeComplianceByResource(DescribeComplianceByResourceRequest describeComplianceByResourceRequest) Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If 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:-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to 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 Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
- Parameters:
describeComplianceByResourceRequest
-- Returns:
- A Java Future containing the result of the DescribeComplianceByResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeComplianceByResource
default CompletableFuture<DescribeComplianceByResourceResponse> describeComplianceByResource(Consumer<DescribeComplianceByResourceRequest.Builder> describeComplianceByResourceRequest) Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If 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:-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to 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 Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's Lambda function has returned
NOT_APPLICABLE
for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
This is a convenience which creates an instance of the
DescribeComplianceByResourceRequest.Builder
avoiding the need to create one manually viaDescribeComplianceByResourceRequest.builder()
- Parameters:
describeComplianceByResourceRequest
- AConsumer
that will call methods onDescribeComplianceByResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeComplianceByResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeComplianceByResource
Indicates whether the specified Amazon Web Services resources are compliant. If a resource is noncompliant, this action returns the number of Config rules that the resource does not comply with.
A resource is compliant if it complies with all the Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
If 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:-
Config has never invoked an evaluation for the rule. To check whether it has, use the
DescribeConfigRuleEvaluationStatus
action to get theLastSuccessfulInvocationTime
andLastFailedInvocationTime
. -
The rule's Lambda function is failing to send evaluation results to 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 Lambda execution role includes theconfig:PutEvaluations
permission. -
The rule's 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.
- Returns:
- A Java Future containing the result of the DescribeComplianceByResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
describeComplianceByResourcePaginator
This is a variant of
describeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeComplianceByResourcePublisher publisher = client.describeComplianceByResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourcePublisher publisher = client.describeComplianceByResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeComplianceByResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeComplianceByResourcePaginator
default DescribeComplianceByResourcePublisher describeComplianceByResourcePaginator(DescribeComplianceByResourceRequest describeComplianceByResourceRequest) This is a variant of
describeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeComplianceByResourcePublisher publisher = client.describeComplianceByResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourcePublisher publisher = client.describeComplianceByResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeComplianceByResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest)
operation.- Parameters:
describeComplianceByResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeComplianceByResourcePaginator
default DescribeComplianceByResourcePublisher describeComplianceByResourcePaginator(Consumer<DescribeComplianceByResourceRequest.Builder> describeComplianceByResourceRequest) This is a variant of
describeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeComplianceByResourcePublisher publisher = client.describeComplianceByResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourcePublisher publisher = client.describeComplianceByResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeComplianceByResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest)
operation.
This is a convenience which creates an instance of the
DescribeComplianceByResourceRequest.Builder
avoiding the need to create one manually viaDescribeComplianceByResourceRequest.builder()
- Parameters:
describeComplianceByResourceRequest
- AConsumer
that will call methods onDescribeComplianceByResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRuleEvaluationStatus
default CompletableFuture<DescribeConfigRuleEvaluationStatusResponse> describeConfigRuleEvaluationStatus(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest) Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
- Parameters:
describeConfigRuleEvaluationStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeConfigRuleEvaluationStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRuleEvaluationStatus
default CompletableFuture<DescribeConfigRuleEvaluationStatusResponse> describeConfigRuleEvaluationStatus(Consumer<DescribeConfigRuleEvaluationStatusRequest.Builder> describeConfigRuleEvaluationStatusRequest) Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
This is a convenience which creates an instance of the
DescribeConfigRuleEvaluationStatusRequest.Builder
avoiding the need to create one manually viaDescribeConfigRuleEvaluationStatusRequest.builder()
- Parameters:
describeConfigRuleEvaluationStatusRequest
- AConsumer
that will call methods onDescribeConfigRuleEvaluationStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConfigRuleEvaluationStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRuleEvaluationStatus
default CompletableFuture<DescribeConfigRuleEvaluationStatusResponse> describeConfigRuleEvaluationStatus()Returns status information for each of your Config managed rules. The status includes information such as the last time Config invoked the rule, the last time Config failed to invoke the rule, and the related error for the last failure.
- Returns:
- A Java Future containing the result of the DescribeConfigRuleEvaluationStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRuleEvaluationStatusPaginator
This is a variant of
describeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusPublisher publisher = client.describeConfigRuleEvaluationStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusPublisher publisher = client.describeConfigRuleEvaluationStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRuleEvaluationStatusPaginator
default DescribeConfigRuleEvaluationStatusPublisher describeConfigRuleEvaluationStatusPaginator(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest) This is a variant of
describeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusPublisher publisher = client.describeConfigRuleEvaluationStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusPublisher publisher = client.describeConfigRuleEvaluationStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest)
operation.- Parameters:
describeConfigRuleEvaluationStatusRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRuleEvaluationStatusPaginator
default DescribeConfigRuleEvaluationStatusPublisher describeConfigRuleEvaluationStatusPaginator(Consumer<DescribeConfigRuleEvaluationStatusRequest.Builder> describeConfigRuleEvaluationStatusRequest) This is a variant of
describeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusPublisher publisher = client.describeConfigRuleEvaluationStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusPublisher publisher = client.describeConfigRuleEvaluationStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest)
operation.
This is a convenience which creates an instance of the
DescribeConfigRuleEvaluationStatusRequest.Builder
avoiding the need to create one manually viaDescribeConfigRuleEvaluationStatusRequest.builder()
- Parameters:
describeConfigRuleEvaluationStatusRequest
- AConsumer
that will call methods onDescribeConfigRuleEvaluationStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRules
default CompletableFuture<DescribeConfigRulesResponse> describeConfigRules(DescribeConfigRulesRequest describeConfigRulesRequest) Returns details about your Config rules.
- Parameters:
describeConfigRulesRequest
-- Returns:
- A Java Future containing the result of the DescribeConfigRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRules
default CompletableFuture<DescribeConfigRulesResponse> describeConfigRules(Consumer<DescribeConfigRulesRequest.Builder> describeConfigRulesRequest) Returns details about your Config rules.
This is a convenience which creates an instance of the
DescribeConfigRulesRequest.Builder
avoiding the need to create one manually viaDescribeConfigRulesRequest.builder()
- Parameters:
describeConfigRulesRequest
- AConsumer
that will call methods onDescribeConfigRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConfigRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRules
Returns details about your Config rules.
- Returns:
- A Java Future containing the result of the DescribeConfigRules operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRulesPaginator
This is a variant of
describeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigRulesPublisher publisher = client.describeConfigRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigRulesPublisher publisher = client.describeConfigRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigRulesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRulesPaginator
default DescribeConfigRulesPublisher describeConfigRulesPaginator(DescribeConfigRulesRequest describeConfigRulesRequest) This is a variant of
describeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigRulesPublisher publisher = client.describeConfigRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigRulesPublisher publisher = client.describeConfigRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigRulesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest)
operation.- Parameters:
describeConfigRulesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigRulesPaginator
default DescribeConfigRulesPublisher describeConfigRulesPaginator(Consumer<DescribeConfigRulesRequest.Builder> describeConfigRulesRequest) This is a variant of
describeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigRulesPublisher publisher = client.describeConfigRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigRulesPublisher publisher = client.describeConfigRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigRulesResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest)
operation.
This is a convenience which creates an instance of the
DescribeConfigRulesRequest.Builder
avoiding the need to create one manually viaDescribeConfigRulesRequest.builder()
- Parameters:
describeConfigRulesRequest
- AConsumer
that will call methods onDescribeConfigRulesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregatorSourcesStatus
default CompletableFuture<DescribeConfigurationAggregatorSourcesStatusResponse> describeConfigurationAggregatorSourcesStatus(DescribeConfigurationAggregatorSourcesStatusRequest describeConfigurationAggregatorSourcesStatusRequest) Returns status information for sources within an aggregator. The status includes information about the last time 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.
- Parameters:
describeConfigurationAggregatorSourcesStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeConfigurationAggregatorSourcesStatus operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregatorSourcesStatus
default CompletableFuture<DescribeConfigurationAggregatorSourcesStatusResponse> describeConfigurationAggregatorSourcesStatus(Consumer<DescribeConfigurationAggregatorSourcesStatusRequest.Builder> describeConfigurationAggregatorSourcesStatusRequest) Returns status information for sources within an aggregator. The status includes information about the last time 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.
This is a convenience which creates an instance of the
DescribeConfigurationAggregatorSourcesStatusRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationAggregatorSourcesStatusRequest.builder()
- Parameters:
describeConfigurationAggregatorSourcesStatusRequest
- AConsumer
that will call methods onDescribeConfigurationAggregatorSourcesStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConfigurationAggregatorSourcesStatus operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregatorSourcesStatusPaginator
default DescribeConfigurationAggregatorSourcesStatusPublisher describeConfigurationAggregatorSourcesStatusPaginator(DescribeConfigurationAggregatorSourcesStatusRequest describeConfigurationAggregatorSourcesStatusRequest) This is a variant of
describeConfigurationAggregatorSourcesStatus(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorSourcesStatusPublisher publisher = client.describeConfigurationAggregatorSourcesStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorSourcesStatusPublisher publisher = client.describeConfigurationAggregatorSourcesStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigurationAggregatorSourcesStatus(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusRequest)
operation.- Parameters:
describeConfigurationAggregatorSourcesStatusRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregatorSourcesStatusPaginator
default DescribeConfigurationAggregatorSourcesStatusPublisher describeConfigurationAggregatorSourcesStatusPaginator(Consumer<DescribeConfigurationAggregatorSourcesStatusRequest.Builder> describeConfigurationAggregatorSourcesStatusRequest) This is a variant of
describeConfigurationAggregatorSourcesStatus(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorSourcesStatusPublisher publisher = client.describeConfigurationAggregatorSourcesStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorSourcesStatusPublisher publisher = client.describeConfigurationAggregatorSourcesStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigurationAggregatorSourcesStatus(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusRequest)
operation.
This is a convenience which creates an instance of the
DescribeConfigurationAggregatorSourcesStatusRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationAggregatorSourcesStatusRequest.builder()
- Parameters:
describeConfigurationAggregatorSourcesStatusRequest
- AConsumer
that will call methods onDescribeConfigurationAggregatorSourcesStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregators
default CompletableFuture<DescribeConfigurationAggregatorsResponse> describeConfigurationAggregators(DescribeConfigurationAggregatorsRequest describeConfigurationAggregatorsRequest) 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.
- Parameters:
describeConfigurationAggregatorsRequest
-- Returns:
- A Java Future containing the result of the DescribeConfigurationAggregators operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregators
default CompletableFuture<DescribeConfigurationAggregatorsResponse> describeConfigurationAggregators(Consumer<DescribeConfigurationAggregatorsRequest.Builder> describeConfigurationAggregatorsRequest) 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.
This is a convenience which creates an instance of the
DescribeConfigurationAggregatorsRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationAggregatorsRequest.builder()
- Parameters:
describeConfigurationAggregatorsRequest
- AConsumer
that will call methods onDescribeConfigurationAggregatorsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConfigurationAggregators operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregators
default CompletableFuture<DescribeConfigurationAggregatorsResponse> describeConfigurationAggregators()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.
- Returns:
- A Java Future containing the result of the DescribeConfigurationAggregators operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregatorsPaginator
This is a variant of
describeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorsPublisher publisher = client.describeConfigurationAggregatorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorsPublisher publisher = client.describeConfigurationAggregatorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregatorsPaginator
default DescribeConfigurationAggregatorsPublisher describeConfigurationAggregatorsPaginator(DescribeConfigurationAggregatorsRequest describeConfigurationAggregatorsRequest) This is a variant of
describeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorsPublisher publisher = client.describeConfigurationAggregatorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorsPublisher publisher = client.describeConfigurationAggregatorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest)
operation.- Parameters:
describeConfigurationAggregatorsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationAggregatorsPaginator
default DescribeConfigurationAggregatorsPublisher describeConfigurationAggregatorsPaginator(Consumer<DescribeConfigurationAggregatorsRequest.Builder> describeConfigurationAggregatorsRequest) This is a variant of
describeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorsPublisher publisher = client.describeConfigurationAggregatorsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorsPublisher publisher = client.describeConfigurationAggregatorsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest)
operation.
This is a convenience which creates an instance of the
DescribeConfigurationAggregatorsRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationAggregatorsRequest.builder()
- Parameters:
describeConfigurationAggregatorsRequest
- AConsumer
that will call methods onDescribeConfigurationAggregatorsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationRecorderStatus
default CompletableFuture<DescribeConfigurationRecorderStatusResponse> describeConfigurationRecorderStatus(DescribeConfigurationRecorderStatusRequest describeConfigurationRecorderStatusRequest) Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
- Parameters:
describeConfigurationRecorderStatusRequest
- The input for the DescribeConfigurationRecorderStatus action.- Returns:
- A Java Future containing the result of the DescribeConfigurationRecorderStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationRecorderStatus
default CompletableFuture<DescribeConfigurationRecorderStatusResponse> describeConfigurationRecorderStatus(Consumer<DescribeConfigurationRecorderStatusRequest.Builder> describeConfigurationRecorderStatusRequest) Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
This is a convenience which creates an instance of the
DescribeConfigurationRecorderStatusRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationRecorderStatusRequest.builder()
- Parameters:
describeConfigurationRecorderStatusRequest
- AConsumer
that will call methods onDescribeConfigurationRecorderStatusRequest.Builder
to create a request. The input for the DescribeConfigurationRecorderStatus action.- Returns:
- A Java Future containing the result of the DescribeConfigurationRecorderStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationRecorderStatus
default CompletableFuture<DescribeConfigurationRecorderStatusResponse> describeConfigurationRecorderStatus()Returns the current status of the specified configuration recorder as well as the status of the last recording event for the recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account.
>You can specify only one configuration recorder for each Amazon Web Services Region for each account. For a detailed status of recording events over time, add your Config events to Amazon CloudWatch metrics and use CloudWatch metrics.
- Returns:
- A Java Future containing the result of the DescribeConfigurationRecorderStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationRecorders
default CompletableFuture<DescribeConfigurationRecordersResponse> describeConfigurationRecorders(DescribeConfigurationRecordersRequest describeConfigurationRecordersRequest) 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.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
- Parameters:
describeConfigurationRecordersRequest
- The input for the DescribeConfigurationRecorders action.- Returns:
- A Java Future containing the result of the DescribeConfigurationRecorders operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationRecorders
default CompletableFuture<DescribeConfigurationRecordersResponse> describeConfigurationRecorders(Consumer<DescribeConfigurationRecordersRequest.Builder> describeConfigurationRecordersRequest) 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.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
This is a convenience which creates an instance of the
DescribeConfigurationRecordersRequest.Builder
avoiding the need to create one manually viaDescribeConfigurationRecordersRequest.builder()
- Parameters:
describeConfigurationRecordersRequest
- AConsumer
that will call methods onDescribeConfigurationRecordersRequest.Builder
to create a request. The input for the DescribeConfigurationRecorders action.- Returns:
- A Java Future containing the result of the DescribeConfigurationRecorders operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConfigurationRecorders
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.
You can specify only one configuration recorder for each Amazon Web Services Region for each account.
- Returns:
- A Java Future containing the result of the DescribeConfigurationRecorders operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePackCompliance
default CompletableFuture<DescribeConformancePackComplianceResponse> describeConformancePackCompliance(DescribeConformancePackComplianceRequest describeConformancePackComplianceRequest) Returns compliance details for each rule in that conformance pack.
You must provide exact rule names.
- Parameters:
describeConformancePackComplianceRequest
-- Returns:
- A Java Future containing the result of the DescribeConformancePackCompliance operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleInConformancePackException Config rule that you passed in the filter does not exist.
- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePackCompliance
default CompletableFuture<DescribeConformancePackComplianceResponse> describeConformancePackCompliance(Consumer<DescribeConformancePackComplianceRequest.Builder> describeConformancePackComplianceRequest) Returns compliance details for each rule in that conformance pack.
You must provide exact rule names.
This is a convenience which creates an instance of the
DescribeConformancePackComplianceRequest.Builder
avoiding the need to create one manually viaDescribeConformancePackComplianceRequest.builder()
- Parameters:
describeConformancePackComplianceRequest
- AConsumer
that will call methods onDescribeConformancePackComplianceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConformancePackCompliance operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleInConformancePackException Config rule that you passed in the filter does not exist.
- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePackCompliancePaginator
default DescribeConformancePackCompliancePublisher describeConformancePackCompliancePaginator(DescribeConformancePackComplianceRequest describeConformancePackComplianceRequest) This is a variant of
describeConformancePackCompliance(software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConformancePackCompliancePublisher publisher = client.describeConformancePackCompliancePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConformancePackCompliancePublisher publisher = client.describeConformancePackCompliancePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConformancePackCompliance(software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceRequest)
operation.- Parameters:
describeConformancePackComplianceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleInConformancePackException Config rule that you passed in the filter does not exist.
- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePackCompliancePaginator
default DescribeConformancePackCompliancePublisher describeConformancePackCompliancePaginator(Consumer<DescribeConformancePackComplianceRequest.Builder> describeConformancePackComplianceRequest) This is a variant of
describeConformancePackCompliance(software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConformancePackCompliancePublisher publisher = client.describeConformancePackCompliancePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConformancePackCompliancePublisher publisher = client.describeConformancePackCompliancePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConformancePackCompliance(software.amazon.awssdk.services.config.model.DescribeConformancePackComplianceRequest)
operation.
This is a convenience which creates an instance of the
DescribeConformancePackComplianceRequest.Builder
avoiding the need to create one manually viaDescribeConformancePackComplianceRequest.builder()
- Parameters:
describeConformancePackComplianceRequest
- AConsumer
that will call methods onDescribeConformancePackComplianceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- NoSuchConfigRuleInConformancePackException Config rule that you passed in the filter does not exist.
- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePackStatus
default CompletableFuture<DescribeConformancePackStatusResponse> describeConformancePackStatus(DescribeConformancePackStatusRequest describeConformancePackStatusRequest) Provides one or more conformance packs deployment status.
If there are no conformance packs then you will see an empty result.
- Parameters:
describeConformancePackStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeConformancePackStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePackStatus
default CompletableFuture<DescribeConformancePackStatusResponse> describeConformancePackStatus(Consumer<DescribeConformancePackStatusRequest.Builder> describeConformancePackStatusRequest) Provides one or more conformance packs deployment status.
If there are no conformance packs then you will see an empty result.
This is a convenience which creates an instance of the
DescribeConformancePackStatusRequest.Builder
avoiding the need to create one manually viaDescribeConformancePackStatusRequest.builder()
- Parameters:
describeConformancePackStatusRequest
- AConsumer
that will call methods onDescribeConformancePackStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConformancePackStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePackStatusPaginator
default DescribeConformancePackStatusPublisher describeConformancePackStatusPaginator(DescribeConformancePackStatusRequest describeConformancePackStatusRequest) This is a variant of
describeConformancePackStatus(software.amazon.awssdk.services.config.model.DescribeConformancePackStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConformancePackStatusPublisher publisher = client.describeConformancePackStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConformancePackStatusPublisher publisher = client.describeConformancePackStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConformancePackStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConformancePackStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConformancePackStatus(software.amazon.awssdk.services.config.model.DescribeConformancePackStatusRequest)
operation.- Parameters:
describeConformancePackStatusRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePackStatusPaginator
default DescribeConformancePackStatusPublisher describeConformancePackStatusPaginator(Consumer<DescribeConformancePackStatusRequest.Builder> describeConformancePackStatusRequest) This is a variant of
describeConformancePackStatus(software.amazon.awssdk.services.config.model.DescribeConformancePackStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConformancePackStatusPublisher publisher = client.describeConformancePackStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConformancePackStatusPublisher publisher = client.describeConformancePackStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConformancePackStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConformancePackStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConformancePackStatus(software.amazon.awssdk.services.config.model.DescribeConformancePackStatusRequest)
operation.
This is a convenience which creates an instance of the
DescribeConformancePackStatusRequest.Builder
avoiding the need to create one manually viaDescribeConformancePackStatusRequest.builder()
- Parameters:
describeConformancePackStatusRequest
- AConsumer
that will call methods onDescribeConformancePackStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePacks
default CompletableFuture<DescribeConformancePacksResponse> describeConformancePacks(DescribeConformancePacksRequest describeConformancePacksRequest) Returns a list of one or more conformance packs.
- Parameters:
describeConformancePacksRequest
-- Returns:
- A Java Future containing the result of the DescribeConformancePacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePacks
default CompletableFuture<DescribeConformancePacksResponse> describeConformancePacks(Consumer<DescribeConformancePacksRequest.Builder> describeConformancePacksRequest) Returns a list of one or more conformance packs.
This is a convenience which creates an instance of the
DescribeConformancePacksRequest.Builder
avoiding the need to create one manually viaDescribeConformancePacksRequest.builder()
- Parameters:
describeConformancePacksRequest
- AConsumer
that will call methods onDescribeConformancePacksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeConformancePacks operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePacksPaginator
default DescribeConformancePacksPublisher describeConformancePacksPaginator(DescribeConformancePacksRequest describeConformancePacksRequest) This is a variant of
describeConformancePacks(software.amazon.awssdk.services.config.model.DescribeConformancePacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConformancePacksPublisher publisher = client.describeConformancePacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConformancePacksPublisher publisher = client.describeConformancePacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConformancePacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConformancePacksResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConformancePacks(software.amazon.awssdk.services.config.model.DescribeConformancePacksRequest)
operation.- Parameters:
describeConformancePacksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeConformancePacksPaginator
default DescribeConformancePacksPublisher describeConformancePacksPaginator(Consumer<DescribeConformancePacksRequest.Builder> describeConformancePacksRequest) This is a variant of
describeConformancePacks(software.amazon.awssdk.services.config.model.DescribeConformancePacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeConformancePacksPublisher publisher = client.describeConformancePacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeConformancePacksPublisher publisher = client.describeConformancePacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeConformancePacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeConformancePacksResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeConformancePacks(software.amazon.awssdk.services.config.model.DescribeConformancePacksRequest)
operation.
This is a convenience which creates an instance of the
DescribeConformancePacksRequest.Builder
avoiding the need to create one manually viaDescribeConformancePacksRequest.builder()
- Parameters:
describeConformancePacksRequest
- AConsumer
that will call methods onDescribeConformancePacksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDeliveryChannelStatus
default CompletableFuture<DescribeDeliveryChannelStatusResponse> 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.
Currently, you can specify only one delivery channel per region in your account.
- Parameters:
describeDeliveryChannelStatusRequest
- The input for the DeliveryChannelStatus action.- Returns:
- A Java Future containing the result of the DescribeDeliveryChannelStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDeliveryChannelStatus
default CompletableFuture<DescribeDeliveryChannelStatusResponse> describeDeliveryChannelStatus(Consumer<DescribeDeliveryChannelStatusRequest.Builder> 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.
Currently, you can specify only one delivery channel per region in your account.
This is a convenience which creates an instance of the
DescribeDeliveryChannelStatusRequest.Builder
avoiding the need to create one manually viaDescribeDeliveryChannelStatusRequest.builder()
- Parameters:
describeDeliveryChannelStatusRequest
- AConsumer
that will call methods onDescribeDeliveryChannelStatusRequest.Builder
to create a request. The input for the DeliveryChannelStatus action.- Returns:
- A Java Future containing the result of the DescribeDeliveryChannelStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDeliveryChannelStatus
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.
- Returns:
- A Java Future containing the result of the DescribeDeliveryChannelStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDeliveryChannels
default CompletableFuture<DescribeDeliveryChannelsResponse> 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 region in your account.
- Parameters:
describeDeliveryChannelsRequest
- The input for the DescribeDeliveryChannels action.- Returns:
- A Java Future containing the result of the DescribeDeliveryChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDeliveryChannels
default CompletableFuture<DescribeDeliveryChannelsResponse> describeDeliveryChannels(Consumer<DescribeDeliveryChannelsRequest.Builder> 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 region in your account.
This is a convenience which creates an instance of the
DescribeDeliveryChannelsRequest.Builder
avoiding the need to create one manually viaDescribeDeliveryChannelsRequest.builder()
- Parameters:
describeDeliveryChannelsRequest
- AConsumer
that will call methods onDescribeDeliveryChannelsRequest.Builder
to create a request. The input for the DescribeDeliveryChannels action.- Returns:
- A Java Future containing the result of the DescribeDeliveryChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeDeliveryChannels
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.
- Returns:
- A Java Future containing the result of the DescribeDeliveryChannels operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchDeliveryChannelException You have specified a delivery channel that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfigRuleStatuses
default CompletableFuture<DescribeOrganizationConfigRuleStatusesResponse> describeOrganizationConfigRuleStatuses(DescribeOrganizationConfigRuleStatusesRequest describeOrganizationConfigRuleStatusesRequest) Provides organization Config rule deployment status for an organization.
The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
- Parameters:
describeOrganizationConfigRuleStatusesRequest
-- Returns:
- A Java Future containing the result of the DescribeOrganizationConfigRuleStatuses operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfigRuleStatuses
default CompletableFuture<DescribeOrganizationConfigRuleStatusesResponse> describeOrganizationConfigRuleStatuses(Consumer<DescribeOrganizationConfigRuleStatusesRequest.Builder> describeOrganizationConfigRuleStatusesRequest) Provides organization Config rule deployment status for an organization.
The status is not considered successful until organization Config rule is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
This is a convenience which creates an instance of the
DescribeOrganizationConfigRuleStatusesRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationConfigRuleStatusesRequest.builder()
- Parameters:
describeOrganizationConfigRuleStatusesRequest
- AConsumer
that will call methods onDescribeOrganizationConfigRuleStatusesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOrganizationConfigRuleStatuses operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfigRuleStatusesPaginator
default DescribeOrganizationConfigRuleStatusesPublisher describeOrganizationConfigRuleStatusesPaginator(DescribeOrganizationConfigRuleStatusesRequest describeOrganizationConfigRuleStatusesRequest) This is a variant of
describeOrganizationConfigRuleStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesPublisher publisher = client.describeOrganizationConfigRuleStatusesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesPublisher publisher = client.describeOrganizationConfigRuleStatusesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrganizationConfigRuleStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesRequest)
operation.- Parameters:
describeOrganizationConfigRuleStatusesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfigRuleStatusesPaginator
default DescribeOrganizationConfigRuleStatusesPublisher describeOrganizationConfigRuleStatusesPaginator(Consumer<DescribeOrganizationConfigRuleStatusesRequest.Builder> describeOrganizationConfigRuleStatusesRequest) This is a variant of
describeOrganizationConfigRuleStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesPublisher publisher = client.describeOrganizationConfigRuleStatusesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesPublisher publisher = client.describeOrganizationConfigRuleStatusesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrganizationConfigRuleStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesRequest)
operation.
This is a convenience which creates an instance of the
DescribeOrganizationConfigRuleStatusesRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationConfigRuleStatusesRequest.builder()
- Parameters:
describeOrganizationConfigRuleStatusesRequest
- AConsumer
that will call methods onDescribeOrganizationConfigRuleStatusesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfigRules
default CompletableFuture<DescribeOrganizationConfigRulesResponse> describeOrganizationConfigRules(DescribeOrganizationConfigRulesRequest describeOrganizationConfigRulesRequest) Returns a list of organization Config rules.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
For accounts within an organization
If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The
DescribeOrganizationConfigRules
andDescribeOrganizationConformancePacks
APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.- Parameters:
describeOrganizationConfigRulesRequest
-- Returns:
- A Java Future containing the result of the DescribeOrganizationConfigRules operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. 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 For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfigRules
default CompletableFuture<DescribeOrganizationConfigRulesResponse> describeOrganizationConfigRules(Consumer<DescribeOrganizationConfigRulesRequest.Builder> describeOrganizationConfigRulesRequest) Returns a list of organization Config rules.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization Config rule names. It is only applicable, when you request all the organization Config rules.
For accounts within an organization
If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The
DescribeOrganizationConfigRules
andDescribeOrganizationConformancePacks
APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
This is a convenience which creates an instance of the
DescribeOrganizationConfigRulesRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationConfigRulesRequest.builder()
- Parameters:
describeOrganizationConfigRulesRequest
- AConsumer
that will call methods onDescribeOrganizationConfigRulesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOrganizationConfigRules operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. 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 For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfigRulesPaginator
default DescribeOrganizationConfigRulesPublisher describeOrganizationConfigRulesPaginator(DescribeOrganizationConfigRulesRequest describeOrganizationConfigRulesRequest) This is a variant of
describeOrganizationConfigRules(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesPublisher publisher = client.describeOrganizationConfigRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesPublisher publisher = client.describeOrganizationConfigRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrganizationConfigRules(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesRequest)
operation.- Parameters:
describeOrganizationConfigRulesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. 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 For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConfigRulesPaginator
default DescribeOrganizationConfigRulesPublisher describeOrganizationConfigRulesPaginator(Consumer<DescribeOrganizationConfigRulesRequest.Builder> describeOrganizationConfigRulesRequest) This is a variant of
describeOrganizationConfigRules(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesPublisher publisher = client.describeOrganizationConfigRulesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesPublisher publisher = client.describeOrganizationConfigRulesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrganizationConfigRules(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesRequest)
operation.
This is a convenience which creates an instance of the
DescribeOrganizationConfigRulesRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationConfigRulesRequest.builder()
- Parameters:
describeOrganizationConfigRulesRequest
- AConsumer
that will call methods onDescribeOrganizationConfigRulesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidNextTokenException The specified next token is not valid. 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 For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeOrganizationConformancePackStatuses
default CompletableFuture<DescribeOrganizationConformancePackStatusesResponse> describeOrganizationConformancePackStatuses(DescribeOrganizationConformancePackStatusesRequest describeOrganizationConformancePackStatusesRequest) Provides organization conformance pack deployment status for an organization.
The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
- Parameters:
describeOrganizationConformancePackStatusesRequest
-- Returns:
- A Java Future containing the result of the DescribeOrganizationConformancePackStatuses operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
describeOrganizationConformancePackStatuses
default CompletableFuture<DescribeOrganizationConformancePackStatusesResponse> describeOrganizationConformancePackStatuses(Consumer<DescribeOrganizationConformancePackStatusesRequest.Builder> describeOrganizationConformancePackStatusesRequest) Provides organization conformance pack deployment status for an organization.
The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts.
When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.
This is a convenience which creates an instance of the
DescribeOrganizationConformancePackStatusesRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationConformancePackStatusesRequest.builder()
- Parameters:
describeOrganizationConformancePackStatusesRequest
- AConsumer
that will call methods onDescribeOrganizationConformancePackStatusesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOrganizationConformancePackStatuses operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
describeOrganizationConformancePackStatusesPaginator
default DescribeOrganizationConformancePackStatusesPublisher describeOrganizationConformancePackStatusesPaginator(DescribeOrganizationConformancePackStatusesRequest describeOrganizationConformancePackStatusesRequest) This is a variant of
describeOrganizationConformancePackStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesPublisher publisher = client.describeOrganizationConformancePackStatusesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesPublisher publisher = client.describeOrganizationConformancePackStatusesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrganizationConformancePackStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesRequest)
operation.- Parameters:
describeOrganizationConformancePackStatusesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
describeOrganizationConformancePackStatusesPaginator
default DescribeOrganizationConformancePackStatusesPublisher describeOrganizationConformancePackStatusesPaginator(Consumer<DescribeOrganizationConformancePackStatusesRequest.Builder> describeOrganizationConformancePackStatusesRequest) This is a variant of
describeOrganizationConformancePackStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesPublisher publisher = client.describeOrganizationConformancePackStatusesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesPublisher publisher = client.describeOrganizationConformancePackStatusesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrganizationConformancePackStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesRequest)
operation.
This is a convenience which creates an instance of the
DescribeOrganizationConformancePackStatusesRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationConformancePackStatusesRequest.builder()
- Parameters:
describeOrganizationConformancePackStatusesRequest
- AConsumer
that will call methods onDescribeOrganizationConformancePackStatusesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
describeOrganizationConformancePacks
default CompletableFuture<DescribeOrganizationConformancePacksResponse> describeOrganizationConformancePacks(DescribeOrganizationConformancePacksRequest describeOrganizationConformancePacksRequest) Returns a list of organization conformance packs.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
For accounts within an organization
If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The
DescribeOrganizationConfigRules
andDescribeOrganizationConformancePacks
APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.- Parameters:
describeOrganizationConformancePacksRequest
-- Returns:
- A Java Future containing the result of the DescribeOrganizationConformancePacks operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidNextTokenException The specified next token is not valid. 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 For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
describeOrganizationConformancePacks
default CompletableFuture<DescribeOrganizationConformancePacksResponse> describeOrganizationConformancePacks(Consumer<DescribeOrganizationConformancePacksRequest.Builder> describeOrganizationConformancePacksRequest) Returns a list of organization conformance packs.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.
For accounts within an organization
If you deploy an organizational rule or conformance pack in an organization administrator account, and then establish a delegated administrator and deploy an organizational rule or conformance pack in the delegated administrator account, you won't be able to see the organizational rule or conformance pack in the organization administrator account from the delegated administrator account or see the organizational rule or conformance pack in the delegated administrator account from organization administrator account. The
DescribeOrganizationConfigRules
andDescribeOrganizationConformancePacks
APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.
This is a convenience which creates an instance of the
DescribeOrganizationConformancePacksRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationConformancePacksRequest.builder()
- Parameters:
describeOrganizationConformancePacksRequest
- AConsumer
that will call methods onDescribeOrganizationConformancePacksRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeOrganizationConformancePacks operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidNextTokenException The specified next token is not valid. 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 For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
describeOrganizationConformancePacksPaginator
default DescribeOrganizationConformancePacksPublisher describeOrganizationConformancePacksPaginator(DescribeOrganizationConformancePacksRequest describeOrganizationConformancePacksRequest) This is a variant of
describeOrganizationConformancePacks(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksPublisher publisher = client.describeOrganizationConformancePacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksPublisher publisher = client.describeOrganizationConformancePacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrganizationConformancePacks(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksRequest)
operation.- Parameters:
describeOrganizationConformancePacksRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidNextTokenException The specified next token is not valid. 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 For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
describeOrganizationConformancePacksPaginator
default DescribeOrganizationConformancePacksPublisher describeOrganizationConformancePacksPaginator(Consumer<DescribeOrganizationConformancePacksRequest.Builder> describeOrganizationConformancePacksRequest) This is a variant of
describeOrganizationConformancePacks(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksPublisher publisher = client.describeOrganizationConformancePacksPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksPublisher publisher = client.describeOrganizationConformancePacksPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOrganizationConformancePacks(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksRequest)
operation.
This is a convenience which creates an instance of the
DescribeOrganizationConformancePacksRequest.Builder
avoiding the need to create one manually viaDescribeOrganizationConformancePacksRequest.builder()
- Parameters:
describeOrganizationConformancePacksRequest
- AConsumer
that will call methods onDescribeOrganizationConformancePacksRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidNextTokenException The specified next token is not valid. 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 For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
describePendingAggregationRequests
default CompletableFuture<DescribePendingAggregationRequestsResponse> describePendingAggregationRequests(DescribePendingAggregationRequestsRequest describePendingAggregationRequestsRequest) Returns a list of all pending aggregation requests.
- Parameters:
describePendingAggregationRequestsRequest
-- Returns:
- A Java Future containing the result of the DescribePendingAggregationRequests operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingAggregationRequests
default CompletableFuture<DescribePendingAggregationRequestsResponse> describePendingAggregationRequests(Consumer<DescribePendingAggregationRequestsRequest.Builder> describePendingAggregationRequestsRequest) Returns a list of all pending aggregation requests.
This is a convenience which creates an instance of the
DescribePendingAggregationRequestsRequest.Builder
avoiding the need to create one manually viaDescribePendingAggregationRequestsRequest.builder()
- Parameters:
describePendingAggregationRequestsRequest
- AConsumer
that will call methods onDescribePendingAggregationRequestsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribePendingAggregationRequests operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingAggregationRequests
default CompletableFuture<DescribePendingAggregationRequestsResponse> describePendingAggregationRequests()Returns a list of all pending aggregation requests.
- Returns:
- A Java Future containing the result of the DescribePendingAggregationRequests operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingAggregationRequestsPaginator
This is a variant of
describePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsPublisher publisher = client.describePendingAggregationRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsPublisher publisher = client.describePendingAggregationRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingAggregationRequestsPaginator
default DescribePendingAggregationRequestsPublisher describePendingAggregationRequestsPaginator(DescribePendingAggregationRequestsRequest describePendingAggregationRequestsRequest) This is a variant of
describePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsPublisher publisher = client.describePendingAggregationRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsPublisher publisher = client.describePendingAggregationRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest)
operation.- Parameters:
describePendingAggregationRequestsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describePendingAggregationRequestsPaginator
default DescribePendingAggregationRequestsPublisher describePendingAggregationRequestsPaginator(Consumer<DescribePendingAggregationRequestsRequest.Builder> describePendingAggregationRequestsRequest) This is a variant of
describePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsPublisher publisher = client.describePendingAggregationRequestsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsPublisher publisher = client.describePendingAggregationRequestsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest)
operation.
This is a convenience which creates an instance of the
DescribePendingAggregationRequestsRequest.Builder
avoiding the need to create one manually viaDescribePendingAggregationRequestsRequest.builder()
- Parameters:
describePendingAggregationRequestsRequest
- AConsumer
that will call methods onDescribePendingAggregationRequestsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRemediationConfigurations
default CompletableFuture<DescribeRemediationConfigurationsResponse> describeRemediationConfigurations(DescribeRemediationConfigurationsRequest describeRemediationConfigurationsRequest) Returns the details of one or more remediation configurations.
- Parameters:
describeRemediationConfigurationsRequest
-- Returns:
- A Java Future containing the result of the DescribeRemediationConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRemediationConfigurations
default CompletableFuture<DescribeRemediationConfigurationsResponse> describeRemediationConfigurations(Consumer<DescribeRemediationConfigurationsRequest.Builder> describeRemediationConfigurationsRequest) Returns the details of one or more remediation configurations.
This is a convenience which creates an instance of the
DescribeRemediationConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeRemediationConfigurationsRequest.builder()
- Parameters:
describeRemediationConfigurationsRequest
- AConsumer
that will call methods onDescribeRemediationConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRemediationConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRemediationExceptions
default CompletableFuture<DescribeRemediationExceptionsResponse> describeRemediationExceptions(DescribeRemediationExceptionsRequest describeRemediationExceptionsRequest) Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
- Parameters:
describeRemediationExceptionsRequest
-- Returns:
- A Java Future containing the result of the DescribeRemediationExceptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The specified next token is not valid. Specify the
- See Also:
-
describeRemediationExceptions
default CompletableFuture<DescribeRemediationExceptionsResponse> describeRemediationExceptions(Consumer<DescribeRemediationExceptionsRequest.Builder> describeRemediationExceptionsRequest) Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response.
Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
When you specify the limit and the next token, you receive a paginated response.
Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.
This is a convenience which creates an instance of the
DescribeRemediationExceptionsRequest.Builder
avoiding the need to create one manually viaDescribeRemediationExceptionsRequest.builder()
- Parameters:
describeRemediationExceptionsRequest
- AConsumer
that will call methods onDescribeRemediationExceptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRemediationExceptions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The specified next token is not valid. Specify the
- See Also:
-
describeRemediationExceptionsPaginator
default DescribeRemediationExceptionsPublisher describeRemediationExceptionsPaginator(DescribeRemediationExceptionsRequest describeRemediationExceptionsRequest) This is a variant of
describeRemediationExceptions(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsPublisher publisher = client.describeRemediationExceptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsPublisher publisher = client.describeRemediationExceptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRemediationExceptions(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsRequest)
operation.- Parameters:
describeRemediationExceptionsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The specified next token is not valid. Specify the
- See Also:
-
describeRemediationExceptionsPaginator
default DescribeRemediationExceptionsPublisher describeRemediationExceptionsPaginator(Consumer<DescribeRemediationExceptionsRequest.Builder> describeRemediationExceptionsRequest) This is a variant of
describeRemediationExceptions(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsPublisher publisher = client.describeRemediationExceptionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsPublisher publisher = client.describeRemediationExceptionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRemediationExceptions(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRemediationExceptionsRequest.Builder
avoiding the need to create one manually viaDescribeRemediationExceptionsRequest.builder()
- Parameters:
describeRemediationExceptionsRequest
- AConsumer
that will call methods onDescribeRemediationExceptionsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The specified next token is not valid. Specify the
- See Also:
-
describeRemediationExecutionStatus
default CompletableFuture<DescribeRemediationExecutionStatusResponse> describeRemediationExecutionStatus(DescribeRemediationExecutionStatusRequest describeRemediationExecutionStatusRequest) 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.
- Parameters:
describeRemediationExecutionStatusRequest
-- Returns:
- A Java Future containing the result of the DescribeRemediationExecutionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchRemediationConfigurationException You specified an Config rule without a remediation configuration.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRemediationExecutionStatus
default CompletableFuture<DescribeRemediationExecutionStatusResponse> describeRemediationExecutionStatus(Consumer<DescribeRemediationExecutionStatusRequest.Builder> describeRemediationExecutionStatusRequest) 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.
This is a convenience which creates an instance of the
DescribeRemediationExecutionStatusRequest.Builder
avoiding the need to create one manually viaDescribeRemediationExecutionStatusRequest.builder()
- Parameters:
describeRemediationExecutionStatusRequest
- AConsumer
that will call methods onDescribeRemediationExecutionStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRemediationExecutionStatus operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchRemediationConfigurationException You specified an Config rule without a remediation configuration.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRemediationExecutionStatusPaginator
default DescribeRemediationExecutionStatusPublisher describeRemediationExecutionStatusPaginator(DescribeRemediationExecutionStatusRequest describeRemediationExecutionStatusRequest) This is a variant of
describeRemediationExecutionStatus(software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeRemediationExecutionStatusPublisher publisher = client.describeRemediationExecutionStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeRemediationExecutionStatusPublisher publisher = client.describeRemediationExecutionStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRemediationExecutionStatus(software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusRequest)
operation.- Parameters:
describeRemediationExecutionStatusRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchRemediationConfigurationException You specified an Config rule without a remediation configuration.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRemediationExecutionStatusPaginator
default DescribeRemediationExecutionStatusPublisher describeRemediationExecutionStatusPaginator(Consumer<DescribeRemediationExecutionStatusRequest.Builder> describeRemediationExecutionStatusRequest) This is a variant of
describeRemediationExecutionStatus(software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeRemediationExecutionStatusPublisher publisher = client.describeRemediationExecutionStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeRemediationExecutionStatusPublisher publisher = client.describeRemediationExecutionStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRemediationExecutionStatus(software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusRequest)
operation.
This is a convenience which creates an instance of the
DescribeRemediationExecutionStatusRequest.Builder
avoiding the need to create one manually viaDescribeRemediationExecutionStatusRequest.builder()
- Parameters:
describeRemediationExecutionStatusRequest
- AConsumer
that will call methods onDescribeRemediationExecutionStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchRemediationConfigurationException You specified an Config rule without a remediation configuration.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRetentionConfigurations
default CompletableFuture<DescribeRetentionConfigurationsResponse> describeRetentionConfigurations(DescribeRetentionConfigurationsRequest describeRetentionConfigurationsRequest) 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, Config supports only one retention configuration per region in your account.
- Parameters:
describeRetentionConfigurationsRequest
-- Returns:
- A Java Future containing the result of the DescribeRetentionConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRetentionConfigurations
default CompletableFuture<DescribeRetentionConfigurationsResponse> describeRetentionConfigurations(Consumer<DescribeRetentionConfigurationsRequest.Builder> describeRetentionConfigurationsRequest) 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, Config supports only one retention configuration per region in your account.
This is a convenience which creates an instance of the
DescribeRetentionConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeRetentionConfigurationsRequest.builder()
- Parameters:
describeRetentionConfigurationsRequest
- AConsumer
that will call methods onDescribeRetentionConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DescribeRetentionConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRetentionConfigurations
default CompletableFuture<DescribeRetentionConfigurationsResponse> describeRetentionConfigurations()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, Config supports only one retention configuration per region in your account.
- Returns:
- A Java Future containing the result of the DescribeRetentionConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRetentionConfigurationsPaginator
This is a variant of
describeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsPublisher publisher = client.describeRetentionConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsPublisher publisher = client.describeRetentionConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRetentionConfigurationsPaginator
default DescribeRetentionConfigurationsPublisher describeRetentionConfigurationsPaginator(DescribeRetentionConfigurationsRequest describeRetentionConfigurationsRequest) This is a variant of
describeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsPublisher publisher = client.describeRetentionConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsPublisher publisher = client.describeRetentionConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest)
operation.- Parameters:
describeRetentionConfigurationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
describeRetentionConfigurationsPaginator
default DescribeRetentionConfigurationsPublisher describeRetentionConfigurationsPaginator(Consumer<DescribeRetentionConfigurationsRequest.Builder> describeRetentionConfigurationsRequest) This is a variant of
describeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsPublisher publisher = client.describeRetentionConfigurationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsPublisher publisher = client.describeRetentionConfigurationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest)
operation.
This is a convenience which creates an instance of the
DescribeRetentionConfigurationsRequest.Builder
avoiding the need to create one manually viaDescribeRetentionConfigurationsRequest.builder()
- Parameters:
describeRetentionConfigurationsRequest
- AConsumer
that will call methods onDescribeRetentionConfigurationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getAggregateComplianceDetailsByConfigRule
default CompletableFuture<GetAggregateComplianceDetailsByConfigRuleResponse> getAggregateComplianceDetailsByConfigRule(GetAggregateComplianceDetailsByConfigRuleRequest getAggregateComplianceDetailsByConfigRuleRequest) Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services 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.- Parameters:
getAggregateComplianceDetailsByConfigRuleRequest
-- Returns:
- A Java Future containing the result of the GetAggregateComplianceDetailsByConfigRule operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateComplianceDetailsByConfigRule
default CompletableFuture<GetAggregateComplianceDetailsByConfigRuleResponse> getAggregateComplianceDetailsByConfigRule(Consumer<GetAggregateComplianceDetailsByConfigRuleRequest.Builder> getAggregateComplianceDetailsByConfigRuleRequest) Returns the evaluation results for the specified Config rule for a specific resource in a rule. The results indicate which Amazon Web Services 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.
This is a convenience which creates an instance of the
GetAggregateComplianceDetailsByConfigRuleRequest.Builder
avoiding the need to create one manually viaGetAggregateComplianceDetailsByConfigRuleRequest.builder()
- Parameters:
getAggregateComplianceDetailsByConfigRuleRequest
- AConsumer
that will call methods onGetAggregateComplianceDetailsByConfigRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAggregateComplianceDetailsByConfigRule operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateComplianceDetailsByConfigRulePaginator
default GetAggregateComplianceDetailsByConfigRulePublisher getAggregateComplianceDetailsByConfigRulePaginator(GetAggregateComplianceDetailsByConfigRuleRequest getAggregateComplianceDetailsByConfigRuleRequest) This is a variant of
getAggregateComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRulePublisher publisher = client.getAggregateComplianceDetailsByConfigRulePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRulePublisher publisher = client.getAggregateComplianceDetailsByConfigRulePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAggregateComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleRequest)
operation.- Parameters:
getAggregateComplianceDetailsByConfigRuleRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateComplianceDetailsByConfigRulePaginator
default GetAggregateComplianceDetailsByConfigRulePublisher getAggregateComplianceDetailsByConfigRulePaginator(Consumer<GetAggregateComplianceDetailsByConfigRuleRequest.Builder> getAggregateComplianceDetailsByConfigRuleRequest) This is a variant of
getAggregateComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRulePublisher publisher = client.getAggregateComplianceDetailsByConfigRulePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRulePublisher publisher = client.getAggregateComplianceDetailsByConfigRulePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAggregateComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleRequest)
operation.
This is a convenience which creates an instance of the
GetAggregateComplianceDetailsByConfigRuleRequest.Builder
avoiding the need to create one manually viaGetAggregateComplianceDetailsByConfigRuleRequest.builder()
- Parameters:
getAggregateComplianceDetailsByConfigRuleRequest
- AConsumer
that will call methods onGetAggregateComplianceDetailsByConfigRuleRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateConfigRuleComplianceSummary
default CompletableFuture<GetAggregateConfigRuleComplianceSummaryResponse> getAggregateConfigRuleComplianceSummary(GetAggregateConfigRuleComplianceSummaryRequest getAggregateConfigRuleComplianceSummaryRequest) 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.
- Parameters:
getAggregateConfigRuleComplianceSummaryRequest
-- Returns:
- A Java Future containing the result of the GetAggregateConfigRuleComplianceSummary operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateConfigRuleComplianceSummary
default CompletableFuture<GetAggregateConfigRuleComplianceSummaryResponse> getAggregateConfigRuleComplianceSummary(Consumer<GetAggregateConfigRuleComplianceSummaryRequest.Builder> getAggregateConfigRuleComplianceSummaryRequest) 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.
This is a convenience which creates an instance of the
GetAggregateConfigRuleComplianceSummaryRequest.Builder
avoiding the need to create one manually viaGetAggregateConfigRuleComplianceSummaryRequest.builder()
- Parameters:
getAggregateConfigRuleComplianceSummaryRequest
- AConsumer
that will call methods onGetAggregateConfigRuleComplianceSummaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAggregateConfigRuleComplianceSummary operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateConfigRuleComplianceSummaryPaginator
default GetAggregateConfigRuleComplianceSummaryPublisher getAggregateConfigRuleComplianceSummaryPaginator(GetAggregateConfigRuleComplianceSummaryRequest getAggregateConfigRuleComplianceSummaryRequest) This is a variant of
getAggregateConfigRuleComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetAggregateConfigRuleComplianceSummaryPublisher publisher = client.getAggregateConfigRuleComplianceSummaryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetAggregateConfigRuleComplianceSummaryPublisher publisher = client.getAggregateConfigRuleComplianceSummaryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAggregateConfigRuleComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryRequest)
operation.- Parameters:
getAggregateConfigRuleComplianceSummaryRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateConfigRuleComplianceSummaryPaginator
default GetAggregateConfigRuleComplianceSummaryPublisher getAggregateConfigRuleComplianceSummaryPaginator(Consumer<GetAggregateConfigRuleComplianceSummaryRequest.Builder> getAggregateConfigRuleComplianceSummaryRequest) This is a variant of
getAggregateConfigRuleComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetAggregateConfigRuleComplianceSummaryPublisher publisher = client.getAggregateConfigRuleComplianceSummaryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetAggregateConfigRuleComplianceSummaryPublisher publisher = client.getAggregateConfigRuleComplianceSummaryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAggregateConfigRuleComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryRequest)
operation.
This is a convenience which creates an instance of the
GetAggregateConfigRuleComplianceSummaryRequest.Builder
avoiding the need to create one manually viaGetAggregateConfigRuleComplianceSummaryRequest.builder()
- Parameters:
getAggregateConfigRuleComplianceSummaryRequest
- AConsumer
that will call methods onGetAggregateConfigRuleComplianceSummaryRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateConformancePackComplianceSummary
default CompletableFuture<GetAggregateConformancePackComplianceSummaryResponse> getAggregateConformancePackComplianceSummary(GetAggregateConformancePackComplianceSummaryRequest getAggregateConformancePackComplianceSummaryRequest) Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
- Parameters:
getAggregateConformancePackComplianceSummaryRequest
-- Returns:
- A Java Future containing the result of the GetAggregateConformancePackComplianceSummary operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateConformancePackComplianceSummary
default CompletableFuture<GetAggregateConformancePackComplianceSummaryResponse> getAggregateConformancePackComplianceSummary(Consumer<GetAggregateConformancePackComplianceSummaryRequest.Builder> getAggregateConformancePackComplianceSummaryRequest) Returns the count of compliant and noncompliant conformance packs across all Amazon Web Services accounts and Amazon Web Services Regions in an aggregator. You can filter based on Amazon Web Services account ID or Amazon Web Services Region.
The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.
This is a convenience which creates an instance of the
GetAggregateConformancePackComplianceSummaryRequest.Builder
avoiding the need to create one manually viaGetAggregateConformancePackComplianceSummaryRequest.builder()
- Parameters:
getAggregateConformancePackComplianceSummaryRequest
- AConsumer
that will call methods onGetAggregateConformancePackComplianceSummaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAggregateConformancePackComplianceSummary operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateConformancePackComplianceSummaryPaginator
default GetAggregateConformancePackComplianceSummaryPublisher getAggregateConformancePackComplianceSummaryPaginator(GetAggregateConformancePackComplianceSummaryRequest getAggregateConformancePackComplianceSummaryRequest) This is a variant of
getAggregateConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetAggregateConformancePackComplianceSummaryPublisher publisher = client.getAggregateConformancePackComplianceSummaryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetAggregateConformancePackComplianceSummaryPublisher publisher = client.getAggregateConformancePackComplianceSummaryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAggregateConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryRequest)
operation.- Parameters:
getAggregateConformancePackComplianceSummaryRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateConformancePackComplianceSummaryPaginator
default GetAggregateConformancePackComplianceSummaryPublisher getAggregateConformancePackComplianceSummaryPaginator(Consumer<GetAggregateConformancePackComplianceSummaryRequest.Builder> getAggregateConformancePackComplianceSummaryRequest) This is a variant of
getAggregateConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetAggregateConformancePackComplianceSummaryPublisher publisher = client.getAggregateConformancePackComplianceSummaryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetAggregateConformancePackComplianceSummaryPublisher publisher = client.getAggregateConformancePackComplianceSummaryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAggregateConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryRequest)
operation.
This is a convenience which creates an instance of the
GetAggregateConformancePackComplianceSummaryRequest.Builder
avoiding the need to create one manually viaGetAggregateConformancePackComplianceSummaryRequest.builder()
- Parameters:
getAggregateConformancePackComplianceSummaryRequest
- AConsumer
that will call methods onGetAggregateConformancePackComplianceSummaryRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateDiscoveredResourceCounts
default CompletableFuture<GetAggregateDiscoveredResourceCountsResponse> getAggregateDiscoveredResourceCounts(GetAggregateDiscoveredResourceCountsRequest getAggregateDiscoveredResourceCountsRequest) Returns the resource counts across accounts and regions that are present in your 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.
- Parameters:
getAggregateDiscoveredResourceCountsRequest
-- Returns:
- A Java Future containing the result of the GetAggregateDiscoveredResourceCounts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateDiscoveredResourceCounts
default CompletableFuture<GetAggregateDiscoveredResourceCountsResponse> getAggregateDiscoveredResourceCounts(Consumer<GetAggregateDiscoveredResourceCountsRequest.Builder> getAggregateDiscoveredResourceCountsRequest) Returns the resource counts across accounts and regions that are present in your 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.
This is a convenience which creates an instance of the
GetAggregateDiscoveredResourceCountsRequest.Builder
avoiding the need to create one manually viaGetAggregateDiscoveredResourceCountsRequest.builder()
- Parameters:
getAggregateDiscoveredResourceCountsRequest
- AConsumer
that will call methods onGetAggregateDiscoveredResourceCountsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAggregateDiscoveredResourceCounts operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateDiscoveredResourceCountsPaginator
default GetAggregateDiscoveredResourceCountsPublisher getAggregateDiscoveredResourceCountsPaginator(GetAggregateDiscoveredResourceCountsRequest getAggregateDiscoveredResourceCountsRequest) This is a variant of
getAggregateDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsPublisher publisher = client.getAggregateDiscoveredResourceCountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsPublisher publisher = client.getAggregateDiscoveredResourceCountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAggregateDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsRequest)
operation.- Parameters:
getAggregateDiscoveredResourceCountsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateDiscoveredResourceCountsPaginator
default GetAggregateDiscoveredResourceCountsPublisher getAggregateDiscoveredResourceCountsPaginator(Consumer<GetAggregateDiscoveredResourceCountsRequest.Builder> getAggregateDiscoveredResourceCountsRequest) This is a variant of
getAggregateDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsPublisher publisher = client.getAggregateDiscoveredResourceCountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsPublisher publisher = client.getAggregateDiscoveredResourceCountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getAggregateDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsRequest)
operation.
This is a convenience which creates an instance of the
GetAggregateDiscoveredResourceCountsRequest.Builder
avoiding the need to create one manually viaGetAggregateDiscoveredResourceCountsRequest.builder()
- Parameters:
getAggregateDiscoveredResourceCountsRequest
- AConsumer
that will call methods onGetAggregateDiscoveredResourceCountsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateResourceConfig
default CompletableFuture<GetAggregateResourceConfigResponse> getAggregateResourceConfig(GetAggregateResourceConfigRequest getAggregateResourceConfigRequest) Returns configuration item that is aggregated for your specific resource in a specific source account and region.
- Parameters:
getAggregateResourceConfigRequest
-- Returns:
- A Java Future containing the result of the GetAggregateResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getAggregateResourceConfig
default CompletableFuture<GetAggregateResourceConfigResponse> getAggregateResourceConfig(Consumer<GetAggregateResourceConfigRequest.Builder> getAggregateResourceConfigRequest) Returns configuration item that is aggregated for your specific resource in a specific source account and region.
This is a convenience which creates an instance of the
GetAggregateResourceConfigRequest.Builder
avoiding the need to create one manually viaGetAggregateResourceConfigRequest.builder()
- Parameters:
getAggregateResourceConfigRequest
- AConsumer
that will call methods onGetAggregateResourceConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetAggregateResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getComplianceDetailsByConfigRule
default CompletableFuture<GetComplianceDetailsByConfigRuleResponse> getComplianceDetailsByConfigRule(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest) Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
- Parameters:
getComplianceDetailsByConfigRuleRequest
-- Returns:
- A Java Future containing the result of the GetComplianceDetailsByConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceDetailsByConfigRule
default CompletableFuture<GetComplianceDetailsByConfigRuleResponse> getComplianceDetailsByConfigRule(Consumer<GetComplianceDetailsByConfigRuleRequest.Builder> getComplianceDetailsByConfigRuleRequest) Returns the evaluation results for the specified Config rule. The results indicate which Amazon Web Services resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
This is a convenience which creates an instance of the
GetComplianceDetailsByConfigRuleRequest.Builder
avoiding the need to create one manually viaGetComplianceDetailsByConfigRuleRequest.builder()
- Parameters:
getComplianceDetailsByConfigRuleRequest
- AConsumer
that will call methods onGetComplianceDetailsByConfigRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetComplianceDetailsByConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceDetailsByConfigRulePaginator
default GetComplianceDetailsByConfigRulePublisher getComplianceDetailsByConfigRulePaginator(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest) This is a variant of
getComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRulePublisher publisher = client.getComplianceDetailsByConfigRulePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRulePublisher publisher = client.getComplianceDetailsByConfigRulePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleRequest)
operation.- Parameters:
getComplianceDetailsByConfigRuleRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceDetailsByConfigRulePaginator
default GetComplianceDetailsByConfigRulePublisher getComplianceDetailsByConfigRulePaginator(Consumer<GetComplianceDetailsByConfigRuleRequest.Builder> getComplianceDetailsByConfigRuleRequest) This is a variant of
getComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRulePublisher publisher = client.getComplianceDetailsByConfigRulePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRulePublisher publisher = client.getComplianceDetailsByConfigRulePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleRequest)
operation.
This is a convenience which creates an instance of the
GetComplianceDetailsByConfigRuleRequest.Builder
avoiding the need to create one manually viaGetComplianceDetailsByConfigRuleRequest.builder()
- Parameters:
getComplianceDetailsByConfigRuleRequest
- AConsumer
that will call methods onGetComplianceDetailsByConfigRuleRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceDetailsByResource
default CompletableFuture<GetComplianceDetailsByResourceResponse> getComplianceDetailsByResource(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest) Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.
- Parameters:
getComplianceDetailsByResourceRequest
-- Returns:
- A Java Future containing the result of the GetComplianceDetailsByResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceDetailsByResource
default CompletableFuture<GetComplianceDetailsByResourceResponse> getComplianceDetailsByResource(Consumer<GetComplianceDetailsByResourceRequest.Builder> getComplianceDetailsByResourceRequest) Returns the evaluation results for the specified Amazon Web Services resource. The results indicate which Config rules were used to evaluate the resource, when each rule was last invoked, and whether the resource complies with each rule.
This is a convenience which creates an instance of the
GetComplianceDetailsByResourceRequest.Builder
avoiding the need to create one manually viaGetComplianceDetailsByResourceRequest.builder()
- Parameters:
getComplianceDetailsByResourceRequest
- AConsumer
that will call methods onGetComplianceDetailsByResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetComplianceDetailsByResource operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceDetailsByResourcePaginator
default GetComplianceDetailsByResourcePublisher getComplianceDetailsByResourcePaginator(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest) This is a variant of
getComplianceDetailsByResource(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourcePublisher publisher = client.getComplianceDetailsByResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourcePublisher publisher = client.getComplianceDetailsByResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getComplianceDetailsByResource(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceRequest)
operation.- Parameters:
getComplianceDetailsByResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceDetailsByResourcePaginator
default GetComplianceDetailsByResourcePublisher getComplianceDetailsByResourcePaginator(Consumer<GetComplianceDetailsByResourceRequest.Builder> getComplianceDetailsByResourceRequest) This is a variant of
getComplianceDetailsByResource(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourcePublisher publisher = client.getComplianceDetailsByResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourcePublisher publisher = client.getComplianceDetailsByResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceResponse response) { //... }; });
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getComplianceDetailsByResource(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceRequest)
operation.
This is a convenience which creates an instance of the
GetComplianceDetailsByResourceRequest.Builder
avoiding the need to create one manually viaGetComplianceDetailsByResourceRequest.builder()
- Parameters:
getComplianceDetailsByResourceRequest
- AConsumer
that will call methods onGetComplianceDetailsByResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceSummaryByConfigRule
default CompletableFuture<GetComplianceSummaryByConfigRuleResponse> getComplianceSummaryByConfigRule(GetComplianceSummaryByConfigRuleRequest getComplianceSummaryByConfigRuleRequest) Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
- Parameters:
getComplianceSummaryByConfigRuleRequest
-- Returns:
- A Java Future containing the result of the GetComplianceSummaryByConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceSummaryByConfigRule
default CompletableFuture<GetComplianceSummaryByConfigRuleResponse> getComplianceSummaryByConfigRule(Consumer<GetComplianceSummaryByConfigRuleRequest.Builder> getComplianceSummaryByConfigRuleRequest) Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
This is a convenience which creates an instance of the
GetComplianceSummaryByConfigRuleRequest.Builder
avoiding the need to create one manually viaGetComplianceSummaryByConfigRuleRequest.builder()
- Parameters:
getComplianceSummaryByConfigRuleRequest
- AConsumer
that will call methods onGetComplianceSummaryByConfigRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetComplianceSummaryByConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceSummaryByConfigRule
default CompletableFuture<GetComplianceSummaryByConfigRuleResponse> getComplianceSummaryByConfigRule()Returns the number of Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
- Returns:
- A Java Future containing the result of the GetComplianceSummaryByConfigRule operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceSummaryByResourceType
default CompletableFuture<GetComplianceSummaryByResourceTypeResponse> 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.
- Parameters:
getComplianceSummaryByResourceTypeRequest
-- Returns:
- A Java Future containing the result of the GetComplianceSummaryByResourceType operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceSummaryByResourceType
default CompletableFuture<GetComplianceSummaryByResourceTypeResponse> getComplianceSummaryByResourceType(Consumer<GetComplianceSummaryByResourceTypeRequest.Builder> 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.
This is a convenience which creates an instance of the
GetComplianceSummaryByResourceTypeRequest.Builder
avoiding the need to create one manually viaGetComplianceSummaryByResourceTypeRequest.builder()
- Parameters:
getComplianceSummaryByResourceTypeRequest
- AConsumer
that will call methods onGetComplianceSummaryByResourceTypeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetComplianceSummaryByResourceType operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getComplianceSummaryByResourceType
default CompletableFuture<GetComplianceSummaryByResourceTypeResponse> getComplianceSummaryByResourceType()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.
- Returns:
- A Java Future containing the result of the GetComplianceSummaryByResourceType operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConformancePackComplianceDetails
default CompletableFuture<GetConformancePackComplianceDetailsResponse> getConformancePackComplianceDetails(GetConformancePackComplianceDetailsRequest getConformancePackComplianceDetailsRequest) Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
- Parameters:
getConformancePackComplianceDetailsRequest
-- Returns:
- A Java Future containing the result of the GetConformancePackComplianceDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- NoSuchConfigRuleInConformancePackException Config rule that you passed in the filter does not exist.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConformancePackComplianceDetails
default CompletableFuture<GetConformancePackComplianceDetailsResponse> getConformancePackComplianceDetails(Consumer<GetConformancePackComplianceDetailsRequest.Builder> getConformancePackComplianceDetailsRequest) Returns compliance details of a conformance pack for all Amazon Web Services resources that are monitered by conformance pack.
This is a convenience which creates an instance of the
GetConformancePackComplianceDetailsRequest.Builder
avoiding the need to create one manually viaGetConformancePackComplianceDetailsRequest.builder()
- Parameters:
getConformancePackComplianceDetailsRequest
- AConsumer
that will call methods onGetConformancePackComplianceDetailsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetConformancePackComplianceDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- NoSuchConfigRuleInConformancePackException Config rule that you passed in the filter does not exist.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConformancePackComplianceDetailsPaginator
default GetConformancePackComplianceDetailsPublisher getConformancePackComplianceDetailsPaginator(GetConformancePackComplianceDetailsRequest getConformancePackComplianceDetailsRequest) This is a variant of
getConformancePackComplianceDetails(software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetConformancePackComplianceDetailsPublisher publisher = client.getConformancePackComplianceDetailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetConformancePackComplianceDetailsPublisher publisher = client.getConformancePackComplianceDetailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getConformancePackComplianceDetails(software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsRequest)
operation.- Parameters:
getConformancePackComplianceDetailsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- NoSuchConfigRuleInConformancePackException Config rule that you passed in the filter does not exist.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConformancePackComplianceDetailsPaginator
default GetConformancePackComplianceDetailsPublisher getConformancePackComplianceDetailsPaginator(Consumer<GetConformancePackComplianceDetailsRequest.Builder> getConformancePackComplianceDetailsRequest) This is a variant of
getConformancePackComplianceDetails(software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetConformancePackComplianceDetailsPublisher publisher = client.getConformancePackComplianceDetailsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetConformancePackComplianceDetailsPublisher publisher = client.getConformancePackComplianceDetailsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getConformancePackComplianceDetails(software.amazon.awssdk.services.config.model.GetConformancePackComplianceDetailsRequest)
operation.
This is a convenience which creates an instance of the
GetConformancePackComplianceDetailsRequest.Builder
avoiding the need to create one manually viaGetConformancePackComplianceDetailsRequest.builder()
- Parameters:
getConformancePackComplianceDetailsRequest
- AConsumer
that will call methods onGetConformancePackComplianceDetailsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- NoSuchConfigRuleInConformancePackException Config rule that you passed in the filter does not exist.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConformancePackComplianceSummary
default CompletableFuture<GetConformancePackComplianceSummaryResponse> getConformancePackComplianceSummary(GetConformancePackComplianceSummaryRequest getConformancePackComplianceSummaryRequest) Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
- Parameters:
getConformancePackComplianceSummaryRequest
-- Returns:
- A Java Future containing the result of the GetConformancePackComplianceSummary operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConformancePackComplianceSummary
default CompletableFuture<GetConformancePackComplianceSummaryResponse> getConformancePackComplianceSummary(Consumer<GetConformancePackComplianceSummaryRequest.Builder> getConformancePackComplianceSummaryRequest) Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.
This is a convenience which creates an instance of the
GetConformancePackComplianceSummaryRequest.Builder
avoiding the need to create one manually viaGetConformancePackComplianceSummaryRequest.builder()
- Parameters:
getConformancePackComplianceSummaryRequest
- AConsumer
that will call methods onGetConformancePackComplianceSummaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetConformancePackComplianceSummary operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConformancePackComplianceSummaryPaginator
default GetConformancePackComplianceSummaryPublisher getConformancePackComplianceSummaryPaginator(GetConformancePackComplianceSummaryRequest getConformancePackComplianceSummaryRequest) This is a variant of
getConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetConformancePackComplianceSummaryPublisher publisher = client.getConformancePackComplianceSummaryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetConformancePackComplianceSummaryPublisher publisher = client.getConformancePackComplianceSummaryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryRequest)
operation.- Parameters:
getConformancePackComplianceSummaryRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getConformancePackComplianceSummaryPaginator
default GetConformancePackComplianceSummaryPublisher getConformancePackComplianceSummaryPaginator(Consumer<GetConformancePackComplianceSummaryRequest.Builder> getConformancePackComplianceSummaryRequest) This is a variant of
getConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetConformancePackComplianceSummaryPublisher publisher = client.getConformancePackComplianceSummaryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetConformancePackComplianceSummaryPublisher publisher = client.getConformancePackComplianceSummaryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryRequest)
operation.
This is a convenience which creates an instance of the
GetConformancePackComplianceSummaryRequest.Builder
avoiding the need to create one manually viaGetConformancePackComplianceSummaryRequest.builder()
- Parameters:
getConformancePackComplianceSummaryRequest
- AConsumer
that will call methods onGetConformancePackComplianceSummaryRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConformancePackException You specified one or more conformance packs that do not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCustomRulePolicy
default CompletableFuture<GetCustomRulePolicyResponse> getCustomRulePolicy(GetCustomRulePolicyRequest getCustomRulePolicyRequest) Returns the policy definition containing the logic for your Config Custom Policy rule.
- Parameters:
getCustomRulePolicyRequest
-- Returns:
- A Java Future containing the result of the GetCustomRulePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getCustomRulePolicy
default CompletableFuture<GetCustomRulePolicyResponse> getCustomRulePolicy(Consumer<GetCustomRulePolicyRequest.Builder> getCustomRulePolicyRequest) Returns the policy definition containing the logic for your Config Custom Policy rule.
This is a convenience which creates an instance of the
GetCustomRulePolicyRequest.Builder
avoiding the need to create one manually viaGetCustomRulePolicyRequest.builder()
- Parameters:
getCustomRulePolicyRequest
- AConsumer
that will call methods onGetCustomRulePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetCustomRulePolicy operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDiscoveredResourceCounts
default CompletableFuture<GetDiscoveredResourceCountsResponse> getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest) Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Example
-
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. -
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, Config lists 100 ResourceCount objects on each page. You can customize this number with the
limit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
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 Config customer.
-
You just enabled resource recording.
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
- Parameters:
getDiscoveredResourceCountsRequest
-- Returns:
- A Java Future containing the result of the GetDiscoveredResourceCounts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
-
getDiscoveredResourceCounts
default CompletableFuture<GetDiscoveredResourceCountsResponse> getDiscoveredResourceCounts(Consumer<GetDiscoveredResourceCountsRequest.Builder> getDiscoveredResourceCountsRequest) Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Example
-
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. -
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, Config lists 100 ResourceCount objects on each page. You can customize this number with the
limit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
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 Config customer.
-
You just enabled resource recording.
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
This is a convenience which creates an instance of the
GetDiscoveredResourceCountsRequest.Builder
avoiding the need to create one manually viaGetDiscoveredResourceCountsRequest.builder()
- Parameters:
getDiscoveredResourceCountsRequest
- AConsumer
that will call methods onGetDiscoveredResourceCountsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetDiscoveredResourceCounts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
-
getDiscoveredResourceCounts
Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.
Example
-
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. -
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, Config lists 100 ResourceCount objects on each page. You can customize this number with the
limit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
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 Config customer.
-
You just enabled resource recording.
It might take a few minutes for Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.
- Returns:
- A Java Future containing the result of the GetDiscoveredResourceCounts operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
-
getDiscoveredResourceCountsPaginator
This is a variant of
getDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsPublisher publisher = client.getDiscoveredResourceCountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsPublisher publisher = client.getDiscoveredResourceCountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsResponse response) { //... }; });
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest)
operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getDiscoveredResourceCountsPaginator
default GetDiscoveredResourceCountsPublisher getDiscoveredResourceCountsPaginator(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest) This is a variant of
getDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsPublisher publisher = client.getDiscoveredResourceCountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsPublisher publisher = client.getDiscoveredResourceCountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsResponse response) { //... }; });
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest)
operation.- Parameters:
getDiscoveredResourceCountsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getDiscoveredResourceCountsPaginator
default GetDiscoveredResourceCountsPublisher getDiscoveredResourceCountsPaginator(Consumer<GetDiscoveredResourceCountsRequest.Builder> getDiscoveredResourceCountsRequest) This is a variant of
getDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsPublisher publisher = client.getDiscoveredResourceCountsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsPublisher publisher = client.getDiscoveredResourceCountsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsResponse response) { //... }; });
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest)
operation.
This is a convenience which creates an instance of the
GetDiscoveredResourceCountsRequest.Builder
avoiding the need to create one manually viaGetDiscoveredResourceCountsRequest.builder()
- Parameters:
getDiscoveredResourceCountsRequest
- AConsumer
that will call methods onGetDiscoveredResourceCountsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getOrganizationConfigRuleDetailedStatus
default CompletableFuture<GetOrganizationConfigRuleDetailedStatusResponse> getOrganizationConfigRuleDetailedStatus(GetOrganizationConfigRuleDetailedStatusRequest getOrganizationConfigRuleDetailedStatusRequest) Returns detailed status for each member account within an organization for a given organization Config rule.
- Parameters:
getOrganizationConfigRuleDetailedStatusRequest
-- Returns:
- A Java Future containing the result of the GetOrganizationConfigRuleDetailedStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrganizationConfigRuleDetailedStatus
default CompletableFuture<GetOrganizationConfigRuleDetailedStatusResponse> getOrganizationConfigRuleDetailedStatus(Consumer<GetOrganizationConfigRuleDetailedStatusRequest.Builder> getOrganizationConfigRuleDetailedStatusRequest) Returns detailed status for each member account within an organization for a given organization Config rule.
This is a convenience which creates an instance of the
GetOrganizationConfigRuleDetailedStatusRequest.Builder
avoiding the need to create one manually viaGetOrganizationConfigRuleDetailedStatusRequest.builder()
- Parameters:
getOrganizationConfigRuleDetailedStatusRequest
- AConsumer
that will call methods onGetOrganizationConfigRuleDetailedStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOrganizationConfigRuleDetailedStatus operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrganizationConfigRuleDetailedStatusPaginator
default GetOrganizationConfigRuleDetailedStatusPublisher getOrganizationConfigRuleDetailedStatusPaginator(GetOrganizationConfigRuleDetailedStatusRequest getOrganizationConfigRuleDetailedStatusRequest) This is a variant of
getOrganizationConfigRuleDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusPublisher publisher = client.getOrganizationConfigRuleDetailedStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusPublisher publisher = client.getOrganizationConfigRuleDetailedStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getOrganizationConfigRuleDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusRequest)
operation.- Parameters:
getOrganizationConfigRuleDetailedStatusRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrganizationConfigRuleDetailedStatusPaginator
default GetOrganizationConfigRuleDetailedStatusPublisher getOrganizationConfigRuleDetailedStatusPaginator(Consumer<GetOrganizationConfigRuleDetailedStatusRequest.Builder> getOrganizationConfigRuleDetailedStatusRequest) This is a variant of
getOrganizationConfigRuleDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusPublisher publisher = client.getOrganizationConfigRuleDetailedStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusPublisher publisher = client.getOrganizationConfigRuleDetailedStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getOrganizationConfigRuleDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusRequest)
operation.
This is a convenience which creates an instance of the
GetOrganizationConfigRuleDetailedStatusRequest.Builder
avoiding the need to create one manually viaGetOrganizationConfigRuleDetailedStatusRequest.builder()
- Parameters:
getOrganizationConfigRuleDetailedStatusRequest
- AConsumer
that will call methods onGetOrganizationConfigRuleDetailedStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrganizationConformancePackDetailedStatus
default CompletableFuture<GetOrganizationConformancePackDetailedStatusResponse> getOrganizationConformancePackDetailedStatus(GetOrganizationConformancePackDetailedStatusRequest getOrganizationConformancePackDetailedStatusRequest) Returns detailed status for each member account within an organization for a given organization conformance pack.
- Parameters:
getOrganizationConformancePackDetailedStatusRequest
-- Returns:
- A Java Future containing the result of the GetOrganizationConformancePackDetailedStatus operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
getOrganizationConformancePackDetailedStatus
default CompletableFuture<GetOrganizationConformancePackDetailedStatusResponse> getOrganizationConformancePackDetailedStatus(Consumer<GetOrganizationConformancePackDetailedStatusRequest.Builder> getOrganizationConformancePackDetailedStatusRequest) Returns detailed status for each member account within an organization for a given organization conformance pack.
This is a convenience which creates an instance of the
GetOrganizationConformancePackDetailedStatusRequest.Builder
avoiding the need to create one manually viaGetOrganizationConformancePackDetailedStatusRequest.builder()
- Parameters:
getOrganizationConformancePackDetailedStatusRequest
- AConsumer
that will call methods onGetOrganizationConformancePackDetailedStatusRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOrganizationConformancePackDetailedStatus operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
getOrganizationConformancePackDetailedStatusPaginator
default GetOrganizationConformancePackDetailedStatusPublisher getOrganizationConformancePackDetailedStatusPaginator(GetOrganizationConformancePackDetailedStatusRequest getOrganizationConformancePackDetailedStatusRequest) This is a variant of
getOrganizationConformancePackDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusPublisher publisher = client.getOrganizationConformancePackDetailedStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusPublisher publisher = client.getOrganizationConformancePackDetailedStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getOrganizationConformancePackDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusRequest)
operation.- Parameters:
getOrganizationConformancePackDetailedStatusRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
getOrganizationConformancePackDetailedStatusPaginator
default GetOrganizationConformancePackDetailedStatusPublisher getOrganizationConformancePackDetailedStatusPaginator(Consumer<GetOrganizationConformancePackDetailedStatusRequest.Builder> getOrganizationConformancePackDetailedStatusRequest) This is a variant of
getOrganizationConformancePackDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusPublisher publisher = client.getOrganizationConformancePackDetailedStatusPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusPublisher publisher = client.getOrganizationConformancePackDetailedStatusPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getOrganizationConformancePackDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusRequest)
operation.
This is a convenience which creates an instance of the
GetOrganizationConformancePackDetailedStatusRequest.Builder
avoiding the need to create one manually viaGetOrganizationConformancePackDetailedStatusRequest.builder()
- Parameters:
getOrganizationConformancePackDetailedStatusRequest
- AConsumer
that will call methods onGetOrganizationConformancePackDetailedStatusRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
For DeleteOrganizationConformancePack, you tried to delete an organization conformance pack that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- NoSuchOrganizationConformancePackException Config organization conformance pack that you passed in
the filter does not exist.
- See Also:
-
getOrganizationCustomRulePolicy
default CompletableFuture<GetOrganizationCustomRulePolicyResponse> getOrganizationCustomRulePolicy(GetOrganizationCustomRulePolicyRequest getOrganizationCustomRulePolicyRequest) Returns the policy definition containing the logic for your organization Config Custom Policy rule.
- Parameters:
getOrganizationCustomRulePolicyRequest
-- Returns:
- A Java Future containing the result of the GetOrganizationCustomRulePolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getOrganizationCustomRulePolicy
default CompletableFuture<GetOrganizationCustomRulePolicyResponse> getOrganizationCustomRulePolicy(Consumer<GetOrganizationCustomRulePolicyRequest.Builder> getOrganizationCustomRulePolicyRequest) Returns the policy definition containing the logic for your organization Config Custom Policy rule.
This is a convenience which creates an instance of the
GetOrganizationCustomRulePolicyRequest.Builder
avoiding the need to create one manually viaGetOrganizationCustomRulePolicyRequest.builder()
- Parameters:
getOrganizationCustomRulePolicyRequest
- AConsumer
that will call methods onGetOrganizationCustomRulePolicyRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetOrganizationCustomRulePolicy operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchOrganizationConfigRuleException The Config rule in the request is not valid. Verify that the rule is an organization Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceConfigHistory
default CompletableFuture<GetResourceConfigHistoryResponse> getResourceConfigHistory(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest) For accurate reporting on the compliance status, you must record the
AWS::Config::ResourceCompliance
resource type. For more information, see Selecting Which Resources Config Records.Returns a list of
ConfigurationItems
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 yourConfigurationItems
between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns theConfigurationItems
for the specified retention period.The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the
limit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
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 thenextToken
.- Parameters:
getResourceConfigHistoryRequest
- The input for the GetResourceConfigHistory action.- Returns:
- A Java Future containing the result of the GetResourceConfigHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- ResourceNotDiscoveredException You have specified a resource that is either unknown or has not been discovered.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getResourceConfigHistory
default CompletableFuture<GetResourceConfigHistoryResponse> getResourceConfigHistory(Consumer<GetResourceConfigHistoryRequest.Builder> getResourceConfigHistoryRequest) For accurate reporting on the compliance status, you must record the
AWS::Config::ResourceCompliance
resource type. For more information, see Selecting Which Resources Config Records.Returns a list of
ConfigurationItems
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 yourConfigurationItems
between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns theConfigurationItems
for the specified retention period.The response is paginated. By default, Config returns a limit of 10 configuration items per page. You can customize this number with the
limit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
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 thenextToken
.
This is a convenience which creates an instance of the
GetResourceConfigHistoryRequest.Builder
avoiding the need to create one manually viaGetResourceConfigHistoryRequest.builder()
- Parameters:
getResourceConfigHistoryRequest
- AConsumer
that will call methods onGetResourceConfigHistoryRequest.Builder
to create a request. The input for the GetResourceConfigHistory action.- Returns:
- A Java Future containing the result of the GetResourceConfigHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- ResourceNotDiscoveredException You have specified a resource that is either unknown or has not been discovered.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getResourceConfigHistoryPaginator
default GetResourceConfigHistoryPublisher getResourceConfigHistoryPaginator(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest) This is a variant of
getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryPublisher publisher = client.getResourceConfigHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryPublisher publisher = client.getResourceConfigHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetResourceConfigHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryResponse response) { //... }; });
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation.- Parameters:
getResourceConfigHistoryRequest
- The input for the GetResourceConfigHistory action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- ResourceNotDiscoveredException You have specified a resource that is either unknown or has not been discovered.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getResourceConfigHistoryPaginator
default GetResourceConfigHistoryPublisher getResourceConfigHistoryPaginator(Consumer<GetResourceConfigHistoryRequest.Builder> getResourceConfigHistoryRequest) This is a variant of
getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryPublisher publisher = client.getResourceConfigHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryPublisher publisher = client.getResourceConfigHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.GetResourceConfigHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryResponse response) { //... }; });
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest)
operation.
This is a convenience which creates an instance of the
GetResourceConfigHistoryRequest.Builder
avoiding the need to create one manually viaGetResourceConfigHistoryRequest.builder()
- Parameters:
getResourceConfigHistoryRequest
- AConsumer
that will call methods onGetResourceConfigHistoryRequest.Builder
to create a request. The input for the GetResourceConfigHistory action.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- 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 not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- ResourceNotDiscoveredException You have specified a resource that is either unknown or has not been discovered.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getResourceEvaluationSummary
default CompletableFuture<GetResourceEvaluationSummaryResponse> getResourceEvaluationSummary(GetResourceEvaluationSummaryRequest getResourceEvaluationSummaryRequest) Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.
To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more information, see the Examples section.
- Parameters:
getResourceEvaluationSummaryRequest
-- Returns:
- A Java Future containing the result of the GetResourceEvaluationSummary operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException You have specified a resource that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getResourceEvaluationSummary
default CompletableFuture<GetResourceEvaluationSummaryResponse> getResourceEvaluationSummary(Consumer<GetResourceEvaluationSummaryRequest.Builder> getResourceEvaluationSummaryRequest) Returns a summary of resource evaluation for the specified resource evaluation ID from the proactive rules that were run. The results indicate which evaluation context was used to evaluate the rules, which resource details were evaluated, the evaluation mode that was run, and whether the resource details comply with the configuration of the proactive rules.
To see additional information about the evaluation result, such as which rule flagged a resource as NON_COMPLIANT, use the GetComplianceDetailsByResource API. For more information, see the Examples section.
This is a convenience which creates an instance of the
GetResourceEvaluationSummaryRequest.Builder
avoiding the need to create one manually viaGetResourceEvaluationSummaryRequest.builder()
- Parameters:
getResourceEvaluationSummaryRequest
- AConsumer
that will call methods onGetResourceEvaluationSummaryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetResourceEvaluationSummary operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException You have specified a resource that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getStoredQuery
default CompletableFuture<GetStoredQueryResponse> getStoredQuery(GetStoredQueryRequest getStoredQueryRequest) Returns the details of a specific stored query.
- Parameters:
getStoredQueryRequest
-- Returns:
- A Java Future containing the result of the GetStoredQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException You have specified a resource that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
getStoredQuery
default CompletableFuture<GetStoredQueryResponse> getStoredQuery(Consumer<GetStoredQueryRequest.Builder> getStoredQueryRequest) Returns the details of a specific stored query.
This is a convenience which creates an instance of the
GetStoredQueryRequest.Builder
avoiding the need to create one manually viaGetStoredQueryRequest.builder()
- Parameters:
getStoredQueryRequest
- AConsumer
that will call methods onGetStoredQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetStoredQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException You have specified a resource that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listAggregateDiscoveredResources
default CompletableFuture<ListAggregateDiscoveredResourcesResponse> listAggregateDiscoveredResources(ListAggregateDiscoveredResourcesRequest listAggregateDiscoveredResourcesRequest) 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.- Parameters:
listAggregateDiscoveredResourcesRequest
-- Returns:
- A Java Future containing the result of the ListAggregateDiscoveredResources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listAggregateDiscoveredResources
default CompletableFuture<ListAggregateDiscoveredResourcesResponse> listAggregateDiscoveredResources(Consumer<ListAggregateDiscoveredResourcesRequest.Builder> listAggregateDiscoveredResourcesRequest) 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.
This is a convenience which creates an instance of the
ListAggregateDiscoveredResourcesRequest.Builder
avoiding the need to create one manually viaListAggregateDiscoveredResourcesRequest.builder()
- Parameters:
listAggregateDiscoveredResourcesRequest
- AConsumer
that will call methods onListAggregateDiscoveredResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListAggregateDiscoveredResources operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listAggregateDiscoveredResourcesPaginator
default ListAggregateDiscoveredResourcesPublisher listAggregateDiscoveredResourcesPaginator(ListAggregateDiscoveredResourcesRequest listAggregateDiscoveredResourcesRequest) This is a variant of
listAggregateDiscoveredResources(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesPublisher publisher = client.listAggregateDiscoveredResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesPublisher publisher = client.listAggregateDiscoveredResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAggregateDiscoveredResources(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesRequest)
operation.- Parameters:
listAggregateDiscoveredResourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listAggregateDiscoveredResourcesPaginator
default ListAggregateDiscoveredResourcesPublisher listAggregateDiscoveredResourcesPaginator(Consumer<ListAggregateDiscoveredResourcesRequest.Builder> listAggregateDiscoveredResourcesRequest) This is a variant of
listAggregateDiscoveredResources(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesPublisher publisher = client.listAggregateDiscoveredResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesPublisher publisher = client.listAggregateDiscoveredResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAggregateDiscoveredResources(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListAggregateDiscoveredResourcesRequest.Builder
avoiding the need to create one manually viaListAggregateDiscoveredResourcesRequest.builder()
- Parameters:
listAggregateDiscoveredResourcesRequest
- AConsumer
that will call methods onListAggregateDiscoveredResourcesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listConformancePackComplianceScores
default CompletableFuture<ListConformancePackComplianceScoresResponse> listConformancePackComplianceScores(ListConformancePackComplianceScoresRequest listConformancePackComplianceScoresRequest) Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.
Conformance packs with no evaluation results will have a compliance score of
INSUFFICIENT_DATA
.- Parameters:
listConformancePackComplianceScoresRequest
-- Returns:
- A Java Future containing the result of the ListConformancePackComplianceScores operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConformancePackComplianceScores
default CompletableFuture<ListConformancePackComplianceScoresResponse> listConformancePackComplianceScores(Consumer<ListConformancePackComplianceScoresRequest.Builder> listConformancePackComplianceScoresRequest) Returns a list of conformance pack compliance scores. A compliance score is the percentage of the number of compliant rule-resource combinations in a conformance pack compared to the number of total possible rule-resource combinations in the conformance pack. This metric provides you with a high-level view of the compliance state of your conformance packs. You can use it to identify, investigate, and understand the level of compliance in your conformance packs.
Conformance packs with no evaluation results will have a compliance score of
INSUFFICIENT_DATA
.
This is a convenience which creates an instance of the
ListConformancePackComplianceScoresRequest.Builder
avoiding the need to create one manually viaListConformancePackComplianceScoresRequest.builder()
- Parameters:
listConformancePackComplianceScoresRequest
- AConsumer
that will call methods onListConformancePackComplianceScoresRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListConformancePackComplianceScores operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConformancePackComplianceScoresPaginator
default ListConformancePackComplianceScoresPublisher listConformancePackComplianceScoresPaginator(ListConformancePackComplianceScoresRequest listConformancePackComplianceScoresRequest) This is a variant of
listConformancePackComplianceScores(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresPublisher publisher = client.listConformancePackComplianceScoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresPublisher publisher = client.listConformancePackComplianceScoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConformancePackComplianceScores(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresRequest)
operation.- Parameters:
listConformancePackComplianceScoresRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listConformancePackComplianceScoresPaginator
default ListConformancePackComplianceScoresPublisher listConformancePackComplianceScoresPaginator(Consumer<ListConformancePackComplianceScoresRequest.Builder> listConformancePackComplianceScoresRequest) This is a variant of
listConformancePackComplianceScores(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresPublisher publisher = client.listConformancePackComplianceScoresPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresPublisher publisher = client.listConformancePackComplianceScoresPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listConformancePackComplianceScores(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresRequest)
operation.
This is a convenience which creates an instance of the
ListConformancePackComplianceScoresRequest.Builder
avoiding the need to create one manually viaListConformancePackComplianceScoresRequest.builder()
- Parameters:
listConformancePackComplianceScoresRequest
- AConsumer
that will call methods onListConformancePackComplianceScoresRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDiscoveredResources
default CompletableFuture<ListDiscoveredResourcesResponse> 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 Config has discovered, including those that 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, Config lists 100 resource identifiers on each page. You can customize this number with the
limit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
parameter.- Parameters:
listDiscoveredResourcesRequest
-- Returns:
- A Java Future containing the result of the ListDiscoveredResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listDiscoveredResources
default CompletableFuture<ListDiscoveredResourcesResponse> listDiscoveredResources(Consumer<ListDiscoveredResourcesRequest.Builder> 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 Config has discovered, including those that 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, Config lists 100 resource identifiers on each page. You can customize this number with the
limit
parameter. The response includes anextToken
string. To get the next page of results, run the request again and specify the string for thenextToken
parameter.
This is a convenience which creates an instance of the
ListDiscoveredResourcesRequest.Builder
avoiding the need to create one manually viaListDiscoveredResourcesRequest.builder()
- Parameters:
listDiscoveredResourcesRequest
- AConsumer
that will call methods onListDiscoveredResourcesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListDiscoveredResources operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listDiscoveredResourcesPaginator
default ListDiscoveredResourcesPublisher listDiscoveredResourcesPaginator(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest) This is a variant of
listDiscoveredResources(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesPublisher publisher = client.listDiscoveredResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesPublisher publisher = client.listDiscoveredResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListDiscoveredResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesResponse response) { //... }; });
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDiscoveredResources(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesRequest)
operation.- Parameters:
listDiscoveredResourcesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listDiscoveredResourcesPaginator
default ListDiscoveredResourcesPublisher listDiscoveredResourcesPaginator(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest) This is a variant of
listDiscoveredResources(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesPublisher publisher = client.listDiscoveredResourcesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesPublisher publisher = client.listDiscoveredResourcesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListDiscoveredResourcesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesResponse response) { //... }; });
Please notice that the configuration of limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDiscoveredResources(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesRequest)
operation.
This is a convenience which creates an instance of the
ListDiscoveredResourcesRequest.Builder
avoiding the need to create one manually viaListDiscoveredResourcesRequest.builder()
- Parameters:
listDiscoveredResourcesRequest
- AConsumer
that will call methods onListDiscoveredResourcesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listResourceEvaluations
default CompletableFuture<ListResourceEvaluationsResponse> listResourceEvaluations(ListResourceEvaluationsRequest listResourceEvaluationsRequest) Returns a list of proactive resource evaluations.
- Parameters:
listResourceEvaluationsRequest
-- Returns:
- A Java Future containing the result of the ListResourceEvaluations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidTimeRangeException The specified time range is not valid. The earlier time is not chronologically before the later time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The specified next token is not valid. Specify the
- See Also:
-
listResourceEvaluations
default CompletableFuture<ListResourceEvaluationsResponse> listResourceEvaluations(Consumer<ListResourceEvaluationsRequest.Builder> listResourceEvaluationsRequest) Returns a list of proactive resource evaluations.
This is a convenience which creates an instance of the
ListResourceEvaluationsRequest.Builder
avoiding the need to create one manually viaListResourceEvaluationsRequest.builder()
- Parameters:
listResourceEvaluationsRequest
- AConsumer
that will call methods onListResourceEvaluationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListResourceEvaluations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidTimeRangeException The specified time range is not valid. The earlier time is not chronologically before the later time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The specified next token is not valid. Specify the
- See Also:
-
listResourceEvaluationsPaginator
default ListResourceEvaluationsPublisher listResourceEvaluationsPaginator(ListResourceEvaluationsRequest listResourceEvaluationsRequest) This is a variant of
listResourceEvaluations(software.amazon.awssdk.services.config.model.ListResourceEvaluationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListResourceEvaluationsPublisher publisher = client.listResourceEvaluationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListResourceEvaluationsPublisher publisher = client.listResourceEvaluationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListResourceEvaluationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListResourceEvaluationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceEvaluations(software.amazon.awssdk.services.config.model.ListResourceEvaluationsRequest)
operation.- Parameters:
listResourceEvaluationsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidTimeRangeException The specified time range is not valid. The earlier time is not chronologically before the later time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The specified next token is not valid. Specify the
- See Also:
-
listResourceEvaluationsPaginator
default ListResourceEvaluationsPublisher listResourceEvaluationsPaginator(Consumer<ListResourceEvaluationsRequest.Builder> listResourceEvaluationsRequest) This is a variant of
listResourceEvaluations(software.amazon.awssdk.services.config.model.ListResourceEvaluationsRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListResourceEvaluationsPublisher publisher = client.listResourceEvaluationsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListResourceEvaluationsPublisher publisher = client.listResourceEvaluationsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListResourceEvaluationsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListResourceEvaluationsResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listResourceEvaluations(software.amazon.awssdk.services.config.model.ListResourceEvaluationsRequest)
operation.
This is a convenience which creates an instance of the
ListResourceEvaluationsRequest.Builder
avoiding the need to create one manually viaListResourceEvaluationsRequest.builder()
- Parameters:
listResourceEvaluationsRequest
- AConsumer
that will call methods onListResourceEvaluationsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidTimeRangeException The specified time range is not valid. The earlier time is not chronologically before the later time.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InvalidNextTokenException The specified next token is not valid. Specify the
- See Also:
-
listStoredQueries
default CompletableFuture<ListStoredQueriesResponse> listStoredQueries(ListStoredQueriesRequest listStoredQueriesRequest) Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
- Parameters:
listStoredQueriesRequest
-- Returns:
- A Java Future containing the result of the ListStoredQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listStoredQueries
default CompletableFuture<ListStoredQueriesResponse> listStoredQueries(Consumer<ListStoredQueriesRequest.Builder> listStoredQueriesRequest) Lists the stored queries for a single Amazon Web Services account and a single Amazon Web Services Region. The default is 100.
This is a convenience which creates an instance of the
ListStoredQueriesRequest.Builder
avoiding the need to create one manually viaListStoredQueriesRequest.builder()
- Parameters:
listStoredQueriesRequest
- AConsumer
that will call methods onListStoredQueriesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListStoredQueries operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listStoredQueriesPaginator
default ListStoredQueriesPublisher listStoredQueriesPaginator(ListStoredQueriesRequest listStoredQueriesRequest) This is a variant of
listStoredQueries(software.amazon.awssdk.services.config.model.ListStoredQueriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListStoredQueriesPublisher publisher = client.listStoredQueriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListStoredQueriesPublisher publisher = client.listStoredQueriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListStoredQueriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListStoredQueriesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStoredQueries(software.amazon.awssdk.services.config.model.ListStoredQueriesRequest)
operation.- Parameters:
listStoredQueriesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listStoredQueriesPaginator
default ListStoredQueriesPublisher listStoredQueriesPaginator(Consumer<ListStoredQueriesRequest.Builder> listStoredQueriesRequest) This is a variant of
listStoredQueries(software.amazon.awssdk.services.config.model.ListStoredQueriesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListStoredQueriesPublisher publisher = client.listStoredQueriesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListStoredQueriesPublisher publisher = client.listStoredQueriesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListStoredQueriesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListStoredQueriesResponse response) { //... }; });
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listStoredQueries(software.amazon.awssdk.services.config.model.ListStoredQueriesRequest)
operation.
This is a convenience which creates an instance of the
ListStoredQueriesRequest.Builder
avoiding the need to create one manually viaListStoredQueriesRequest.builder()
- Parameters:
listStoredQueriesRequest
- AConsumer
that will call methods onListStoredQueriesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) List the tags for Config resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException You have specified a resource that does not exist.
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) List the tags for Config resource.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException You have specified a resource that does not exist.
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.config.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.config.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException You have specified a resource that does not exist.
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourcePublisher listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant of
listTagsForResource(software.amazon.awssdk.services.config.model.ListTagsForResourceRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.ListTagsForResourcePublisher publisher = client.listTagsForResourcePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.ListTagsForResourceResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.ListTagsForResourceResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.config.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException You have specified a resource that does not exist.
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAggregationAuthorization
default CompletableFuture<PutAggregationAuthorizationResponse> putAggregationAuthorization(PutAggregationAuthorizationRequest putAggregationAuthorizationRequest) Authorizes the aggregator account and region to collect data from the source account and region.
PutAggregationAuthorization
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has differenttags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case,tags
will not be updated, even if they are different.- Parameters:
putAggregationAuthorizationRequest
-- Returns:
- A Java Future containing the result of the PutAggregationAuthorization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putAggregationAuthorization
default CompletableFuture<PutAggregationAuthorizationResponse> putAggregationAuthorization(Consumer<PutAggregationAuthorizationRequest.Builder> putAggregationAuthorizationRequest) Authorizes the aggregator account and region to collect data from the source account and region.
PutAggregationAuthorization
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has differenttags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case,tags
will not be updated, even if they are different.
This is a convenience which creates an instance of the
PutAggregationAuthorizationRequest.Builder
avoiding the need to create one manually viaPutAggregationAuthorizationRequest.builder()
- Parameters:
putAggregationAuthorizationRequest
- AConsumer
that will call methods onPutAggregationAuthorizationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutAggregationAuthorization operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigRule
default CompletableFuture<PutConfigRuleResponse> putConfigRule(PutConfigRuleRequest putConfigRuleRequest) Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
There are two types of rules: Config Managed Rules and Config Custom Rules. You can use
PutConfigRule
to create both Config Managed Rules and Config Custom Rules.Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the
SourceIdentifier
key.Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function that the rule invokes to evaluate your resources. When you use
PutConfigRule
to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. You specify the ARN in theSourceIdentifier
key. This key is part of theSource
object, which is part of theConfigRule
object.For any new Config rule that you add, specify the
ConfigRuleName
in theConfigRule
object. Do not specify theConfigRuleArn
or theConfigRuleId
. These values are generated by Config for new rules.If you are updating a rule that you added previously, you can specify the rule by
ConfigRuleName
,ConfigRuleId
, orConfigRuleArn
in theConfigRule
data type that you use in this request.For more information about developing and using Config rules, see Evaluating Resources with Config Rules in the Config Developer Guide.
PutConfigRule
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has differenttags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case,tags
will not be updated, even if they are different.- Parameters:
putConfigRuleRequest
-- Returns:
- A Java Future containing the result of the PutConfigRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- MaxNumberOfConfigRulesExceededException Failed to add the Config rule because the account already contains the maximum number of 1000 rules. Consider deleting any deactivated rules before you add new rules.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigRule
default CompletableFuture<PutConfigRuleResponse> putConfigRule(Consumer<PutConfigRuleRequest.Builder> putConfigRuleRequest) Adds or updates an Config rule to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
There are two types of rules: Config Managed Rules and Config Custom Rules. You can use
PutConfigRule
to create both Config Managed Rules and Config Custom Rules.Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the
SourceIdentifier
key.Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function that the rule invokes to evaluate your resources. When you use
PutConfigRule
to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function. You specify the ARN in theSourceIdentifier
key. This key is part of theSource
object, which is part of theConfigRule
object.For any new Config rule that you add, specify the
ConfigRuleName
in theConfigRule
object. Do not specify theConfigRuleArn
or theConfigRuleId
. These values are generated by Config for new rules.If you are updating a rule that you added previously, you can specify the rule by
ConfigRuleName
,ConfigRuleId
, orConfigRuleArn
in theConfigRule
data type that you use in this request.For more information about developing and using Config rules, see Evaluating Resources with Config Rules in the Config Developer Guide.
PutConfigRule
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has differenttags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case,tags
will not be updated, even if they are different.
This is a convenience which creates an instance of the
PutConfigRuleRequest.Builder
avoiding the need to create one manually viaPutConfigRuleRequest.builder()
- Parameters:
putConfigRuleRequest
- AConsumer
that will call methods onPutConfigRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutConfigRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- MaxNumberOfConfigRulesExceededException Failed to add the Config rule because the account already contains the maximum number of 1000 rules. Consider deleting any deactivated rules before you add new rules.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- NoAvailableConfigurationRecorderException There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationAggregator
default CompletableFuture<PutConfigurationAggregatorResponse> putConfigurationAggregator(PutConfigurationAggregatorRequest putConfigurationAggregatorRequest) Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
accountIds
that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, callDescribeConfigurationAggregators
to get the previous accounts and then append new ones.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 management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls
EnableAwsServiceAccess
API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config callsListDelegatedAdministrators
API to verify whether the caller is a valid delegated administrator.To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.
PutConfigurationAggregator
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has differenttags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case,tags
will not be updated, even if they are different.- Parameters:
putConfigurationAggregatorRequest
-- Returns:
- A Java Future containing the result of the PutConfigurationAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 Amazon Resource Name (ARN) for the IAM role assumed by Config and used by the configuration recorder.
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- NoAvailableOrganizationException Organization is no longer available.
- OrganizationAllFeaturesNotEnabledException Config resource cannot be created because your organization does not have all features enabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationAggregator
default CompletableFuture<PutConfigurationAggregatorResponse> putConfigurationAggregator(Consumer<PutConfigurationAggregatorRequest.Builder> putConfigurationAggregatorRequest) Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization.
accountIds
that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, callDescribeConfigurationAggregators
to get the previous accounts and then append new ones.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 management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, Config calls
EnableAwsServiceAccess
API to enable integration between Config and Organizations. If the caller is a registered delegated administrator, Config callsListDelegatedAdministrators
API to verify whether the caller is a valid delegated administrator.To register a delegated administrator, see Register a Delegated Administrator in the Config developer guide.
PutConfigurationAggregator
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has differenttags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case,tags
will not be updated, even if they are different.
This is a convenience which creates an instance of the
PutConfigurationAggregatorRequest.Builder
avoiding the need to create one manually viaPutConfigurationAggregatorRequest.builder()
- Parameters:
putConfigurationAggregatorRequest
- AConsumer
that will call methods onPutConfigurationAggregatorRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutConfigurationAggregator operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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 Amazon Resource Name (ARN) for the IAM role assumed by Config and used by the configuration recorder.
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- NoAvailableOrganizationException Organization is no longer available.
- OrganizationAllFeaturesNotEnabledException Config resource cannot be created because your organization does not have all features enabled.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationRecorder
default CompletableFuture<PutConfigurationRecorderResponse> putConfigurationRecorder(PutConfigurationRecorderRequest putConfigurationRecorderRequest) Creates a new configuration recorder to record configuration changes for specified resource types.
You can also use this action to change the
roleARN
or therecordingGroup
of an existing recorder. For more information, see Managing the Configuration Recorder in the Config Developer Guide.You can specify only one configuration recorder for each Amazon Web Services Region for each account.
If the configuration recorder does not have the
recordingGroup
field specified, the default is to record all supported resource types.- Parameters:
putConfigurationRecorderRequest
- The input for the PutConfigurationRecorder action.- Returns:
- A Java Future containing the result of the PutConfigurationRecorder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MaxNumberOfConfigurationRecordersExceededException You have reached the limit of the number of configuration recorders you can create.
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidConfigurationRecorderNameException You have provided a name for the configuration recorder that is not valid.
- InvalidRoleException You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by Config and used by the configuration recorder.
- InvalidRecordingGroupException Indicates one of the following errors:
-
You have provided a combination of parameter values that is not valid. For example:
-
Setting the
allSupported
field of RecordingGroup totrue
, but providing a non-empty list for theresourceTypes
field of RecordingGroup. -
Setting the
allSupported
field of RecordingGroup totrue
, but also setting theuseOnly
field of RecordingStrategy toEXCLUSION_BY_RESOURCE_TYPES
.
-
-
Every parameter is either null, false, or empty.
-
You have reached the limit of the number of resource types you can provide for the recording group.
-
You have provided resource types or a recording strategy that are not valid.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConfigurationRecorder
default CompletableFuture<PutConfigurationRecorderResponse> putConfigurationRecorder(Consumer<PutConfigurationRecorderRequest.Builder> putConfigurationRecorderRequest) Creates a new configuration recorder to record configuration changes for specified resource types.
You can also use this action to change the
roleARN
or therecordingGroup
of an existing recorder. For more information, see Managing the Configuration Recorder in the Config Developer Guide.You can specify only one configuration recorder for each Amazon Web Services Region for each account.
If the configuration recorder does not have the
recordingGroup
field specified, the default is to record all supported resource types.
This is a convenience which creates an instance of the
PutConfigurationRecorderRequest.Builder
avoiding the need to create one manually viaPutConfigurationRecorderRequest.builder()
- Parameters:
putConfigurationRecorderRequest
- AConsumer
that will call methods onPutConfigurationRecorderRequest.Builder
to create a request. The input for the PutConfigurationRecorder action.- Returns:
- A Java Future containing the result of the PutConfigurationRecorder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MaxNumberOfConfigurationRecordersExceededException You have reached the limit of the number of configuration recorders you can create.
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InvalidConfigurationRecorderNameException You have provided a name for the configuration recorder that is not valid.
- InvalidRoleException You have provided a null or empty Amazon Resource Name (ARN) for the IAM role assumed by Config and used by the configuration recorder.
- InvalidRecordingGroupException Indicates one of the following errors:
-
You have provided a combination of parameter values that is not valid. For example:
-
Setting the
allSupported
field of RecordingGroup totrue
, but providing a non-empty list for theresourceTypes
field of RecordingGroup. -
Setting the
allSupported
field of RecordingGroup totrue
, but also setting theuseOnly
field of RecordingStrategy toEXCLUSION_BY_RESOURCE_TYPES
.
-
-
Every parameter is either null, false, or empty.
-
You have reached the limit of the number of resource types you can provide for the recording group.
-
You have provided resource types or a recording strategy that are not valid.
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putConformancePack
default CompletableFuture<PutConformancePackResponse> putConformancePack(PutConformancePackRequest putConformancePackRequest) Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.
This API creates a service-linked role
AWSServiceRoleForConfigConforms
in your account. The service-linked role is created only when the role does not exist in your account.You must specify only one of the follow parameters:
TemplateS3Uri
,TemplateBody
orTemplateSSMDocumentDetails
.- Parameters:
putConformancePackRequest
-- Returns:
- A Java Future containing the result of the PutConformancePack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- ConformancePackTemplateValidationException You have specified a template that is not valid or supported.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- MaxNumberOfConformancePacksExceededException You have reached the limit of the number of conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InsufficientPermissionsException Indicates one of the following errors:
- See Also:
-
putConformancePack
default CompletableFuture<PutConformancePackResponse> putConformancePack(Consumer<PutConformancePackRequest.Builder> putConformancePackRequest) Creates or updates a conformance pack. A conformance pack is a collection of Config rules that can be easily deployed in an account and a region and across an organization. For information on how many conformance packs you can have per account, see Service Limits in the Config Developer Guide.
This API creates a service-linked role
AWSServiceRoleForConfigConforms
in your account. The service-linked role is created only when the role does not exist in your account.You must specify only one of the follow parameters:
TemplateS3Uri
,TemplateBody
orTemplateSSMDocumentDetails
.
This is a convenience which creates an instance of the
PutConformancePackRequest.Builder
avoiding the need to create one manually viaPutConformancePackRequest.builder()
- Parameters:
putConformancePackRequest
- AConsumer
that will call methods onPutConformancePackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutConformancePack operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- ConformancePackTemplateValidationException You have specified a template that is not valid or supported.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- MaxNumberOfConformancePacksExceededException You have reached the limit of the number of conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InsufficientPermissionsException Indicates one of the following errors:
- See Also:
-
putDeliveryChannel
default CompletableFuture<PutDeliveryChannelResponse> putDeliveryChannel(PutDeliveryChannelRequest putDeliveryChannelRequest) Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic. For more information, see Notifications that Config Sends to an Amazon SNS topic.
Before you can create a delivery channel, you must create a configuration recorder.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
You can have only one delivery channel per region in your account.
- Parameters:
putDeliveryChannelRequest
- The input for the PutDeliveryChannel action.- Returns:
- A Java Future containing the result of the PutDeliveryChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidS3KmsKeyArnException The specified Amazon KMS Key ARN is not valid.
- InvalidSnsTopicArnException The specified Amazon SNS topic does not exist.
- InsufficientDeliveryPolicyException Your Amazon S3 bucket policy does not permit Config to write to it.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putDeliveryChannel
default CompletableFuture<PutDeliveryChannelResponse> putDeliveryChannel(Consumer<PutDeliveryChannelRequest.Builder> putDeliveryChannelRequest) Creates a delivery channel object to deliver configuration information and other compliance information to an Amazon S3 bucket and Amazon SNS topic. For more information, see Notifications that Config Sends to an Amazon SNS topic.
Before you can create a delivery channel, you must create a configuration recorder.
You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
You can have only one delivery channel per region in your account.
This is a convenience which creates an instance of the
PutDeliveryChannelRequest.Builder
avoiding the need to create one manually viaPutDeliveryChannelRequest.builder()
- Parameters:
putDeliveryChannelRequest
- AConsumer
that will call methods onPutDeliveryChannelRequest.Builder
to create a request. The input for the PutDeliveryChannel action.- Returns:
- A Java Future containing the result of the PutDeliveryChannel operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- 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.
- InvalidS3KmsKeyArnException The specified Amazon KMS Key ARN is not valid.
- InvalidSnsTopicArnException The specified Amazon SNS topic does not exist.
- InsufficientDeliveryPolicyException Your Amazon S3 bucket policy does not permit Config to write to it.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEvaluations
default CompletableFuture<PutEvaluationsResponse> putEvaluations(PutEvaluationsRequest putEvaluationsRequest) Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.
- Parameters:
putEvaluationsRequest
-- Returns:
- A Java Future containing the result of the PutEvaluations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidResultTokenException The specified
ResultToken
is not valid. - NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putEvaluations
default CompletableFuture<PutEvaluationsResponse> putEvaluations(Consumer<PutEvaluationsRequest.Builder> putEvaluationsRequest) Used by an Lambda function to deliver evaluation results to Config. This action is required in every Lambda function that is invoked by an Config rule.
This is a convenience which creates an instance of the
PutEvaluationsRequest.Builder
avoiding the need to create one manually viaPutEvaluationsRequest.builder()
- Parameters:
putEvaluationsRequest
- AConsumer
that will call methods onPutEvaluationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutEvaluations operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InvalidResultTokenException The specified
ResultToken
is not valid. - NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putExternalEvaluation
default CompletableFuture<PutExternalEvaluationResponse> putExternalEvaluation(PutExternalEvaluationRequest putExternalEvaluationRequest) Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.
- Parameters:
putExternalEvaluationRequest
-- Returns:
- A Java Future containing the result of the PutExternalEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putExternalEvaluation
default CompletableFuture<PutExternalEvaluationResponse> putExternalEvaluation(Consumer<PutExternalEvaluationRequest.Builder> putExternalEvaluationRequest) Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the Config rule is provided.
This is a convenience which creates an instance of the
PutExternalEvaluationRequest.Builder
avoiding the need to create one manually viaPutExternalEvaluationRequest.builder()
- Parameters:
putExternalEvaluationRequest
- AConsumer
that will call methods onPutExternalEvaluationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutExternalEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOrganizationConfigRule
default CompletableFuture<PutOrganizationConfigRuleResponse> putOrganizationConfigRule(PutOrganizationConfigRuleRequest putOrganizationConfigRuleRequest) Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators.This API enables organization service access through the
EnableAWSServiceAccess
action and creates a service-linked roleAWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. Config verifies the existence of role withGetRole
action.To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
register-delegated-administrator
forconfig-multiaccountsetup.amazonaws.com
.There are two types of rules: Config Managed Rules and Config Custom Rules. You can use
PutOrganizationConfigRule
to create both Config Managed Rules and Config Custom Rules.Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the
RuleIdentifier
key.Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function in the management account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. When you use
PutOrganizationConfigRule
to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function.Prerequisite: Ensure you call
EnableAllFeatures
API to enable all features in an organization.Make sure to specify one of either
OrganizationCustomPolicyRuleMetadata
for Custom Policy rules,OrganizationCustomRuleMetadata
for Custom Lambda rules, orOrganizationManagedRuleMetadata
for managed rules.- Parameters:
putOrganizationConfigRuleRequest
-- Returns:
- A Java Future containing the result of the PutOrganizationConfigRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MaxNumberOfOrganizationConfigRulesExceededException You have reached the limit of the number of organization Config rules you can create. For more information, see see Service Limits in the Config Developer Guide.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- NoAvailableOrganizationException Organization is no longer available.
- OrganizationAllFeaturesNotEnabledException Config resource cannot be created because your organization does not have all features enabled.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOrganizationConfigRule
default CompletableFuture<PutOrganizationConfigRuleResponse> putOrganizationConfigRule(Consumer<PutOrganizationConfigRuleRequest.Builder> putOrganizationConfigRuleRequest) Adds or updates an Config rule for your entire organization to evaluate if your Amazon Web Services resources comply with your desired configurations. For information on how many organization Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can create or update an organization Config rule. When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators.This API enables organization service access through the
EnableAWSServiceAccess
action and creates a service-linked roleAWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. Config verifies the existence of role withGetRole
action.To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization
register-delegated-administrator
forconfig-multiaccountsetup.amazonaws.com
.There are two types of rules: Config Managed Rules and Config Custom Rules. You can use
PutOrganizationConfigRule
to create both Config Managed Rules and Config Custom Rules.Config Managed Rules are predefined, customizable rules created by Config. For a list of managed rules, see List of Config Managed Rules. If you are adding an Config managed rule, you must specify the rule's identifier for the
RuleIdentifier
key.Config Custom Rules are rules that you create from scratch. There are two ways to create Config custom rules: with Lambda functions ( Lambda Developer Guide) and with Guard (Guard GitHub Repository), a policy-as-code language. Config custom rules created with Lambda are called Config Custom Lambda Rules and Config custom rules created with Guard are called Config Custom Policy Rules.
If you are adding a new Config Custom Lambda rule, you first need to create an Lambda function in the management account or a delegated administrator that the rule invokes to evaluate your resources. You also need to create an IAM role in the managed account that can be assumed by the Lambda function. When you use
PutOrganizationConfigRule
to add a Custom Lambda rule to Config, you must specify the Amazon Resource Name (ARN) that Lambda assigns to the function.Prerequisite: Ensure you call
EnableAllFeatures
API to enable all features in an organization.Make sure to specify one of either
OrganizationCustomPolicyRuleMetadata
for Custom Policy rules,OrganizationCustomRuleMetadata
for Custom Lambda rules, orOrganizationManagedRuleMetadata
for managed rules.
This is a convenience which creates an instance of the
PutOrganizationConfigRuleRequest.Builder
avoiding the need to create one manually viaPutOrganizationConfigRuleRequest.builder()
- Parameters:
putOrganizationConfigRuleRequest
- AConsumer
that will call methods onPutOrganizationConfigRuleRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutOrganizationConfigRule operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MaxNumberOfOrganizationConfigRulesExceededException You have reached the limit of the number of organization Config rules you can create. For more information, see see Service Limits in the Config Developer Guide.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- NoAvailableOrganizationException Organization is no longer available.
- OrganizationAllFeaturesNotEnabledException Config resource cannot be created because your organization does not have all features enabled.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOrganizationConformancePack
default CompletableFuture<PutOrganizationConformancePackResponse> putOrganizationConformancePack(PutOrganizationConformancePackRequest putOrganizationConformancePackRequest) Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators.This API enables organization service access for
config-multiaccountsetup.amazonaws.com
through theEnableAWSServiceAccess
action and creates a service-linked roleAWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organizationregister-delegate-admin
forconfig-multiaccountsetup.amazonaws.com
.Prerequisite: Ensure you call
EnableAllFeatures
API to enable all features in an organization.You must specify either the
TemplateS3Uri
or theTemplateBody
parameter, but not both. If you provide both Config uses theTemplateS3Uri
parameter and ignores theTemplateBody
parameter.Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
- Parameters:
putOrganizationConformancePackRequest
-- Returns:
- A Java Future containing the result of the PutOrganizationConformancePack operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MaxNumberOfOrganizationConformancePacksExceededException You have reached the limit of the number of organization conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- OrganizationConformancePackTemplateValidationException You have specified a template that is not valid or supported.
- OrganizationAllFeaturesNotEnabledException Config resource cannot be created because your organization does not have all features enabled.
- NoAvailableOrganizationException Organization is no longer available.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putOrganizationConformancePack
default CompletableFuture<PutOrganizationConformancePackResponse> putOrganizationConformancePack(Consumer<PutOrganizationConformancePackRequest.Builder> putOrganizationConformancePackRequest) Deploys conformance packs across member accounts in an Amazon Web Services Organization. For information on how many organization conformance packs and how many Config rules you can have per account, see Service Limits in the Config Developer Guide.
Only a management account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure Organizations
ListDelegatedAdministrator
permissions are added. An organization can have up to 3 delegated administrators.This API enables organization service access for
config-multiaccountsetup.amazonaws.com
through theEnableAWSServiceAccess
action and creates a service-linked roleAWSServiceRoleForConfigMultiAccountSetup
in the management or delegated administrator account of your organization. The service-linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organizationregister-delegate-admin
forconfig-multiaccountsetup.amazonaws.com
.Prerequisite: Ensure you call
EnableAllFeatures
API to enable all features in an organization.You must specify either the
TemplateS3Uri
or theTemplateBody
parameter, but not both. If you provide both Config uses theTemplateS3Uri
parameter and ignores theTemplateBody
parameter.Config sets the state of a conformance pack to CREATE_IN_PROGRESS and UPDATE_IN_PROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state.
This is a convenience which creates an instance of the
PutOrganizationConformancePackRequest.Builder
avoiding the need to create one manually viaPutOrganizationConformancePackRequest.builder()
- Parameters:
putOrganizationConformancePackRequest
- AConsumer
that will call methods onPutOrganizationConformancePackRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutOrganizationConformancePack operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- MaxNumberOfOrganizationConformancePacksExceededException You have reached the limit of the number of organization conformance packs you can create in an account. For more information, see Service Limits in the Config Developer Guide.
- ResourceInUseException You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- OrganizationAccessDeniedException For
PutConfigurationAggregator
API, you can see this exception for the following reasons:-
No permission to call
EnableAWSServiceAccess
API -
The configuration aggregator cannot be updated because your Amazon Web Services Organization management account or the delegated administrator role changed. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
The configuration aggregator is associated with a previous Amazon Web Services Organization and Config cannot aggregate data with current Amazon Web Services Organization. Delete this aggregator and create a new one with the current Amazon Web Services Organization.
-
You are not a registered delegated administrator for Config with permissions to call
ListDelegatedAdministrators
API. Ensure that the management account registers delagated administrator for Config service principle name before the delegated administrator creates an aggregator.
For all
OrganizationConfigRule
andOrganizationConformancePack
APIs, Config throws an exception if APIs are called from member accounts. All APIs must be called from organization management account. -
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- OrganizationConformancePackTemplateValidationException You have specified a template that is not valid or supported.
- OrganizationAllFeaturesNotEnabledException Config resource cannot be created because your organization does not have all features enabled.
- NoAvailableOrganizationException Organization is no longer available.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRemediationConfigurations
default CompletableFuture<PutRemediationConfigurationsResponse> putRemediationConfigurations(PutRemediationConfigurationsRequest putRemediationConfigurationsRequest) Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the
RemediationConfiguration
object for the Config rule. The 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.Be aware of backward incompatible changes
If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.
This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
Required fields
For manual remediation configuration, you need to provide a value for
automationAssumeRole
or use a value in theassumeRole
field to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.However, for automatic remediation configuration, the only valid
assumeRole
field value isAutomationAssumeRole
and you need to provide a value forAutomationAssumeRole
to remediate your resources.Auto remediation can be initiated even for compliant resources
If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console, it initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
- Parameters:
putRemediationConfigurationsRequest
-- Returns:
- A Java Future containing the result of the PutRemediationConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InsufficientPermissionsException Indicates one of the following errors:
- See Also:
-
putRemediationConfigurations
default CompletableFuture<PutRemediationConfigurationsResponse> putRemediationConfigurations(Consumer<PutRemediationConfigurationsRequest.Builder> putRemediationConfigurationsRequest) Adds or updates the remediation configuration with a specific Config rule with the selected target or action. The API creates the
RemediationConfiguration
object for the Config rule. The 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.Be aware of backward incompatible changes
If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run.
This API does not support adding remediation configurations for service-linked Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by Amazon Web Services Security Hub.
Required fields
For manual remediation configuration, you need to provide a value for
automationAssumeRole
or use a value in theassumeRole
field to remediate your resources. The SSM automation document can use either as long as it maps to a valid parameter.However, for automatic remediation configuration, the only valid
assumeRole
field value isAutomationAssumeRole
and you need to provide a value forAutomationAssumeRole
to remediate your resources.Auto remediation can be initiated even for compliant resources
If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console, it initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
This is a convenience which creates an instance of the
PutRemediationConfigurationsRequest.Builder
avoiding the need to create one manually viaPutRemediationConfigurationsRequest.builder()
- Parameters:
putRemediationConfigurationsRequest
- AConsumer
that will call methods onPutRemediationConfigurationsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRemediationConfigurations operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- InsufficientPermissionsException Indicates one of the following errors:
- See Also:
-
putRemediationExceptions
default CompletableFuture<PutRemediationExceptionsResponse> putRemediationExceptions(PutRemediationExceptionsRequest putRemediationExceptionsRequest) A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.
Exceptions block auto remediation
Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
Manual remediation is recommended when placing an exception
When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as
NON_COMPLIANT
. Once the resource has been evaluated asNON_COMPLIANT
, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before aNON_COMPLIANT
evaluation result can delete resources before the exception is applied.Exceptions can only be performed on non-compliant resources
Placing an exception can only be performed on resources that are
NON_COMPLIANT
. If you use this API forCOMPLIANT
resources or resources that areNOT_APPLICABLE
, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see Concepts | Config Rules in the Config Developer Guide.Auto remediation can be initiated even for compliant resources
If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console, it initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
- Parameters:
putRemediationExceptionsRequest
-- Returns:
- A Java Future containing the result of the PutRemediationExceptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRemediationExceptions
default CompletableFuture<PutRemediationExceptionsResponse> putRemediationExceptions(Consumer<PutRemediationExceptionsRequest.Builder> putRemediationExceptionsRequest) A remediation exception is when a specified resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specified resource with a specified Config rule.
Exceptions block auto remediation
Config generates a remediation exception when a problem occurs running a remediation action for a specified resource. Remediation exceptions blocks auto-remediation until the exception is cleared.
Manual remediation is recommended when placing an exception
When placing an exception on an Amazon Web Services resource, it is recommended that remediation is set as manual remediation until the given Config rule for the specified resource evaluates the resource as
NON_COMPLIANT
. Once the resource has been evaluated asNON_COMPLIANT
, you can add remediation exceptions and change the remediation type back from Manual to Auto if you want to use auto-remediation. Otherwise, using auto-remediation before aNON_COMPLIANT
evaluation result can delete resources before the exception is applied.Exceptions can only be performed on non-compliant resources
Placing an exception can only be performed on resources that are
NON_COMPLIANT
. If you use this API forCOMPLIANT
resources or resources that areNOT_APPLICABLE
, a remediation exception will not be generated. For more information on the conditions that initiate the possible Config evaluation results, see Concepts | Config Rules in the Config Developer Guide.Auto remediation can be initiated even for compliant resources
If you enable auto remediation for a specific Config rule using the PutRemediationConfigurations API or the Config console, it initiates the remediation process for all non-compliant resources for that specific rule. The auto remediation process relies on the compliance data snapshot which is captured on a periodic basis. Any non-compliant resource that is updated between the snapshot schedule will continue to be remediated based on the last known compliance data snapshot.
This means that in some cases auto remediation can be initiated even for compliant resources, since the bootstrap processor uses a database that can have stale evaluation results based on the last known compliance data snapshot.
This is a convenience which creates an instance of the
PutRemediationExceptionsRequest.Builder
avoiding the need to create one manually viaPutRemediationExceptionsRequest.builder()
- Parameters:
putRemediationExceptionsRequest
- AConsumer
that will call methods onPutRemediationExceptionsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRemediationExceptions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putResourceConfig
default CompletableFuture<PutResourceConfigResponse> putResourceConfig(PutResourceConfigRequest putResourceConfigRequest) Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.
The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.
When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
Write-only schema properites are not recorded as part of the published configuration item.
- Parameters:
putResourceConfigRequest
-- Returns:
- A Java Future containing the result of the PutResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- NoRunningConfigurationRecorderException There is no configuration recorder running.
- MaxActiveResourcesExceededException You have reached the limit of active custom resource types in
your account. There is a limit of 100,000. Delete unused resources using DeleteResourceConfig
.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
putResourceConfig
default CompletableFuture<PutResourceConfigResponse> putResourceConfig(Consumer<PutResourceConfigRequest.Builder> putResourceConfigRequest) Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing Config APIs.
The custom resource type must be registered with CloudFormation. This API accepts the configuration item registered with CloudFormation.
When you call this API, Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource.
Write-only schema properites are not recorded as part of the published configuration item.
This is a convenience which creates an instance of the
PutResourceConfigRequest.Builder
avoiding the need to create one manually viaPutResourceConfigRequest.builder()
- Parameters:
putResourceConfigRequest
- AConsumer
that will call methods onPutResourceConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- NoRunningConfigurationRecorderException There is no configuration recorder running.
- MaxActiveResourcesExceededException You have reached the limit of active custom resource types in
your account. There is a limit of 100,000. Delete unused resources using DeleteResourceConfig
.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
putRetentionConfiguration
default CompletableFuture<PutRetentionConfigurationResponse> putRetentionConfiguration(PutRetentionConfigurationRequest putRetentionConfigurationRequest) Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the
RetentionConfiguration
object and names the object as default. When you have aRetentionConfiguration
object named default, calling the API modifies the default object.Currently, Config supports only one retention configuration per region in your account.
- Parameters:
putRetentionConfigurationRequest
-- Returns:
- A Java Future containing the result of the PutRetentionConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putRetentionConfiguration
default CompletableFuture<PutRetentionConfigurationResponse> putRetentionConfiguration(Consumer<PutRetentionConfigurationRequest.Builder> putRetentionConfigurationRequest) Creates and updates the retention configuration with details about retention period (number of days) that Config stores your historical information. The API creates the
RetentionConfiguration
object and names the object as default. When you have aRetentionConfiguration
object named default, calling the API modifies the default object.Currently, Config supports only one retention configuration per region in your account.
This is a convenience which creates an instance of the
PutRetentionConfigurationRequest.Builder
avoiding the need to create one manually viaPutRetentionConfigurationRequest.builder()
- Parameters:
putRetentionConfigurationRequest
- AConsumer
that will call methods onPutRetentionConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutRetentionConfiguration operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. 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.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
putStoredQuery
default CompletableFuture<PutStoredQueryResponse> putStoredQuery(PutStoredQueryRequest putStoredQueryRequest) Saves a new query or updates an existing saved query. The
QueryName
must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.PutStoredQuery
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has differenttags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case,tags
will not be updated, even if they are different.- Parameters:
putStoredQueryRequest
-- Returns:
- A Java Future containing the result of the PutStoredQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- TooManyTagsException You have reached the limit of the number of tags you can use. For more information, see Service Limits in the Config Developer Guide.
- ResourceConcurrentModificationException Two users are trying to modify the same query at the same time. Wait for a moment and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
putStoredQuery
default CompletableFuture<PutStoredQueryResponse> putStoredQuery(Consumer<PutStoredQueryRequest.Builder> putStoredQueryRequest) Saves a new query or updates an existing saved query. The
QueryName
must be unique for a single Amazon Web Services account and a single Amazon Web Services Region. You can create upto 300 queries in a single Amazon Web Services account and a single Amazon Web Services Region.PutStoredQuery
is an idempotent API. Subsequent requests won’t create a duplicate resource if one was already created. If a following request has differenttags
values, Config will ignore these differences and treat it as an idempotent request of the previous. In this case,tags
will not be updated, even if they are different.
This is a convenience which creates an instance of the
PutStoredQueryRequest.Builder
avoiding the need to create one manually viaPutStoredQueryRequest.builder()
- Parameters:
putStoredQueryRequest
- AConsumer
that will call methods onPutStoredQueryRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the PutStoredQuery operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- TooManyTagsException You have reached the limit of the number of tags you can use. For more information, see Service Limits in the Config Developer Guide.
- ResourceConcurrentModificationException Two users are trying to modify the same query at the same time. Wait for a moment and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
selectAggregateResourceConfig
default CompletableFuture<SelectAggregateResourceConfigResponse> selectAggregateResourceConfig(SelectAggregateResourceConfigRequest selectAggregateResourceConfigRequest) Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
If you run an aggregation query (i.e., using
GROUP BY
or using aggregate functions such asCOUNT
; e.g.,SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId
) and do not specify theMaxResults
or theLimit
query parameters, the default page size is set to 500.If you run a non-aggregation query (i.e., not using
GROUP BY
or aggregate function; e.g.,SELECT * WHERE resourceType = 'AWS::IAM::Role'
) and do not specify theMaxResults
or theLimit
query parameters, the default page size is set to 25.- Parameters:
selectAggregateResourceConfigRequest
-- Returns:
- A Java Future containing the result of the SelectAggregateResourceConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidExpressionException The syntax of the query is incorrect.
- NoSuchConfigurationAggregatorException You have specified a configuration aggregator that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
selectAggregateResourceConfig
default CompletableFuture<SelectAggregateResourceConfigResponse> selectAggregateResourceConfig(Consumer<SelectAggregateResourceConfigRequest.Builder> selectAggregateResourceConfigRequest) Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of Amazon Web Services resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties.
For more information about query components, see the Query Components section in the Config Developer Guide.
If you run an aggregation query (i.e., using
GROUP BY
or using aggregate functions such asCOUNT
; e.g.,SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId
) and do not specify theMaxResults
or theLimit
query parameters, the default page size is set to 500.If you run a non-aggregation query (i.e., not using
GROUP BY
or aggregate function; e.g.,SELECT * WHERE resourceType = 'AWS::IAM::Role'
) and do not specify theMaxResults
or theLimit
query parameters, the default page size is set to 25.
This is a convenience which creates an instance of the
SelectAggregateResourceConfigRequest.Builder
avoiding the need to create one manually viaSelectAggregateResourceConfigRequest.builder()
- Parameters:
selectAggregateResourceConfigRequest
- AConsumer
that will call methods onSelectAggregateResourceConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SelectAggregateResourceConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidExpressionException The syntax of the query is incorrect.
- NoSuchConfigurationAggregatorException You have specified a configuration aggregator that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
selectAggregateResourceConfigPaginator
default SelectAggregateResourceConfigPublisher selectAggregateResourceConfigPaginator(SelectAggregateResourceConfigRequest selectAggregateResourceConfigRequest) This is a variant of
selectAggregateResourceConfig(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigPublisher publisher = client.selectAggregateResourceConfigPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigPublisher publisher = client.selectAggregateResourceConfigPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
selectAggregateResourceConfig(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigRequest)
operation.- Parameters:
selectAggregateResourceConfigRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidExpressionException The syntax of the query is incorrect.
- NoSuchConfigurationAggregatorException You have specified a configuration aggregator that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
selectAggregateResourceConfigPaginator
default SelectAggregateResourceConfigPublisher selectAggregateResourceConfigPaginator(Consumer<SelectAggregateResourceConfigRequest.Builder> selectAggregateResourceConfigRequest) This is a variant of
selectAggregateResourceConfig(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigPublisher publisher = client.selectAggregateResourceConfigPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigPublisher publisher = client.selectAggregateResourceConfigPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
selectAggregateResourceConfig(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigRequest)
operation.
This is a convenience which creates an instance of the
SelectAggregateResourceConfigRequest.Builder
avoiding the need to create one manually viaSelectAggregateResourceConfigRequest.builder()
- Parameters:
selectAggregateResourceConfigRequest
- AConsumer
that will call methods onSelectAggregateResourceConfigRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidExpressionException The syntax of the query is incorrect.
- NoSuchConfigurationAggregatorException You have specified a configuration aggregator that does not exist.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
selectResourceConfig
default CompletableFuture<SelectResourceConfigResponse> selectResourceConfig(SelectResourceConfigRequest selectResourceConfigRequest) 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 Config Developer Guide.
- Parameters:
selectResourceConfigRequest
-- Returns:
- A Java Future containing the result of the SelectResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidExpressionException The syntax of the query is incorrect.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
selectResourceConfig
default CompletableFuture<SelectResourceConfigResponse> selectResourceConfig(Consumer<SelectResourceConfigRequest.Builder> selectResourceConfigRequest) 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 Config Developer Guide.
This is a convenience which creates an instance of the
SelectResourceConfigRequest.Builder
avoiding the need to create one manually viaSelectResourceConfigRequest.builder()
- Parameters:
selectResourceConfigRequest
- AConsumer
that will call methods onSelectResourceConfigRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the SelectResourceConfig operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidExpressionException The syntax of the query is incorrect.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
selectResourceConfigPaginator
default SelectResourceConfigPublisher selectResourceConfigPaginator(SelectResourceConfigRequest selectResourceConfigRequest) This is a variant of
selectResourceConfig(software.amazon.awssdk.services.config.model.SelectResourceConfigRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.SelectResourceConfigPublisher publisher = client.selectResourceConfigPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.SelectResourceConfigPublisher publisher = client.selectResourceConfigPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.SelectResourceConfigResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.SelectResourceConfigResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
selectResourceConfig(software.amazon.awssdk.services.config.model.SelectResourceConfigRequest)
operation.- Parameters:
selectResourceConfigRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidExpressionException The syntax of the query is incorrect.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
selectResourceConfigPaginator
default SelectResourceConfigPublisher selectResourceConfigPaginator(Consumer<SelectResourceConfigRequest.Builder> selectResourceConfigRequest) This is a variant of
selectResourceConfig(software.amazon.awssdk.services.config.model.SelectResourceConfigRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe method will result in a newSubscription
i.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper methodsoftware.amazon.awssdk.services.config.paginators.SelectResourceConfigPublisher publisher = client.selectResourceConfigPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.config.paginators.SelectResourceConfigPublisher publisher = client.selectResourceConfigPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.config.model.SelectResourceConfigResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.config.model.SelectResourceConfigResponse response) { //... }; });
Please notice that the configuration of Limit won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
selectResourceConfig(software.amazon.awssdk.services.config.model.SelectResourceConfigRequest)
operation.
This is a convenience which creates an instance of the
SelectResourceConfigRequest.Builder
avoiding the need to create one manually viaSelectResourceConfigRequest.builder()
- Parameters:
selectResourceConfigRequest
- AConsumer
that will call methods onSelectResourceConfigRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidExpressionException The syntax of the query is incorrect.
- InvalidLimitException The specified limit is outside the allowable range.
- InvalidNextTokenException The specified next token is not valid. Specify the
nextToken
string that was returned in the previous response to get the next page of results. - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startConfigRulesEvaluation
default CompletableFuture<StartConfigRulesEvaluationResponse> startConfigRulesEvaluation(StartConfigRulesEvaluationRequest startConfigRulesEvaluationRequest) Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use
StartConfigRulesEvaluation
when you want to test 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 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 Config stream to an Amazon SNS topic, you will receive aConfigRuleEvaluationStarted
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, 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. -
Config invokes your Lambda function and evaluates your IAM resources.
-
Your custom rule will still run periodic evaluations every 24 hours.
- Parameters:
startConfigRulesEvaluationRequest
-- Returns:
- A Java Future containing the result of the StartConfigRulesEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying 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 You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startConfigRulesEvaluation
default CompletableFuture<StartConfigRulesEvaluationResponse> startConfigRulesEvaluation(Consumer<StartConfigRulesEvaluationRequest.Builder> startConfigRulesEvaluationRequest) Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. 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 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 Config stream to an Amazon SNS topic, you will receive aConfigRuleEvaluationStarted
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, 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. -
Config invokes your Lambda function and evaluates your IAM resources.
-
Your custom rule will still run periodic evaluations every 24 hours.
This is a convenience which creates an instance of the
StartConfigRulesEvaluationRequest.Builder
avoiding the need to create one manually viaStartConfigRulesEvaluationRequest.builder()
- Parameters:
startConfigRulesEvaluationRequest
- AConsumer
that will call methods onStartConfigRulesEvaluationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartConfigRulesEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigRuleException The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying 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 You see this exception in the following cases:
-
For DeleteConfigRule, Config is deleting this rule. Try your request again later.
-
For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.
-
For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.
-
For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.
-
For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.
-
For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.
-
- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
startConfigurationRecorder
default CompletableFuture<StartConfigurationRecorderResponse> startConfigurationRecorder(StartConfigurationRecorderRequest startConfigurationRecorderRequest) Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
You must have created at least one delivery channel to successfully start the configuration recorder.
- Parameters:
startConfigurationRecorderRequest
- The input for the StartConfigurationRecorder action.- Returns:
- A Java Future containing the result of the StartConfigurationRecorder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- NoAvailableDeliveryChannelException There is no delivery channel available to record configurations.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startConfigurationRecorder
default CompletableFuture<StartConfigurationRecorderResponse> startConfigurationRecorder(Consumer<StartConfigurationRecorderRequest.Builder> startConfigurationRecorderRequest) Starts recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
You must have created at least one delivery channel to successfully start the configuration recorder.
This is a convenience which creates an instance of the
StartConfigurationRecorderRequest.Builder
avoiding the need to create one manually viaStartConfigurationRecorderRequest.builder()
- Parameters:
startConfigurationRecorderRequest
- AConsumer
that will call methods onStartConfigurationRecorderRequest.Builder
to create a request. The input for the StartConfigurationRecorder action.- Returns:
- A Java Future containing the result of the StartConfigurationRecorder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- NoAvailableDeliveryChannelException There is no delivery channel available to record configurations.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startRemediationExecution
default CompletableFuture<StartRemediationExecutionResponse> startRemediationExecution(StartRemediationExecutionRequest startRemediationExecutionRequest) Runs an on-demand remediation for the specified 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.
- Parameters:
startRemediationExecutionRequest
-- Returns:
- A Java Future containing the result of the StartRemediationExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- NoSuchRemediationConfigurationException You specified an Config rule without a remediation configuration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startRemediationExecution
default CompletableFuture<StartRemediationExecutionResponse> startRemediationExecution(Consumer<StartRemediationExecutionRequest.Builder> startRemediationExecutionRequest) Runs an on-demand remediation for the specified 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.
This is a convenience which creates an instance of the
StartRemediationExecutionRequest.Builder
avoiding the need to create one manually viaStartRemediationExecutionRequest.builder()
- Parameters:
startRemediationExecutionRequest
- AConsumer
that will call methods onStartRemediationExecutionRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartRemediationExecution operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- InsufficientPermissionsException Indicates one of the following errors:
-
For PutConfigRule, the rule cannot be created because the IAM role assigned to Config lacks permissions to perform the config:Put* action.
-
For PutConfigRule, the Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
-
For PutOrganizationConfigRule, organization Config rule cannot be created because you do not have permissions to call IAM
GetRole
action or create a service-linked role. -
For PutConformancePack and PutOrganizationConformancePack, a conformance pack cannot be created because you do not have the following permissions:
-
You do not have permission to call IAM
GetRole
action or create a service-linked role. -
You do not have permission to read Amazon S3 bucket or call SSM:GetDocument.
-
-
- NoSuchRemediationConfigurationException You specified an Config rule without a remediation configuration.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startResourceEvaluation
default CompletableFuture<StartResourceEvaluationResponse> startResourceEvaluation(StartResourceEvaluationRequest startResourceEvaluationRequest) Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.
Ensure you have the
cloudformation:DescribeType
role setup to validate the resource type schema.You can find the Resource type schema in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand:
aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE
.For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.
- Parameters:
startResourceEvaluationRequest
-- Returns:
- A Java Future containing the result of the StartResourceEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- IdempotentParameterMismatchException Using the same client token with one or more different parameters. Specify a new client token with the parameter changes and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
startResourceEvaluation
default CompletableFuture<StartResourceEvaluationResponse> startResourceEvaluation(Consumer<StartResourceEvaluationRequest.Builder> startResourceEvaluationRequest) Runs an on-demand evaluation for the specified resource to determine whether the resource details will comply with configured Config rules. You can also use it for evaluation purposes. Config recommends using an evaluation context. It runs an execution against the resource details with all of the Config rules in your account that match with the specified proactive mode and resource type.
Ensure you have the
cloudformation:DescribeType
role setup to validate the resource type schema.You can find the Resource type schema in "Amazon Web Services public extensions" within the CloudFormation registry or with the following CLI commmand:
aws cloudformation describe-type --type-name "AWS::S3::Bucket" --type RESOURCE
.For more information, see Managing extensions through the CloudFormation registry and Amazon Web Services resource and property types reference in the CloudFormation User Guide.
This is a convenience which creates an instance of the
StartResourceEvaluationRequest.Builder
avoiding the need to create one manually viaStartResourceEvaluationRequest.builder()
- Parameters:
startResourceEvaluationRequest
- AConsumer
that will call methods onStartResourceEvaluationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the StartResourceEvaluation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InvalidParameterValueException One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.
- IdempotentParameterMismatchException Using the same client token with one or more different parameters. Specify a new client token with the parameter changes and try again.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopConfigurationRecorder
default CompletableFuture<StopConfigurationRecorderResponse> stopConfigurationRecorder(StopConfigurationRecorderRequest stopConfigurationRecorderRequest) Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
- Parameters:
stopConfigurationRecorderRequest
- The input for the StopConfigurationRecorder action.- Returns:
- A Java Future containing the result of the StopConfigurationRecorder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
stopConfigurationRecorder
default CompletableFuture<StopConfigurationRecorderResponse> stopConfigurationRecorder(Consumer<StopConfigurationRecorderRequest.Builder> stopConfigurationRecorderRequest) Stops recording configurations of the Amazon Web Services resources you have selected to record in your Amazon Web Services account.
This is a convenience which creates an instance of the
StopConfigurationRecorderRequest.Builder
avoiding the need to create one manually viaStopConfigurationRecorderRequest.builder()
- Parameters:
stopConfigurationRecorderRequest
- AConsumer
that will call methods onStopConfigurationRecorderRequest.Builder
to create a request. The input for the StopConfigurationRecorder action.- Returns:
- A Java Future containing the result of the StopConfigurationRecorder operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- NoSuchConfigurationRecorderException You have specified a configuration recorder that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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. If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException You have specified a resource that does not exist.
- TooManyTagsException You have reached the limit of the number of tags you can use. For more information, see Service Limits in the Config Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) 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. If existing tags are specified, however, then their values will be updated. When a resource is deleted, the tags associated with that resource are deleted as well.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException You have specified a resource that does not exist.
- TooManyTagsException You have reached the limit of the number of tags you can use. For more information, see Service Limits in the Config Developer Guide.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Deletes specified tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException You have specified a resource that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Deletes specified tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ValidationException The requested action is not valid.
For PutStoredQuery, you will see this exception if there are missing required fields or if the input value fails the validation, or if you are trying to create more than 300 queries.
For GetStoredQuery, ListStoredQuery, and DeleteStoredQuery you will see this exception if there are missing required fields or if the input value fails the validation.
- ResourceNotFoundException You have specified a resource that does not exist.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ConfigException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- ValidationException The requested action is not valid.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aConfigAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aConfigAsyncClient
.
-