Interface ConfigClient

  • All Superinterfaces:
    AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

    @Generated("software.amazon.awssdk:codegen")
    @ThreadSafe
    public interface ConfigClient
    extends AwsClient
    Service client for accessing Config Service. This can be created using the static builder() method. Config

    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.

    • Method Detail

      • batchGetAggregateResourceConfig

        default BatchGetAggregateResourceConfigResponse batchGetAggregateResourceConfig​(BatchGetAggregateResourceConfigRequest batchGetAggregateResourceConfigRequest)
                                                                                 throws ValidationException,
                                                                                        NoSuchConfigurationAggregatorException,
                                                                                        AwsServiceException,
                                                                                        SdkClientException,
                                                                                        ConfigException

        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:
        Result of the BatchGetAggregateResourceConfig operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • batchGetResourceConfig

        default BatchGetResourceConfigResponse batchGetResourceConfig​(BatchGetResourceConfigRequest batchGetResourceConfigRequest)
                                                               throws ValidationException,
                                                                      NoAvailableConfigurationRecorderException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      ConfigException

        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:
        Result of the BatchGetResourceConfig operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteConfigRule

        default DeleteConfigRuleResponse deleteConfigRule​(DeleteConfigRuleRequest deleteConfigRuleRequest)
                                                   throws NoSuchConfigRuleException,
                                                          ResourceInUseException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConfigException

        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 a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

        You can check the state of a rule by using the DescribeConfigRules request.

        Parameters:
        deleteConfigRuleRequest -
        Returns:
        Result of the DeleteConfigRule operation returned by the service.
        Throws:
        NoSuchConfigRuleException - 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteConfigRule

        default DeleteConfigRuleResponse deleteConfigRule​(Consumer<DeleteConfigRuleRequest.Builder> deleteConfigRuleRequest)
                                                   throws NoSuchConfigRuleException,
                                                          ResourceInUseException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          ConfigException

        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 a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException.

        You can check the state of a rule by using the DescribeConfigRules request.


        This is a convenience which creates an instance of the DeleteConfigRuleRequest.Builder avoiding the need to create one manually via DeleteConfigRuleRequest.builder()

        Parameters:
        deleteConfigRuleRequest - A Consumer that will call methods on DeleteConfigRuleRequest.Builder to create a request.
        Returns:
        Result of the DeleteConfigRule operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteConfigurationRecorder

        default DeleteConfigurationRecorderResponse deleteConfigurationRecorder​(DeleteConfigurationRecorderRequest deleteConfigurationRecorderRequest)
                                                                         throws NoSuchConfigurationRecorderException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConfigException

        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 the DeleteConfigurationRecorder action.
        Returns:
        Result of the DeleteConfigurationRecorder operation returned by the service.
        Throws:
        NoSuchConfigurationRecorderException - You have specified a configuration recorder that does not exist.
        SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
        SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
        ConfigException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteConformancePack

        default DeleteConformancePackResponse deleteConformancePack​(DeleteConformancePackRequest deleteConformancePackRequest)
                                                             throws NoSuchConformancePackException,
                                                                    ResourceInUseException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConfigException

        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:
        Result of the DeleteConformancePack operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteConformancePack

        default DeleteConformancePackResponse deleteConformancePack​(Consumer<DeleteConformancePackRequest.Builder> deleteConformancePackRequest)
                                                             throws NoSuchConformancePackException,
                                                                    ResourceInUseException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    ConfigException

        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 via DeleteConformancePackRequest.builder()

        Parameters:
        deleteConformancePackRequest - A Consumer that will call methods on DeleteConformancePackRequest.Builder to create a request.
        Returns:
        Result of the DeleteConformancePack operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteEvaluationResults

        default DeleteEvaluationResultsResponse deleteEvaluationResults​(DeleteEvaluationResultsRequest deleteEvaluationResultsRequest)
                                                                 throws NoSuchConfigRuleException,
                                                                        ResourceInUseException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConfigException

        Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your Amazon Web Services resources against the rule.

        Parameters:
        deleteEvaluationResultsRequest -
        Returns:
        Result of the DeleteEvaluationResults operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteEvaluationResults

        default DeleteEvaluationResultsResponse deleteEvaluationResults​(Consumer<DeleteEvaluationResultsRequest.Builder> deleteEvaluationResultsRequest)
                                                                 throws NoSuchConfigRuleException,
                                                                        ResourceInUseException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConfigException

        Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your 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 via DeleteEvaluationResultsRequest.builder()

        Parameters:
        deleteEvaluationResultsRequest - A Consumer that will call methods on DeleteEvaluationResultsRequest.Builder to create a request.
        Returns:
        Result of the DeleteEvaluationResults operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteOrganizationConfigRule

        default DeleteOrganizationConfigRuleResponse deleteOrganizationConfigRule​(DeleteOrganizationConfigRuleRequest deleteOrganizationConfigRuleRequest)
                                                                           throws NoSuchOrganizationConfigRuleException,
                                                                                  ResourceInUseException,
                                                                                  OrganizationAccessDeniedException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConfigException

        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:
        Result of the DeleteOrganizationConfigRule operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteOrganizationConfigRule

        default DeleteOrganizationConfigRuleResponse deleteOrganizationConfigRule​(Consumer<DeleteOrganizationConfigRuleRequest.Builder> deleteOrganizationConfigRuleRequest)
                                                                           throws NoSuchOrganizationConfigRuleException,
                                                                                  ResourceInUseException,
                                                                                  OrganizationAccessDeniedException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConfigException

        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 via DeleteOrganizationConfigRuleRequest.builder()

        Parameters:
        deleteOrganizationConfigRuleRequest - A Consumer that will call methods on DeleteOrganizationConfigRuleRequest.Builder to create a request.
        Returns:
        Result of the DeleteOrganizationConfigRule operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteOrganizationConformancePack

        default DeleteOrganizationConformancePackResponse deleteOrganizationConformancePack​(DeleteOrganizationConformancePackRequest deleteOrganizationConformancePackRequest)
                                                                                     throws NoSuchOrganizationConformancePackException,
                                                                                            ResourceInUseException,
                                                                                            OrganizationAccessDeniedException,
                                                                                            AwsServiceException,
                                                                                            SdkClientException,
                                                                                            ConfigException

        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:
        Result of the DeleteOrganizationConformancePack operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteOrganizationConformancePack

        default DeleteOrganizationConformancePackResponse deleteOrganizationConformancePack​(Consumer<DeleteOrganizationConformancePackRequest.Builder> deleteOrganizationConformancePackRequest)
                                                                                     throws NoSuchOrganizationConformancePackException,
                                                                                            ResourceInUseException,
                                                                                            OrganizationAccessDeniedException,
                                                                                            AwsServiceException,
                                                                                            SdkClientException,
                                                                                            ConfigException

        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 via DeleteOrganizationConformancePackRequest.builder()

        Parameters:
        deleteOrganizationConformancePackRequest - A Consumer that will call methods on DeleteOrganizationConformancePackRequest.Builder to create a request.
        Returns:
        Result of the DeleteOrganizationConformancePack operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteResourceConfig

        default DeleteResourceConfigResponse deleteResourceConfig​(DeleteResourceConfigRequest deleteResourceConfigRequest)
                                                           throws ValidationException,
                                                                  NoRunningConfigurationRecorderException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  ConfigException

        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:
        Result of the DeleteResourceConfig operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • deleteStoredQuery

        default DeleteStoredQueryResponse deleteStoredQuery​(DeleteStoredQueryRequest deleteStoredQueryRequest)
                                                     throws ValidationException,
                                                            ResourceNotFoundException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConfigException

        Deletes the stored query for a single Amazon Web Services account and a single Amazon Web Services Region.

        Parameters:
        deleteStoredQueryRequest -
        Returns:
        Result of the DeleteStoredQuery operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeAggregateComplianceByConfigRulesPaginator

        default DescribeAggregateComplianceByConfigRulesIterable describeAggregateComplianceByConfigRulesPaginator​(DescribeAggregateComplianceByConfigRulesRequest describeAggregateComplianceByConfigRulesRequest)
                                                                                                            throws ValidationException,
                                                                                                                   InvalidLimitException,
                                                                                                                   InvalidNextTokenException,
                                                                                                                   NoSuchConfigurationAggregatorException,
                                                                                                                   AwsServiceException,
                                                                                                                   SdkClientException,
                                                                                                                   ConfigException

        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 variant of describeAggregateComplianceByConfigRules(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConfigRulesIterable responses = client.describeAggregateComplianceByConfigRulesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConfigRulesIterable responses = client
                     .describeAggregateComplianceByConfigRulesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConfigRulesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConfigRulesIterable responses = client.describeAggregateComplianceByConfigRulesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeAggregateComplianceByConformancePacks

        default DescribeAggregateComplianceByConformancePacksResponse describeAggregateComplianceByConformancePacks​(DescribeAggregateComplianceByConformancePacksRequest describeAggregateComplianceByConformancePacksRequest)
                                                                                                             throws ValidationException,
                                                                                                                    InvalidLimitException,
                                                                                                                    InvalidNextTokenException,
                                                                                                                    NoSuchConfigurationAggregatorException,
                                                                                                                    AwsServiceException,
                                                                                                                    SdkClientException,
                                                                                                                    ConfigException

        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:
        Result of the DescribeAggregateComplianceByConformancePacks operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeAggregateComplianceByConformancePacksPaginator

        default DescribeAggregateComplianceByConformancePacksIterable describeAggregateComplianceByConformancePacksPaginator​(DescribeAggregateComplianceByConformancePacksRequest describeAggregateComplianceByConformancePacksRequest)
                                                                                                                      throws ValidationException,
                                                                                                                             InvalidLimitException,
                                                                                                                             InvalidNextTokenException,
                                                                                                                             NoSuchConfigurationAggregatorException,
                                                                                                                             AwsServiceException,
                                                                                                                             SdkClientException,
                                                                                                                             ConfigException

        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 variant of describeAggregateComplianceByConformancePacks(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksIterable responses = client.describeAggregateComplianceByConformancePacksPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksIterable responses = client
                     .describeAggregateComplianceByConformancePacksPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksIterable responses = client.describeAggregateComplianceByConformancePacksPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeAggregateComplianceByConformancePacksPaginator

        default DescribeAggregateComplianceByConformancePacksIterable describeAggregateComplianceByConformancePacksPaginator​(Consumer<DescribeAggregateComplianceByConformancePacksRequest.Builder> describeAggregateComplianceByConformancePacksRequest)
                                                                                                                      throws ValidationException,
                                                                                                                             InvalidLimitException,
                                                                                                                             InvalidNextTokenException,
                                                                                                                             NoSuchConfigurationAggregatorException,
                                                                                                                             AwsServiceException,
                                                                                                                             SdkClientException,
                                                                                                                             ConfigException

        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 variant of describeAggregateComplianceByConformancePacks(software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksIterable responses = client.describeAggregateComplianceByConformancePacksPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksIterable responses = client
                     .describeAggregateComplianceByConformancePacksPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeAggregateComplianceByConformancePacksResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregateComplianceByConformancePacksIterable responses = client.describeAggregateComplianceByConformancePacksPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeAggregateComplianceByConformancePacksRequest.builder()

        Parameters:
        describeAggregateComplianceByConformancePacksRequest - A Consumer that will call methods on DescribeAggregateComplianceByConformancePacksRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeAggregationAuthorizationsPaginator

        default DescribeAggregationAuthorizationsIterable describeAggregationAuthorizationsPaginator()
                                                                                              throws InvalidParameterValueException,
                                                                                                     InvalidNextTokenException,
                                                                                                     InvalidLimitException,
                                                                                                     AwsServiceException,
                                                                                                     SdkClientException,
                                                                                                     ConfigException

        Returns a list of authorizations granted to various aggregator accounts and regions.


        This is a variant of describeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsIterable responses = client.describeAggregationAuthorizationsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsIterable responses = client
                     .describeAggregationAuthorizationsPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsIterable responses = client.describeAggregationAuthorizationsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        describeAggregationAuthorizationsPaginator(DescribeAggregationAuthorizationsRequest), AWS API Documentation
      • describeAggregationAuthorizationsPaginator

        default DescribeAggregationAuthorizationsIterable describeAggregationAuthorizationsPaginator​(DescribeAggregationAuthorizationsRequest describeAggregationAuthorizationsRequest)
                                                                                              throws InvalidParameterValueException,
                                                                                                     InvalidNextTokenException,
                                                                                                     InvalidLimitException,
                                                                                                     AwsServiceException,
                                                                                                     SdkClientException,
                                                                                                     ConfigException

        Returns a list of authorizations granted to various aggregator accounts and regions.


        This is a variant of describeAggregationAuthorizations(software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsIterable responses = client.describeAggregationAuthorizationsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsIterable responses = client
                     .describeAggregationAuthorizationsPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeAggregationAuthorizationsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeAggregationAuthorizationsIterable responses = client.describeAggregationAuthorizationsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeComplianceByConfigRule

        default DescribeComplianceByConfigRuleResponse describeComplianceByConfigRule​(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest)
                                                                               throws InvalidParameterValueException,
                                                                                      NoSuchConfigRuleException,
                                                                                      InvalidNextTokenException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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:
        Result of the DescribeComplianceByConfigRule operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeComplianceByConfigRule

        default DescribeComplianceByConfigRuleResponse describeComplianceByConfigRule​(Consumer<DescribeComplianceByConfigRuleRequest.Builder> describeComplianceByConfigRuleRequest)
                                                                               throws InvalidParameterValueException,
                                                                                      NoSuchConfigRuleException,
                                                                                      InvalidNextTokenException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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 via DescribeComplianceByConfigRuleRequest.builder()

        Parameters:
        describeComplianceByConfigRuleRequest - A Consumer that will call methods on DescribeComplianceByConfigRuleRequest.Builder to create a request.
        Returns:
        Result of the DescribeComplianceByConfigRule operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeComplianceByConfigRule

        default DescribeComplianceByConfigRuleResponse describeComplianceByConfigRule()
                                                                               throws InvalidParameterValueException,
                                                                                      NoSuchConfigRuleException,
                                                                                      InvalidNextTokenException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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:
        Result of the DescribeComplianceByConfigRule operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        describeComplianceByConfigRule(DescribeComplianceByConfigRuleRequest), AWS API Documentation
      • describeComplianceByConfigRulePaginator

        default DescribeComplianceByConfigRuleIterable describeComplianceByConfigRulePaginator()
                                                                                        throws InvalidParameterValueException,
                                                                                               NoSuchConfigRuleException,
                                                                                               InvalidNextTokenException,
                                                                                               AwsServiceException,
                                                                                               SdkClientException,
                                                                                               ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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 variant of describeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRuleIterable responses = client.describeComplianceByConfigRulePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRuleIterable responses = client
                     .describeComplianceByConfigRulePaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRuleIterable responses = client.describeComplianceByConfigRulePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        describeComplianceByConfigRulePaginator(DescribeComplianceByConfigRuleRequest), AWS API Documentation
      • describeComplianceByConfigRulePaginator

        default DescribeComplianceByConfigRuleIterable describeComplianceByConfigRulePaginator​(DescribeComplianceByConfigRuleRequest describeComplianceByConfigRuleRequest)
                                                                                        throws InvalidParameterValueException,
                                                                                               NoSuchConfigRuleException,
                                                                                               InvalidNextTokenException,
                                                                                               AwsServiceException,
                                                                                               SdkClientException,
                                                                                               ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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 variant of describeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRuleIterable responses = client.describeComplianceByConfigRulePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRuleIterable responses = client
                     .describeComplianceByConfigRulePaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRuleIterable responses = client.describeComplianceByConfigRulePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeComplianceByConfigRulePaginator

        default DescribeComplianceByConfigRuleIterable describeComplianceByConfigRulePaginator​(Consumer<DescribeComplianceByConfigRuleRequest.Builder> describeComplianceByConfigRuleRequest)
                                                                                        throws InvalidParameterValueException,
                                                                                               NoSuchConfigRuleException,
                                                                                               InvalidNextTokenException,
                                                                                               AwsServiceException,
                                                                                               SdkClientException,
                                                                                               ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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 variant of describeComplianceByConfigRule(software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRuleIterable responses = client.describeComplianceByConfigRulePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRuleIterable responses = client
                     .describeComplianceByConfigRulePaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeComplianceByConfigRuleResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByConfigRuleIterable responses = client.describeComplianceByConfigRulePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeComplianceByConfigRuleRequest.builder()

        Parameters:
        describeComplianceByConfigRuleRequest - A Consumer that will call methods on DescribeComplianceByConfigRuleRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeComplianceByResource

        default DescribeComplianceByResourceResponse describeComplianceByResource​(DescribeComplianceByResourceRequest describeComplianceByResourceRequest)
                                                                           throws InvalidParameterValueException,
                                                                                  InvalidNextTokenException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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:
        Result of the DescribeComplianceByResource operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeComplianceByResource

        default DescribeComplianceByResourceResponse describeComplianceByResource​(Consumer<DescribeComplianceByResourceRequest.Builder> describeComplianceByResourceRequest)
                                                                           throws InvalidParameterValueException,
                                                                                  InvalidNextTokenException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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 via DescribeComplianceByResourceRequest.builder()

        Parameters:
        describeComplianceByResourceRequest - A Consumer that will call methods on DescribeComplianceByResourceRequest.Builder to create a request.
        Returns:
        Result of the DescribeComplianceByResource operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeComplianceByResource

        default DescribeComplianceByResourceResponse describeComplianceByResource()
                                                                           throws InvalidParameterValueException,
                                                                                  InvalidNextTokenException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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:
        Result of the DescribeComplianceByResource operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        describeComplianceByResource(DescribeComplianceByResourceRequest), AWS API Documentation
      • describeComplianceByResourcePaginator

        default DescribeComplianceByResourceIterable describeComplianceByResourcePaginator()
                                                                                    throws InvalidParameterValueException,
                                                                                           InvalidNextTokenException,
                                                                                           AwsServiceException,
                                                                                           SdkClientException,
                                                                                           ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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 variant of describeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourceIterable responses = client.describeComplianceByResourcePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourceIterable responses = client
                     .describeComplianceByResourcePaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeComplianceByResourceResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourceIterable responses = client.describeComplianceByResourcePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        describeComplianceByResourcePaginator(DescribeComplianceByResourceRequest), AWS API Documentation
      • describeComplianceByResourcePaginator

        default DescribeComplianceByResourceIterable describeComplianceByResourcePaginator​(DescribeComplianceByResourceRequest describeComplianceByResourceRequest)
                                                                                    throws InvalidParameterValueException,
                                                                                           InvalidNextTokenException,
                                                                                           AwsServiceException,
                                                                                           SdkClientException,
                                                                                           ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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 variant of describeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourceIterable responses = client.describeComplianceByResourcePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourceIterable responses = client
                     .describeComplianceByResourcePaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeComplianceByResourceResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourceIterable responses = client.describeComplianceByResourcePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeComplianceByResourcePaginator

        default DescribeComplianceByResourceIterable describeComplianceByResourcePaginator​(Consumer<DescribeComplianceByResourceRequest.Builder> describeComplianceByResourceRequest)
                                                                                    throws InvalidParameterValueException,
                                                                                           InvalidNextTokenException,
                                                                                           AwsServiceException,
                                                                                           SdkClientException,
                                                                                           ConfigException

        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 the LastSuccessfulInvocationTime and LastFailedInvocationTime.

        • 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 the config: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 variant of describeComplianceByResource(software.amazon.awssdk.services.config.model.DescribeComplianceByResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourceIterable responses = client.describeComplianceByResourcePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourceIterable responses = client
                     .describeComplianceByResourcePaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeComplianceByResourceResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeComplianceByResourceIterable responses = client.describeComplianceByResourcePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeComplianceByResourceRequest.builder()

        Parameters:
        describeComplianceByResourceRequest - A Consumer that will call methods on DescribeComplianceByResourceRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeConfigRuleEvaluationStatusPaginator

        default DescribeConfigRuleEvaluationStatusIterable describeConfigRuleEvaluationStatusPaginator()
                                                                                                throws NoSuchConfigRuleException,
                                                                                                       InvalidParameterValueException,
                                                                                                       InvalidNextTokenException,
                                                                                                       AwsServiceException,
                                                                                                       SdkClientException,
                                                                                                       ConfigException

        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 variant of describeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusIterable responses = client.describeConfigRuleEvaluationStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusIterable responses = client
                     .describeConfigRuleEvaluationStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusIterable responses = client.describeConfigRuleEvaluationStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        describeConfigRuleEvaluationStatusPaginator(DescribeConfigRuleEvaluationStatusRequest), AWS API Documentation
      • describeConfigRuleEvaluationStatusPaginator

        default DescribeConfigRuleEvaluationStatusIterable describeConfigRuleEvaluationStatusPaginator​(DescribeConfigRuleEvaluationStatusRequest describeConfigRuleEvaluationStatusRequest)
                                                                                                throws NoSuchConfigRuleException,
                                                                                                       InvalidParameterValueException,
                                                                                                       InvalidNextTokenException,
                                                                                                       AwsServiceException,
                                                                                                       SdkClientException,
                                                                                                       ConfigException

        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 variant of describeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusIterable responses = client.describeConfigRuleEvaluationStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusIterable responses = client
                     .describeConfigRuleEvaluationStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusIterable responses = client.describeConfigRuleEvaluationStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeConfigRuleEvaluationStatusPaginator

        default DescribeConfigRuleEvaluationStatusIterable describeConfigRuleEvaluationStatusPaginator​(Consumer<DescribeConfigRuleEvaluationStatusRequest.Builder> describeConfigRuleEvaluationStatusRequest)
                                                                                                throws NoSuchConfigRuleException,
                                                                                                       InvalidParameterValueException,
                                                                                                       InvalidNextTokenException,
                                                                                                       AwsServiceException,
                                                                                                       SdkClientException,
                                                                                                       ConfigException

        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 variant of describeConfigRuleEvaluationStatus(software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusIterable responses = client.describeConfigRuleEvaluationStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusIterable responses = client
                     .describeConfigRuleEvaluationStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConfigRuleEvaluationStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRuleEvaluationStatusIterable responses = client.describeConfigRuleEvaluationStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeConfigRuleEvaluationStatusRequest.builder()

        Parameters:
        describeConfigRuleEvaluationStatusRequest - A Consumer that will call methods on DescribeConfigRuleEvaluationStatusRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeConfigRulesPaginator

        default DescribeConfigRulesIterable describeConfigRulesPaginator()
                                                                  throws NoSuchConfigRuleException,
                                                                         InvalidNextTokenException,
                                                                         InvalidParameterValueException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConfigException

        Returns details about your Config rules.


        This is a variant of describeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRulesIterable responses = client.describeConfigRulesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConfigRulesIterable responses = client
                     .describeConfigRulesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConfigRulesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRulesIterable responses = client.describeConfigRulesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        describeConfigRulesPaginator(DescribeConfigRulesRequest), AWS API Documentation
      • describeConfigRulesPaginator

        default DescribeConfigRulesIterable describeConfigRulesPaginator​(DescribeConfigRulesRequest describeConfigRulesRequest)
                                                                  throws NoSuchConfigRuleException,
                                                                         InvalidNextTokenException,
                                                                         InvalidParameterValueException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConfigException

        Returns details about your Config rules.


        This is a variant of describeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRulesIterable responses = client.describeConfigRulesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConfigRulesIterable responses = client
                     .describeConfigRulesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConfigRulesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRulesIterable responses = client.describeConfigRulesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeConfigRulesPaginator

        default DescribeConfigRulesIterable describeConfigRulesPaginator​(Consumer<DescribeConfigRulesRequest.Builder> describeConfigRulesRequest)
                                                                  throws NoSuchConfigRuleException,
                                                                         InvalidNextTokenException,
                                                                         InvalidParameterValueException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConfigException

        Returns details about your Config rules.


        This is a variant of describeConfigRules(software.amazon.awssdk.services.config.model.DescribeConfigRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRulesIterable responses = client.describeConfigRulesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConfigRulesIterable responses = client
                     .describeConfigRulesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConfigRulesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigRulesIterable responses = client.describeConfigRulesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeConfigRulesRequest.builder()

        Parameters:
        describeConfigRulesRequest - A Consumer that will call methods on DescribeConfigRulesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeConfigurationAggregatorSourcesStatusPaginator

        default DescribeConfigurationAggregatorSourcesStatusIterable describeConfigurationAggregatorSourcesStatusPaginator​(DescribeConfigurationAggregatorSourcesStatusRequest describeConfigurationAggregatorSourcesStatusRequest)
                                                                                                                    throws InvalidParameterValueException,
                                                                                                                           NoSuchConfigurationAggregatorException,
                                                                                                                           InvalidNextTokenException,
                                                                                                                           InvalidLimitException,
                                                                                                                           AwsServiceException,
                                                                                                                           SdkClientException,
                                                                                                                           ConfigException

        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 variant of describeConfigurationAggregatorSourcesStatus(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorSourcesStatusIterable responses = client.describeConfigurationAggregatorSourcesStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorSourcesStatusIterable responses = client
                     .describeConfigurationAggregatorSourcesStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorSourcesStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorSourcesStatusIterable responses = client.describeConfigurationAggregatorSourcesStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeConfigurationAggregatorsPaginator

        default DescribeConfigurationAggregatorsIterable describeConfigurationAggregatorsPaginator​(DescribeConfigurationAggregatorsRequest describeConfigurationAggregatorsRequest)
                                                                                            throws InvalidParameterValueException,
                                                                                                   NoSuchConfigurationAggregatorException,
                                                                                                   InvalidNextTokenException,
                                                                                                   InvalidLimitException,
                                                                                                   AwsServiceException,
                                                                                                   SdkClientException,
                                                                                                   ConfigException

        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 variant of describeConfigurationAggregators(software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorsIterable responses = client.describeConfigurationAggregatorsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorsIterable responses = client
                     .describeConfigurationAggregatorsPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConfigurationAggregatorsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConfigurationAggregatorsIterable responses = client.describeConfigurationAggregatorsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeConformancePackStatusPaginator

        default DescribeConformancePackStatusIterable describeConformancePackStatusPaginator​(DescribeConformancePackStatusRequest describeConformancePackStatusRequest)
                                                                                      throws InvalidLimitException,
                                                                                             InvalidNextTokenException,
                                                                                             InvalidParameterValueException,
                                                                                             AwsServiceException,
                                                                                             SdkClientException,
                                                                                             ConfigException

        Provides one or more conformance packs deployment status.

        If there are no conformance packs then you will see an empty result.


        This is a variant of describeConformancePackStatus(software.amazon.awssdk.services.config.model.DescribeConformancePackStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConformancePackStatusIterable responses = client.describeConformancePackStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConformancePackStatusIterable responses = client
                     .describeConformancePackStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConformancePackStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConformancePackStatusIterable responses = client.describeConformancePackStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeConformancePacksPaginator

        default DescribeConformancePacksIterable describeConformancePacksPaginator​(DescribeConformancePacksRequest describeConformancePacksRequest)
                                                                            throws NoSuchConformancePackException,
                                                                                   InvalidLimitException,
                                                                                   InvalidNextTokenException,
                                                                                   InvalidParameterValueException,
                                                                                   AwsServiceException,
                                                                                   SdkClientException,
                                                                                   ConfigException

        Returns a list of one or more conformance packs.


        This is a variant of describeConformancePacks(software.amazon.awssdk.services.config.model.DescribeConformancePacksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeConformancePacksIterable responses = client.describeConformancePacksPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeConformancePacksIterable responses = client
                     .describeConformancePacksPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeConformancePacksResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeConformancePacksIterable responses = client.describeConformancePacksPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConfigRuleStatuses

        default DescribeOrganizationConfigRuleStatusesResponse describeOrganizationConfigRuleStatuses​(DescribeOrganizationConfigRuleStatusesRequest describeOrganizationConfigRuleStatusesRequest)
                                                                                               throws NoSuchOrganizationConfigRuleException,
                                                                                                      InvalidLimitException,
                                                                                                      InvalidNextTokenException,
                                                                                                      OrganizationAccessDeniedException,
                                                                                                      AwsServiceException,
                                                                                                      SdkClientException,
                                                                                                      ConfigException

        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:
        Result of the DescribeOrganizationConfigRuleStatuses operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConfigRuleStatuses

        default DescribeOrganizationConfigRuleStatusesResponse describeOrganizationConfigRuleStatuses​(Consumer<DescribeOrganizationConfigRuleStatusesRequest.Builder> describeOrganizationConfigRuleStatusesRequest)
                                                                                               throws NoSuchOrganizationConfigRuleException,
                                                                                                      InvalidLimitException,
                                                                                                      InvalidNextTokenException,
                                                                                                      OrganizationAccessDeniedException,
                                                                                                      AwsServiceException,
                                                                                                      SdkClientException,
                                                                                                      ConfigException

        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 via DescribeOrganizationConfigRuleStatusesRequest.builder()

        Parameters:
        describeOrganizationConfigRuleStatusesRequest - A Consumer that will call methods on DescribeOrganizationConfigRuleStatusesRequest.Builder to create a request.
        Returns:
        Result of the DescribeOrganizationConfigRuleStatuses operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConfigRuleStatusesPaginator

        default DescribeOrganizationConfigRuleStatusesIterable describeOrganizationConfigRuleStatusesPaginator​(DescribeOrganizationConfigRuleStatusesRequest describeOrganizationConfigRuleStatusesRequest)
                                                                                                        throws NoSuchOrganizationConfigRuleException,
                                                                                                               InvalidLimitException,
                                                                                                               InvalidNextTokenException,
                                                                                                               OrganizationAccessDeniedException,
                                                                                                               AwsServiceException,
                                                                                                               SdkClientException,
                                                                                                               ConfigException

        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 variant of describeOrganizationConfigRuleStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesIterable responses = client.describeOrganizationConfigRuleStatusesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesIterable responses = client
                     .describeOrganizationConfigRuleStatusesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesIterable responses = client.describeOrganizationConfigRuleStatusesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConfigRuleStatusesPaginator

        default DescribeOrganizationConfigRuleStatusesIterable describeOrganizationConfigRuleStatusesPaginator​(Consumer<DescribeOrganizationConfigRuleStatusesRequest.Builder> describeOrganizationConfigRuleStatusesRequest)
                                                                                                        throws NoSuchOrganizationConfigRuleException,
                                                                                                               InvalidLimitException,
                                                                                                               InvalidNextTokenException,
                                                                                                               OrganizationAccessDeniedException,
                                                                                                               AwsServiceException,
                                                                                                               SdkClientException,
                                                                                                               ConfigException

        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 variant of describeOrganizationConfigRuleStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesIterable responses = client.describeOrganizationConfigRuleStatusesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesIterable responses = client
                     .describeOrganizationConfigRuleStatusesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRuleStatusesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRuleStatusesIterable responses = client.describeOrganizationConfigRuleStatusesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeOrganizationConfigRuleStatusesRequest.builder()

        Parameters:
        describeOrganizationConfigRuleStatusesRequest - A Consumer that will call methods on DescribeOrganizationConfigRuleStatusesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConfigRules

        default DescribeOrganizationConfigRulesResponse describeOrganizationConfigRules​(DescribeOrganizationConfigRulesRequest describeOrganizationConfigRulesRequest)
                                                                                 throws NoSuchOrganizationConfigRuleException,
                                                                                        InvalidNextTokenException,
                                                                                        InvalidLimitException,
                                                                                        OrganizationAccessDeniedException,
                                                                                        AwsServiceException,
                                                                                        SdkClientException,
                                                                                        ConfigException

        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 organzation

        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 and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.

        Parameters:
        describeOrganizationConfigRulesRequest -
        Returns:
        Result of the DescribeOrganizationConfigRules operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConfigRules

        default DescribeOrganizationConfigRulesResponse describeOrganizationConfigRules​(Consumer<DescribeOrganizationConfigRulesRequest.Builder> describeOrganizationConfigRulesRequest)
                                                                                 throws NoSuchOrganizationConfigRuleException,
                                                                                        InvalidNextTokenException,
                                                                                        InvalidLimitException,
                                                                                        OrganizationAccessDeniedException,
                                                                                        AwsServiceException,
                                                                                        SdkClientException,
                                                                                        ConfigException

        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 organzation

        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 and DescribeOrganizationConformancePacks 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 via DescribeOrganizationConfigRulesRequest.builder()

        Parameters:
        describeOrganizationConfigRulesRequest - A Consumer that will call methods on DescribeOrganizationConfigRulesRequest.Builder to create a request.
        Returns:
        Result of the DescribeOrganizationConfigRules operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConfigRulesPaginator

        default DescribeOrganizationConfigRulesIterable describeOrganizationConfigRulesPaginator​(DescribeOrganizationConfigRulesRequest describeOrganizationConfigRulesRequest)
                                                                                          throws NoSuchOrganizationConfigRuleException,
                                                                                                 InvalidNextTokenException,
                                                                                                 InvalidLimitException,
                                                                                                 OrganizationAccessDeniedException,
                                                                                                 AwsServiceException,
                                                                                                 SdkClientException,
                                                                                                 ConfigException

        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 organzation

        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 and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.


        This is a variant of describeOrganizationConfigRules(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesIterable responses = client.describeOrganizationConfigRulesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesIterable responses = client
                     .describeOrganizationConfigRulesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesIterable responses = client.describeOrganizationConfigRulesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConfigRulesPaginator

        default DescribeOrganizationConfigRulesIterable describeOrganizationConfigRulesPaginator​(Consumer<DescribeOrganizationConfigRulesRequest.Builder> describeOrganizationConfigRulesRequest)
                                                                                          throws NoSuchOrganizationConfigRuleException,
                                                                                                 InvalidNextTokenException,
                                                                                                 InvalidLimitException,
                                                                                                 OrganizationAccessDeniedException,
                                                                                                 AwsServiceException,
                                                                                                 SdkClientException,
                                                                                                 ConfigException

        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 organzation

        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 and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.


        This is a variant of describeOrganizationConfigRules(software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesIterable responses = client.describeOrganizationConfigRulesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesIterable responses = client
                     .describeOrganizationConfigRulesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeOrganizationConfigRulesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConfigRulesIterable responses = client.describeOrganizationConfigRulesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeOrganizationConfigRulesRequest.builder()

        Parameters:
        describeOrganizationConfigRulesRequest - A Consumer that will call methods on DescribeOrganizationConfigRulesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConformancePackStatuses

        default DescribeOrganizationConformancePackStatusesResponse describeOrganizationConformancePackStatuses​(DescribeOrganizationConformancePackStatusesRequest describeOrganizationConformancePackStatusesRequest)
                                                                                                         throws NoSuchOrganizationConformancePackException,
                                                                                                                InvalidLimitException,
                                                                                                                InvalidNextTokenException,
                                                                                                                OrganizationAccessDeniedException,
                                                                                                                AwsServiceException,
                                                                                                                SdkClientException,
                                                                                                                ConfigException

        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:
        Result of the DescribeOrganizationConformancePackStatuses operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConformancePackStatuses

        default DescribeOrganizationConformancePackStatusesResponse describeOrganizationConformancePackStatuses​(Consumer<DescribeOrganizationConformancePackStatusesRequest.Builder> describeOrganizationConformancePackStatusesRequest)
                                                                                                         throws NoSuchOrganizationConformancePackException,
                                                                                                                InvalidLimitException,
                                                                                                                InvalidNextTokenException,
                                                                                                                OrganizationAccessDeniedException,
                                                                                                                AwsServiceException,
                                                                                                                SdkClientException,
                                                                                                                ConfigException

        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 via DescribeOrganizationConformancePackStatusesRequest.builder()

        Parameters:
        describeOrganizationConformancePackStatusesRequest - A Consumer that will call methods on DescribeOrganizationConformancePackStatusesRequest.Builder to create a request.
        Returns:
        Result of the DescribeOrganizationConformancePackStatuses operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConformancePackStatusesPaginator

        default DescribeOrganizationConformancePackStatusesIterable describeOrganizationConformancePackStatusesPaginator​(DescribeOrganizationConformancePackStatusesRequest describeOrganizationConformancePackStatusesRequest)
                                                                                                                  throws NoSuchOrganizationConformancePackException,
                                                                                                                         InvalidLimitException,
                                                                                                                         InvalidNextTokenException,
                                                                                                                         OrganizationAccessDeniedException,
                                                                                                                         AwsServiceException,
                                                                                                                         SdkClientException,
                                                                                                                         ConfigException

        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 variant of describeOrganizationConformancePackStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesIterable responses = client.describeOrganizationConformancePackStatusesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesIterable responses = client
                     .describeOrganizationConformancePackStatusesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesIterable responses = client.describeOrganizationConformancePackStatusesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConformancePackStatusesPaginator

        default DescribeOrganizationConformancePackStatusesIterable describeOrganizationConformancePackStatusesPaginator​(Consumer<DescribeOrganizationConformancePackStatusesRequest.Builder> describeOrganizationConformancePackStatusesRequest)
                                                                                                                  throws NoSuchOrganizationConformancePackException,
                                                                                                                         InvalidLimitException,
                                                                                                                         InvalidNextTokenException,
                                                                                                                         OrganizationAccessDeniedException,
                                                                                                                         AwsServiceException,
                                                                                                                         SdkClientException,
                                                                                                                         ConfigException

        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 variant of describeOrganizationConformancePackStatuses(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesIterable responses = client.describeOrganizationConformancePackStatusesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesIterable responses = client
                     .describeOrganizationConformancePackStatusesPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePackStatusesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePackStatusesIterable responses = client.describeOrganizationConformancePackStatusesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeOrganizationConformancePackStatusesRequest.builder()

        Parameters:
        describeOrganizationConformancePackStatusesRequest - A Consumer that will call methods on DescribeOrganizationConformancePackStatusesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConformancePacks

        default DescribeOrganizationConformancePacksResponse describeOrganizationConformancePacks​(DescribeOrganizationConformancePacksRequest describeOrganizationConformancePacksRequest)
                                                                                           throws NoSuchOrganizationConformancePackException,
                                                                                                  InvalidNextTokenException,
                                                                                                  InvalidLimitException,
                                                                                                  OrganizationAccessDeniedException,
                                                                                                  AwsServiceException,
                                                                                                  SdkClientException,
                                                                                                  ConfigException

        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 organzation

        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 and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.

        Parameters:
        describeOrganizationConformancePacksRequest -
        Returns:
        Result of the DescribeOrganizationConformancePacks operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConformancePacks

        default DescribeOrganizationConformancePacksResponse describeOrganizationConformancePacks​(Consumer<DescribeOrganizationConformancePacksRequest.Builder> describeOrganizationConformancePacksRequest)
                                                                                           throws NoSuchOrganizationConformancePackException,
                                                                                                  InvalidNextTokenException,
                                                                                                  InvalidLimitException,
                                                                                                  OrganizationAccessDeniedException,
                                                                                                  AwsServiceException,
                                                                                                  SdkClientException,
                                                                                                  ConfigException

        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 organzation

        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 and DescribeOrganizationConformancePacks 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 via DescribeOrganizationConformancePacksRequest.builder()

        Parameters:
        describeOrganizationConformancePacksRequest - A Consumer that will call methods on DescribeOrganizationConformancePacksRequest.Builder to create a request.
        Returns:
        Result of the DescribeOrganizationConformancePacks operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConformancePacksPaginator

        default DescribeOrganizationConformancePacksIterable describeOrganizationConformancePacksPaginator​(DescribeOrganizationConformancePacksRequest describeOrganizationConformancePacksRequest)
                                                                                                    throws NoSuchOrganizationConformancePackException,
                                                                                                           InvalidNextTokenException,
                                                                                                           InvalidLimitException,
                                                                                                           OrganizationAccessDeniedException,
                                                                                                           AwsServiceException,
                                                                                                           SdkClientException,
                                                                                                           ConfigException

        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 organzation

        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 and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.


        This is a variant of describeOrganizationConformancePacks(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksIterable responses = client.describeOrganizationConformancePacksPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksIterable responses = client
                     .describeOrganizationConformancePacksPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksIterable responses = client.describeOrganizationConformancePacksPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeOrganizationConformancePacksPaginator

        default DescribeOrganizationConformancePacksIterable describeOrganizationConformancePacksPaginator​(Consumer<DescribeOrganizationConformancePacksRequest.Builder> describeOrganizationConformancePacksRequest)
                                                                                                    throws NoSuchOrganizationConformancePackException,
                                                                                                           InvalidNextTokenException,
                                                                                                           InvalidLimitException,
                                                                                                           OrganizationAccessDeniedException,
                                                                                                           AwsServiceException,
                                                                                                           SdkClientException,
                                                                                                           ConfigException

        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 organzation

        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 and DescribeOrganizationConformancePacks APIs can only see and interact with the organization-related resource that were deployed from within the account calling those APIs.


        This is a variant of describeOrganizationConformancePacks(software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksIterable responses = client.describeOrganizationConformancePacksPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksIterable responses = client
                     .describeOrganizationConformancePacksPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeOrganizationConformancePacksResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeOrganizationConformancePacksIterable responses = client.describeOrganizationConformancePacksPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeOrganizationConformancePacksRequest.builder()

        Parameters:
        describeOrganizationConformancePacksRequest - A Consumer that will call methods on DescribeOrganizationConformancePacksRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describePendingAggregationRequestsPaginator

        default DescribePendingAggregationRequestsIterable describePendingAggregationRequestsPaginator()
                                                                                                throws InvalidParameterValueException,
                                                                                                       InvalidNextTokenException,
                                                                                                       InvalidLimitException,
                                                                                                       AwsServiceException,
                                                                                                       SdkClientException,
                                                                                                       ConfigException

        Returns a list of all pending aggregation requests.


        This is a variant of describePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsIterable responses = client.describePendingAggregationRequestsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsIterable responses = client
                     .describePendingAggregationRequestsPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsIterable responses = client.describePendingAggregationRequestsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        describePendingAggregationRequestsPaginator(DescribePendingAggregationRequestsRequest), AWS API Documentation
      • describePendingAggregationRequestsPaginator

        default DescribePendingAggregationRequestsIterable describePendingAggregationRequestsPaginator​(DescribePendingAggregationRequestsRequest describePendingAggregationRequestsRequest)
                                                                                                throws InvalidParameterValueException,
                                                                                                       InvalidNextTokenException,
                                                                                                       InvalidLimitException,
                                                                                                       AwsServiceException,
                                                                                                       SdkClientException,
                                                                                                       ConfigException

        Returns a list of all pending aggregation requests.


        This is a variant of describePendingAggregationRequests(software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsIterable responses = client.describePendingAggregationRequestsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsIterable responses = client
                     .describePendingAggregationRequestsPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribePendingAggregationRequestsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribePendingAggregationRequestsIterable responses = client.describePendingAggregationRequestsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeRemediationExceptions

        default DescribeRemediationExceptionsResponse describeRemediationExceptions​(DescribeRemediationExceptionsRequest describeRemediationExceptionsRequest)
                                                                             throws InvalidNextTokenException,
                                                                                    InvalidParameterValueException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    ConfigException

        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:
        Result of the DescribeRemediationExceptions operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeRemediationExceptionsPaginator

        default DescribeRemediationExceptionsIterable describeRemediationExceptionsPaginator​(DescribeRemediationExceptionsRequest describeRemediationExceptionsRequest)
                                                                                      throws InvalidNextTokenException,
                                                                                             InvalidParameterValueException,
                                                                                             AwsServiceException,
                                                                                             SdkClientException,
                                                                                             ConfigException

        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 variant of describeRemediationExceptions(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsIterable responses = client.describeRemediationExceptionsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsIterable responses = client
                     .describeRemediationExceptionsPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsIterable responses = client.describeRemediationExceptionsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeRemediationExceptionsPaginator

        default DescribeRemediationExceptionsIterable describeRemediationExceptionsPaginator​(Consumer<DescribeRemediationExceptionsRequest.Builder> describeRemediationExceptionsRequest)
                                                                                      throws InvalidNextTokenException,
                                                                                             InvalidParameterValueException,
                                                                                             AwsServiceException,
                                                                                             SdkClientException,
                                                                                             ConfigException

        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 variant of describeRemediationExceptions(software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsIterable responses = client.describeRemediationExceptionsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsIterable responses = client
                     .describeRemediationExceptionsPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeRemediationExceptionsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeRemediationExceptionsIterable responses = client.describeRemediationExceptionsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via DescribeRemediationExceptionsRequest.builder()

        Parameters:
        describeRemediationExceptionsRequest - A Consumer that will call methods on DescribeRemediationExceptionsRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeRemediationExecutionStatusPaginator

        default DescribeRemediationExecutionStatusIterable describeRemediationExecutionStatusPaginator​(DescribeRemediationExecutionStatusRequest describeRemediationExecutionStatusRequest)
                                                                                                throws NoSuchRemediationConfigurationException,
                                                                                                       InvalidNextTokenException,
                                                                                                       InvalidParameterValueException,
                                                                                                       AwsServiceException,
                                                                                                       SdkClientException,
                                                                                                       ConfigException

        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 variant of describeRemediationExecutionStatus(software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeRemediationExecutionStatusIterable responses = client.describeRemediationExecutionStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeRemediationExecutionStatusIterable responses = client
                     .describeRemediationExecutionStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeRemediationExecutionStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeRemediationExecutionStatusIterable responses = client.describeRemediationExecutionStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • describeRetentionConfigurationsPaginator

        default DescribeRetentionConfigurationsIterable describeRetentionConfigurationsPaginator()
                                                                                          throws InvalidParameterValueException,
                                                                                                 NoSuchRetentionConfigurationException,
                                                                                                 InvalidNextTokenException,
                                                                                                 AwsServiceException,
                                                                                                 SdkClientException,
                                                                                                 ConfigException

        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 variant of describeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsIterable responses = client.describeRetentionConfigurationsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsIterable responses = client
                     .describeRetentionConfigurationsPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsIterable responses = client.describeRetentionConfigurationsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        describeRetentionConfigurationsPaginator(DescribeRetentionConfigurationsRequest), AWS API Documentation
      • describeRetentionConfigurationsPaginator

        default DescribeRetentionConfigurationsIterable describeRetentionConfigurationsPaginator​(DescribeRetentionConfigurationsRequest describeRetentionConfigurationsRequest)
                                                                                          throws InvalidParameterValueException,
                                                                                                 NoSuchRetentionConfigurationException,
                                                                                                 InvalidNextTokenException,
                                                                                                 AwsServiceException,
                                                                                                 SdkClientException,
                                                                                                 ConfigException

        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 variant of describeRetentionConfigurations(software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsIterable responses = client.describeRetentionConfigurationsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsIterable responses = client
                     .describeRetentionConfigurationsPaginator(request);
             for (software.amazon.awssdk.services.config.model.DescribeRetentionConfigurationsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.DescribeRetentionConfigurationsIterable responses = client.describeRetentionConfigurationsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getAggregateComplianceDetailsByConfigRule

        default GetAggregateComplianceDetailsByConfigRuleResponse getAggregateComplianceDetailsByConfigRule​(GetAggregateComplianceDetailsByConfigRuleRequest getAggregateComplianceDetailsByConfigRuleRequest)
                                                                                                     throws ValidationException,
                                                                                                            InvalidLimitException,
                                                                                                            InvalidNextTokenException,
                                                                                                            NoSuchConfigurationAggregatorException,
                                                                                                            AwsServiceException,
                                                                                                            SdkClientException,
                                                                                                            ConfigException

        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:
        Result of the GetAggregateComplianceDetailsByConfigRule operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getAggregateComplianceDetailsByConfigRulePaginator

        default GetAggregateComplianceDetailsByConfigRuleIterable getAggregateComplianceDetailsByConfigRulePaginator​(GetAggregateComplianceDetailsByConfigRuleRequest getAggregateComplianceDetailsByConfigRuleRequest)
                                                                                                              throws ValidationException,
                                                                                                                     InvalidLimitException,
                                                                                                                     InvalidNextTokenException,
                                                                                                                     NoSuchConfigurationAggregatorException,
                                                                                                                     AwsServiceException,
                                                                                                                     SdkClientException,
                                                                                                                     ConfigException

        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 variant of getAggregateComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRuleIterable responses = client.getAggregateComplianceDetailsByConfigRulePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRuleIterable responses = client
                     .getAggregateComplianceDetailsByConfigRulePaginator(request);
             for (software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRuleIterable responses = client.getAggregateComplianceDetailsByConfigRulePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getAggregateComplianceDetailsByConfigRulePaginator

        default GetAggregateComplianceDetailsByConfigRuleIterable getAggregateComplianceDetailsByConfigRulePaginator​(Consumer<GetAggregateComplianceDetailsByConfigRuleRequest.Builder> getAggregateComplianceDetailsByConfigRuleRequest)
                                                                                                              throws ValidationException,
                                                                                                                     InvalidLimitException,
                                                                                                                     InvalidNextTokenException,
                                                                                                                     NoSuchConfigurationAggregatorException,
                                                                                                                     AwsServiceException,
                                                                                                                     SdkClientException,
                                                                                                                     ConfigException

        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 variant of getAggregateComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRuleIterable responses = client.getAggregateComplianceDetailsByConfigRulePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRuleIterable responses = client
                     .getAggregateComplianceDetailsByConfigRulePaginator(request);
             for (software.amazon.awssdk.services.config.model.GetAggregateComplianceDetailsByConfigRuleResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetAggregateComplianceDetailsByConfigRuleIterable responses = client.getAggregateComplianceDetailsByConfigRulePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via GetAggregateComplianceDetailsByConfigRuleRequest.builder()

        Parameters:
        getAggregateComplianceDetailsByConfigRuleRequest - A Consumer that will call methods on GetAggregateComplianceDetailsByConfigRuleRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getAggregateConfigRuleComplianceSummaryPaginator

        default GetAggregateConfigRuleComplianceSummaryIterable getAggregateConfigRuleComplianceSummaryPaginator​(GetAggregateConfigRuleComplianceSummaryRequest getAggregateConfigRuleComplianceSummaryRequest)
                                                                                                          throws ValidationException,
                                                                                                                 InvalidLimitException,
                                                                                                                 InvalidNextTokenException,
                                                                                                                 NoSuchConfigurationAggregatorException,
                                                                                                                 AwsServiceException,
                                                                                                                 SdkClientException,
                                                                                                                 ConfigException

        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 variant of getAggregateConfigRuleComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetAggregateConfigRuleComplianceSummaryIterable responses = client.getAggregateConfigRuleComplianceSummaryPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetAggregateConfigRuleComplianceSummaryIterable responses = client
                     .getAggregateConfigRuleComplianceSummaryPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetAggregateConfigRuleComplianceSummaryResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetAggregateConfigRuleComplianceSummaryIterable responses = client.getAggregateConfigRuleComplianceSummaryPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getAggregateConformancePackComplianceSummaryPaginator

        default GetAggregateConformancePackComplianceSummaryIterable getAggregateConformancePackComplianceSummaryPaginator​(GetAggregateConformancePackComplianceSummaryRequest getAggregateConformancePackComplianceSummaryRequest)
                                                                                                                    throws ValidationException,
                                                                                                                           InvalidLimitException,
                                                                                                                           InvalidNextTokenException,
                                                                                                                           NoSuchConfigurationAggregatorException,
                                                                                                                           AwsServiceException,
                                                                                                                           SdkClientException,
                                                                                                                           ConfigException

        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 variant of getAggregateConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetAggregateConformancePackComplianceSummaryIterable responses = client.getAggregateConformancePackComplianceSummaryPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetAggregateConformancePackComplianceSummaryIterable responses = client
                     .getAggregateConformancePackComplianceSummaryPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetAggregateConformancePackComplianceSummaryResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetAggregateConformancePackComplianceSummaryIterable responses = client.getAggregateConformancePackComplianceSummaryPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getAggregateDiscoveredResourceCounts

        default GetAggregateDiscoveredResourceCountsResponse getAggregateDiscoveredResourceCounts​(GetAggregateDiscoveredResourceCountsRequest getAggregateDiscoveredResourceCountsRequest)
                                                                                           throws ValidationException,
                                                                                                  InvalidLimitException,
                                                                                                  InvalidNextTokenException,
                                                                                                  NoSuchConfigurationAggregatorException,
                                                                                                  AwsServiceException,
                                                                                                  SdkClientException,
                                                                                                  ConfigException

        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:
        Result of the GetAggregateDiscoveredResourceCounts operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getAggregateDiscoveredResourceCountsPaginator

        default GetAggregateDiscoveredResourceCountsIterable getAggregateDiscoveredResourceCountsPaginator​(GetAggregateDiscoveredResourceCountsRequest getAggregateDiscoveredResourceCountsRequest)
                                                                                                    throws ValidationException,
                                                                                                           InvalidLimitException,
                                                                                                           InvalidNextTokenException,
                                                                                                           NoSuchConfigurationAggregatorException,
                                                                                                           AwsServiceException,
                                                                                                           SdkClientException,
                                                                                                           ConfigException

        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 variant of getAggregateDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsIterable responses = client.getAggregateDiscoveredResourceCountsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsIterable responses = client
                     .getAggregateDiscoveredResourceCountsPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsIterable responses = client.getAggregateDiscoveredResourceCountsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getAggregateDiscoveredResourceCountsPaginator

        default GetAggregateDiscoveredResourceCountsIterable getAggregateDiscoveredResourceCountsPaginator​(Consumer<GetAggregateDiscoveredResourceCountsRequest.Builder> getAggregateDiscoveredResourceCountsRequest)
                                                                                                    throws ValidationException,
                                                                                                           InvalidLimitException,
                                                                                                           InvalidNextTokenException,
                                                                                                           NoSuchConfigurationAggregatorException,
                                                                                                           AwsServiceException,
                                                                                                           SdkClientException,
                                                                                                           ConfigException

        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 variant of getAggregateDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsIterable responses = client.getAggregateDiscoveredResourceCountsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsIterable responses = client
                     .getAggregateDiscoveredResourceCountsPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetAggregateDiscoveredResourceCountsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetAggregateDiscoveredResourceCountsIterable responses = client.getAggregateDiscoveredResourceCountsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via GetAggregateDiscoveredResourceCountsRequest.builder()

        Parameters:
        getAggregateDiscoveredResourceCountsRequest - A Consumer that will call methods on GetAggregateDiscoveredResourceCountsRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getComplianceDetailsByConfigRulePaginator

        default GetComplianceDetailsByConfigRuleIterable getComplianceDetailsByConfigRulePaginator​(GetComplianceDetailsByConfigRuleRequest getComplianceDetailsByConfigRuleRequest)
                                                                                            throws InvalidParameterValueException,
                                                                                                   InvalidNextTokenException,
                                                                                                   NoSuchConfigRuleException,
                                                                                                   AwsServiceException,
                                                                                                   SdkClientException,
                                                                                                   ConfigException

        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 variant of getComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRuleIterable responses = client.getComplianceDetailsByConfigRulePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRuleIterable responses = client
                     .getComplianceDetailsByConfigRulePaginator(request);
             for (software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRuleIterable responses = client.getComplianceDetailsByConfigRulePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getComplianceDetailsByConfigRulePaginator

        default GetComplianceDetailsByConfigRuleIterable getComplianceDetailsByConfigRulePaginator​(Consumer<GetComplianceDetailsByConfigRuleRequest.Builder> getComplianceDetailsByConfigRuleRequest)
                                                                                            throws InvalidParameterValueException,
                                                                                                   InvalidNextTokenException,
                                                                                                   NoSuchConfigRuleException,
                                                                                                   AwsServiceException,
                                                                                                   SdkClientException,
                                                                                                   ConfigException

        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 variant of getComplianceDetailsByConfigRule(software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRuleIterable responses = client.getComplianceDetailsByConfigRulePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRuleIterable responses = client
                     .getComplianceDetailsByConfigRulePaginator(request);
             for (software.amazon.awssdk.services.config.model.GetComplianceDetailsByConfigRuleResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByConfigRuleIterable responses = client.getComplianceDetailsByConfigRulePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via GetComplianceDetailsByConfigRuleRequest.builder()

        Parameters:
        getComplianceDetailsByConfigRuleRequest - A Consumer that will call methods on GetComplianceDetailsByConfigRuleRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getComplianceDetailsByResourcePaginator

        default GetComplianceDetailsByResourceIterable getComplianceDetailsByResourcePaginator​(GetComplianceDetailsByResourceRequest getComplianceDetailsByResourceRequest)
                                                                                        throws InvalidParameterValueException,
                                                                                               AwsServiceException,
                                                                                               SdkClientException,
                                                                                               ConfigException

        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 variant of getComplianceDetailsByResource(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourceIterable responses = client.getComplianceDetailsByResourcePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourceIterable responses = client
                     .getComplianceDetailsByResourcePaginator(request);
             for (software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourceIterable responses = client.getComplianceDetailsByResourcePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getComplianceDetailsByResourcePaginator

        default GetComplianceDetailsByResourceIterable getComplianceDetailsByResourcePaginator​(Consumer<GetComplianceDetailsByResourceRequest.Builder> getComplianceDetailsByResourceRequest)
                                                                                        throws InvalidParameterValueException,
                                                                                               AwsServiceException,
                                                                                               SdkClientException,
                                                                                               ConfigException

        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 variant of getComplianceDetailsByResource(software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourceIterable responses = client.getComplianceDetailsByResourcePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourceIterable responses = client
                     .getComplianceDetailsByResourcePaginator(request);
             for (software.amazon.awssdk.services.config.model.GetComplianceDetailsByResourceResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetComplianceDetailsByResourceIterable responses = client.getComplianceDetailsByResourcePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via GetComplianceDetailsByResourceRequest.builder()

        Parameters:
        getComplianceDetailsByResourceRequest - A Consumer that will call methods on GetComplianceDetailsByResourceRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getConformancePackComplianceSummaryPaginator

        default GetConformancePackComplianceSummaryIterable getConformancePackComplianceSummaryPaginator​(GetConformancePackComplianceSummaryRequest getConformancePackComplianceSummaryRequest)
                                                                                                  throws NoSuchConformancePackException,
                                                                                                         InvalidLimitException,
                                                                                                         InvalidNextTokenException,
                                                                                                         AwsServiceException,
                                                                                                         SdkClientException,
                                                                                                         ConfigException

        Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.


        This is a variant of getConformancePackComplianceSummary(software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetConformancePackComplianceSummaryIterable responses = client.getConformancePackComplianceSummaryPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetConformancePackComplianceSummaryIterable responses = client
                     .getConformancePackComplianceSummaryPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetConformancePackComplianceSummaryResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetConformancePackComplianceSummaryIterable responses = client.getConformancePackComplianceSummaryPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getDiscoveredResourceCounts

        default GetDiscoveredResourceCountsResponse getDiscoveredResourceCounts​(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest)
                                                                         throws ValidationException,
                                                                                InvalidLimitException,
                                                                                InvalidNextTokenException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConfigException

        Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

        Example

        1. 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.

        2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

        3. 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

        • You are a new 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:
        Result of the GetDiscoveredResourceCounts operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getDiscoveredResourceCounts

        default GetDiscoveredResourceCountsResponse getDiscoveredResourceCounts​(Consumer<GetDiscoveredResourceCountsRequest.Builder> getDiscoveredResourceCountsRequest)
                                                                         throws ValidationException,
                                                                                InvalidLimitException,
                                                                                InvalidNextTokenException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConfigException

        Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

        Example

        1. 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.

        2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

        3. 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

        • You are a new 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 via GetDiscoveredResourceCountsRequest.builder()

        Parameters:
        getDiscoveredResourceCountsRequest - A Consumer that will call methods on GetDiscoveredResourceCountsRequest.Builder to create a request.
        Returns:
        Result of the GetDiscoveredResourceCounts operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getDiscoveredResourceCounts

        default GetDiscoveredResourceCountsResponse getDiscoveredResourceCounts()
                                                                         throws ValidationException,
                                                                                InvalidLimitException,
                                                                                InvalidNextTokenException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConfigException

        Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

        Example

        1. 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.

        2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

        3. 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

        • You are a new 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:
        Result of the GetDiscoveredResourceCounts operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        getDiscoveredResourceCounts(GetDiscoveredResourceCountsRequest), AWS API Documentation
      • getDiscoveredResourceCountsPaginator

        default GetDiscoveredResourceCountsIterable getDiscoveredResourceCountsPaginator()
                                                                                  throws ValidationException,
                                                                                         InvalidLimitException,
                                                                                         InvalidNextTokenException,
                                                                                         AwsServiceException,
                                                                                         SdkClientException,
                                                                                         ConfigException

        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

        1. 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.

        2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

        3. 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

        • You are a new 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 variant of getDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsIterable responses = client.getDiscoveredResourceCountsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsIterable responses = client
                     .getDiscoveredResourceCountsPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsIterable responses = client.getDiscoveredResourceCountsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        getDiscoveredResourceCountsPaginator(GetDiscoveredResourceCountsRequest), AWS API Documentation
      • getDiscoveredResourceCountsPaginator

        default GetDiscoveredResourceCountsIterable getDiscoveredResourceCountsPaginator​(GetDiscoveredResourceCountsRequest getDiscoveredResourceCountsRequest)
                                                                                  throws ValidationException,
                                                                                         InvalidLimitException,
                                                                                         InvalidNextTokenException,
                                                                                         AwsServiceException,
                                                                                         SdkClientException,
                                                                                         ConfigException

        Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

        Example

        1. 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.

        2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

        3. 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

        • You are a new 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 variant of getDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsIterable responses = client.getDiscoveredResourceCountsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsIterable responses = client
                     .getDiscoveredResourceCountsPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsIterable responses = client.getDiscoveredResourceCountsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getDiscoveredResourceCountsPaginator

        default GetDiscoveredResourceCountsIterable getDiscoveredResourceCountsPaginator​(Consumer<GetDiscoveredResourceCountsRequest.Builder> getDiscoveredResourceCountsRequest)
                                                                                  throws ValidationException,
                                                                                         InvalidLimitException,
                                                                                         InvalidNextTokenException,
                                                                                         AwsServiceException,
                                                                                         SdkClientException,
                                                                                         ConfigException

        Returns the resource types, the number of each resource type, and the total number of resources that Config is recording in this region for your Amazon Web Services account.

        Example

        1. 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.

        2. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types.

        3. 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations:

        • You are a new 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 variant of getDiscoveredResourceCounts(software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsIterable responses = client.getDiscoveredResourceCountsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsIterable responses = client
                     .getDiscoveredResourceCountsPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetDiscoveredResourceCountsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetDiscoveredResourceCountsIterable responses = client.getDiscoveredResourceCountsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via GetDiscoveredResourceCountsRequest.builder()

        Parameters:
        getDiscoveredResourceCountsRequest - A Consumer that will call methods on GetDiscoveredResourceCountsRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getOrganizationConfigRuleDetailedStatus

        default GetOrganizationConfigRuleDetailedStatusResponse getOrganizationConfigRuleDetailedStatus​(GetOrganizationConfigRuleDetailedStatusRequest getOrganizationConfigRuleDetailedStatusRequest)
                                                                                                 throws NoSuchOrganizationConfigRuleException,
                                                                                                        InvalidLimitException,
                                                                                                        InvalidNextTokenException,
                                                                                                        OrganizationAccessDeniedException,
                                                                                                        AwsServiceException,
                                                                                                        SdkClientException,
                                                                                                        ConfigException

        Returns detailed status for each member account within an organization for a given organization Config rule.

        Parameters:
        getOrganizationConfigRuleDetailedStatusRequest -
        Returns:
        Result of the GetOrganizationConfigRuleDetailedStatus operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getOrganizationConfigRuleDetailedStatusPaginator

        default GetOrganizationConfigRuleDetailedStatusIterable getOrganizationConfigRuleDetailedStatusPaginator​(GetOrganizationConfigRuleDetailedStatusRequest getOrganizationConfigRuleDetailedStatusRequest)
                                                                                                          throws NoSuchOrganizationConfigRuleException,
                                                                                                                 InvalidLimitException,
                                                                                                                 InvalidNextTokenException,
                                                                                                                 OrganizationAccessDeniedException,
                                                                                                                 AwsServiceException,
                                                                                                                 SdkClientException,
                                                                                                                 ConfigException

        Returns detailed status for each member account within an organization for a given organization Config rule.


        This is a variant of getOrganizationConfigRuleDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusIterable responses = client.getOrganizationConfigRuleDetailedStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusIterable responses = client
                     .getOrganizationConfigRuleDetailedStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusIterable responses = client.getOrganizationConfigRuleDetailedStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getOrganizationConfigRuleDetailedStatusPaginator

        default GetOrganizationConfigRuleDetailedStatusIterable getOrganizationConfigRuleDetailedStatusPaginator​(Consumer<GetOrganizationConfigRuleDetailedStatusRequest.Builder> getOrganizationConfigRuleDetailedStatusRequest)
                                                                                                          throws NoSuchOrganizationConfigRuleException,
                                                                                                                 InvalidLimitException,
                                                                                                                 InvalidNextTokenException,
                                                                                                                 OrganizationAccessDeniedException,
                                                                                                                 AwsServiceException,
                                                                                                                 SdkClientException,
                                                                                                                 ConfigException

        Returns detailed status for each member account within an organization for a given organization Config rule.


        This is a variant of getOrganizationConfigRuleDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusIterable responses = client.getOrganizationConfigRuleDetailedStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusIterable responses = client
                     .getOrganizationConfigRuleDetailedStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetOrganizationConfigRuleDetailedStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetOrganizationConfigRuleDetailedStatusIterable responses = client.getOrganizationConfigRuleDetailedStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via GetOrganizationConfigRuleDetailedStatusRequest.builder()

        Parameters:
        getOrganizationConfigRuleDetailedStatusRequest - A Consumer that will call methods on GetOrganizationConfigRuleDetailedStatusRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getOrganizationConformancePackDetailedStatus

        default GetOrganizationConformancePackDetailedStatusResponse getOrganizationConformancePackDetailedStatus​(GetOrganizationConformancePackDetailedStatusRequest getOrganizationConformancePackDetailedStatusRequest)
                                                                                                           throws NoSuchOrganizationConformancePackException,
                                                                                                                  InvalidLimitException,
                                                                                                                  InvalidNextTokenException,
                                                                                                                  OrganizationAccessDeniedException,
                                                                                                                  AwsServiceException,
                                                                                                                  SdkClientException,
                                                                                                                  ConfigException

        Returns detailed status for each member account within an organization for a given organization conformance pack.

        Parameters:
        getOrganizationConformancePackDetailedStatusRequest -
        Returns:
        Result of the GetOrganizationConformancePackDetailedStatus operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getOrganizationConformancePackDetailedStatusPaginator

        default GetOrganizationConformancePackDetailedStatusIterable getOrganizationConformancePackDetailedStatusPaginator​(GetOrganizationConformancePackDetailedStatusRequest getOrganizationConformancePackDetailedStatusRequest)
                                                                                                                    throws NoSuchOrganizationConformancePackException,
                                                                                                                           InvalidLimitException,
                                                                                                                           InvalidNextTokenException,
                                                                                                                           OrganizationAccessDeniedException,
                                                                                                                           AwsServiceException,
                                                                                                                           SdkClientException,
                                                                                                                           ConfigException

        Returns detailed status for each member account within an organization for a given organization conformance pack.


        This is a variant of getOrganizationConformancePackDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusIterable responses = client.getOrganizationConformancePackDetailedStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusIterable responses = client
                     .getOrganizationConformancePackDetailedStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusIterable responses = client.getOrganizationConformancePackDetailedStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getOrganizationConformancePackDetailedStatusPaginator

        default GetOrganizationConformancePackDetailedStatusIterable getOrganizationConformancePackDetailedStatusPaginator​(Consumer<GetOrganizationConformancePackDetailedStatusRequest.Builder> getOrganizationConformancePackDetailedStatusRequest)
                                                                                                                    throws NoSuchOrganizationConformancePackException,
                                                                                                                           InvalidLimitException,
                                                                                                                           InvalidNextTokenException,
                                                                                                                           OrganizationAccessDeniedException,
                                                                                                                           AwsServiceException,
                                                                                                                           SdkClientException,
                                                                                                                           ConfigException

        Returns detailed status for each member account within an organization for a given organization conformance pack.


        This is a variant of getOrganizationConformancePackDetailedStatus(software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusIterable responses = client.getOrganizationConformancePackDetailedStatusPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusIterable responses = client
                     .getOrganizationConformancePackDetailedStatusPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetOrganizationConformancePackDetailedStatusResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetOrganizationConformancePackDetailedStatusIterable responses = client.getOrganizationConformancePackDetailedStatusPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via GetOrganizationConformancePackDetailedStatusRequest.builder()

        Parameters:
        getOrganizationConformancePackDetailedStatusRequest - A Consumer that will call methods on GetOrganizationConformancePackDetailedStatusRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getOrganizationCustomRulePolicy

        default GetOrganizationCustomRulePolicyResponse getOrganizationCustomRulePolicy​(GetOrganizationCustomRulePolicyRequest getOrganizationCustomRulePolicyRequest)
                                                                                 throws NoSuchOrganizationConfigRuleException,
                                                                                        OrganizationAccessDeniedException,
                                                                                        AwsServiceException,
                                                                                        SdkClientException,
                                                                                        ConfigException

        Returns the policy definition containing the logic for your organization Config Custom Policy rule.

        Parameters:
        getOrganizationCustomRulePolicyRequest -
        Returns:
        Result of the GetOrganizationCustomRulePolicy operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getOrganizationCustomRulePolicy

        default GetOrganizationCustomRulePolicyResponse getOrganizationCustomRulePolicy​(Consumer<GetOrganizationCustomRulePolicyRequest.Builder> getOrganizationCustomRulePolicyRequest)
                                                                                 throws NoSuchOrganizationConfigRuleException,
                                                                                        OrganizationAccessDeniedException,
                                                                                        AwsServiceException,
                                                                                        SdkClientException,
                                                                                        ConfigException

        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 via GetOrganizationCustomRulePolicyRequest.builder()

        Parameters:
        getOrganizationCustomRulePolicyRequest - A Consumer that will call methods on GetOrganizationCustomRulePolicyRequest.Builder to create a request.
        Returns:
        Result of the GetOrganizationCustomRulePolicy operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getResourceConfigHistory

        default GetResourceConfigHistoryResponse getResourceConfigHistory​(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)
                                                                   throws ValidationException,
                                                                          InvalidTimeRangeException,
                                                                          InvalidLimitException,
                                                                          InvalidNextTokenException,
                                                                          NoAvailableConfigurationRecorderException,
                                                                          ResourceNotDiscoveredException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConfigException

        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 your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

        Parameters:
        getResourceConfigHistoryRequest - The input for the GetResourceConfigHistory action.
        Returns:
        Result of the GetResourceConfigHistory operation returned by the service.
        Throws:
        ValidationException - The requested action is not valid.

        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getResourceConfigHistoryPaginator

        default GetResourceConfigHistoryIterable getResourceConfigHistoryPaginator​(GetResourceConfigHistoryRequest getResourceConfigHistoryRequest)
                                                                            throws ValidationException,
                                                                                   InvalidTimeRangeException,
                                                                                   InvalidLimitException,
                                                                                   InvalidNextTokenException,
                                                                                   NoAvailableConfigurationRecorderException,
                                                                                   ResourceNotDiscoveredException,
                                                                                   AwsServiceException,
                                                                                   SdkClientException,
                                                                                   ConfigException

        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 your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.


        This is a variant of getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client.getResourceConfigHistoryPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client
                     .getResourceConfigHistoryPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetResourceConfigHistoryResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client.getResourceConfigHistoryPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getResourceConfigHistoryPaginator

        default GetResourceConfigHistoryIterable getResourceConfigHistoryPaginator​(Consumer<GetResourceConfigHistoryRequest.Builder> getResourceConfigHistoryRequest)
                                                                            throws ValidationException,
                                                                                   InvalidTimeRangeException,
                                                                                   InvalidLimitException,
                                                                                   InvalidNextTokenException,
                                                                                   NoAvailableConfigurationRecorderException,
                                                                                   ResourceNotDiscoveredException,
                                                                                   AwsServiceException,
                                                                                   SdkClientException,
                                                                                   ConfigException

        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 your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), Config returns the ConfigurationItems 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.


        This is a variant of getResourceConfigHistory(software.amazon.awssdk.services.config.model.GetResourceConfigHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client.getResourceConfigHistoryPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client
                     .getResourceConfigHistoryPaginator(request);
             for (software.amazon.awssdk.services.config.model.GetResourceConfigHistoryResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.GetResourceConfigHistoryIterable responses = client.getResourceConfigHistoryPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via GetResourceConfigHistoryRequest.builder()

        Parameters:
        getResourceConfigHistoryRequest - A Consumer that will call methods on GetResourceConfigHistoryRequest.Builder to create a request. The input for the GetResourceConfigHistory action.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getResourceEvaluationSummary

        default GetResourceEvaluationSummaryResponse getResourceEvaluationSummary​(GetResourceEvaluationSummaryRequest getResourceEvaluationSummaryRequest)
                                                                           throws ResourceNotFoundException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConfigException

        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:
        Result of the GetResourceEvaluationSummary operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • getStoredQuery

        default GetStoredQueryResponse getStoredQuery​(GetStoredQueryRequest getStoredQueryRequest)
                                               throws ValidationException,
                                                      ResourceNotFoundException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConfigException

        Returns the details of a specific stored query.

        Parameters:
        getStoredQueryRequest -
        Returns:
        Result of the GetStoredQuery operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listAggregateDiscoveredResources

        default ListAggregateDiscoveredResourcesResponse listAggregateDiscoveredResources​(ListAggregateDiscoveredResourcesRequest listAggregateDiscoveredResourcesRequest)
                                                                                   throws ValidationException,
                                                                                          InvalidLimitException,
                                                                                          InvalidNextTokenException,
                                                                                          NoSuchConfigurationAggregatorException,
                                                                                          AwsServiceException,
                                                                                          SdkClientException,
                                                                                          ConfigException

        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:
        Result of the ListAggregateDiscoveredResources operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listAggregateDiscoveredResourcesPaginator

        default ListAggregateDiscoveredResourcesIterable listAggregateDiscoveredResourcesPaginator​(ListAggregateDiscoveredResourcesRequest listAggregateDiscoveredResourcesRequest)
                                                                                            throws ValidationException,
                                                                                                   InvalidLimitException,
                                                                                                   InvalidNextTokenException,
                                                                                                   NoSuchConfigurationAggregatorException,
                                                                                                   AwsServiceException,
                                                                                                   SdkClientException,
                                                                                                   ConfigException

        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 variant of listAggregateDiscoveredResources(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesIterable responses = client.listAggregateDiscoveredResourcesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesIterable responses = client
                     .listAggregateDiscoveredResourcesPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesIterable responses = client.listAggregateDiscoveredResourcesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listAggregateDiscoveredResourcesPaginator

        default ListAggregateDiscoveredResourcesIterable listAggregateDiscoveredResourcesPaginator​(Consumer<ListAggregateDiscoveredResourcesRequest.Builder> listAggregateDiscoveredResourcesRequest)
                                                                                            throws ValidationException,
                                                                                                   InvalidLimitException,
                                                                                                   InvalidNextTokenException,
                                                                                                   NoSuchConfigurationAggregatorException,
                                                                                                   AwsServiceException,
                                                                                                   SdkClientException,
                                                                                                   ConfigException

        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 variant of listAggregateDiscoveredResources(software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesIterable responses = client.listAggregateDiscoveredResourcesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesIterable responses = client
                     .listAggregateDiscoveredResourcesPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListAggregateDiscoveredResourcesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListAggregateDiscoveredResourcesIterable responses = client.listAggregateDiscoveredResourcesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via ListAggregateDiscoveredResourcesRequest.builder()

        Parameters:
        listAggregateDiscoveredResourcesRequest - A Consumer that will call methods on ListAggregateDiscoveredResourcesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listConformancePackComplianceScores

        default ListConformancePackComplianceScoresResponse listConformancePackComplianceScores​(ListConformancePackComplianceScoresRequest listConformancePackComplianceScoresRequest)
                                                                                         throws InvalidParameterValueException,
                                                                                                InvalidLimitException,
                                                                                                InvalidNextTokenException,
                                                                                                AwsServiceException,
                                                                                                SdkClientException,
                                                                                                ConfigException

        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:
        Result of the ListConformancePackComplianceScores operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listConformancePackComplianceScoresPaginator

        default ListConformancePackComplianceScoresIterable listConformancePackComplianceScoresPaginator​(ListConformancePackComplianceScoresRequest listConformancePackComplianceScoresRequest)
                                                                                                  throws InvalidParameterValueException,
                                                                                                         InvalidLimitException,
                                                                                                         InvalidNextTokenException,
                                                                                                         AwsServiceException,
                                                                                                         SdkClientException,
                                                                                                         ConfigException

        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 variant of listConformancePackComplianceScores(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresIterable responses = client.listConformancePackComplianceScoresPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresIterable responses = client
                     .listConformancePackComplianceScoresPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresIterable responses = client.listConformancePackComplianceScoresPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listConformancePackComplianceScoresPaginator

        default ListConformancePackComplianceScoresIterable listConformancePackComplianceScoresPaginator​(Consumer<ListConformancePackComplianceScoresRequest.Builder> listConformancePackComplianceScoresRequest)
                                                                                                  throws InvalidParameterValueException,
                                                                                                         InvalidLimitException,
                                                                                                         InvalidNextTokenException,
                                                                                                         AwsServiceException,
                                                                                                         SdkClientException,
                                                                                                         ConfigException

        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 variant of listConformancePackComplianceScores(software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresIterable responses = client.listConformancePackComplianceScoresPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresIterable responses = client
                     .listConformancePackComplianceScoresPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListConformancePackComplianceScoresResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListConformancePackComplianceScoresIterable responses = client.listConformancePackComplianceScoresPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via ListConformancePackComplianceScoresRequest.builder()

        Parameters:
        listConformancePackComplianceScoresRequest - A Consumer that will call methods on ListConformancePackComplianceScoresRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listDiscoveredResources

        default ListDiscoveredResourcesResponse listDiscoveredResources​(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
                                                                 throws ValidationException,
                                                                        InvalidLimitException,
                                                                        InvalidNextTokenException,
                                                                        NoAvailableConfigurationRecorderException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConfigException

        Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

        Parameters:
        listDiscoveredResourcesRequest -
        Returns:
        Result of the ListDiscoveredResources operation returned by the service.
        Throws:
        ValidationException - The requested action is not valid.

        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listDiscoveredResources

        default ListDiscoveredResourcesResponse listDiscoveredResources​(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest)
                                                                 throws ValidationException,
                                                                        InvalidLimitException,
                                                                        InvalidNextTokenException,
                                                                        NoAvailableConfigurationRecorderException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        ConfigException

        Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.


        This is a convenience which creates an instance of the ListDiscoveredResourcesRequest.Builder avoiding the need to create one manually via ListDiscoveredResourcesRequest.builder()

        Parameters:
        listDiscoveredResourcesRequest - A Consumer that will call methods on ListDiscoveredResourcesRequest.Builder to create a request.
        Returns:
        Result of the ListDiscoveredResources operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listDiscoveredResourcesPaginator

        default ListDiscoveredResourcesIterable listDiscoveredResourcesPaginator​(ListDiscoveredResourcesRequest listDiscoveredResourcesRequest)
                                                                          throws ValidationException,
                                                                                 InvalidLimitException,
                                                                                 InvalidNextTokenException,
                                                                                 NoAvailableConfigurationRecorderException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 ConfigException

        Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.


        This is a variant of listDiscoveredResources(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesIterable responses = client.listDiscoveredResourcesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesIterable responses = client
                     .listDiscoveredResourcesPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListDiscoveredResourcesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesIterable responses = client.listDiscoveredResourcesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listDiscoveredResourcesPaginator

        default ListDiscoveredResourcesIterable listDiscoveredResourcesPaginator​(Consumer<ListDiscoveredResourcesRequest.Builder> listDiscoveredResourcesRequest)
                                                                          throws ValidationException,
                                                                                 InvalidLimitException,
                                                                                 InvalidNextTokenException,
                                                                                 NoAvailableConfigurationRecorderException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 ConfigException

        Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that 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 a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.


        This is a variant of listDiscoveredResources(software.amazon.awssdk.services.config.model.ListDiscoveredResourcesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesIterable responses = client.listDiscoveredResourcesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesIterable responses = client
                     .listDiscoveredResourcesPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListDiscoveredResourcesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListDiscoveredResourcesIterable responses = client.listDiscoveredResourcesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via ListDiscoveredResourcesRequest.builder()

        Parameters:
        listDiscoveredResourcesRequest - A Consumer that will call methods on ListDiscoveredResourcesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listResourceEvaluationsPaginator

        default ListResourceEvaluationsIterable listResourceEvaluationsPaginator​(ListResourceEvaluationsRequest listResourceEvaluationsRequest)
                                                                          throws InvalidNextTokenException,
                                                                                 InvalidParameterValueException,
                                                                                 InvalidTimeRangeException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 ConfigException

        Returns a list of proactive resource evaluations.


        This is a variant of listResourceEvaluations(software.amazon.awssdk.services.config.model.ListResourceEvaluationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListResourceEvaluationsIterable responses = client.listResourceEvaluationsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListResourceEvaluationsIterable responses = client
                     .listResourceEvaluationsPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListResourceEvaluationsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListResourceEvaluationsIterable responses = client.listResourceEvaluationsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listResourceEvaluationsPaginator

        default ListResourceEvaluationsIterable listResourceEvaluationsPaginator​(Consumer<ListResourceEvaluationsRequest.Builder> listResourceEvaluationsRequest)
                                                                          throws InvalidNextTokenException,
                                                                                 InvalidParameterValueException,
                                                                                 InvalidTimeRangeException,
                                                                                 AwsServiceException,
                                                                                 SdkClientException,
                                                                                 ConfigException

        Returns a list of proactive resource evaluations.


        This is a variant of listResourceEvaluations(software.amazon.awssdk.services.config.model.ListResourceEvaluationsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListResourceEvaluationsIterable responses = client.listResourceEvaluationsPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListResourceEvaluationsIterable responses = client
                     .listResourceEvaluationsPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListResourceEvaluationsResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListResourceEvaluationsIterable responses = client.listResourceEvaluationsPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via ListResourceEvaluationsRequest.builder()

        Parameters:
        listResourceEvaluationsRequest - A Consumer that will call methods on ListResourceEvaluationsRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listStoredQueries

        default ListStoredQueriesResponse listStoredQueries​(ListStoredQueriesRequest listStoredQueriesRequest)
                                                     throws ValidationException,
                                                            InvalidNextTokenException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConfigException

        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:
        Result of the ListStoredQueries operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listStoredQueriesPaginator

        default ListStoredQueriesIterable listStoredQueriesPaginator​(ListStoredQueriesRequest listStoredQueriesRequest)
                                                              throws ValidationException,
                                                                     InvalidNextTokenException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ConfigException

        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 variant of listStoredQueries(software.amazon.awssdk.services.config.model.ListStoredQueriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListStoredQueriesIterable responses = client.listStoredQueriesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListStoredQueriesIterable responses = client
                     .listStoredQueriesPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListStoredQueriesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListStoredQueriesIterable responses = client.listStoredQueriesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listStoredQueriesPaginator

        default ListStoredQueriesIterable listStoredQueriesPaginator​(Consumer<ListStoredQueriesRequest.Builder> listStoredQueriesRequest)
                                                              throws ValidationException,
                                                                     InvalidNextTokenException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     ConfigException

        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 variant of listStoredQueries(software.amazon.awssdk.services.config.model.ListStoredQueriesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListStoredQueriesIterable responses = client.listStoredQueriesPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListStoredQueriesIterable responses = client
                     .listStoredQueriesPaginator(request);
             for (software.amazon.awssdk.services.config.model.ListStoredQueriesResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListStoredQueriesIterable responses = client.listStoredQueriesPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via ListStoredQueriesRequest.builder()

        Parameters:
        listStoredQueriesRequest - A Consumer that will call methods on ListStoredQueriesRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listTagsForResourcePaginator

        default ListTagsForResourceIterable listTagsForResourcePaginator​(ListTagsForResourceRequest listTagsForResourceRequest)
                                                                  throws ResourceNotFoundException,
                                                                         ValidationException,
                                                                         InvalidLimitException,
                                                                         InvalidNextTokenException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConfigException

        List the tags for Config resource.


        This is a variant of listTagsForResource(software.amazon.awssdk.services.config.model.ListTagsForResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListTagsForResourceIterable responses = client
                     .listTagsForResourcePaginator(request);
             for (software.amazon.awssdk.services.config.model.ListTagsForResourceResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • listTagsForResourcePaginator

        default ListTagsForResourceIterable listTagsForResourcePaginator​(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                                  throws ResourceNotFoundException,
                                                                         ValidationException,
                                                                         InvalidLimitException,
                                                                         InvalidNextTokenException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         ConfigException

        List the tags for Config resource.


        This is a variant of listTagsForResource(software.amazon.awssdk.services.config.model.ListTagsForResourceRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.ListTagsForResourceIterable responses = client
                     .listTagsForResourcePaginator(request);
             for (software.amazon.awssdk.services.config.model.ListTagsForResourceResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via ListTagsForResourceRequest.builder()

        Parameters:
        listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putAggregationAuthorization

        default PutAggregationAuthorizationResponse putAggregationAuthorization​(PutAggregationAuthorizationRequest putAggregationAuthorizationRequest)
                                                                         throws InvalidParameterValueException,
                                                                                AwsServiceException,
                                                                                SdkClientException,
                                                                                ConfigException

        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 different tags 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:
        Result of the PutAggregationAuthorization operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putConfigRule

        default PutConfigRuleResponse putConfigRule​(PutConfigRuleRequest putConfigRuleRequest)
                                             throws InvalidParameterValueException,
                                                    MaxNumberOfConfigRulesExceededException,
                                                    ResourceInUseException,
                                                    InsufficientPermissionsException,
                                                    NoAvailableConfigurationRecorderException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConfigException

        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 the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

        For any new Config rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. 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, or ConfigRuleArn in the ConfigRule 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 different tags 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:
        Result of the PutConfigRule operation returned by the service.
        Throws:
        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 150 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putConfigRule

        default PutConfigRuleResponse putConfigRule​(Consumer<PutConfigRuleRequest.Builder> putConfigRuleRequest)
                                             throws InvalidParameterValueException,
                                                    MaxNumberOfConfigRulesExceededException,
                                                    ResourceInUseException,
                                                    InsufficientPermissionsException,
                                                    NoAvailableConfigurationRecorderException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConfigException

        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 the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object.

        For any new Config rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. 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, or ConfigRuleArn in the ConfigRule 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 different tags 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 via PutConfigRuleRequest.builder()

        Parameters:
        putConfigRuleRequest - A Consumer that will call methods on PutConfigRuleRequest.Builder to create a request.
        Returns:
        Result of the PutConfigRule operation returned by the service.
        Throws:
        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 150 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putConfigurationAggregator

        default PutConfigurationAggregatorResponse putConfigurationAggregator​(PutConfigurationAggregatorRequest putConfigurationAggregatorRequest)
                                                                       throws InvalidParameterValueException,
                                                                              LimitExceededException,
                                                                              InvalidRoleException,
                                                                              OrganizationAccessDeniedException,
                                                                              NoAvailableOrganizationException,
                                                                              OrganizationAllFeaturesNotEnabledException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConfigException

        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, call DescribeConfigurationAggregators 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 calls ListDelegatedAdministrators 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 different tags 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:
        Result of the PutConfigurationAggregator operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putConfigurationAggregator

        default PutConfigurationAggregatorResponse putConfigurationAggregator​(Consumer<PutConfigurationAggregatorRequest.Builder> putConfigurationAggregatorRequest)
                                                                       throws InvalidParameterValueException,
                                                                              LimitExceededException,
                                                                              InvalidRoleException,
                                                                              OrganizationAccessDeniedException,
                                                                              NoAvailableOrganizationException,
                                                                              OrganizationAllFeaturesNotEnabledException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConfigException

        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, call DescribeConfigurationAggregators 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 calls ListDelegatedAdministrators 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 different tags 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 via PutConfigurationAggregatorRequest.builder()

        Parameters:
        putConfigurationAggregatorRequest - A Consumer that will call methods on PutConfigurationAggregatorRequest.Builder to create a request.
        Returns:
        Result of the PutConfigurationAggregator operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putConformancePack

        default PutConformancePackResponse putConformancePack​(PutConformancePackRequest putConformancePackRequest)
                                                       throws InsufficientPermissionsException,
                                                              ConformancePackTemplateValidationException,
                                                              ResourceInUseException,
                                                              InvalidParameterValueException,
                                                              MaxNumberOfConformancePacksExceededException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConfigException

        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 or TemplateSSMDocumentDetails.

        Parameters:
        putConformancePackRequest -
        Returns:
        Result of the PutConformancePack operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putConformancePack

        default PutConformancePackResponse putConformancePack​(Consumer<PutConformancePackRequest.Builder> putConformancePackRequest)
                                                       throws InsufficientPermissionsException,
                                                              ConformancePackTemplateValidationException,
                                                              ResourceInUseException,
                                                              InvalidParameterValueException,
                                                              MaxNumberOfConformancePacksExceededException,
                                                              AwsServiceException,
                                                              SdkClientException,
                                                              ConfigException

        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 or TemplateSSMDocumentDetails.


        This is a convenience which creates an instance of the PutConformancePackRequest.Builder avoiding the need to create one manually via PutConformancePackRequest.builder()

        Parameters:
        putConformancePackRequest - A Consumer that will call methods on PutConformancePackRequest.Builder to create a request.
        Returns:
        Result of the PutConformancePack operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putOrganizationConfigRule

        default PutOrganizationConfigRuleResponse putOrganizationConfigRule​(PutOrganizationConfigRuleRequest putOrganizationConfigRuleRequest)
                                                                     throws MaxNumberOfOrganizationConfigRulesExceededException,
                                                                            ResourceInUseException,
                                                                            InvalidParameterValueException,
                                                                            ValidationException,
                                                                            OrganizationAccessDeniedException,
                                                                            NoAvailableOrganizationException,
                                                                            OrganizationAllFeaturesNotEnabledException,
                                                                            InsufficientPermissionsException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            ConfigException

        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 role AWSServiceRoleForConfigMultiAccountSetup 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 with GetRole action.

        To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator for config-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, or OrganizationManagedRuleMetadata for managed rules.

        Parameters:
        putOrganizationConfigRuleRequest -
        Returns:
        Result of the PutOrganizationConfigRule operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putOrganizationConfigRule

        default PutOrganizationConfigRuleResponse putOrganizationConfigRule​(Consumer<PutOrganizationConfigRuleRequest.Builder> putOrganizationConfigRuleRequest)
                                                                     throws MaxNumberOfOrganizationConfigRulesExceededException,
                                                                            ResourceInUseException,
                                                                            InvalidParameterValueException,
                                                                            ValidationException,
                                                                            OrganizationAccessDeniedException,
                                                                            NoAvailableOrganizationException,
                                                                            OrganizationAllFeaturesNotEnabledException,
                                                                            InsufficientPermissionsException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            ConfigException

        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 role AWSServiceRoleForConfigMultiAccountSetup 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 with GetRole action.

        To use this API with delegated administrator, register a delegated administrator by calling Amazon Web Services Organization register-delegated-administrator for config-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, or OrganizationManagedRuleMetadata for managed rules.


        This is a convenience which creates an instance of the PutOrganizationConfigRuleRequest.Builder avoiding the need to create one manually via PutOrganizationConfigRuleRequest.builder()

        Parameters:
        putOrganizationConfigRuleRequest - A Consumer that will call methods on PutOrganizationConfigRuleRequest.Builder to create a request.
        Returns:
        Result of the PutOrganizationConfigRule operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putOrganizationConformancePack

        default PutOrganizationConformancePackResponse putOrganizationConformancePack​(PutOrganizationConformancePackRequest putOrganizationConformancePackRequest)
                                                                               throws MaxNumberOfOrganizationConformancePacksExceededException,
                                                                                      ResourceInUseException,
                                                                                      ValidationException,
                                                                                      OrganizationAccessDeniedException,
                                                                                      InsufficientPermissionsException,
                                                                                      OrganizationConformancePackTemplateValidationException,
                                                                                      OrganizationAllFeaturesNotEnabledException,
                                                                                      NoAvailableOrganizationException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      ConfigException

        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 the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup 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 Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com.

        Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

        You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody 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:
        Result of the PutOrganizationConformancePack operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putOrganizationConformancePack

        default PutOrganizationConformancePackResponse putOrganizationConformancePack​(Consumer<PutOrganizationConformancePackRequest.Builder> putOrganizationConformancePackRequest)
                                                                               throws MaxNumberOfOrganizationConformancePacksExceededException,
                                                                                      ResourceInUseException,
                                                                                      ValidationException,
                                                                                      OrganizationAccessDeniedException,
                                                                                      InsufficientPermissionsException,
                                                                                      OrganizationConformancePackTemplateValidationException,
                                                                                      OrganizationAllFeaturesNotEnabledException,
                                                                                      NoAvailableOrganizationException,
                                                                                      AwsServiceException,
                                                                                      SdkClientException,
                                                                                      ConfigException

        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 the EnableAWSServiceAccess action and creates a service-linked role AWSServiceRoleForConfigMultiAccountSetup 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 Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com.

        Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization.

        You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both Config uses the TemplateS3Uri parameter and ignores the TemplateBody 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 via PutOrganizationConformancePackRequest.builder()

        Parameters:
        putOrganizationConformancePackRequest - A Consumer that will call methods on PutOrganizationConformancePackRequest.Builder to create a request.
        Returns:
        Result of the PutOrganizationConformancePack operation returned by the service.
        Throws:
        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 and OrganizationConformancePack 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putRemediationConfigurations

        default PutRemediationConfigurationsResponse putRemediationConfigurations​(PutRemediationConfigurationsRequest putRemediationConfigurationsRequest)
                                                                           throws InsufficientPermissionsException,
                                                                                  InvalidParameterValueException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConfigException

        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.

        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.

        For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield 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 is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources.

        Parameters:
        putRemediationConfigurationsRequest -
        Returns:
        Result of the PutRemediationConfigurations operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putRemediationConfigurations

        default PutRemediationConfigurationsResponse putRemediationConfigurations​(Consumer<PutRemediationConfigurationsRequest.Builder> putRemediationConfigurationsRequest)
                                                                           throws InsufficientPermissionsException,
                                                                                  InvalidParameterValueException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  ConfigException

        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.

        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.

        For manual remediation configuration, you need to provide a value for automationAssumeRole or use a value in the assumeRolefield 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 is AutomationAssumeRole and you need to provide a value for AutomationAssumeRole to remediate your resources.


        This is a convenience which creates an instance of the PutRemediationConfigurationsRequest.Builder avoiding the need to create one manually via PutRemediationConfigurationsRequest.builder()

        Parameters:
        putRemediationConfigurationsRequest - A Consumer that will call methods on PutRemediationConfigurationsRequest.Builder to create a request.
        Returns:
        Result of the PutRemediationConfigurations operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putRemediationExceptions

        default PutRemediationExceptionsResponse putRemediationExceptions​(PutRemediationExceptionsRequest putRemediationExceptionsRequest)
                                                                   throws InvalidParameterValueException,
                                                                          InsufficientPermissionsException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConfigException

        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.

        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.

        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 as NON_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 a NON_COMPLIANT evaluation result can delete resources before the exception is applied.

        Placing an exception can only be performed on resources that are NON_COMPLIANT. If you use this API for COMPLIANT resources or resources that are NOT_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.

        Parameters:
        putRemediationExceptionsRequest -
        Returns:
        Result of the PutRemediationExceptions operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putRemediationExceptions

        default PutRemediationExceptionsResponse putRemediationExceptions​(Consumer<PutRemediationExceptionsRequest.Builder> putRemediationExceptionsRequest)
                                                                   throws InvalidParameterValueException,
                                                                          InsufficientPermissionsException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          ConfigException

        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.

        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.

        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 as NON_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 a NON_COMPLIANT evaluation result can delete resources before the exception is applied.

        Placing an exception can only be performed on resources that are NON_COMPLIANT. If you use this API for COMPLIANT resources or resources that are NOT_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.


        This is a convenience which creates an instance of the PutRemediationExceptionsRequest.Builder avoiding the need to create one manually via PutRemediationExceptionsRequest.builder()

        Parameters:
        putRemediationExceptionsRequest - A Consumer that will call methods on PutRemediationExceptionsRequest.Builder to create a request.
        Returns:
        Result of the PutRemediationExceptions operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putResourceConfig

        default PutResourceConfigResponse putResourceConfig​(PutResourceConfigRequest putResourceConfigRequest)
                                                     throws ValidationException,
                                                            InsufficientPermissionsException,
                                                            NoRunningConfigurationRecorderException,
                                                            MaxActiveResourcesExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConfigException

        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:
        Result of the PutResourceConfig operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putResourceConfig

        default PutResourceConfigResponse putResourceConfig​(Consumer<PutResourceConfigRequest.Builder> putResourceConfigRequest)
                                                     throws ValidationException,
                                                            InsufficientPermissionsException,
                                                            NoRunningConfigurationRecorderException,
                                                            MaxActiveResourcesExceededException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            ConfigException

        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 via PutResourceConfigRequest.builder()

        Parameters:
        putResourceConfigRequest - A Consumer that will call methods on PutResourceConfigRequest.Builder to create a request.
        Returns:
        Result of the PutResourceConfig operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putStoredQuery

        default PutStoredQueryResponse putStoredQuery​(PutStoredQueryRequest putStoredQueryRequest)
                                               throws ValidationException,
                                                      TooManyTagsException,
                                                      ResourceConcurrentModificationException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConfigException

        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 different tags 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:
        Result of the PutStoredQuery operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • putStoredQuery

        default PutStoredQueryResponse putStoredQuery​(Consumer<PutStoredQueryRequest.Builder> putStoredQueryRequest)
                                               throws ValidationException,
                                                      TooManyTagsException,
                                                      ResourceConcurrentModificationException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      ConfigException

        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 different tags 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 via PutStoredQueryRequest.builder()

        Parameters:
        putStoredQueryRequest - A Consumer that will call methods on PutStoredQueryRequest.Builder to create a request.
        Returns:
        Result of the PutStoredQuery operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • selectAggregateResourceConfig

        default SelectAggregateResourceConfigResponse selectAggregateResourceConfig​(SelectAggregateResourceConfigRequest selectAggregateResourceConfigRequest)
                                                                             throws InvalidExpressionException,
                                                                                    NoSuchConfigurationAggregatorException,
                                                                                    InvalidLimitException,
                                                                                    InvalidNextTokenException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    ConfigException

        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 as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId) and do not specify the MaxResults or the Limit 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 the MaxResults or the Limit query parameters, the default page size is set to 25.

        Parameters:
        selectAggregateResourceConfigRequest -
        Returns:
        Result of the SelectAggregateResourceConfig operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • selectAggregateResourceConfigPaginator

        default SelectAggregateResourceConfigIterable selectAggregateResourceConfigPaginator​(SelectAggregateResourceConfigRequest selectAggregateResourceConfigRequest)
                                                                                      throws InvalidExpressionException,
                                                                                             NoSuchConfigurationAggregatorException,
                                                                                             InvalidLimitException,
                                                                                             InvalidNextTokenException,
                                                                                             AwsServiceException,
                                                                                             SdkClientException,
                                                                                             ConfigException

        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 as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId) and do not specify the MaxResults or the Limit 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 the MaxResults or the Limit query parameters, the default page size is set to 25.


        This is a variant of selectAggregateResourceConfig(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigIterable responses = client.selectAggregateResourceConfigPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigIterable responses = client
                     .selectAggregateResourceConfigPaginator(request);
             for (software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigIterable responses = client.selectAggregateResourceConfigPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • selectAggregateResourceConfigPaginator

        default SelectAggregateResourceConfigIterable selectAggregateResourceConfigPaginator​(Consumer<SelectAggregateResourceConfigRequest.Builder> selectAggregateResourceConfigRequest)
                                                                                      throws InvalidExpressionException,
                                                                                             NoSuchConfigurationAggregatorException,
                                                                                             InvalidLimitException,
                                                                                             InvalidNextTokenException,
                                                                                             AwsServiceException,
                                                                                             SdkClientException,
                                                                                             ConfigException

        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 as COUNT; e.g., SELECT resourceId, COUNT(*) WHERE resourceType = 'AWS::IAM::Role' GROUP BY resourceId) and do not specify the MaxResults or the Limit 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 the MaxResults or the Limit query parameters, the default page size is set to 25.


        This is a variant of selectAggregateResourceConfig(software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigIterable responses = client.selectAggregateResourceConfigPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigIterable responses = client
                     .selectAggregateResourceConfigPaginator(request);
             for (software.amazon.awssdk.services.config.model.SelectAggregateResourceConfigResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.SelectAggregateResourceConfigIterable responses = client.selectAggregateResourceConfigPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via SelectAggregateResourceConfigRequest.builder()

        Parameters:
        selectAggregateResourceConfigRequest - A Consumer that will call methods on SelectAggregateResourceConfigRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • selectResourceConfigPaginator

        default SelectResourceConfigIterable selectResourceConfigPaginator​(SelectResourceConfigRequest selectResourceConfigRequest)
                                                                    throws InvalidExpressionException,
                                                                           InvalidLimitException,
                                                                           InvalidNextTokenException,
                                                                           AwsServiceException,
                                                                           SdkClientException,
                                                                           ConfigException

        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 variant of selectResourceConfig(software.amazon.awssdk.services.config.model.SelectResourceConfigRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.SelectResourceConfigIterable responses = client.selectResourceConfigPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.SelectResourceConfigIterable responses = client
                     .selectResourceConfigPaginator(request);
             for (software.amazon.awssdk.services.config.model.SelectResourceConfigResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.SelectResourceConfigIterable responses = client.selectResourceConfigPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • selectResourceConfigPaginator

        default SelectResourceConfigIterable selectResourceConfigPaginator​(Consumer<SelectResourceConfigRequest.Builder> selectResourceConfigRequest)
                                                                    throws InvalidExpressionException,
                                                                           InvalidLimitException,
                                                                           InvalidNextTokenException,
                                                                           AwsServiceException,
                                                                           SdkClientException,
                                                                           ConfigException

        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 variant of selectResourceConfig(software.amazon.awssdk.services.config.model.SelectResourceConfigRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

        When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

        The following are few ways to iterate through the response pages:

        1) Using a Stream
         
         software.amazon.awssdk.services.config.paginators.SelectResourceConfigIterable responses = client.selectResourceConfigPaginator(request);
         responses.stream().forEach(....);
         
         
        2) Using For loop
         {
             @code
             software.amazon.awssdk.services.config.paginators.SelectResourceConfigIterable responses = client
                     .selectResourceConfigPaginator(request);
             for (software.amazon.awssdk.services.config.model.SelectResourceConfigResponse response : responses) {
                 // do something;
             }
         }
         
        3) Use iterator directly
         
         software.amazon.awssdk.services.config.paginators.SelectResourceConfigIterable responses = client.selectResourceConfigPaginator(request);
         responses.iterator().forEachRemaining(....);
         
         

        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 via SelectResourceConfigRequest.builder()

        Parameters:
        selectResourceConfigRequest - A Consumer that will call methods on SelectResourceConfigRequest.Builder to create a request.
        Returns:
        A custom iterable that can be used to iterate through all the response pages.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • startConfigRulesEvaluation

        default StartConfigRulesEvaluationResponse startConfigRulesEvaluation​(StartConfigRulesEvaluationRequest startConfigRulesEvaluationRequest)
                                                                       throws NoSuchConfigRuleException,
                                                                              LimitExceededException,
                                                                              ResourceInUseException,
                                                                              InvalidParameterValueException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConfigException

        Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test 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 a ConfigRuleEvaluationStarted notification when the evaluation starts.

        You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, 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:

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

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

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

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

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

        Parameters:
        startConfigRulesEvaluationRequest -
        Returns:
        Result of the StartConfigRulesEvaluation operation returned by the service.
        Throws:
        NoSuchConfigRuleException - 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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • startConfigRulesEvaluation

        default StartConfigRulesEvaluationResponse startConfigRulesEvaluation​(Consumer<StartConfigRulesEvaluationRequest.Builder> startConfigRulesEvaluationRequest)
                                                                       throws NoSuchConfigRuleException,
                                                                              LimitExceededException,
                                                                              ResourceInUseException,
                                                                              InvalidParameterValueException,
                                                                              AwsServiceException,
                                                                              SdkClientException,
                                                                              ConfigException

        Runs an on-demand evaluation for the specified Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test 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 a ConfigRuleEvaluationStarted notification when the evaluation starts.

        You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, 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:

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

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

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

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

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


        This is a convenience which creates an instance of the StartConfigRulesEvaluationRequest.Builder avoiding the need to create one manually via StartConfigRulesEvaluationRequest.builder()

        Parameters:
        startConfigRulesEvaluationRequest - A Consumer that will call methods on StartConfigRulesEvaluationRequest.Builder to create a request.
        Returns:
        Result of the StartConfigRulesEvaluation operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • startRemediationExecution

        default StartRemediationExecutionResponse startRemediationExecution​(StartRemediationExecutionRequest startRemediationExecutionRequest)
                                                                     throws InvalidParameterValueException,
                                                                            InsufficientPermissionsException,
                                                                            NoSuchRemediationConfigurationException,
                                                                            AwsServiceException,
                                                                            SdkClientException,
                                                                            ConfigException

        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:
        Result of the StartRemediationExecution operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • tagResource

        default TagResourceResponse tagResource​(TagResourceRequest tagResourceRequest)
                                         throws ValidationException,
                                                ResourceNotFoundException,
                                                TooManyTagsException,
                                                AwsServiceException,
                                                SdkClientException,
                                                ConfigException

        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:
        Result of the TagResource operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation
      • untagResource

        default UntagResourceResponse untagResource​(UntagResourceRequest untagResourceRequest)
                                             throws ValidationException,
                                                    ResourceNotFoundException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    ConfigException

        Deletes specified tags from a resource.

        Parameters:
        untagResourceRequest -
        Returns:
        Result of the UntagResource operation returned by the service.
        Throws:
        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.
        AwsServiceException
        See Also:
        AWS API Documentation