summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md25
-rw-r--r--amazonka-config.cabal31
-rw-r--r--gen/Network/AWS/Config.hs9
-rw-r--r--gen/Network/AWS/Config/DeleteConfigRule.hs14
-rw-r--r--gen/Network/AWS/Config/DeleteConfigurationRecorder.hs12
-rw-r--r--gen/Network/AWS/Config/DeleteDeliveryChannel.hs10
-rw-r--r--gen/Network/AWS/Config/DeleteEvaluationResults.hs18
-rw-r--r--gen/Network/AWS/Config/DeliverConfigSnapshot.hs28
-rw-r--r--gen/Network/AWS/Config/DescribeComplianceByConfigRule.hs46
-rw-r--r--gen/Network/AWS/Config/DescribeComplianceByResource.hs54
-rw-r--r--gen/Network/AWS/Config/DescribeConfigRuleEvaluationStatus.hs22
-rw-r--r--gen/Network/AWS/Config/DescribeConfigRules.hs28
-rw-r--r--gen/Network/AWS/Config/DescribeConfigurationRecorderStatus.hs18
-rw-r--r--gen/Network/AWS/Config/DescribeConfigurationRecorders.hs20
-rw-r--r--gen/Network/AWS/Config/DescribeDeliveryChannelStatus.hs18
-rw-r--r--gen/Network/AWS/Config/DescribeDeliveryChannels.hs18
-rw-r--r--gen/Network/AWS/Config/GetComplianceDetailsByConfigRule.hs36
-rw-r--r--gen/Network/AWS/Config/GetComplianceDetailsByResource.hs36
-rw-r--r--gen/Network/AWS/Config/GetComplianceSummaryByConfigRule.hs14
-rw-r--r--gen/Network/AWS/Config/GetComplianceSummaryByResourceType.hs26
-rw-r--r--gen/Network/AWS/Config/GetResourceConfigHistory.hs38
-rw-r--r--gen/Network/AWS/Config/ListDiscoveredResources.hs38
-rw-r--r--gen/Network/AWS/Config/PutConfigRule.hs19
-rw-r--r--gen/Network/AWS/Config/PutConfigurationRecorder.hs10
-rw-r--r--gen/Network/AWS/Config/PutDeliveryChannel.hs8
-rw-r--r--gen/Network/AWS/Config/PutEvaluations.hs24
-rw-r--r--gen/Network/AWS/Config/StartConfigRulesEvaluation.hs31
-rw-r--r--gen/Network/AWS/Config/StartConfigurationRecorder.hs8
-rw-r--r--gen/Network/AWS/Config/StopConfigurationRecorder.hs8
-rw-r--r--gen/Network/AWS/Config/Types.hs69
-rw-r--r--gen/Network/AWS/Config/Types/Product.hs447
-rw-r--r--gen/Network/AWS/Config/Types/Sum.hs5
32 files changed, 692 insertions, 496 deletions
diff --git a/README.md b/README.md
index b909108..e11604e 100644
--- a/README.md
+++ b/README.md
@@ -8,35 +8,28 @@
## Version
-`1.4.4`
+`1.4.5`
## Description
-AWS Config
-
-AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see <http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources Supported AWS Resources>.
-
-You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config
-
-This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config.
-
-The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process>.
-
-For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see <http://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html What Is AWS Config?> in the /AWS Config Developer Guide/.
-
Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-config)
and the [AWS API Reference](https://aws.amazon.com/documentation/).
The types from this library are intended to be used with [amazonka](http://hackage.haskell.org/package/amazonka),
-which provides mechanisms for specifying AuthN/AuthZ information and sending requests.
+which provides mechanisms for specifying AuthN/AuthZ information, sending requests,
+and receiving responses.
-Use of lenses is required for constructing and manipulating types.
-This is due to the amount of nesting of AWS types and transparency regarding
+Lenses are used for constructing and manipulating types,
+due to the depth of nesting of AWS types and transparency regarding
de/serialisation into more palatable Haskell values.
The provided lenses should be compatible with any of the major lens libraries
[lens](http://hackage.haskell.org/package/lens) or [lens-family-core](http://hackage.haskell.org/package/lens-family-core).
+See [Network.AWS.Config](http://hackage.haskell.org/package/amazonka-config/docs/Network-AWS-Config.html)
+or [the AWS documentation](https://aws.amazon.com/documentation/) to get started.
+
+
## Contribute
For any problems, comments, or feedback please create an issue [here on GitHub](https://github.com/brendanhay/amazonka/issues).
diff --git a/amazonka-config.cabal b/amazonka-config.cabal
index c2fe60a..999e593 100644
--- a/amazonka-config.cabal
+++ b/amazonka-config.cabal
@@ -1,5 +1,5 @@
name: amazonka-config
-version: 1.4.4
+version: 1.4.5
synopsis: Amazon Config SDK.
homepage: https://github.com/brendanhay/amazonka
bug-reports: https://github.com/brendanhay/amazonka/issues
@@ -13,30 +13,19 @@ build-type: Simple
cabal-version: >= 1.10
extra-source-files: README.md fixture/*.yaml fixture/*.proto src/.gitkeep
description:
- AWS Config
-
- AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see <http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources Supported AWS Resources>.
-
- You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config
-
- This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config.
-
- The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process>.
-
- For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see <http://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html What Is AWS Config?> in the /AWS Config Developer Guide/.
- .
The types from this library are intended to be used with
<http://hackage.haskell.org/package/amazonka amazonka>, which provides
- mechanisms for specifying AuthN/AuthZ information and sending requests.
+ mechanisms for specifying AuthN/AuthZ information, sending requests,
+ and receiving responses.
.
- Use of lenses is required for constructing and manipulating types.
- This is due to the amount of nesting of AWS types and transparency regarding
+ Lenses are used for constructing and manipulating types,
+ due to the depth of nesting of AWS types and transparency regarding
de/serialisation into more palatable Haskell values.
The provided lenses should be compatible with any of the major lens libraries
such as <http://hackage.haskell.org/package/lens lens> or
<http://hackage.haskell.org/package/lens-family-core lens-family-core>.
.
- See "Network.AWS.Config" or <https://aws.amazon.com/documentation/ the AWS Documentation>
+ See "Network.AWS.Config" or <https://aws.amazon.com/documentation/ the AWS documentation>
to get started.
source-repository head
@@ -85,7 +74,7 @@ library
, Network.AWS.Config.Types.Sum
build-depends:
- amazonka-core == 1.4.4.*
+ amazonka-core == 1.4.5.*
, base >= 4.7 && < 5
test-suite amazonka-config-test
@@ -105,9 +94,9 @@ test-suite amazonka-config-test
, Test.AWS.Config.Internal
build-depends:
- amazonka-core == 1.4.4.*
- , amazonka-test == 1.4.4.*
- , amazonka-config == 1.4.4.*
+ amazonka-core == 1.4.5.*
+ , amazonka-test == 1.4.5.*
+ , amazonka-config == 1.4.5.*
, base
, bytestring
, tasty
diff --git a/gen/Network/AWS/Config.hs b/gen/Network/AWS/Config.hs
index 2fd15ec..46d2259 100644
--- a/gen/Network/AWS/Config.hs
+++ b/gen/Network/AWS/Config.hs
@@ -11,17 +11,18 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- AWS Config
+-- __AWS Config__
--
--- AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see <http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources Supported AWS Resources>.
+-- AWS Config provides a way to keep track of the configurations of all the AWS resources associated with your AWS account. You can use AWS Config to get the current and historical configurations of each AWS resource and also to get information about the relationship between the resources. An AWS resource can be an Amazon Compute Cloud (Amazon EC2) instance, an Elastic Block Store (EBS) volume, an Elastic network Interface (ENI), or a security group. For a complete list of resources currently supported by AWS Config, see <http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources Supported AWS Resources> .
--
-- You can access and manage AWS Config through the AWS Management Console, the AWS Command Line Interface (AWS CLI), the AWS Config API, or the AWS SDKs for AWS Config
--
-- This reference guide contains documentation for the AWS Config API and the AWS CLI commands that you can use to manage AWS Config.
--
--- The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process>.
+-- The AWS Config API uses the Signature Version 4 protocol for signing requests. For more information about how to sign a request with this protocol, see <http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html Signature Version 4 Signing Process> .
+--
+-- For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see <http://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html What Is AWS Config?> in the /AWS Config Developer Guide/ .
--
--- For detailed information about AWS Config features and their associated actions or commands, as well as how to work with AWS Management Console, see <http://docs.aws.amazon.com/config/latest/developerguide/WhatIsConfig.html What Is AWS Config?> in the /AWS Config Developer Guide/.
module Network.AWS.Config
(
-- * Service Configuration
diff --git a/gen/Network/AWS/Config/DeleteConfigRule.hs b/gen/Network/AWS/Config/DeleteConfigRule.hs
index 2362e93..e62deb9 100644
--- a/gen/Network/AWS/Config/DeleteConfigRule.hs
+++ b/gen/Network/AWS/Config/DeleteConfigRule.hs
@@ -20,9 +20,11 @@
--
-- Deletes the specified AWS Config rule and all of its evaluation results.
--
--- AWS Config sets the state of a rule to 'DELETING' until the deletion is complete. You cannot update a rule while it is in this state. If you make a 'PutConfigRule' or 'DeleteConfigRule' request for the rule, you will receive a 'ResourceInUseException'.
--
--- You can check the state of a rule by using the 'DescribeConfigRules' request.
+-- AWS Config sets the state of a rule to @DELETING@ until the deletion is complete. You cannot update a rule while it is in this state. If you make a @PutConfigRule@ or @DeleteConfigRule@ request for the rule, you will receive a @ResourceInUseException@ .
+--
+-- You can check the state of a rule by using the @DescribeConfigRules@ request.
+--
module Network.AWS.Config.DeleteConfigRule
(
-- * Creating a Request
@@ -43,7 +45,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'deleteConfigRule' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'deleteConfigRule' smart constructor.
newtype DeleteConfigRule = DeleteConfigRule'
{ _dcrConfigRuleName :: Text
} deriving (Eq,Read,Show,Data,Typeable,Generic)
@@ -52,7 +58,7 @@ newtype DeleteConfigRule = DeleteConfigRule'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcrConfigRuleName'
+-- * 'dcrConfigRuleName' - The name of the AWS Config rule that you want to delete.
deleteConfigRule
:: Text -- ^ 'dcrConfigRuleName'
-> DeleteConfigRule
diff --git a/gen/Network/AWS/Config/DeleteConfigurationRecorder.hs b/gen/Network/AWS/Config/DeleteConfigurationRecorder.hs
index d117096..5dc6631 100644
--- a/gen/Network/AWS/Config/DeleteConfigurationRecorder.hs
+++ b/gen/Network/AWS/Config/DeleteConfigurationRecorder.hs
@@ -20,9 +20,11 @@
--
-- Deletes the configuration recorder.
--
+--
-- After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder.
--
--- This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the 'GetResourceConfigHistory' action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder.
+-- This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the @GetResourceConfigHistory@ action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder.
+--
module Network.AWS.Config.DeleteConfigurationRecorder
(
-- * Creating a Request
@@ -43,7 +45,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The request object for the 'DeleteConfigurationRecorder' action.
+-- | The request object for the @DeleteConfigurationRecorder@ action.
+--
+--
--
-- /See:/ 'deleteConfigurationRecorder' smart constructor.
newtype DeleteConfigurationRecorder = DeleteConfigurationRecorder'
@@ -54,7 +58,7 @@ newtype DeleteConfigurationRecorder = DeleteConfigurationRecorder'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcrConfigurationRecorderName'
+-- * 'dcrConfigurationRecorderName' - The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the @DescribeConfigurationRecorders@ action.
deleteConfigurationRecorder
:: Text -- ^ 'dcrConfigurationRecorderName'
-> DeleteConfigurationRecorder
@@ -63,7 +67,7 @@ deleteConfigurationRecorder pConfigurationRecorderName_ =
{ _dcrConfigurationRecorderName = pConfigurationRecorderName_
}
--- | The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the 'DescribeConfigurationRecorders' action.
+-- | The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the @DescribeConfigurationRecorders@ action.
dcrConfigurationRecorderName :: Lens' DeleteConfigurationRecorder Text
dcrConfigurationRecorderName = lens _dcrConfigurationRecorderName (\ s a -> s{_dcrConfigurationRecorderName = a});
diff --git a/gen/Network/AWS/Config/DeleteDeliveryChannel.hs b/gen/Network/AWS/Config/DeleteDeliveryChannel.hs
index 5f7c250..4fe70a5 100644
--- a/gen/Network/AWS/Config/DeleteDeliveryChannel.hs
+++ b/gen/Network/AWS/Config/DeleteDeliveryChannel.hs
@@ -20,7 +20,9 @@
--
-- Deletes the delivery channel.
--
--- Before you can delete the delivery channel, you must stop the configuration recorder by using the < StopConfigurationRecorder> action.
+--
+-- Before you can delete the delivery channel, you must stop the configuration recorder by using the 'StopConfigurationRecorder' action.
+--
module Network.AWS.Config.DeleteDeliveryChannel
(
-- * Creating a Request
@@ -41,7 +43,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < DeleteDeliveryChannel> action. The action accepts the following data in JSON format.
+-- | The input for the 'DeleteDeliveryChannel' action. The action accepts the following data in JSON format.
+--
+--
--
-- /See:/ 'deleteDeliveryChannel' smart constructor.
newtype DeleteDeliveryChannel = DeleteDeliveryChannel'
@@ -52,7 +56,7 @@ newtype DeleteDeliveryChannel = DeleteDeliveryChannel'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ddcDeliveryChannelName'
+-- * 'ddcDeliveryChannelName' - The name of the delivery channel to delete.
deleteDeliveryChannel
:: Text -- ^ 'ddcDeliveryChannelName'
-> DeleteDeliveryChannel
diff --git a/gen/Network/AWS/Config/DeleteEvaluationResults.hs b/gen/Network/AWS/Config/DeleteEvaluationResults.hs
index 01493d0..2db86ad 100644
--- a/gen/Network/AWS/Config/DeleteEvaluationResults.hs
+++ b/gen/Network/AWS/Config/DeleteEvaluationResults.hs
@@ -18,7 +18,9 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the < StartConfigRulesEvaluation> API to start evaluating your AWS resources against the rule.
+-- Deletes the evaluation results for the specified Config rule. You can specify one Config rule per request. After you delete the evaluation results, you can call the 'StartConfigRulesEvaluation' API to start evaluating your AWS resources against the rule.
+--
+--
module Network.AWS.Config.DeleteEvaluationResults
(
-- * Creating a Request
@@ -41,7 +43,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'deleteEvaluationResults' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'deleteEvaluationResults' smart constructor.
newtype DeleteEvaluationResults = DeleteEvaluationResults'
{ _derConfigRuleName :: Text
} deriving (Eq,Read,Show,Data,Typeable,Generic)
@@ -50,7 +56,7 @@ newtype DeleteEvaluationResults = DeleteEvaluationResults'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'derConfigRuleName'
+-- * 'derConfigRuleName' - The name of the Config rule for which you want to delete the evaluation results.
deleteEvaluationResults
:: Text -- ^ 'derConfigRuleName'
-> DeleteEvaluationResults
@@ -101,6 +107,8 @@ instance ToQuery DeleteEvaluationResults where
-- | The output when you delete the evaluation results for the specified Config rule.
--
+--
+--
-- /See:/ 'deleteEvaluationResultsResponse' smart constructor.
newtype DeleteEvaluationResultsResponse = DeleteEvaluationResultsResponse'
{ _derrsResponseStatus :: Int
@@ -110,7 +118,7 @@ newtype DeleteEvaluationResultsResponse = DeleteEvaluationResultsResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'derrsResponseStatus'
+-- * 'derrsResponseStatus' - -- | The response status code.
deleteEvaluationResultsResponse
:: Int -- ^ 'derrsResponseStatus'
-> DeleteEvaluationResultsResponse
@@ -119,7 +127,7 @@ deleteEvaluationResultsResponse pResponseStatus_ =
{ _derrsResponseStatus = pResponseStatus_
}
--- | The response status code.
+-- | -- | The response status code.
derrsResponseStatus :: Lens' DeleteEvaluationResultsResponse Int
derrsResponseStatus = lens _derrsResponseStatus (\ s a -> s{_derrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/DeliverConfigSnapshot.hs b/gen/Network/AWS/Config/DeliverConfigSnapshot.hs
index 462209f..e799502 100644
--- a/gen/Network/AWS/Config/DeliverConfigSnapshot.hs
+++ b/gen/Network/AWS/Config/DeliverConfigSnapshot.hs
@@ -20,9 +20,15 @@
--
-- Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends following notifications using an Amazon SNS topic that you have specified.
--
--- - Notification of starting the delivery.
--- - Notification of delivery completed, if the delivery was successfully completed.
--- - Notification of delivery failure, if the delivery failed to complete.
+--
+-- * Notification of starting the delivery.
+--
+-- * Notification of delivery completed, if the delivery was successfully completed.
+--
+-- * Notification of delivery failure, if the delivery failed to complete.
+--
+--
+--
module Network.AWS.Config.DeliverConfigSnapshot
(
-- * Creating a Request
@@ -46,7 +52,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < DeliverConfigSnapshot> action.
+-- | The input for the 'DeliverConfigSnapshot' action.
+--
+--
--
-- /See:/ 'deliverConfigSnapshot' smart constructor.
newtype DeliverConfigSnapshot = DeliverConfigSnapshot'
@@ -57,7 +65,7 @@ newtype DeliverConfigSnapshot = DeliverConfigSnapshot'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcsDeliveryChannelName'
+-- * 'dcsDeliveryChannelName' - The name of the delivery channel through which the snapshot is delivered.
deliverConfigSnapshot
:: Text -- ^ 'dcsDeliveryChannelName'
-> DeliverConfigSnapshot
@@ -107,7 +115,9 @@ instance ToPath DeliverConfigSnapshot where
instance ToQuery DeliverConfigSnapshot where
toQuery = const mempty
--- | The output for the < DeliverConfigSnapshot> action in JSON format.
+-- | The output for the 'DeliverConfigSnapshot' action in JSON format.
+--
+--
--
-- /See:/ 'deliverConfigSnapshotResponse' smart constructor.
data DeliverConfigSnapshotResponse = DeliverConfigSnapshotResponse'
@@ -119,9 +129,9 @@ data DeliverConfigSnapshotResponse = DeliverConfigSnapshotResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcsrsConfigSnapshotId'
+-- * 'dcsrsConfigSnapshotId' - The ID of the snapshot that is being created.
--
--- * 'dcsrsResponseStatus'
+-- * 'dcsrsResponseStatus' - -- | The response status code.
deliverConfigSnapshotResponse
:: Int -- ^ 'dcsrsResponseStatus'
-> DeliverConfigSnapshotResponse
@@ -135,7 +145,7 @@ deliverConfigSnapshotResponse pResponseStatus_ =
dcsrsConfigSnapshotId :: Lens' DeliverConfigSnapshotResponse (Maybe Text)
dcsrsConfigSnapshotId = lens _dcsrsConfigSnapshotId (\ s a -> s{_dcsrsConfigSnapshotId = a});
--- | The response status code.
+-- | -- | The response status code.
dcsrsResponseStatus :: Lens' DeliverConfigSnapshotResponse Int
dcsrsResponseStatus = lens _dcsrsResponseStatus (\ s a -> s{_dcsrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/DescribeComplianceByConfigRule.hs b/gen/Network/AWS/Config/DescribeComplianceByConfigRule.hs
index d7f9446..f29b694 100644
--- a/gen/Network/AWS/Config/DescribeComplianceByConfigRule.hs
+++ b/gen/Network/AWS/Config/DescribeComplianceByConfigRule.hs
@@ -20,13 +20,19 @@
--
-- Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule.
--
+--
-- A rule is compliant if all of the evaluated resources comply with it, and it is noncompliant if any of these resources do not comply.
--
--- If AWS Config has no current evaluation results for the rule, it returns 'INSUFFICIENT_DATA'. This result might indicate one of the following conditions:
+-- If AWS Config has no current evaluation results for the rule, it returns @INSUFFICIENT_DATA@ . This result might indicate one of the following conditions:
+--
+-- * AWS Config has never invoked an evaluation for the rule. To check whether it has, use the @DescribeConfigRuleEvaluationStatus@ action to get the @LastSuccessfulInvocationTime@ and @LastFailedInvocationTime@ .
+--
+-- * The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the @config:PutEvaluations@ permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the @config:PutEvaluations@ permission.
+--
+-- * The rule's AWS Lambda function has returned @NOT_APPLICABLE@ for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
+--
+--
--
--- - AWS Config has never invoked an evaluation for the rule. To check whether it has, use the 'DescribeConfigRuleEvaluationStatus' action to get the 'LastSuccessfulInvocationTime' and 'LastFailedInvocationTime'.
--- - The rule\'s AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the 'config:PutEvaluations' permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the 'config:PutEvaluations' permission.
--- - The rule\'s AWS Lambda function has returned 'NOT_APPLICABLE' for all evaluation results. This can occur if the resources were deleted or removed from the rule\'s scope.
module Network.AWS.Config.DescribeComplianceByConfigRule
(
-- * Creating a Request
@@ -53,7 +59,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'describeComplianceByConfigRule' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'describeComplianceByConfigRule' smart constructor.
data DescribeComplianceByConfigRule = DescribeComplianceByConfigRule'
{ _dcbcrConfigRuleNames :: !(Maybe [Text])
, _dcbcrComplianceTypes :: !(Maybe [ComplianceType])
@@ -64,11 +74,11 @@ data DescribeComplianceByConfigRule = DescribeComplianceByConfigRule'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcbcrConfigRuleNames'
+-- * 'dcbcrConfigRuleNames' - Specify one or more AWS Config rule names to filter the results by rule.
--
--- * 'dcbcrComplianceTypes'
+-- * 'dcbcrComplianceTypes' - Filters the results by compliance. The allowed values are @COMPLIANT@ , @NON_COMPLIANT@ , and @INSUFFICIENT_DATA@ .
--
--- * 'dcbcrNextToken'
+-- * 'dcbcrNextToken' - The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
describeComplianceByConfigRule
:: DescribeComplianceByConfigRule
describeComplianceByConfigRule =
@@ -82,13 +92,11 @@ describeComplianceByConfigRule =
dcbcrConfigRuleNames :: Lens' DescribeComplianceByConfigRule [Text]
dcbcrConfigRuleNames = lens _dcbcrConfigRuleNames (\ s a -> s{_dcbcrConfigRuleNames = a}) . _Default . _Coerce;
--- | Filters the results by compliance.
---
--- The allowed values are 'COMPLIANT', 'NON_COMPLIANT', and 'INSUFFICIENT_DATA'.
+-- | Filters the results by compliance. The allowed values are @COMPLIANT@ , @NON_COMPLIANT@ , and @INSUFFICIENT_DATA@ .
dcbcrComplianceTypes :: Lens' DescribeComplianceByConfigRule [ComplianceType]
dcbcrComplianceTypes = lens _dcbcrComplianceTypes (\ s a -> s{_dcbcrComplianceTypes = a}) . _Default . _Coerce;
--- | The 'nextToken' string returned on a previous page that you use to get the next page of results in a paginated response.
+-- | The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
dcbcrNextToken :: Lens' DescribeComplianceByConfigRule (Maybe Text)
dcbcrNextToken = lens _dcbcrNextToken (\ s a -> s{_dcbcrNextToken = a});
@@ -134,7 +142,11 @@ instance ToPath DescribeComplianceByConfigRule where
instance ToQuery DescribeComplianceByConfigRule where
toQuery = const mempty
--- | /See:/ 'describeComplianceByConfigRuleResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'describeComplianceByConfigRuleResponse' smart constructor.
data DescribeComplianceByConfigRuleResponse = DescribeComplianceByConfigRuleResponse'
{ _dcbcrrsComplianceByConfigRules :: !(Maybe [ComplianceByConfigRule])
, _dcbcrrsNextToken :: !(Maybe Text)
@@ -145,11 +157,11 @@ data DescribeComplianceByConfigRuleResponse = DescribeComplianceByConfigRuleResp
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcbcrrsComplianceByConfigRules'
+-- * 'dcbcrrsComplianceByConfigRules' - Indicates whether each of the specified AWS Config rules is compliant.
--
--- * 'dcbcrrsNextToken'
+-- * 'dcbcrrsNextToken' - The string that you use in a subsequent request to get the next page of results in a paginated response.
--
--- * 'dcbcrrsResponseStatus'
+-- * 'dcbcrrsResponseStatus' - -- | The response status code.
describeComplianceByConfigRuleResponse
:: Int -- ^ 'dcbcrrsResponseStatus'
-> DescribeComplianceByConfigRuleResponse
@@ -168,7 +180,7 @@ dcbcrrsComplianceByConfigRules = lens _dcbcrrsComplianceByConfigRules (\ s a ->
dcbcrrsNextToken :: Lens' DescribeComplianceByConfigRuleResponse (Maybe Text)
dcbcrrsNextToken = lens _dcbcrrsNextToken (\ s a -> s{_dcbcrrsNextToken = a});
--- | The response status code.
+-- | -- | The response status code.
dcbcrrsResponseStatus :: Lens' DescribeComplianceByConfigRuleResponse Int
dcbcrrsResponseStatus = lens _dcbcrrsResponseStatus (\ s a -> s{_dcbcrrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/DescribeComplianceByResource.hs b/gen/Network/AWS/Config/DescribeComplianceByResource.hs
index 8d3086e..a091ac2 100644
--- a/gen/Network/AWS/Config/DescribeComplianceByResource.hs
+++ b/gen/Network/AWS/Config/DescribeComplianceByResource.hs
@@ -20,13 +20,19 @@
--
-- Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with.
--
+--
-- A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules.
--
--- If AWS Config has no current evaluation results for the resource, it returns 'INSUFFICIENT_DATA'. This result might indicate one of the following conditions about the rules that evaluate the resource:
+-- If AWS Config has no current evaluation results for the resource, it returns @INSUFFICIENT_DATA@ . This result might indicate one of the following conditions about the rules that evaluate the resource:
+--
+-- * AWS Config has never invoked an evaluation for the rule. To check whether it has, use the @DescribeConfigRuleEvaluationStatus@ action to get the @LastSuccessfulInvocationTime@ and @LastFailedInvocationTime@ .
+--
+-- * The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the @config:PutEvaluations@ permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the @config:PutEvaluations@ permission.
+--
+-- * The rule's AWS Lambda function has returned @NOT_APPLICABLE@ for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.
+--
+--
--
--- - AWS Config has never invoked an evaluation for the rule. To check whether it has, use the 'DescribeConfigRuleEvaluationStatus' action to get the 'LastSuccessfulInvocationTime' and 'LastFailedInvocationTime'.
--- - The rule\'s AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the 'config:PutEvaluations' permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the 'config:PutEvaluations' permission.
--- - The rule\'s AWS Lambda function has returned 'NOT_APPLICABLE' for all evaluation results. This can occur if the resources were deleted or removed from the rule\'s scope.
module Network.AWS.Config.DescribeComplianceByResource
(
-- * Creating a Request
@@ -55,7 +61,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'describeComplianceByResource' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'describeComplianceByResource' smart constructor.
data DescribeComplianceByResource = DescribeComplianceByResource'
{ _dcbrResourceId :: !(Maybe Text)
, _dcbrResourceType :: !(Maybe Text)
@@ -68,15 +78,15 @@ data DescribeComplianceByResource = DescribeComplianceByResource'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcbrResourceId'
+-- * 'dcbrResourceId' - The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for @ResourceType@ .
--
--- * 'dcbrResourceType'
+-- * 'dcbrResourceType' - The types of AWS resources for which you want compliance information; for example, @AWS::EC2::Instance@ . For this action, you can specify that the resource type is an AWS account by specifying @AWS::::Account@ .
--
--- * 'dcbrComplianceTypes'
+-- * 'dcbrComplianceTypes' - Filters the results by compliance. The allowed values are @COMPLIANT@ , @NON_COMPLIANT@ , and @INSUFFICIENT_DATA@ .
--
--- * 'dcbrNextToken'
+-- * 'dcbrNextToken' - The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
--
--- * 'dcbrLimit'
+-- * 'dcbrLimit' - The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.
describeComplianceByResource
:: DescribeComplianceByResource
describeComplianceByResource =
@@ -88,21 +98,19 @@ describeComplianceByResource =
, _dcbrLimit = Nothing
}
--- | The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for 'ResourceType'.
+-- | The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for @ResourceType@ .
dcbrResourceId :: Lens' DescribeComplianceByResource (Maybe Text)
dcbrResourceId = lens _dcbrResourceId (\ s a -> s{_dcbrResourceId = a});
--- | The types of AWS resources for which you want compliance information; for example, 'AWS::EC2::Instance'. For this action, you can specify that the resource type is an AWS account by specifying 'AWS::::Account'.
+-- | The types of AWS resources for which you want compliance information; for example, @AWS::EC2::Instance@ . For this action, you can specify that the resource type is an AWS account by specifying @AWS::::Account@ .
dcbrResourceType :: Lens' DescribeComplianceByResource (Maybe Text)
dcbrResourceType = lens _dcbrResourceType (\ s a -> s{_dcbrResourceType = a});
--- | Filters the results by compliance.
---
--- The allowed values are 'COMPLIANT', 'NON_COMPLIANT', and 'INSUFFICIENT_DATA'.
+-- | Filters the results by compliance. The allowed values are @COMPLIANT@ , @NON_COMPLIANT@ , and @INSUFFICIENT_DATA@ .
dcbrComplianceTypes :: Lens' DescribeComplianceByResource [ComplianceType]
dcbrComplianceTypes = lens _dcbrComplianceTypes (\ s a -> s{_dcbrComplianceTypes = a}) . _Default . _Coerce;
--- | The 'nextToken' string returned on a previous page that you use to get the next page of results in a paginated response.
+-- | The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
dcbrNextToken :: Lens' DescribeComplianceByResource (Maybe Text)
dcbrNextToken = lens _dcbrNextToken (\ s a -> s{_dcbrNextToken = a});
@@ -153,7 +161,11 @@ instance ToPath DescribeComplianceByResource where
instance ToQuery DescribeComplianceByResource where
toQuery = const mempty
--- | /See:/ 'describeComplianceByResourceResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'describeComplianceByResourceResponse' smart constructor.
data DescribeComplianceByResourceResponse = DescribeComplianceByResourceResponse'
{ _dcbrrsComplianceByResources :: !(Maybe [ComplianceByResource])
, _dcbrrsNextToken :: !(Maybe Text)
@@ -164,11 +176,11 @@ data DescribeComplianceByResourceResponse = DescribeComplianceByResourceResponse
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcbrrsComplianceByResources'
+-- * 'dcbrrsComplianceByResources' - Indicates whether the specified AWS resource complies with all of the AWS Config rules that evaluate it.
--
--- * 'dcbrrsNextToken'
+-- * 'dcbrrsNextToken' - The string that you use in a subsequent request to get the next page of results in a paginated response.
--
--- * 'dcbrrsResponseStatus'
+-- * 'dcbrrsResponseStatus' - -- | The response status code.
describeComplianceByResourceResponse
:: Int -- ^ 'dcbrrsResponseStatus'
-> DescribeComplianceByResourceResponse
@@ -187,7 +199,7 @@ dcbrrsComplianceByResources = lens _dcbrrsComplianceByResources (\ s a -> s{_dcb
dcbrrsNextToken :: Lens' DescribeComplianceByResourceResponse (Maybe Text)
dcbrrsNextToken = lens _dcbrrsNextToken (\ s a -> s{_dcbrrsNextToken = a});
--- | The response status code.
+-- | -- | The response status code.
dcbrrsResponseStatus :: Lens' DescribeComplianceByResourceResponse Int
dcbrrsResponseStatus = lens _dcbrrsResponseStatus (\ s a -> s{_dcbrrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/DescribeConfigRuleEvaluationStatus.hs b/gen/Network/AWS/Config/DescribeConfigRuleEvaluationStatus.hs
index b6eca42..fbd6d6b 100644
--- a/gen/Network/AWS/Config/DescribeConfigRuleEvaluationStatus.hs
+++ b/gen/Network/AWS/Config/DescribeConfigRuleEvaluationStatus.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.
+--
+--
module Network.AWS.Config.DescribeConfigRuleEvaluationStatus
(
-- * Creating a Request
@@ -42,7 +44,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'describeConfigRuleEvaluationStatus' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'describeConfigRuleEvaluationStatus' smart constructor.
newtype DescribeConfigRuleEvaluationStatus = DescribeConfigRuleEvaluationStatus'
{ _dcresConfigRuleNames :: Maybe [Text]
} deriving (Eq,Read,Show,Data,Typeable,Generic)
@@ -51,7 +57,7 @@ newtype DescribeConfigRuleEvaluationStatus = DescribeConfigRuleEvaluationStatus'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcresConfigRuleNames'
+-- * 'dcresConfigRuleNames' - The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use.
describeConfigRuleEvaluationStatus
:: DescribeConfigRuleEvaluationStatus
describeConfigRuleEvaluationStatus =
@@ -105,7 +111,11 @@ instance ToQuery DescribeConfigRuleEvaluationStatus
where
toQuery = const mempty
--- | /See:/ 'describeConfigRuleEvaluationStatusResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'describeConfigRuleEvaluationStatusResponse' smart constructor.
data DescribeConfigRuleEvaluationStatusResponse = DescribeConfigRuleEvaluationStatusResponse'
{ _dcresrsConfigRulesEvaluationStatus :: !(Maybe [ConfigRuleEvaluationStatus])
, _dcresrsResponseStatus :: !Int
@@ -115,9 +125,9 @@ data DescribeConfigRuleEvaluationStatusResponse = DescribeConfigRuleEvaluationSt
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcresrsConfigRulesEvaluationStatus'
+-- * 'dcresrsConfigRulesEvaluationStatus' - Status information about your AWS managed Config rules.
--
--- * 'dcresrsResponseStatus'
+-- * 'dcresrsResponseStatus' - -- | The response status code.
describeConfigRuleEvaluationStatusResponse
:: Int -- ^ 'dcresrsResponseStatus'
-> DescribeConfigRuleEvaluationStatusResponse
@@ -131,7 +141,7 @@ describeConfigRuleEvaluationStatusResponse pResponseStatus_ =
dcresrsConfigRulesEvaluationStatus :: Lens' DescribeConfigRuleEvaluationStatusResponse [ConfigRuleEvaluationStatus]
dcresrsConfigRulesEvaluationStatus = lens _dcresrsConfigRulesEvaluationStatus (\ s a -> s{_dcresrsConfigRulesEvaluationStatus = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
dcresrsResponseStatus :: Lens' DescribeConfigRuleEvaluationStatusResponse Int
dcresrsResponseStatus = lens _dcresrsResponseStatus (\ s a -> s{_dcresrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/DescribeConfigRules.hs b/gen/Network/AWS/Config/DescribeConfigRules.hs
index 8dfe77c..535e476 100644
--- a/gen/Network/AWS/Config/DescribeConfigRules.hs
+++ b/gen/Network/AWS/Config/DescribeConfigRules.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Returns details about your AWS Config rules.
+--
+--
module Network.AWS.Config.DescribeConfigRules
(
-- * Creating a Request
@@ -44,7 +46,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'describeConfigRules' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'describeConfigRules' smart constructor.
data DescribeConfigRules = DescribeConfigRules'
{ _dcrConfigRuleNames :: !(Maybe [Text])
, _dcrNextToken :: !(Maybe Text)
@@ -54,9 +60,9 @@ data DescribeConfigRules = DescribeConfigRules'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcrConfigRuleNames'
+-- * 'dcrConfigRuleNames' - The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules.
--
--- * 'dcrNextToken'
+-- * 'dcrNextToken' - The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
describeConfigRules
:: DescribeConfigRules
describeConfigRules =
@@ -69,7 +75,7 @@ describeConfigRules =
dcrConfigRuleNames :: Lens' DescribeConfigRules [Text]
dcrConfigRuleNames = lens _dcrConfigRuleNames (\ s a -> s{_dcrConfigRuleNames = a}) . _Default . _Coerce;
--- | The 'nextToken' string returned on a previous page that you use to get the next page of results in a paginated response.
+-- | The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
dcrNextToken :: Lens' DescribeConfigRules (Maybe Text)
dcrNextToken = lens _dcrNextToken (\ s a -> s{_dcrNextToken = a});
@@ -112,7 +118,11 @@ instance ToPath DescribeConfigRules where
instance ToQuery DescribeConfigRules where
toQuery = const mempty
--- | /See:/ 'describeConfigRulesResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'describeConfigRulesResponse' smart constructor.
data DescribeConfigRulesResponse = DescribeConfigRulesResponse'
{ _dcrrsConfigRules :: !(Maybe [ConfigRule])
, _dcrrsNextToken :: !(Maybe Text)
@@ -123,11 +133,11 @@ data DescribeConfigRulesResponse = DescribeConfigRulesResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcrrsConfigRules'
+-- * 'dcrrsConfigRules' - The details about your AWS Config rules.
--
--- * 'dcrrsNextToken'
+-- * 'dcrrsNextToken' - The string that you use in a subsequent request to get the next page of results in a paginated response.
--
--- * 'dcrrsResponseStatus'
+-- * 'dcrrsResponseStatus' - -- | The response status code.
describeConfigRulesResponse
:: Int -- ^ 'dcrrsResponseStatus'
-> DescribeConfigRulesResponse
@@ -146,7 +156,7 @@ dcrrsConfigRules = lens _dcrrsConfigRules (\ s a -> s{_dcrrsConfigRules = a}) .
dcrrsNextToken :: Lens' DescribeConfigRulesResponse (Maybe Text)
dcrrsNextToken = lens _dcrrsNextToken (\ s a -> s{_dcrrsNextToken = a});
--- | The response status code.
+-- | -- | The response status code.
dcrrsResponseStatus :: Lens' DescribeConfigRulesResponse Int
dcrrsResponseStatus = lens _dcrrsResponseStatus (\ s a -> s{_dcrrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/DescribeConfigurationRecorderStatus.hs b/gen/Network/AWS/Config/DescribeConfigurationRecorderStatus.hs
index d447d12..61b63c4 100644
--- a/gen/Network/AWS/Config/DescribeConfigurationRecorderStatus.hs
+++ b/gen/Network/AWS/Config/DescribeConfigurationRecorderStatus.hs
@@ -20,7 +20,7 @@
--
-- Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorder associated with the account.
--
--- Currently, you can specify only one configuration recorder per account.
+--
module Network.AWS.Config.DescribeConfigurationRecorderStatus
(
-- * Creating a Request
@@ -44,7 +44,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < DescribeConfigurationRecorderStatus> action.
+-- | The input for the 'DescribeConfigurationRecorderStatus' action.
+--
+--
--
-- /See:/ 'describeConfigurationRecorderStatus' smart constructor.
newtype DescribeConfigurationRecorderStatus = DescribeConfigurationRecorderStatus'
@@ -55,7 +57,7 @@ newtype DescribeConfigurationRecorderStatus = DescribeConfigurationRecorderStatu
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcrsConfigurationRecorderNames'
+-- * 'dcrsConfigurationRecorderNames' - The name(s) of the configuration recorder. If the name is not specified, the action returns the current status of all the configuration recorders associated with the account.
describeConfigurationRecorderStatus
:: DescribeConfigurationRecorderStatus
describeConfigurationRecorderStatus =
@@ -110,7 +112,9 @@ instance ToQuery DescribeConfigurationRecorderStatus
where
toQuery = const mempty
--- | The output for the < DescribeConfigurationRecorderStatus> action in JSON format.
+-- | The output for the 'DescribeConfigurationRecorderStatus' action in JSON format.
+--
+--
--
-- /See:/ 'describeConfigurationRecorderStatusResponse' smart constructor.
data DescribeConfigurationRecorderStatusResponse = DescribeConfigurationRecorderStatusResponse'
@@ -122,9 +126,9 @@ data DescribeConfigurationRecorderStatusResponse = DescribeConfigurationRecorder
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcrsrsConfigurationRecordersStatus'
+-- * 'dcrsrsConfigurationRecordersStatus' - A list that contains status of the specified recorders.
--
--- * 'dcrsrsResponseStatus'
+-- * 'dcrsrsResponseStatus' - -- | The response status code.
describeConfigurationRecorderStatusResponse
:: Int -- ^ 'dcrsrsResponseStatus'
-> DescribeConfigurationRecorderStatusResponse
@@ -138,7 +142,7 @@ describeConfigurationRecorderStatusResponse pResponseStatus_ =
dcrsrsConfigurationRecordersStatus :: Lens' DescribeConfigurationRecorderStatusResponse [ConfigurationRecorderStatus]
dcrsrsConfigurationRecordersStatus = lens _dcrsrsConfigurationRecordersStatus (\ s a -> s{_dcrsrsConfigurationRecordersStatus = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
dcrsrsResponseStatus :: Lens' DescribeConfigurationRecorderStatusResponse Int
dcrsrsResponseStatus = lens _dcrsrsResponseStatus (\ s a -> s{_dcrsrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/DescribeConfigurationRecorders.hs b/gen/Network/AWS/Config/DescribeConfigurationRecorders.hs
index a4ad992..8689a88 100644
--- a/gen/Network/AWS/Config/DescribeConfigurationRecorders.hs
+++ b/gen/Network/AWS/Config/DescribeConfigurationRecorders.hs
@@ -18,9 +18,9 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Returns the name of one or more specified configuration recorders. If the recorder name is not specified, this action returns the names of all the configuration recorders associated with the account.
+-- Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account.
+--
--
--- Currently, you can specify only one configuration recorder per account.
module Network.AWS.Config.DescribeConfigurationRecorders
(
-- * Creating a Request
@@ -44,7 +44,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < DescribeConfigurationRecorders> action.
+-- | The input for the 'DescribeConfigurationRecorders' action.
+--
+--
--
-- /See:/ 'describeConfigurationRecorders' smart constructor.
newtype DescribeConfigurationRecorders = DescribeConfigurationRecorders'
@@ -55,7 +57,7 @@ newtype DescribeConfigurationRecorders = DescribeConfigurationRecorders'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcrConfigurationRecorderNames'
+-- * 'dcrConfigurationRecorderNames' - A list of configuration recorder names.
describeConfigurationRecorders
:: DescribeConfigurationRecorders
describeConfigurationRecorders =
@@ -107,7 +109,9 @@ instance ToPath DescribeConfigurationRecorders where
instance ToQuery DescribeConfigurationRecorders where
toQuery = const mempty
--- | The output for the < DescribeConfigurationRecorders> action.
+-- | The output for the 'DescribeConfigurationRecorders' action.
+--
+--
--
-- /See:/ 'describeConfigurationRecordersResponse' smart constructor.
data DescribeConfigurationRecordersResponse = DescribeConfigurationRecordersResponse'
@@ -119,9 +123,9 @@ data DescribeConfigurationRecordersResponse = DescribeConfigurationRecordersResp
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'drsConfigurationRecorders'
+-- * 'drsConfigurationRecorders' - A list that contains the descriptions of the specified configuration recorders.
--
--- * 'drsResponseStatus'
+-- * 'drsResponseStatus' - -- | The response status code.
describeConfigurationRecordersResponse
:: Int -- ^ 'drsResponseStatus'
-> DescribeConfigurationRecordersResponse
@@ -135,7 +139,7 @@ describeConfigurationRecordersResponse pResponseStatus_ =
drsConfigurationRecorders :: Lens' DescribeConfigurationRecordersResponse [ConfigurationRecorder]
drsConfigurationRecorders = lens _drsConfigurationRecorders (\ s a -> s{_drsConfigurationRecorders = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
drsResponseStatus :: Lens' DescribeConfigurationRecordersResponse Int
drsResponseStatus = lens _drsResponseStatus (\ s a -> s{_drsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/DescribeDeliveryChannelStatus.hs b/gen/Network/AWS/Config/DescribeDeliveryChannelStatus.hs
index 2352b40..74dac82 100644
--- a/gen/Network/AWS/Config/DescribeDeliveryChannelStatus.hs
+++ b/gen/Network/AWS/Config/DescribeDeliveryChannelStatus.hs
@@ -20,7 +20,7 @@
--
-- Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account.
--
--- Currently, you can specify only one delivery channel per account.
+--
module Network.AWS.Config.DescribeDeliveryChannelStatus
(
-- * Creating a Request
@@ -44,7 +44,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < DeliveryChannelStatus> action.
+-- | The input for the 'DeliveryChannelStatus' action.
+--
+--
--
-- /See:/ 'describeDeliveryChannelStatus' smart constructor.
newtype DescribeDeliveryChannelStatus = DescribeDeliveryChannelStatus'
@@ -55,7 +57,7 @@ newtype DescribeDeliveryChannelStatus = DescribeDeliveryChannelStatus'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ddcsDeliveryChannelNames'
+-- * 'ddcsDeliveryChannelNames' - A list of delivery channel names.
describeDeliveryChannelStatus
:: DescribeDeliveryChannelStatus
describeDeliveryChannelStatus =
@@ -107,7 +109,9 @@ instance ToPath DescribeDeliveryChannelStatus where
instance ToQuery DescribeDeliveryChannelStatus where
toQuery = const mempty
--- | The output for the < DescribeDeliveryChannelStatus> action.
+-- | The output for the 'DescribeDeliveryChannelStatus' action.
+--
+--
--
-- /See:/ 'describeDeliveryChannelStatusResponse' smart constructor.
data DescribeDeliveryChannelStatusResponse = DescribeDeliveryChannelStatusResponse'
@@ -119,9 +123,9 @@ data DescribeDeliveryChannelStatusResponse = DescribeDeliveryChannelStatusRespon
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ddcsrsDeliveryChannelsStatus'
+-- * 'ddcsrsDeliveryChannelsStatus' - A list that contains the status of a specified delivery channel.
--
--- * 'ddcsrsResponseStatus'
+-- * 'ddcsrsResponseStatus' - -- | The response status code.
describeDeliveryChannelStatusResponse
:: Int -- ^ 'ddcsrsResponseStatus'
-> DescribeDeliveryChannelStatusResponse
@@ -135,7 +139,7 @@ describeDeliveryChannelStatusResponse pResponseStatus_ =
ddcsrsDeliveryChannelsStatus :: Lens' DescribeDeliveryChannelStatusResponse [DeliveryChannelStatus]
ddcsrsDeliveryChannelsStatus = lens _ddcsrsDeliveryChannelsStatus (\ s a -> s{_ddcsrsDeliveryChannelsStatus = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
ddcsrsResponseStatus :: Lens' DescribeDeliveryChannelStatusResponse Int
ddcsrsResponseStatus = lens _ddcsrsResponseStatus (\ s a -> s{_ddcsrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/DescribeDeliveryChannels.hs b/gen/Network/AWS/Config/DescribeDeliveryChannels.hs
index 763f739..a2974d6 100644
--- a/gen/Network/AWS/Config/DescribeDeliveryChannels.hs
+++ b/gen/Network/AWS/Config/DescribeDeliveryChannels.hs
@@ -20,7 +20,7 @@
--
-- Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account.
--
--- Currently, you can specify only one delivery channel per account.
+--
module Network.AWS.Config.DescribeDeliveryChannels
(
-- * Creating a Request
@@ -44,7 +44,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < DescribeDeliveryChannels> action.
+-- | The input for the 'DescribeDeliveryChannels' action.
+--
+--
--
-- /See:/ 'describeDeliveryChannels' smart constructor.
newtype DescribeDeliveryChannels = DescribeDeliveryChannels'
@@ -55,7 +57,7 @@ newtype DescribeDeliveryChannels = DescribeDeliveryChannels'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ddcDeliveryChannelNames'
+-- * 'ddcDeliveryChannelNames' - A list of delivery channel names.
describeDeliveryChannels
:: DescribeDeliveryChannels
describeDeliveryChannels =
@@ -105,7 +107,9 @@ instance ToPath DescribeDeliveryChannels where
instance ToQuery DescribeDeliveryChannels where
toQuery = const mempty
--- | The output for the < DescribeDeliveryChannels> action.
+-- | The output for the 'DescribeDeliveryChannels' action.
+--
+--
--
-- /See:/ 'describeDeliveryChannelsResponse' smart constructor.
data DescribeDeliveryChannelsResponse = DescribeDeliveryChannelsResponse'
@@ -117,9 +121,9 @@ data DescribeDeliveryChannelsResponse = DescribeDeliveryChannelsResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ddcrsDeliveryChannels'
+-- * 'ddcrsDeliveryChannels' - A list that contains the descriptions of the specified delivery channel.
--
--- * 'ddcrsResponseStatus'
+-- * 'ddcrsResponseStatus' - -- | The response status code.
describeDeliveryChannelsResponse
:: Int -- ^ 'ddcrsResponseStatus'
-> DescribeDeliveryChannelsResponse
@@ -133,7 +137,7 @@ describeDeliveryChannelsResponse pResponseStatus_ =
ddcrsDeliveryChannels :: Lens' DescribeDeliveryChannelsResponse [DeliveryChannel]
ddcrsDeliveryChannels = lens _ddcrsDeliveryChannels (\ s a -> s{_ddcrsDeliveryChannels = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
ddcrsResponseStatus :: Lens' DescribeDeliveryChannelsResponse Int
ddcrsResponseStatus = lens _ddcrsResponseStatus (\ s a -> s{_ddcrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/GetComplianceDetailsByConfigRule.hs b/gen/Network/AWS/Config/GetComplianceDetailsByConfigRule.hs
index e5acf41..e3f137e 100644
--- a/gen/Network/AWS/Config/GetComplianceDetailsByConfigRule.hs
+++ b/gen/Network/AWS/Config/GetComplianceDetailsByConfigRule.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.
+--
+--
module Network.AWS.Config.GetComplianceDetailsByConfigRule
(
-- * Creating a Request
@@ -46,7 +48,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'getComplianceDetailsByConfigRule' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'getComplianceDetailsByConfigRule' smart constructor.
data GetComplianceDetailsByConfigRule = GetComplianceDetailsByConfigRule'
{ _gcdbcrComplianceTypes :: !(Maybe [ComplianceType])
, _gcdbcrNextToken :: !(Maybe Text)
@@ -58,13 +64,13 @@ data GetComplianceDetailsByConfigRule = GetComplianceDetailsByConfigRule'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gcdbcrComplianceTypes'
+-- * 'gcdbcrComplianceTypes' - Filters the results by compliance. The allowed values are @COMPLIANT@ , @NON_COMPLIANT@ , and @NOT_APPLICABLE@ .
--
--- * 'gcdbcrNextToken'
+-- * 'gcdbcrNextToken' - The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
--
--- * 'gcdbcrLimit'
+-- * 'gcdbcrLimit' - The maximum number of evaluation results returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.
--
--- * 'gcdbcrConfigRuleName'
+-- * 'gcdbcrConfigRuleName' - The name of the AWS Config rule for which you want compliance information.
getComplianceDetailsByConfigRule
:: Text -- ^ 'gcdbcrConfigRuleName'
-> GetComplianceDetailsByConfigRule
@@ -76,13 +82,11 @@ getComplianceDetailsByConfigRule pConfigRuleName_ =
, _gcdbcrConfigRuleName = pConfigRuleName_
}
--- | Filters the results by compliance.
---
--- The allowed values are 'COMPLIANT', 'NON_COMPLIANT', and 'NOT_APPLICABLE'.
+-- | Filters the results by compliance. The allowed values are @COMPLIANT@ , @NON_COMPLIANT@ , and @NOT_APPLICABLE@ .
gcdbcrComplianceTypes :: Lens' GetComplianceDetailsByConfigRule [ComplianceType]
gcdbcrComplianceTypes = lens _gcdbcrComplianceTypes (\ s a -> s{_gcdbcrComplianceTypes = a}) . _Default . _Coerce;
--- | The 'nextToken' string returned on a previous page that you use to get the next page of results in a paginated response.
+-- | The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
gcdbcrNextToken :: Lens' GetComplianceDetailsByConfigRule (Maybe Text)
gcdbcrNextToken = lens _gcdbcrNextToken (\ s a -> s{_gcdbcrNextToken = a});
@@ -140,7 +144,11 @@ instance ToQuery GetComplianceDetailsByConfigRule
where
toQuery = const mempty
--- | /See:/ 'getComplianceDetailsByConfigRuleResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'getComplianceDetailsByConfigRuleResponse' smart constructor.
data GetComplianceDetailsByConfigRuleResponse = GetComplianceDetailsByConfigRuleResponse'
{ _gcdbcrrsEvaluationResults :: !(Maybe [EvaluationResult])
, _gcdbcrrsNextToken :: !(Maybe Text)
@@ -151,11 +159,11 @@ data GetComplianceDetailsByConfigRuleResponse = GetComplianceDetailsByConfigRule
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gcdbcrrsEvaluationResults'
+-- * 'gcdbcrrsEvaluationResults' - Indicates whether the AWS resource complies with the specified AWS Config rule.
--
--- * 'gcdbcrrsNextToken'
+-- * 'gcdbcrrsNextToken' - The string that you use in a subsequent request to get the next page of results in a paginated response.
--
--- * 'gcdbcrrsResponseStatus'
+-- * 'gcdbcrrsResponseStatus' - -- | The response status code.
getComplianceDetailsByConfigRuleResponse
:: Int -- ^ 'gcdbcrrsResponseStatus'
-> GetComplianceDetailsByConfigRuleResponse
@@ -174,7 +182,7 @@ gcdbcrrsEvaluationResults = lens _gcdbcrrsEvaluationResults (\ s a -> s{_gcdbcrr
gcdbcrrsNextToken :: Lens' GetComplianceDetailsByConfigRuleResponse (Maybe Text)
gcdbcrrsNextToken = lens _gcdbcrrsNextToken (\ s a -> s{_gcdbcrrsNextToken = a});
--- | The response status code.
+-- | -- | The response status code.
gcdbcrrsResponseStatus :: Lens' GetComplianceDetailsByConfigRuleResponse Int
gcdbcrrsResponseStatus = lens _gcdbcrrsResponseStatus (\ s a -> s{_gcdbcrrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/GetComplianceDetailsByResource.hs b/gen/Network/AWS/Config/GetComplianceDetailsByResource.hs
index bf7b63b..18b936b 100644
--- a/gen/Network/AWS/Config/GetComplianceDetailsByResource.hs
+++ b/gen/Network/AWS/Config/GetComplianceDetailsByResource.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.
+--
+--
module Network.AWS.Config.GetComplianceDetailsByResource
(
-- * Creating a Request
@@ -46,7 +48,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'getComplianceDetailsByResource' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'getComplianceDetailsByResource' smart constructor.
data GetComplianceDetailsByResource = GetComplianceDetailsByResource'
{ _gcdbrComplianceTypes :: !(Maybe [ComplianceType])
, _gcdbrNextToken :: !(Maybe Text)
@@ -58,13 +64,13 @@ data GetComplianceDetailsByResource = GetComplianceDetailsByResource'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gcdbrComplianceTypes'
+-- * 'gcdbrComplianceTypes' - Filters the results by compliance. The allowed values are @COMPLIANT@ , @NON_COMPLIANT@ , and @NOT_APPLICABLE@ .
--
--- * 'gcdbrNextToken'
+-- * 'gcdbrNextToken' - The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
--
--- * 'gcdbrResourceType'
+-- * 'gcdbrResourceType' - The type of the AWS resource for which you want compliance information.
--
--- * 'gcdbrResourceId'
+-- * 'gcdbrResourceId' - The ID of the AWS resource for which you want compliance information.
getComplianceDetailsByResource
:: Text -- ^ 'gcdbrResourceType'
-> Text -- ^ 'gcdbrResourceId'
@@ -77,13 +83,11 @@ getComplianceDetailsByResource pResourceType_ pResourceId_ =
, _gcdbrResourceId = pResourceId_
}
--- | Filters the results by compliance.
---
--- The allowed values are 'COMPLIANT', 'NON_COMPLIANT', and 'NOT_APPLICABLE'.
+-- | Filters the results by compliance. The allowed values are @COMPLIANT@ , @NON_COMPLIANT@ , and @NOT_APPLICABLE@ .
gcdbrComplianceTypes :: Lens' GetComplianceDetailsByResource [ComplianceType]
gcdbrComplianceTypes = lens _gcdbrComplianceTypes (\ s a -> s{_gcdbrComplianceTypes = a}) . _Default . _Coerce;
--- | The 'nextToken' string returned on a previous page that you use to get the next page of results in a paginated response.
+-- | The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
gcdbrNextToken :: Lens' GetComplianceDetailsByResource (Maybe Text)
gcdbrNextToken = lens _gcdbrNextToken (\ s a -> s{_gcdbrNextToken = a});
@@ -138,7 +142,11 @@ instance ToPath GetComplianceDetailsByResource where
instance ToQuery GetComplianceDetailsByResource where
toQuery = const mempty
--- | /See:/ 'getComplianceDetailsByResourceResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'getComplianceDetailsByResourceResponse' smart constructor.
data GetComplianceDetailsByResourceResponse = GetComplianceDetailsByResourceResponse'
{ _gcdbrrsEvaluationResults :: !(Maybe [EvaluationResult])
, _gcdbrrsNextToken :: !(Maybe Text)
@@ -149,11 +157,11 @@ data GetComplianceDetailsByResourceResponse = GetComplianceDetailsByResourceResp
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gcdbrrsEvaluationResults'
+-- * 'gcdbrrsEvaluationResults' - Indicates whether the specified AWS resource complies each AWS Config rule.
--
--- * 'gcdbrrsNextToken'
+-- * 'gcdbrrsNextToken' - The string that you use in a subsequent request to get the next page of results in a paginated response.
--
--- * 'gcdbrrsResponseStatus'
+-- * 'gcdbrrsResponseStatus' - -- | The response status code.
getComplianceDetailsByResourceResponse
:: Int -- ^ 'gcdbrrsResponseStatus'
-> GetComplianceDetailsByResourceResponse
@@ -172,7 +180,7 @@ gcdbrrsEvaluationResults = lens _gcdbrrsEvaluationResults (\ s a -> s{_gcdbrrsEv
gcdbrrsNextToken :: Lens' GetComplianceDetailsByResourceResponse (Maybe Text)
gcdbrrsNextToken = lens _gcdbrrsNextToken (\ s a -> s{_gcdbrrsNextToken = a});
--- | The response status code.
+-- | -- | The response status code.
gcdbrrsResponseStatus :: Lens' GetComplianceDetailsByResourceResponse Int
gcdbrrsResponseStatus = lens _gcdbrrsResponseStatus (\ s a -> s{_gcdbrrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/GetComplianceSummaryByConfigRule.hs b/gen/Network/AWS/Config/GetComplianceSummaryByConfigRule.hs
index ae6559e..819e979 100644
--- a/gen/Network/AWS/Config/GetComplianceSummaryByConfigRule.hs
+++ b/gen/Network/AWS/Config/GetComplianceSummaryByConfigRule.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Returns the number of AWS Config rules that are compliant and noncompliant, up to a maximum of 25 for each.
+--
+--
module Network.AWS.Config.GetComplianceSummaryByConfigRule
(
-- * Creating a Request
@@ -89,7 +91,11 @@ instance ToQuery GetComplianceSummaryByConfigRule
where
toQuery = const mempty
--- | /See:/ 'getComplianceSummaryByConfigRuleResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'getComplianceSummaryByConfigRuleResponse' smart constructor.
data GetComplianceSummaryByConfigRuleResponse = GetComplianceSummaryByConfigRuleResponse'
{ _gcsbcrrsComplianceSummary :: !(Maybe ComplianceSummary)
, _gcsbcrrsResponseStatus :: !Int
@@ -99,9 +105,9 @@ data GetComplianceSummaryByConfigRuleResponse = GetComplianceSummaryByConfigRule
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gcsbcrrsComplianceSummary'
+-- * 'gcsbcrrsComplianceSummary' - The number of AWS Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.
--
--- * 'gcsbcrrsResponseStatus'
+-- * 'gcsbcrrsResponseStatus' - -- | The response status code.
getComplianceSummaryByConfigRuleResponse
:: Int -- ^ 'gcsbcrrsResponseStatus'
-> GetComplianceSummaryByConfigRuleResponse
@@ -115,7 +121,7 @@ getComplianceSummaryByConfigRuleResponse pResponseStatus_ =
gcsbcrrsComplianceSummary :: Lens' GetComplianceSummaryByConfigRuleResponse (Maybe ComplianceSummary)
gcsbcrrsComplianceSummary = lens _gcsbcrrsComplianceSummary (\ s a -> s{_gcsbcrrsComplianceSummary = a});
--- | The response status code.
+-- | -- | The response status code.
gcsbcrrsResponseStatus :: Lens' GetComplianceSummaryByConfigRuleResponse Int
gcsbcrrsResponseStatus = lens _gcsbcrrsResponseStatus (\ s a -> s{_gcsbcrrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/GetComplianceSummaryByResourceType.hs b/gen/Network/AWS/Config/GetComplianceSummaryByResourceType.hs
index eba4585..a26e396 100644
--- a/gen/Network/AWS/Config/GetComplianceSummaryByResourceType.hs
+++ b/gen/Network/AWS/Config/GetComplianceSummaryByResourceType.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.
+--
+--
module Network.AWS.Config.GetComplianceSummaryByResourceType
(
-- * Creating a Request
@@ -42,7 +44,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'getComplianceSummaryByResourceType' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'getComplianceSummaryByResourceType' smart constructor.
newtype GetComplianceSummaryByResourceType = GetComplianceSummaryByResourceType'
{ _gcsbrtResourceTypes :: Maybe [Text]
} deriving (Eq,Read,Show,Data,Typeable,Generic)
@@ -51,7 +57,7 @@ newtype GetComplianceSummaryByResourceType = GetComplianceSummaryByResourceType'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gcsbrtResourceTypes'
+-- * 'gcsbrtResourceTypes' - Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type. For this request, you can specify an AWS resource type such as @AWS::EC2::Instance@ , and you can specify that the resource type is an AWS account by specifying @AWS::::Account@ .
getComplianceSummaryByResourceType
:: GetComplianceSummaryByResourceType
getComplianceSummaryByResourceType =
@@ -59,9 +65,7 @@ getComplianceSummaryByResourceType =
{ _gcsbrtResourceTypes = Nothing
}
--- | Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type.
---
--- For this request, you can specify an AWS resource type such as 'AWS::EC2::Instance', and you can specify that the resource type is an AWS account by specifying 'AWS::::Account'.
+-- | Specify one or more resource types to get the number of resources that are compliant and the number that are noncompliant for each resource type. For this request, you can specify an AWS resource type such as @AWS::EC2::Instance@ , and you can specify that the resource type is an AWS account by specifying @AWS::::Account@ .
gcsbrtResourceTypes :: Lens' GetComplianceSummaryByResourceType [Text]
gcsbrtResourceTypes = lens _gcsbrtResourceTypes (\ s a -> s{_gcsbrtResourceTypes = a}) . _Default . _Coerce;
@@ -108,7 +112,11 @@ instance ToQuery GetComplianceSummaryByResourceType
where
toQuery = const mempty
--- | /See:/ 'getComplianceSummaryByResourceTypeResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'getComplianceSummaryByResourceTypeResponse' smart constructor.
data GetComplianceSummaryByResourceTypeResponse = GetComplianceSummaryByResourceTypeResponse'
{ _gcsbrtrsComplianceSummariesByResourceType :: !(Maybe [ComplianceSummaryByResourceType])
, _gcsbrtrsResponseStatus :: !Int
@@ -118,9 +126,9 @@ data GetComplianceSummaryByResourceTypeResponse = GetComplianceSummaryByResource
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'gcsbrtrsComplianceSummariesByResourceType'
+-- * 'gcsbrtrsComplianceSummariesByResourceType' - The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.
--
--- * 'gcsbrtrsResponseStatus'
+-- * 'gcsbrtrsResponseStatus' - -- | The response status code.
getComplianceSummaryByResourceTypeResponse
:: Int -- ^ 'gcsbrtrsResponseStatus'
-> GetComplianceSummaryByResourceTypeResponse
@@ -134,7 +142,7 @@ getComplianceSummaryByResourceTypeResponse pResponseStatus_ =
gcsbrtrsComplianceSummariesByResourceType :: Lens' GetComplianceSummaryByResourceTypeResponse [ComplianceSummaryByResourceType]
gcsbrtrsComplianceSummariesByResourceType = lens _gcsbrtrsComplianceSummariesByResourceType (\ s a -> s{_gcsbrtrsComplianceSummariesByResourceType = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
gcsbrtrsResponseStatus :: Lens' GetComplianceSummaryByResourceTypeResponse Int
gcsbrtrsResponseStatus = lens _gcsbrtrsResponseStatus (\ s a -> s{_gcsbrtrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/GetResourceConfigHistory.hs b/gen/Network/AWS/Config/GetResourceConfigHistory.hs
index 8cd19b8..9033bae 100644
--- a/gen/Network/AWS/Config/GetResourceConfigHistory.hs
+++ b/gen/Network/AWS/Config/GetResourceConfigHistory.hs
@@ -20,9 +20,9 @@
--
-- Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval.
--
--- The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the 'limit' parameter. The response includes a 'nextToken' string, and to get the next page of results, run the request again and enter this string for the 'nextToken' parameter.
--
--- Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified 'limit'. In such cases, you can make another call, using the 'nextToken'.
+-- The response is paginated, and by default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the @limit@ parameter. The response includes a @nextToken@ string, and to get the next page of results, run the request again and enter this string for the @nextToken@ parameter.
+--
module Network.AWS.Config.GetResourceConfigHistory
(
-- * Creating a Request
@@ -53,7 +53,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < GetResourceConfigHistory> action.
+-- | The input for the 'GetResourceConfigHistory' action.
+--
+--
--
-- /See:/ 'getResourceConfigHistory' smart constructor.
data GetResourceConfigHistory = GetResourceConfigHistory'
@@ -70,19 +72,19 @@ data GetResourceConfigHistory = GetResourceConfigHistory'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'grchChronologicalOrder'
+-- * 'grchChronologicalOrder' - The chronological order for configuration items listed. By default the results are listed in reverse chronological order.
--
--- * 'grchNextToken'
+-- * 'grchNextToken' - The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
--
--- * 'grchLimit'
+-- * 'grchLimit' - The maximum number of configuration items returned on each page. The default is 10. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.
--
--- * 'grchLaterTime'
+-- * 'grchLaterTime' - The time stamp that indicates a later time. If not specified, current time is taken.
--
--- * 'grchEarlierTime'
+-- * 'grchEarlierTime' - The time stamp that indicates an earlier time. If not specified, the action returns paginated results that contain configuration items that start from when the first configuration item was recorded.
--
--- * 'grchResourceType'
+-- * 'grchResourceType' - The resource type.
--
--- * 'grchResourceId'
+-- * 'grchResourceId' - The ID of the resource (for example., @sg-xxxxxx@ ).
getResourceConfigHistory
:: ResourceType -- ^ 'grchResourceType'
-> Text -- ^ 'grchResourceId'
@@ -102,7 +104,7 @@ getResourceConfigHistory pResourceType_ pResourceId_ =
grchChronologicalOrder :: Lens' GetResourceConfigHistory (Maybe ChronologicalOrder)
grchChronologicalOrder = lens _grchChronologicalOrder (\ s a -> s{_grchChronologicalOrder = a});
--- | The 'nextToken' string returned on a previous page that you use to get the next page of results in a paginated response.
+-- | The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
grchNextToken :: Lens' GetResourceConfigHistory (Maybe Text)
grchNextToken = lens _grchNextToken (\ s a -> s{_grchNextToken = a});
@@ -122,7 +124,7 @@ grchEarlierTime = lens _grchEarlierTime (\ s a -> s{_grchEarlierTime = a}) . map
grchResourceType :: Lens' GetResourceConfigHistory ResourceType
grchResourceType = lens _grchResourceType (\ s a -> s{_grchResourceType = a});
--- | The ID of the resource (for example., 'sg-xxxxxx').
+-- | The ID of the resource (for example., @sg-xxxxxx@ ).
grchResourceId :: Lens' GetResourceConfigHistory Text
grchResourceId = lens _grchResourceId (\ s a -> s{_grchResourceId = a});
@@ -171,7 +173,9 @@ instance ToPath GetResourceConfigHistory where
instance ToQuery GetResourceConfigHistory where
toQuery = const mempty
--- | The output for the < GetResourceConfigHistory> action.
+-- | The output for the 'GetResourceConfigHistory' action.
+--
+--
--
-- /See:/ 'getResourceConfigHistoryResponse' smart constructor.
data GetResourceConfigHistoryResponse = GetResourceConfigHistoryResponse'
@@ -184,11 +188,11 @@ data GetResourceConfigHistoryResponse = GetResourceConfigHistoryResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'grchrsNextToken'
+-- * 'grchrsNextToken' - The string that you use in a subsequent request to get the next page of results in a paginated response.
--
--- * 'grchrsConfigurationItems'
+-- * 'grchrsConfigurationItems' - A list that contains the configuration history of one or more resources.
--
--- * 'grchrsResponseStatus'
+-- * 'grchrsResponseStatus' - -- | The response status code.
getResourceConfigHistoryResponse
:: Int -- ^ 'grchrsResponseStatus'
-> GetResourceConfigHistoryResponse
@@ -207,7 +211,7 @@ grchrsNextToken = lens _grchrsNextToken (\ s a -> s{_grchrsNextToken = a});
grchrsConfigurationItems :: Lens' GetResourceConfigHistoryResponse [ConfigurationItem]
grchrsConfigurationItems = lens _grchrsConfigurationItems (\ s a -> s{_grchrsConfigurationItems = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
grchrsResponseStatus :: Lens' GetResourceConfigHistoryResponse Int
grchrsResponseStatus = lens _grchrsResponseStatus (\ s a -> s{_grchrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/ListDiscoveredResources.hs b/gen/Network/AWS/Config/ListDiscoveredResources.hs
index af6e908..1a791d5 100644
--- a/gen/Network/AWS/Config/ListDiscoveredResources.hs
+++ b/gen/Network/AWS/Config/ListDiscoveredResources.hs
@@ -20,9 +20,9 @@
--
-- Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name.
--
--- You can specify either resource IDs or a resource name but not both in the same request.
--
--- The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the 'limit' parameter. The response includes a 'nextToken' string, and to get the next page of results, run the request again and enter this string for the 'nextToken' parameter.
+-- The response is paginated, and by default AWS Config lists 100 resource identifiers on each page. You can customize this number with the @limit@ parameter. The response includes a @nextToken@ string, and to get the next page of results, run the request again and enter this string for the @nextToken@ parameter.
+--
module Network.AWS.Config.ListDiscoveredResources
(
-- * Creating a Request
@@ -52,7 +52,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'listDiscoveredResources' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'listDiscoveredResources' smart constructor.
data ListDiscoveredResources = ListDiscoveredResources'
{ _ldrResourceIds :: !(Maybe [Text])
, _ldrResourceName :: !(Maybe Text)
@@ -66,17 +70,17 @@ data ListDiscoveredResources = ListDiscoveredResources'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ldrResourceIds'
+-- * 'ldrResourceIds' - The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.
--
--- * 'ldrResourceName'
+-- * 'ldrResourceName' - The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.
--
--- * 'ldrIncludeDeletedResources'
+-- * 'ldrIncludeDeletedResources' - Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.
--
--- * 'ldrNextToken'
+-- * 'ldrNextToken' - The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
--
--- * 'ldrLimit'
+-- * 'ldrLimit' - The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a limit greater than 100. If you specify 0, AWS Config uses the default.
--
--- * 'ldrResourceType'
+-- * 'ldrResourceType' - The type of resources that you want AWS Config to list in the response.
listDiscoveredResources
:: ResourceType -- ^ 'ldrResourceType'
-> ListDiscoveredResources
@@ -102,7 +106,7 @@ ldrResourceName = lens _ldrResourceName (\ s a -> s{_ldrResourceName = a});
ldrIncludeDeletedResources :: Lens' ListDiscoveredResources (Maybe Bool)
ldrIncludeDeletedResources = lens _ldrIncludeDeletedResources (\ s a -> s{_ldrIncludeDeletedResources = a});
--- | The 'nextToken' string returned on a previous page that you use to get the next page of results in a paginated response.
+-- | The @nextToken@ string returned on a previous page that you use to get the next page of results in a paginated response.
ldrNextToken :: Lens' ListDiscoveredResources (Maybe Text)
ldrNextToken = lens _ldrNextToken (\ s a -> s{_ldrNextToken = a});
@@ -158,7 +162,11 @@ instance ToPath ListDiscoveredResources where
instance ToQuery ListDiscoveredResources where
toQuery = const mempty
--- | /See:/ 'listDiscoveredResourcesResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'listDiscoveredResourcesResponse' smart constructor.
data ListDiscoveredResourcesResponse = ListDiscoveredResourcesResponse'
{ _ldrrsNextToken :: !(Maybe Text)
, _ldrrsResourceIdentifiers :: !(Maybe [ResourceIdentifier])
@@ -169,11 +177,11 @@ data ListDiscoveredResourcesResponse = ListDiscoveredResourcesResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ldrrsNextToken'
+-- * 'ldrrsNextToken' - The string that you use in a subsequent request to get the next page of results in a paginated response.
--
--- * 'ldrrsResourceIdentifiers'
+-- * 'ldrrsResourceIdentifiers' - The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name.
--
--- * 'ldrrsResponseStatus'
+-- * 'ldrrsResponseStatus' - -- | The response status code.
listDiscoveredResourcesResponse
:: Int -- ^ 'ldrrsResponseStatus'
-> ListDiscoveredResourcesResponse
@@ -192,7 +200,7 @@ ldrrsNextToken = lens _ldrrsNextToken (\ s a -> s{_ldrrsNextToken = a});
ldrrsResourceIdentifiers :: Lens' ListDiscoveredResourcesResponse [ResourceIdentifier]
ldrrsResourceIdentifiers = lens _ldrrsResourceIdentifiers (\ s a -> s{_ldrrsResourceIdentifiers = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
ldrrsResponseStatus :: Lens' ListDiscoveredResourcesResponse Int
ldrrsResponseStatus = lens _ldrrsResponseStatus (\ s a -> s{_ldrrsResponseStatus = a});
diff --git a/gen/Network/AWS/Config/PutConfigRule.hs b/gen/Network/AWS/Config/PutConfigRule.hs
index d6919f1..1d3eb5f 100644
--- a/gen/Network/AWS/Config/PutConfigRule.hs
+++ b/gen/Network/AWS/Config/PutConfigRule.hs
@@ -20,19 +20,20 @@
--
-- Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations.
--
+--
-- You can use this action for custom Config rules and AWS managed Config rules. A custom Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides.
--
--- If you are adding a new custom Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the 'PutConfigRule' action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the 'SourceIdentifier' key. This key is part of the 'Source' object, which is part of the 'ConfigRule' object.
+-- If you are adding a new custom Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the @PutConfigRule@ action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the @SourceIdentifier@ key. This key is part of the @Source@ object, which is part of the @ConfigRule@ object.
--
--- If you are adding a new AWS managed Config rule, specify the rule\'s identifier for the 'SourceIdentifier' key. To reference AWS managed Config rule identifiers, see <http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html Using AWS Managed Config Rules>.
+-- If you are adding a new AWS managed Config rule, specify the rule's identifier for the @SourceIdentifier@ key. To reference AWS managed Config rule identifiers, see <http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html Using AWS Managed Config Rules> .
--
--- For any new rule that you add, specify the 'ConfigRuleName' in the 'ConfigRule' object. Do not specify the 'ConfigRuleArn' or the 'ConfigRuleId'. These values are generated by AWS Config for new rules.
+-- For any new rule that you add, specify the @ConfigRuleName@ in the @ConfigRule@ object. Do not specify the @ConfigRuleArn@ or the @ConfigRuleId@ . These values are generated by AWS Config for new rules.
--
--- If you are updating a rule that you have added previously, specify the rule\'s 'ConfigRuleName', 'ConfigRuleId', or 'ConfigRuleArn' in the 'ConfigRule' data type that you use in this request.
+-- If you are updating a rule that you added previously, you can specify the rule by @ConfigRuleName@ , @ConfigRuleId@ , or @ConfigRuleArn@ in the @ConfigRule@ data type that you use in this request.
--
-- The maximum number of rules that AWS Config supports is 25.
--
--- For more information about developing and using AWS Config rules, see <http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html Evaluating AWS Resource Configurations with AWS Config> in the /AWS Config Developer Guide/.
+-- For more information about developing and using AWS Config rules, see <http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html Evaluating AWS Resource Configurations with AWS Config> in the /AWS Config Developer Guide/ .
--
module Network.AWS.Config.PutConfigRule
(
@@ -54,7 +55,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'putConfigRule' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'putConfigRule' smart constructor.
newtype PutConfigRule = PutConfigRule'
{ _pcrConfigRule :: ConfigRule
} deriving (Eq,Read,Show,Data,Typeable,Generic)
@@ -63,7 +68,7 @@ newtype PutConfigRule = PutConfigRule'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'pcrConfigRule'
+-- * 'pcrConfigRule' - Undocumented member.
putConfigRule
:: ConfigRule -- ^ 'pcrConfigRule'
-> PutConfigRule
diff --git a/gen/Network/AWS/Config/PutConfigurationRecorder.hs b/gen/Network/AWS/Config/PutConfigurationRecorder.hs
index 2a61a32..53b8441 100644
--- a/gen/Network/AWS/Config/PutConfigurationRecorder.hs
+++ b/gen/Network/AWS/Config/PutConfigurationRecorder.hs
@@ -20,11 +20,9 @@
--
-- Creates a new configuration recorder to record the selected resource configurations.
--
--- You can use this action to change the role 'roleARN' and\/or the 'recordingGroup' of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.
--
--- Currently, you can specify only one configuration recorder per account.
+-- You can use this action to change the role @roleARN@ and/or the @recordingGroup@ of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role.
--
--- If 'ConfigurationRecorder' does not have the __recordingGroup__ parameter specified, the default is to record all supported resource types.
module Network.AWS.Config.PutConfigurationRecorder
(
-- * Creating a Request
@@ -45,7 +43,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < PutConfigurationRecorder> action.
+-- | The input for the 'PutConfigurationRecorder' action.
+--
+--
--
-- /See:/ 'putConfigurationRecorder' smart constructor.
newtype PutConfigurationRecorder = PutConfigurationRecorder'
@@ -56,7 +56,7 @@ newtype PutConfigurationRecorder = PutConfigurationRecorder'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'pcrConfigurationRecorder'
+-- * 'pcrConfigurationRecorder' - The configuration recorder object that records each configuration change made to the resources.
putConfigurationRecorder
:: ConfigurationRecorder -- ^ 'pcrConfigurationRecorder'
-> PutConfigurationRecorder
diff --git a/gen/Network/AWS/Config/PutDeliveryChannel.hs b/gen/Network/AWS/Config/PutDeliveryChannel.hs
index 2008a6e..a079c06 100644
--- a/gen/Network/AWS/Config/PutDeliveryChannel.hs
+++ b/gen/Network/AWS/Config/PutDeliveryChannel.hs
@@ -20,11 +20,11 @@
--
-- Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic.
--
+--
-- Before you can create a delivery channel, you must create a configuration recorder.
--
-- You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed.
--
--- You can have only one delivery channel per AWS account.
module Network.AWS.Config.PutDeliveryChannel
(
-- * Creating a Request
@@ -45,7 +45,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < PutDeliveryChannel> action.
+-- | The input for the 'PutDeliveryChannel' action.
+--
+--
--
-- /See:/ 'putDeliveryChannel' smart constructor.
newtype PutDeliveryChannel = PutDeliveryChannel'
@@ -56,7 +58,7 @@ newtype PutDeliveryChannel = PutDeliveryChannel'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'pdcDeliveryChannel'
+-- * 'pdcDeliveryChannel' - The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket, and to an Amazon SNS topic.
putDeliveryChannel
:: DeliveryChannel -- ^ 'pdcDeliveryChannel'
-> PutDeliveryChannel
diff --git a/gen/Network/AWS/Config/PutEvaluations.hs b/gen/Network/AWS/Config/PutEvaluations.hs
index ac3fb27..6a4faf2 100644
--- a/gen/Network/AWS/Config/PutEvaluations.hs
+++ b/gen/Network/AWS/Config/PutEvaluations.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.
+--
+--
module Network.AWS.Config.PutEvaluations
(
-- * Creating a Request
@@ -43,7 +45,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'putEvaluations' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'putEvaluations' smart constructor.
data PutEvaluations = PutEvaluations'
{ _peEvaluations :: !(Maybe [Evaluation])
, _peResultToken :: !Text
@@ -53,9 +59,9 @@ data PutEvaluations = PutEvaluations'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'peEvaluations'
+-- * 'peEvaluations' - The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.
--
--- * 'peResultToken'
+-- * 'peResultToken' - An encrypted token that associates an evaluation with an AWS Config rule. Identifies the rule and the event that triggered the evaluation
putEvaluations
:: Text -- ^ 'peResultToken'
-> PutEvaluations
@@ -109,7 +115,11 @@ instance ToPath PutEvaluations where
instance ToQuery PutEvaluations where
toQuery = const mempty
--- | /See:/ 'putEvaluationsResponse' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'putEvaluationsResponse' smart constructor.
data PutEvaluationsResponse = PutEvaluationsResponse'
{ _persFailedEvaluations :: !(Maybe [Evaluation])
, _persResponseStatus :: !Int
@@ -119,9 +129,9 @@ data PutEvaluationsResponse = PutEvaluationsResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'persFailedEvaluations'
+-- * 'persFailedEvaluations' - Requests that failed because of a client or server error.
--
--- * 'persResponseStatus'
+-- * 'persResponseStatus' - -- | The response status code.
putEvaluationsResponse
:: Int -- ^ 'persResponseStatus'
-> PutEvaluationsResponse
@@ -135,7 +145,7 @@ putEvaluationsResponse pResponseStatus_ =
persFailedEvaluations :: Lens' PutEvaluationsResponse [Evaluation]
persFailedEvaluations = lens _persFailedEvaluations (\ s a -> s{_persFailedEvaluations = a}) . _Default . _Coerce;
--- | The response status code.
+-- | -- | The response status code.
persResponseStatus :: Lens' PutEvaluationsResponse Int
persResponseStatus = lens _persResponseStatus (\ s a -> s{_persResponseStatus = a});
diff --git a/gen/Network/AWS/Config/StartConfigRulesEvaluation.hs b/gen/Network/AWS/Config/StartConfigRulesEvaluation.hs
index 467f4e4..5a98319 100644
--- a/gen/Network/AWS/Config/StartConfigRulesEvaluation.hs
+++ b/gen/Network/AWS/Config/StartConfigRulesEvaluation.hs
@@ -20,21 +20,22 @@
--
-- Evaluates your resources against the specified Config rules. You can specify up to 25 Config rules per request.
--
--- An existing < StartConfigRulesEvaluation> call must complete for the specified rules before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a 'ConfigRuleEvaluationStarted' notification when the evaluation starts.
--
--- You don\'t need to call the 'StartConfigRulesEvaluation' API to run an evaluation for a new rule. When you create a new rule, AWS Config automatically evaluates your resources against the rule.
+-- An existing 'StartConfigRulesEvaluation' call must complete for the specified rules before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a @ConfigRuleEvaluationStarted@ notification when the evaluation starts.
--
--- The 'StartConfigRulesEvaluation' API is useful if you want to run on-demand evaluations, such as the following example:
+-- 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.
+-- * 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.
+-- * 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.
+-- * Instead of waiting for the next periodic evaluation, you call the @StartConfigRulesEvaluation@ API.
+--
+-- * AWS Config invokes your Lambda function and evaluates your IAM resources.
+--
+-- * Your custom rule will still run periodic evaluations every 24 hours.
--
--- 4. AWS Config invokes your Lambda function and evaluates your IAM resources.
--
--- 5. Your custom rule will still run periodic evaluations every 24 hours.
--
module Network.AWS.Config.StartConfigRulesEvaluation
(
@@ -58,7 +59,11 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | /See:/ 'startConfigRulesEvaluation' smart constructor.
+-- |
+--
+--
+--
+-- /See:/ 'startConfigRulesEvaluation' smart constructor.
newtype StartConfigRulesEvaluation = StartConfigRulesEvaluation'
{ _screConfigRuleNames :: Maybe (List1 Text)
} deriving (Eq,Read,Show,Data,Typeable,Generic)
@@ -67,7 +72,7 @@ newtype StartConfigRulesEvaluation = StartConfigRulesEvaluation'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'screConfigRuleNames'
+-- * 'screConfigRuleNames' - The list of names of Config rules that you want to run evaluations for.
startConfigRulesEvaluation
:: StartConfigRulesEvaluation
startConfigRulesEvaluation =
@@ -117,6 +122,8 @@ instance ToQuery StartConfigRulesEvaluation where
-- | The output when you start the evaluation for the specified Config rule.
--
+--
+--
-- /See:/ 'startConfigRulesEvaluationResponse' smart constructor.
newtype StartConfigRulesEvaluationResponse = StartConfigRulesEvaluationResponse'
{ _scrersResponseStatus :: Int
@@ -126,7 +133,7 @@ newtype StartConfigRulesEvaluationResponse = StartConfigRulesEvaluationResponse'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'scrersResponseStatus'
+-- * 'scrersResponseStatus' - -- | The response status code.
startConfigRulesEvaluationResponse
:: Int -- ^ 'scrersResponseStatus'
-> StartConfigRulesEvaluationResponse
@@ -135,7 +142,7 @@ startConfigRulesEvaluationResponse pResponseStatus_ =
{ _scrersResponseStatus = pResponseStatus_
}
--- | The response status code.
+-- | -- | The response status code.
scrersResponseStatus :: Lens' StartConfigRulesEvaluationResponse Int
scrersResponseStatus = lens _scrersResponseStatus (\ s a -> s{_scrersResponseStatus = a});
diff --git a/gen/Network/AWS/Config/StartConfigurationRecorder.hs b/gen/Network/AWS/Config/StartConfigurationRecorder.hs
index 1e72236..f4c06a1 100644
--- a/gen/Network/AWS/Config/StartConfigurationRecorder.hs
+++ b/gen/Network/AWS/Config/StartConfigurationRecorder.hs
@@ -20,7 +20,9 @@
--
-- Starts recording configurations of the AWS resources you have selected to record in your AWS account.
--
+--
-- You must have created at least one delivery channel to successfully start the configuration recorder.
+--
module Network.AWS.Config.StartConfigurationRecorder
(
-- * Creating a Request
@@ -41,7 +43,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < StartConfigurationRecorder> action.
+-- | The input for the 'StartConfigurationRecorder' action.
+--
+--
--
-- /See:/ 'startConfigurationRecorder' smart constructor.
newtype StartConfigurationRecorder = StartConfigurationRecorder'
@@ -52,7 +56,7 @@ newtype StartConfigurationRecorder = StartConfigurationRecorder'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'sConfigurationRecorderName'
+-- * 'sConfigurationRecorderName' - The name of the recorder object that records each configuration change made to the resources.
startConfigurationRecorder
:: Text -- ^ 'sConfigurationRecorderName'
-> StartConfigurationRecorder
diff --git a/gen/Network/AWS/Config/StopConfigurationRecorder.hs b/gen/Network/AWS/Config/StopConfigurationRecorder.hs
index 85b349e..0ec5ceb 100644
--- a/gen/Network/AWS/Config/StopConfigurationRecorder.hs
+++ b/gen/Network/AWS/Config/StopConfigurationRecorder.hs
@@ -19,6 +19,8 @@
-- Portability : non-portable (GHC extensions)
--
-- Stops recording configurations of the AWS resources you have selected to record in your AWS account.
+--
+--
module Network.AWS.Config.StopConfigurationRecorder
(
-- * Creating a Request
@@ -39,7 +41,9 @@ import Network.AWS.Prelude
import Network.AWS.Request
import Network.AWS.Response
--- | The input for the < StopConfigurationRecorder> action.
+-- | The input for the 'StopConfigurationRecorder' action.
+--
+--
--
-- /See:/ 'stopConfigurationRecorder' smart constructor.
newtype StopConfigurationRecorder = StopConfigurationRecorder'
@@ -50,7 +54,7 @@ newtype StopConfigurationRecorder = StopConfigurationRecorder'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'scrConfigurationRecorderName'
+-- * 'scrConfigurationRecorderName' - The name of the recorder object that records each configuration change made to the resources.
stopConfigurationRecorder
:: Text -- ^ 'scrConfigurationRecorderName'
-> StopConfigurationRecorder
diff --git a/gen/Network/AWS/Config/Types.hs b/gen/Network/AWS/Config/Types.hs
index 300f5fb..7b255f0 100644
--- a/gen/Network/AWS/Config/Types.hs
+++ b/gen/Network/AWS/Config/Types.hs
@@ -309,7 +309,7 @@ import Network.AWS.Lens
import Network.AWS.Prelude
import Network.AWS.Sign.V4
--- | API version '2014-11-12' of the Amazon Config SDK configuration.
+-- | API version @2014-11-12@ of the Amazon Config SDK configuration.
config :: Service
config =
Service
@@ -344,139 +344,198 @@ config =
| otherwise = Nothing
-- | The specified time range is not valid. The earlier time is not chronologically before the later time.
+--
+--
_InvalidTimeRangeException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidTimeRangeException =
_ServiceError . hasCode "InvalidTimeRangeException"
-- | The specified Amazon SNS topic does not exist.
+--
+--
_InvalidSNSTopicARNException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidSNSTopicARNException =
_ServiceError . hasCode "InvalidSNSTopicARNException"
-- | AWS Config throws an exception if the recording group does not contain a valid list of resource types. Invalid values could also be incorrectly formatted.
+--
+--
_InvalidRecordingGroupException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidRecordingGroupException =
_ServiceError . hasCode "InvalidRecordingGroupException"
-- | The requested action is not valid.
+--
+--
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
_ValidationException = _ServiceError . hasCode "ValidationException"
-- | You have provided a null or empty role ARN.
+--
+--
_InvalidRoleException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidRoleException = _ServiceError . hasCode "InvalidRoleException"
-- | You cannot delete the delivery channel you specified because the configuration recorder is running.
+--
+--
_LastDeliveryChannelDeleteFailedException :: AsError a => Getting (First ServiceError) a ServiceError
_LastDeliveryChannelDeleteFailedException =
_ServiceError . hasCode "LastDeliveryChannelDeleteFailedException"
-- | The specified limit is outside the allowable range.
+--
+--
_InvalidLimitException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidLimitException = _ServiceError . hasCode "InvalidLimitException"
-- | The specified delivery channel name is not valid.
+--
+--
_InvalidDeliveryChannelNameException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidDeliveryChannelNameException =
_ServiceError . hasCode "InvalidDeliveryChannelNameException"
-- | One or more of the specified parameters are invalid. Verify that your parameters are valid and try again.
+--
+--
_InvalidParameterValueException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidParameterValueException =
_ServiceError . hasCode "InvalidParameterValueException"
-- | The result token is invalid.
+--
+--
_InvalidResultTokenException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidResultTokenException =
_ServiceError . hasCode "InvalidResultTokenException"
-- | You have specified a delivery channel that does not exist.
+--
+--
_NoSuchDeliveryChannelException :: AsError a => Getting (First ServiceError) a ServiceError
_NoSuchDeliveryChannelException =
_ServiceError . hasCode "NoSuchDeliveryChannelException"
-- | One or more AWS Config rules in the request are invalid. Verify that the rule names are correct and try again.
+--
+--
_NoSuchConfigRuleException :: AsError a => Getting (First ServiceError) a ServiceError
_NoSuchConfigRuleException =
_ServiceError . hasCode "NoSuchConfigRuleException"
-- | Indicates one of the following errors:
--
--- - The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.
--- - The AWS Lambda function cannot be invoked. Check the function ARN, and check the function\'s permissions.
+--
+-- * The rule cannot be created because the IAM role assigned to AWS Config lacks permissions to perform the config:Put* action.
+--
+-- * The AWS Lambda function cannot be invoked. Check the function ARN, and check the function's permissions.
+--
+--
+--
_InsufficientPermissionsException :: AsError a => Getting (First ServiceError) a ServiceError
_InsufficientPermissionsException =
_ServiceError . hasCode "InsufficientPermissionsException"
-- | You have specified a resource that is either unknown or has not been discovered.
+--
+--
_ResourceNotDiscoveredException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceNotDiscoveredException =
_ServiceError . hasCode "ResourceNotDiscoveredException"
--- | The specified next token is invalid. Specify the 'nextToken' string that was returned in the previous response to get the next page of results.
+-- | The specified next token is invalid. Specify the @nextToken@ string that was returned in the previous response to get the next page of results.
+--
+--
_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidNextTokenException =
_ServiceError . hasCode "InvalidNextTokenException"
-- | Failed to add the AWS Config rule because the account already contains the maximum number of 25 rules. Consider deleting any deactivated rules before adding new rules.
+--
+--
_MaxNumberOfConfigRulesExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_MaxNumberOfConfigRulesExceededException =
_ServiceError . hasCode "MaxNumberOfConfigRulesExceededException"
-- | There are no configuration recorders available to provide the role needed to describe your resources. Create a configuration recorder.
+--
+--
_NoAvailableConfigurationRecorderException :: AsError a => Getting (First ServiceError) a ServiceError
_NoAvailableConfigurationRecorderException =
_ServiceError . hasCode "NoAvailableConfigurationRecorderException"
-- | The specified Amazon S3 bucket does not exist.
+--
+--
_NoSuchBucketException :: AsError a => Getting (First ServiceError) a ServiceError
_NoSuchBucketException = _ServiceError . hasCode "NoSuchBucketException"
-- | There is no delivery channel available to record configurations.
+--
+--
_NoAvailableDeliveryChannelException :: AsError a => Getting (First ServiceError) a ServiceError
_NoAvailableDeliveryChannelException =
_ServiceError . hasCode "NoAvailableDeliveryChannelException"
-- | You have provided a configuration recorder name that is not valid.
+--
+--
_InvalidConfigurationRecorderNameException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidConfigurationRecorderNameException =
_ServiceError . hasCode "InvalidConfigurationRecorderNameException"
-- | There is no configuration recorder running.
+--
+--
_NoRunningConfigurationRecorderException :: AsError a => Getting (First ServiceError) a ServiceError
_NoRunningConfigurationRecorderException =
_ServiceError . hasCode "NoRunningConfigurationRecorderException"
-- | You have reached the limit on the number of recorders you can create.
+--
+--
_MaxNumberOfConfigurationRecordersExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_MaxNumberOfConfigurationRecordersExceededException =
_ServiceError .
hasCode "MaxNumberOfConfigurationRecordersExceededException"
-- | Your Amazon S3 bucket policy does not permit AWS Config to write to it.
+--
+--
_InsufficientDeliveryPolicyException :: AsError a => Getting (First ServiceError) a ServiceError
_InsufficientDeliveryPolicyException =
_ServiceError . hasCode "InsufficientDeliveryPolicyException"
-- | You have reached the limit on the number of delivery channels you can create.
+--
+--
_MaxNumberOfDeliveryChannelsExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_MaxNumberOfDeliveryChannelsExceededException =
_ServiceError . hasCode "MaxNumberOfDeliveryChannelsExceededException"
-- | You have specified a configuration recorder that does not exist.
+--
+--
_NoSuchConfigurationRecorderException :: AsError a => Getting (First ServiceError) a ServiceError
_NoSuchConfigurationRecorderException =
_ServiceError . hasCode "NoSuchConfigurationRecorderException"
-- | The specified Amazon S3 key prefix is not valid.
+--
+--
_InvalidS3KeyPrefixException :: AsError a => Getting (First ServiceError) a ServiceError
_InvalidS3KeyPrefixException =
_ServiceError . hasCode "InvalidS3KeyPrefixException"
--- | This exception is thrown if an evaluation is in progress or if you call the < StartConfigRulesEvaluation> API more than once per minute.
+-- | This exception is thrown if an evaluation is in progress or if you call the 'StartConfigRulesEvaluation' API more than once per minute.
+--
+--
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
_LimitExceededException = _ServiceError . hasCode "LimitExceededException"
-- | The rule is currently being deleted or the rule is deleting your evaluation results. Try your request again later.
+--
+--
_ResourceInUseException :: AsError a => Getting (First ServiceError) a ServiceError
_ResourceInUseException = _ServiceError . hasCode "ResourceInUseException"
diff --git a/gen/Network/AWS/Config/Types/Product.hs b/gen/Network/AWS/Config/Types/Product.hs
index a4e037c..6bb70db 100644
--- a/gen/Network/AWS/Config/Types/Product.hs
+++ b/gen/Network/AWS/Config/Types/Product.hs
@@ -23,6 +23,8 @@ import Network.AWS.Prelude
-- | Indicates whether an AWS resource or AWS Config rule is compliant and provides the number of contributors that affect the compliance.
--
+--
+--
-- /See:/ 'compliance' smart constructor.
data Compliance = Compliance'
{ _cComplianceContributorCount :: !(Maybe ComplianceContributorCount)
@@ -33,9 +35,9 @@ data Compliance = Compliance'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'cComplianceContributorCount'
+-- * 'cComplianceContributorCount' - The number of AWS resources or AWS Config rules that cause a result of @NON_COMPLIANT@ , up to a maximum number.
--
--- * 'cComplianceType'
+-- * 'cComplianceType' - Indicates whether an AWS resource or AWS Config rule is compliant. A resource is compliant if it complies with all of the AWS Config rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules. A rule is compliant if all of the resources that the rule evaluates comply with it, and it is noncompliant if any of these resources do not comply. AWS Config returns the @INSUFFICIENT_DATA@ value when no evaluation results are available for the AWS resource or Config rule. For the @Compliance@ data type, AWS Config supports only @COMPLIANT@ , @NON_COMPLIANT@ , and @INSUFFICIENT_DATA@ values. AWS Config does not support the @NOT_APPLICABLE@ value for the @Compliance@ data type.
compliance
:: Compliance
compliance =
@@ -44,19 +46,11 @@ compliance =
, _cComplianceType = Nothing
}
--- | The number of AWS resources or AWS Config rules that cause a result of 'NON_COMPLIANT', up to a maximum number.
+-- | The number of AWS resources or AWS Config rules that cause a result of @NON_COMPLIANT@ , up to a maximum number.
cComplianceContributorCount :: Lens' Compliance (Maybe ComplianceContributorCount)
cComplianceContributorCount = lens _cComplianceContributorCount (\ s a -> s{_cComplianceContributorCount = a});
--- | Indicates whether an AWS resource or AWS Config rule is compliant.
---
--- A resource is compliant if it complies with all of the AWS Config rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules.
---
--- A rule is compliant if all of the resources that the rule evaluates comply with it, and it is noncompliant if any of these resources do not comply.
---
--- AWS Config returns the 'INSUFFICIENT_DATA' value when no evaluation results are available for the AWS resource or Config rule.
---
--- For the 'Compliance' data type, AWS Config supports only 'COMPLIANT', 'NON_COMPLIANT', and 'INSUFFICIENT_DATA' values. AWS Config does not support the 'NOT_APPLICABLE' value for the 'Compliance' data type.
+-- | Indicates whether an AWS resource or AWS Config rule is compliant. A resource is compliant if it complies with all of the AWS Config rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules. A rule is compliant if all of the resources that the rule evaluates comply with it, and it is noncompliant if any of these resources do not comply. AWS Config returns the @INSUFFICIENT_DATA@ value when no evaluation results are available for the AWS resource or Config rule. For the @Compliance@ data type, AWS Config supports only @COMPLIANT@ , @NON_COMPLIANT@ , and @INSUFFICIENT_DATA@ values. AWS Config does not support the @NOT_APPLICABLE@ value for the @Compliance@ data type.
cComplianceType :: Lens' Compliance (Maybe ComplianceType)
cComplianceType = lens _cComplianceType (\ s a -> s{_cComplianceType = a});
@@ -74,6 +68,8 @@ instance NFData Compliance
-- | Indicates whether an AWS Config rule is compliant. A rule is compliant if all of the resources that the rule evaluated comply with it, and it is noncompliant if any of these resources do not comply.
--
+--
+--
-- /See:/ 'complianceByConfigRule' smart constructor.
data ComplianceByConfigRule = ComplianceByConfigRule'
{ _cbcrCompliance :: !(Maybe Compliance)
@@ -84,9 +80,9 @@ data ComplianceByConfigRule = ComplianceByConfigRule'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'cbcrCompliance'
+-- * 'cbcrCompliance' - Indicates whether the AWS Config rule is compliant.
--
--- * 'cbcrConfigRuleName'
+-- * 'cbcrConfigRuleName' - The name of the AWS Config rule.
complianceByConfigRule
:: ComplianceByConfigRule
complianceByConfigRule =
@@ -116,6 +112,8 @@ instance NFData ComplianceByConfigRule
-- | Indicates whether an AWS resource that is evaluated according to one or more AWS Config rules is compliant. A resource is compliant if it complies with all of the rules that evaluate it, and it is noncompliant if it does not comply with one or more of these rules.
--
+--
+--
-- /See:/ 'complianceByResource' smart constructor.
data ComplianceByResource = ComplianceByResource'
{ _cbrResourceId :: !(Maybe Text)
@@ -127,11 +125,11 @@ data ComplianceByResource = ComplianceByResource'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'cbrResourceId'
+-- * 'cbrResourceId' - The ID of the AWS resource that was evaluated.
--
--- * 'cbrResourceType'
+-- * 'cbrResourceType' - The type of the AWS resource that was evaluated.
--
--- * 'cbrCompliance'
+-- * 'cbrCompliance' - Indicates whether the AWS resource complies with all of the AWS Config rules that evaluated it.
complianceByResource
:: ComplianceByResource
complianceByResource =
@@ -167,6 +165,8 @@ instance NFData ComplianceByResource
-- | The number of AWS resources or AWS Config rules responsible for the current compliance of the item, up to a maximum number.
--
+--
+--
-- /See:/ 'complianceContributorCount' smart constructor.
data ComplianceContributorCount = ComplianceContributorCount'
{ _cccCappedCount :: !(Maybe Int)
@@ -177,9 +177,9 @@ data ComplianceContributorCount = ComplianceContributorCount'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'cccCappedCount'
+-- * 'cccCappedCount' - The number of AWS resources or AWS Config rules responsible for the current compliance of the item.
--
--- * 'cccCapExceeded'
+-- * 'cccCapExceeded' - Indicates whether the maximum count is reached.
complianceContributorCount
:: ComplianceContributorCount
complianceContributorCount =
@@ -209,6 +209,8 @@ instance NFData ComplianceContributorCount
-- | The number of AWS Config rules or AWS resources that are compliant and noncompliant, up to a maximum.
--
+--
+--
-- /See:/ 'complianceSummary' smart constructor.
data ComplianceSummary = ComplianceSummary'
{ _csComplianceSummaryTimestamp :: !(Maybe POSIX)
@@ -220,11 +222,11 @@ data ComplianceSummary = ComplianceSummary'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'csComplianceSummaryTimestamp'
+-- * 'csComplianceSummaryTimestamp' - The time that AWS Config created the compliance summary.
--
--- * 'csCompliantResourceCount'
+-- * 'csCompliantResourceCount' - The number of AWS Config rules or AWS resources that are compliant, up to a maximum of 25 for rules and 100 for resources.
--
--- * 'csNonCompliantResourceCount'
+-- * 'csNonCompliantResourceCount' - The number of AWS Config rules or AWS resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.
complianceSummary
:: ComplianceSummary
complianceSummary =
@@ -261,6 +263,8 @@ instance NFData ComplianceSummary
-- | The number of AWS resources of a specific type that are compliant or noncompliant, up to a maximum of 100 for each compliance.
--
+--
+--
-- /See:/ 'complianceSummaryByResourceType' smart constructor.
data ComplianceSummaryByResourceType = ComplianceSummaryByResourceType'
{ _csbrtResourceType :: !(Maybe Text)
@@ -271,9 +275,9 @@ data ComplianceSummaryByResourceType = ComplianceSummaryByResourceType'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'csbrtResourceType'
+-- * 'csbrtResourceType' - The type of AWS resource.
--
--- * 'csbrtComplianceSummary'
+-- * 'csbrtComplianceSummary' - The number of AWS resources that are compliant or noncompliant, up to a maximum of 100 for each compliance.
complianceSummaryByResourceType
:: ComplianceSummaryByResourceType
complianceSummaryByResourceType =
@@ -305,6 +309,8 @@ instance NFData ComplianceSummaryByResourceType
-- | A list that contains the status of the delivery of either the snapshot or the configuration history to the specified Amazon S3 bucket.
--
+--
+--
-- /See:/ 'configExportDeliveryInfo' smart constructor.
data ConfigExportDeliveryInfo = ConfigExportDeliveryInfo'
{ _cediLastErrorCode :: !(Maybe Text)
@@ -319,17 +325,17 @@ data ConfigExportDeliveryInfo = ConfigExportDeliveryInfo'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'cediLastErrorCode'
+-- * 'cediLastErrorCode' - The error code from the last attempted delivery.
--
--- * 'cediLastAttemptTime'
+-- * 'cediLastAttemptTime' - The time of the last attempted delivery.
--
--- * 'cediLastSuccessfulTime'
+-- * 'cediLastSuccessfulTime' - The time of the last successful delivery.
--
--- * 'cediLastStatus'
+-- * 'cediLastStatus' - Status of the last attempted delivery.
--
--- * 'cediLastErrorMessage'
+-- * 'cediLastErrorMessage' - The error message from the last attempted delivery.
--
--- * 'cediNextDeliveryTime'
+-- * 'cediNextDeliveryTime' - The time that the next delivery occurs.
configExportDeliveryInfo
:: ConfigExportDeliveryInfo
configExportDeliveryInfo =
@@ -383,9 +389,9 @@ instance NFData ConfigExportDeliveryInfo
-- | An AWS Config rule represents an AWS Lambda function that you create for a custom rule or a predefined function for an AWS managed rule. The function evaluates configuration items to assess whether your AWS resources comply with your desired configurations. This function can run when AWS Config detects a configuration change to an AWS resource and at a periodic frequency that you choose (for example, every 24 hours).
--
--- You can use the AWS CLI and AWS SDKs if you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot. For more information, see < ConfigSnapshotDeliveryProperties>.
--
--- For more information about developing and using AWS Config rules, see <http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html Evaluating AWS Resource Configurations with AWS Config> in the /AWS Config Developer Guide/.
+-- For more information about developing and using AWS Config rules, see <http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config.html Evaluating AWS Resource Configurations with AWS Config> in the /AWS Config Developer Guide/ .
+--
--
-- /See:/ 'configRule' smart constructor.
data ConfigRule = ConfigRule'
@@ -404,23 +410,23 @@ data ConfigRule = ConfigRule'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'crInputParameters'
+-- * 'crInputParameters' - A string in JSON format that is passed to the AWS Config rule Lambda function.
--
--- * 'crConfigRuleName'
+-- * 'crConfigRuleName' - The name that you assign to the AWS Config rule. The name is required if you are adding a new rule.
--
--- * 'crMaximumExecutionFrequency'
+-- * 'crMaximumExecutionFrequency' - The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for @MaximumExecutionFrequency@ when: * You are using an AWS managed rule that is triggered at a periodic frequency. * Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see 'ConfigSnapshotDeliveryProperties' .
--
--- * 'crConfigRuleId'
+-- * 'crConfigRuleId' - The ID of the AWS Config rule.
--
--- * 'crScope'
+-- * 'crScope' - Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.
--
--- * 'crConfigRuleState'
+-- * 'crConfigRuleState' - Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the Config rule. AWS Config sets the state of the rule to @EVALUATING@ temporarily after you use the @StartConfigRulesEvaluation@ request to evaluate your resources against the Config rule. AWS Config sets the state of the rule to @DELETING_RESULTS@ temporarily after you use the @DeleteEvaluationResults@ request to delete the current evaluation results for the Config rule. AWS Config sets the state of a rule to @DELETING@ temporarily after you use the @DeleteConfigRule@ request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
--
--- * 'crDescription'
+-- * 'crDescription' - The description that you provide for the AWS Config rule.
--
--- * 'crConfigRuleARN'
+-- * 'crConfigRuleARN' - The Amazon Resource Name (ARN) of the AWS Config rule.
--
--- * 'crSource'
+-- * 'crSource' - Provides the rule owner (AWS or customer), the rule identifier, and the notifications that cause the function to evaluate your AWS resources.
configRule
:: Source -- ^ 'crSource'
-> ConfigRule
@@ -445,13 +451,7 @@ crInputParameters = lens _crInputParameters (\ s a -> s{_crInputParameters = a})
crConfigRuleName :: Lens' ConfigRule (Maybe Text)
crConfigRuleName = lens _crConfigRuleName (\ s a -> s{_crConfigRuleName = a});
--- | The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for 'MaximumExecutionFrequency' when:
---
--- - You are using an AWS managed rule that is triggered at a periodic frequency.
---
--- - Your custom rule is triggered when AWS Config delivers the configuration snapshot.
---
--- For more information, see < ConfigSnapshotDeliveryProperties>.
+-- | The maximum frequency with which AWS Config runs evaluations for a rule. You can specify a value for @MaximumExecutionFrequency@ when: * You are using an AWS managed rule that is triggered at a periodic frequency. * Your custom rule is triggered when AWS Config delivers the configuration snapshot. For more information, see 'ConfigSnapshotDeliveryProperties' .
crMaximumExecutionFrequency :: Lens' ConfigRule (Maybe MaximumExecutionFrequency)
crMaximumExecutionFrequency = lens _crMaximumExecutionFrequency (\ s a -> s{_crMaximumExecutionFrequency = a});
@@ -463,13 +463,7 @@ crConfigRuleId = lens _crConfigRuleId (\ s a -> s{_crConfigRuleId = a});
crScope :: Lens' ConfigRule (Maybe Scope)
crScope = lens _crScope (\ s a -> s{_crScope = a});
--- | Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the Config rule.
---
--- AWS Config sets the state of the rule to 'EVALUATING' temporarily after you use the 'StartConfigRulesEvaluation' request to evaluate your resources against the Config rule.
---
--- AWS Config sets the state of the rule to 'DELETING_RESULTS' temporarily after you use the 'DeleteEvaluationResults' request to delete the current evaluation results for the Config rule.
---
--- AWS Config sets the state of a rule to 'DELETING' temporarily after you use the 'DeleteConfigRule' request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
+-- | Indicates whether the AWS Config rule is active or is currently being deleted by AWS Config. It can also indicate the evaluation status for the Config rule. AWS Config sets the state of the rule to @EVALUATING@ temporarily after you use the @StartConfigRulesEvaluation@ request to evaluate your resources against the Config rule. AWS Config sets the state of the rule to @DELETING_RESULTS@ temporarily after you use the @DeleteEvaluationResults@ request to delete the current evaluation results for the Config rule. AWS Config sets the state of a rule to @DELETING@ temporarily after you use the @DeleteConfigRule@ request to delete the rule. After AWS Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.
crConfigRuleState :: Lens' ConfigRule (Maybe ConfigRuleState)
crConfigRuleState = lens _crConfigRuleState (\ s a -> s{_crConfigRuleState = a});
@@ -521,8 +515,10 @@ instance ToJSON ConfigRule where
-- | Status information for your AWS managed Config rules. The status includes information such as the last time the rule ran, the last time it failed, and the related error for the last failure.
--
+--
-- This action does not return status information about custom Config rules.
--
+--
-- /See:/ 'configRuleEvaluationStatus' smart constructor.
data ConfigRuleEvaluationStatus = ConfigRuleEvaluationStatus'
{ _cresLastErrorCode :: !(Maybe Text)
@@ -542,27 +538,27 @@ data ConfigRuleEvaluationStatus = ConfigRuleEvaluationStatus'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'cresLastErrorCode'
+-- * 'cresLastErrorCode' - The error code that AWS Config returned when the rule last failed.
--
--- * 'cresLastFailedEvaluationTime'
+-- * 'cresLastFailedEvaluationTime' - The time that AWS Config last failed to evaluate your AWS resources against the rule.
--
--- * 'cresFirstActivatedTime'
+-- * 'cresFirstActivatedTime' - The time that you first activated the AWS Config rule.
--
--- * 'cresLastSuccessfulEvaluationTime'
+-- * 'cresLastSuccessfulEvaluationTime' - The time that AWS Config last successfully evaluated your AWS resources against the rule.
--
--- * 'cresConfigRuleName'
+-- * 'cresConfigRuleName' - The name of the AWS Config rule.
--
--- * 'cresLastErrorMessage'
+-- * 'cresLastErrorMessage' - The error message that AWS Config returned when the rule last failed.
--
--- * 'cresConfigRuleId'
+-- * 'cresConfigRuleId' - The ID of the AWS Config rule.
--
--- * 'cresLastFailedInvocationTime'
+-- * 'cresLastFailedInvocationTime' - The time that AWS Config last failed to invoke the AWS Config rule to evaluate your AWS resources.
--
--- * 'cresFirstEvaluationStarted'
+-- * 'cresFirstEvaluationStarted' - Indicates whether AWS Config has evaluated your resources against the rule at least once. * @true@ - AWS Config has evaluated your AWS resources against the rule at least once. * @false@ - AWS Config has not once finished evaluating your AWS resources against the rule.
--
--- * 'cresLastSuccessfulInvocationTime'
+-- * 'cresLastSuccessfulInvocationTime' - The time that AWS Config last successfully invoked the AWS Config rule to evaluate your AWS resources.
--
--- * 'cresConfigRuleARN'
+-- * 'cresConfigRuleARN' - The Amazon Resource Name (ARN) of the AWS Config rule.
configRuleEvaluationStatus
:: ConfigRuleEvaluationStatus
configRuleEvaluationStatus =
@@ -612,10 +608,7 @@ cresConfigRuleId = lens _cresConfigRuleId (\ s a -> s{_cresConfigRuleId = a});
cresLastFailedInvocationTime :: Lens' ConfigRuleEvaluationStatus (Maybe UTCTime)
cresLastFailedInvocationTime = lens _cresLastFailedInvocationTime (\ s a -> s{_cresLastFailedInvocationTime = a}) . mapping _Time;
--- | Indicates whether AWS Config has evaluated your resources against the rule at least once.
---
--- - 'true' - AWS Config has evaluated your AWS resources against the rule at least once.
--- - 'false' - AWS Config has not once finished evaluating your AWS resources against the rule.
+-- | Indicates whether AWS Config has evaluated your resources against the rule at least once. * @true@ - AWS Config has evaluated your AWS resources against the rule at least once. * @false@ - AWS Config has not once finished evaluating your AWS resources against the rule.
cresFirstEvaluationStarted :: Lens' ConfigRuleEvaluationStatus (Maybe Bool)
cresFirstEvaluationStarted = lens _cresFirstEvaluationStarted (\ s a -> s{_cresFirstEvaluationStarted = a});
@@ -650,27 +643,31 @@ instance NFData ConfigRuleEvaluationStatus
-- | Provides options for how often AWS Config delivers configuration snapshots to the Amazon S3 bucket in your delivery channel.
--
--- If you want to create a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot, see the following:
--
-- The frequency for a rule that triggers evaluations for your resources when AWS Config delivers the configuration snapshot is set by one of two values, depending on which is less frequent:
--
--- - The value for the 'deliveryFrequency' parameter within the delivery channel configuration, which sets how often AWS Config delivers configuration snapshots. This value also sets how often AWS Config invokes evaluations for Config rules.
+-- * The value for the @deliveryFrequency@ parameter within the delivery channel configuration, which sets how often AWS Config delivers configuration snapshots. This value also sets how often AWS Config invokes evaluations for Config rules.
+--
+-- * The value for the @MaximumExecutionFrequency@ parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see 'ConfigRule' .
+--
+--
+--
+-- If the @deliveryFrequency@ value is less frequent than the @MaximumExecutionFrequency@ value for a rule, AWS Config invokes the rule only as often as the @deliveryFrequency@ value.
+--
+-- * For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot.
--
--- - The value for the 'MaximumExecutionFrequency' parameter, which sets the maximum frequency with which AWS Config invokes evaluations for the rule. For more information, see < ConfigRule>.
+-- * You specify the @MaximumExecutionFrequency@ value for @Six_Hours@ .
--
--- If the 'deliveryFrequency' value is less frequent than the 'MaximumExecutionFrequency' value for a rule, AWS Config invokes the rule only as often as the 'deliveryFrequency' value.
+-- * You then specify the delivery channel @deliveryFrequency@ value for @TwentyFour_Hours@ .
--
--- 1. For example, you want your rule to run evaluations when AWS Config delivers the configuration snapshot.
+-- * Because the value for @deliveryFrequency@ is less frequent than @MaximumExecutionFrequency@ , AWS Config invokes evaluations for the rule every 24 hours.
--
--- 2. You specify the 'MaximumExecutionFrequency' value for 'Six_Hours'.
--
--- 3. You then specify the delivery channel 'deliveryFrequency' value for 'TwentyFour_Hours'.
--
--- 4. Because the value for 'deliveryFrequency' is less frequent than 'MaximumExecutionFrequency', AWS Config invokes evaluations for the rule every 24 hours.
+-- You should set the @MaximumExecutionFrequency@ value to be at least as frequent as the @deliveryFrequency@ value. You can view the @deliveryFrequency@ value by using the @DescribeDeliveryChannnels@ action.
--
--- You should set the 'MaximumExecutionFrequency' value to be at least as frequent as the 'deliveryFrequency' value. You can view the 'deliveryFrequency' value by using the 'DescribeDeliveryChannnels' action.
+-- To update the @deliveryFrequency@ with which AWS Config delivers your configuration snapshots, use the @PutDeliveryChannel@ action.
--
--- To update the 'deliveryFrequency' with which AWS Config delivers your configuration snapshots, use the 'PutDeliveryChannel' action.
--
-- /See:/ 'configSnapshotDeliveryProperties' smart constructor.
newtype ConfigSnapshotDeliveryProperties = ConfigSnapshotDeliveryProperties'
@@ -681,7 +678,7 @@ newtype ConfigSnapshotDeliveryProperties = ConfigSnapshotDeliveryProperties'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'csdpDeliveryFrequency'
+-- * 'csdpDeliveryFrequency' - The frequency with which AWS Config delivers configuration snapshots.
configSnapshotDeliveryProperties
:: ConfigSnapshotDeliveryProperties
configSnapshotDeliveryProperties =
@@ -715,6 +712,8 @@ instance ToJSON ConfigSnapshotDeliveryProperties
-- | A list that contains the status of the delivery of the configuration stream notification to the Amazon SNS topic.
--
+--
+--
-- /See:/ 'configStreamDeliveryInfo' smart constructor.
data ConfigStreamDeliveryInfo = ConfigStreamDeliveryInfo'
{ _csdiLastErrorCode :: !(Maybe Text)
@@ -727,13 +726,13 @@ data ConfigStreamDeliveryInfo = ConfigStreamDeliveryInfo'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'csdiLastErrorCode'
+-- * 'csdiLastErrorCode' - The error code from the last attempted delivery.
--
--- * 'csdiLastStatusChangeTime'
+-- * 'csdiLastStatusChangeTime' - The time from the last status change.
--
--- * 'csdiLastStatus'
+-- * 'csdiLastStatus' - Status of the last attempted delivery. __Note__ Providing an SNS topic on a <http://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html DeliveryChannel> for AWS Config is optional. If the SNS delivery is turned off, the last status will be __Not_Applicable__ .
--
--- * 'csdiLastErrorMessage'
+-- * 'csdiLastErrorMessage' - The error message from the last attempted delivery.
configStreamDeliveryInfo
:: ConfigStreamDeliveryInfo
configStreamDeliveryInfo =
@@ -752,9 +751,7 @@ csdiLastErrorCode = lens _csdiLastErrorCode (\ s a -> s{_csdiLastErrorCode = a})
csdiLastStatusChangeTime :: Lens' ConfigStreamDeliveryInfo (Maybe UTCTime)
csdiLastStatusChangeTime = lens _csdiLastStatusChangeTime (\ s a -> s{_csdiLastStatusChangeTime = a}) . mapping _Time;
--- | Status of the last attempted delivery.
---
--- __Note__ Providing an SNS topic on a <http://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html DeliveryChannel> for AWS Config is optional. If the SNS delivery is turned off, the last status will be __Not_Applicable__.
+-- | Status of the last attempted delivery. __Note__ Providing an SNS topic on a <http://docs.aws.amazon.com/config/latest/APIReference/API_DeliveryChannel.html DeliveryChannel> for AWS Config is optional. If the SNS delivery is turned off, the last status will be __Not_Applicable__ .
csdiLastStatus :: Lens' ConfigStreamDeliveryInfo (Maybe DeliveryStatus)
csdiLastStatus = lens _csdiLastStatus (\ s a -> s{_csdiLastStatus = a});
@@ -778,7 +775,7 @@ instance NFData ConfigStreamDeliveryInfo
-- | A list that contains detailed configurations of a specified resource.
--
--- Currently, the list does not contain information about non-AWS components (for example, applications on your Amazon EC2 instances).
+--
--
-- /See:/ 'configurationItem' smart constructor.
data ConfigurationItem = ConfigurationItem'
@@ -806,41 +803,41 @@ data ConfigurationItem = ConfigurationItem'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'ciResourceId'
+-- * 'ciResourceId' - The ID of the resource (for example., @sg-xxxxxx@ ).
--
--- * 'ciResourceType'
+-- * 'ciResourceType' - The type of AWS resource.
--
--- * 'ciConfigurationStateId'
+-- * 'ciConfigurationStateId' - An identifier that indicates the ordering of the configuration items of a resource.
--
--- * 'ciArn'
+-- * 'ciArn' - The Amazon Resource Name (ARN) of the resource.
--
--- * 'ciResourceName'
+-- * 'ciResourceName' - The custom name of the resource, if available.
--
--- * 'ciResourceCreationTime'
+-- * 'ciResourceCreationTime' - The time stamp when the resource was created.
--
--- * 'ciConfigurationItemStatus'
+-- * 'ciConfigurationItemStatus' - The configuration item status.
--
--- * 'ciConfigurationItemCaptureTime'
+-- * 'ciConfigurationItemCaptureTime' - The time when the configuration recording was initiated.
--
--- * 'ciAccountId'
+-- * 'ciAccountId' - The 12 digit AWS account ID associated with the resource.
--
--- * 'ciSupplementaryConfiguration'
+-- * 'ciSupplementaryConfiguration' - Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the @configuration@ parameter.
--
--- * 'ciAvailabilityZone'
+-- * 'ciAvailabilityZone' - The Availability Zone associated with the resource.
--
--- * 'ciRelationships'
+-- * 'ciRelationships' - A list of related AWS resources.
--
--- * 'ciVersion'
+-- * 'ciVersion' - The version number of the resource configuration.
--
--- * 'ciAwsRegion'
+-- * 'ciAwsRegion' - The region where the resource resides.
--
--- * 'ciRelatedEvents'
+-- * 'ciRelatedEvents' - A list of CloudTrail event IDs. A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see <http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html What is AWS CloudTrail?> . An empty field indicates that the current configuration was not initiated by any event.
--
--- * 'ciConfiguration'
+-- * 'ciConfiguration' - The description of the resource configuration.
--
--- * 'ciConfigurationItemMD5Hash'
+-- * 'ciConfigurationItemMD5Hash' - Unique MD5 hash that represents the configuration item's state. You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
--
--- * 'ciTags'
+-- * 'ciTags' - A mapping of key value tags associated with the resource.
configurationItem
:: ConfigurationItem
configurationItem =
@@ -865,7 +862,7 @@ configurationItem =
, _ciTags = Nothing
}
--- | The ID of the resource (for example., 'sg-xxxxxx').
+-- | The ID of the resource (for example., @sg-xxxxxx@ ).
ciResourceId :: Lens' ConfigurationItem (Maybe Text)
ciResourceId = lens _ciResourceId (\ s a -> s{_ciResourceId = a});
@@ -901,7 +898,7 @@ ciConfigurationItemCaptureTime = lens _ciConfigurationItemCaptureTime (\ s a ->
ciAccountId :: Lens' ConfigurationItem (Maybe Text)
ciAccountId = lens _ciAccountId (\ s a -> s{_ciAccountId = a});
--- | Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the 'configuration' parameter.
+-- | Configuration attributes that AWS Config returns for certain resource types to supplement the information returned for the @configuration@ parameter.
ciSupplementaryConfiguration :: Lens' ConfigurationItem (HashMap Text Text)
ciSupplementaryConfiguration = lens _ciSupplementaryConfiguration (\ s a -> s{_ciSupplementaryConfiguration = a}) . _Default . _Map;
@@ -921,11 +918,7 @@ ciVersion = lens _ciVersion (\ s a -> s{_ciVersion = a});
ciAwsRegion :: Lens' ConfigurationItem (Maybe Text)
ciAwsRegion = lens _ciAwsRegion (\ s a -> s{_ciAwsRegion = a});
--- | A list of CloudTrail event IDs.
---
--- A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see <http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html What is AWS CloudTrail?>.
---
--- An empty field indicates that the current configuration was not initiated by any event.
+-- | A list of CloudTrail event IDs. A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see <http://docs.aws.amazon.com/awscloudtrail/latest/userguide/what_is_cloud_trail_top_level.html What is AWS CloudTrail?> . An empty field indicates that the current configuration was not initiated by any event.
ciRelatedEvents :: Lens' ConfigurationItem [Text]
ciRelatedEvents = lens _ciRelatedEvents (\ s a -> s{_ciRelatedEvents = a}) . _Default . _Coerce;
@@ -933,9 +926,7 @@ ciRelatedEvents = lens _ciRelatedEvents (\ s a -> s{_ciRelatedEvents = a}) . _De
ciConfiguration :: Lens' ConfigurationItem (Maybe Text)
ciConfiguration = lens _ciConfiguration (\ s a -> s{_ciConfiguration = a});
--- | Unique MD5 hash that represents the configuration item\'s state.
---
--- You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
+-- | Unique MD5 hash that represents the configuration item's state. You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.
ciConfigurationItemMD5Hash :: Lens' ConfigurationItem (Maybe Text)
ciConfigurationItemMD5Hash = lens _ciConfigurationItemMD5Hash (\ s a -> s{_ciConfigurationItemMD5Hash = a});
@@ -972,6 +963,8 @@ instance NFData ConfigurationItem
-- | An object that represents the recording of configuration changes of an AWS resource.
--
+--
+--
-- /See:/ 'configurationRecorder' smart constructor.
data ConfigurationRecorder = ConfigurationRecorder'
{ _crName :: !(Maybe Text)
@@ -983,11 +976,11 @@ data ConfigurationRecorder = ConfigurationRecorder'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'crName'
+-- * 'crName' - The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.
--
--- * 'crRecordingGroup'
+-- * 'crRecordingGroup' - Specifies the types of AWS resource for which AWS Config records configuration changes.
--
--- * 'crRoleARN'
+-- * 'crRoleARN' - Amazon Resource Name (ARN) of the IAM role used to describe the AWS resources associated with the account.
configurationRecorder
:: ConfigurationRecorder
configurationRecorder =
@@ -997,7 +990,7 @@ configurationRecorder =
, _crRoleARN = Nothing
}
--- | The name of the recorder. By default, AWS Config automatically assigns the name \"default\" when creating the configuration recorder. You cannot change the assigned name.
+-- | The name of the recorder. By default, AWS Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.
crName :: Lens' ConfigurationRecorder (Maybe Text)
crName = lens _crName (\ s a -> s{_crName = a});
@@ -1031,6 +1024,8 @@ instance ToJSON ConfigurationRecorder where
-- | The current status of the configuration recorder.
--
+--
+--
-- /See:/ 'configurationRecorderStatus' smart constructor.
data ConfigurationRecorderStatus = ConfigurationRecorderStatus'
{ _crsLastErrorCode :: !(Maybe Text)
@@ -1047,21 +1042,21 @@ data ConfigurationRecorderStatus = ConfigurationRecorderStatus'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'crsLastErrorCode'
+-- * 'crsLastErrorCode' - The error code indicating that the recording failed.
--
--- * 'crsLastStopTime'
+-- * 'crsLastStopTime' - The time the recorder was last stopped.
--
--- * 'crsLastStatusChangeTime'
+-- * 'crsLastStatusChangeTime' - The time when the status was last changed.
--
--- * 'crsRecording'
+-- * 'crsRecording' - Specifies whether the recorder is currently recording or not.
--
--- * 'crsLastStatus'
+-- * 'crsLastStatus' - The last (previous) status of the recorder.
--
--- * 'crsLastErrorMessage'
+-- * 'crsLastErrorMessage' - The message indicating that the recording failed due to an error.
--
--- * 'crsName'
+-- * 'crsName' - The name of the configuration recorder.
--
--- * 'crsLastStartTime'
+-- * 'crsLastStartTime' - The time the recorder was last started.
configurationRecorderStatus
:: ConfigurationRecorderStatus
configurationRecorderStatus =
@@ -1127,6 +1122,8 @@ instance NFData ConfigurationRecorderStatus
-- | The channel through which AWS Config delivers notifications and updated configuration states.
--
+--
+--
-- /See:/ 'deliveryChannel' smart constructor.
data DeliveryChannel = DeliveryChannel'
{ _dcS3KeyPrefix :: !(Maybe Text)
@@ -1140,15 +1137,15 @@ data DeliveryChannel = DeliveryChannel'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcS3KeyPrefix'
+-- * 'dcS3KeyPrefix' - The prefix for the specified Amazon S3 bucket.
--
--- * 'dcSnsTopicARN'
+-- * 'dcSnsTopicARN' - The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes. If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see <http://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html Permissions for the Amazon SNS Topic> in the AWS Config Developer Guide.
--
--- * 'dcName'
+-- * 'dcName' - The name of the delivery channel. By default, AWS Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.
--
--- * 'dcConfigSnapshotDeliveryProperties'
+-- * 'dcConfigSnapshotDeliveryProperties' - Undocumented member.
--
--- * 'dcS3BucketName'
+-- * 'dcS3BucketName' - The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files. If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see <http://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html Permissions for the Amazon S3 Bucket> in the AWS Config Developer Guide.
deliveryChannel
:: DeliveryChannel
deliveryChannel =
@@ -1164,13 +1161,11 @@ deliveryChannel =
dcS3KeyPrefix :: Lens' DeliveryChannel (Maybe Text)
dcS3KeyPrefix = lens _dcS3KeyPrefix (\ s a -> s{_dcS3KeyPrefix = a});
--- | The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes.
---
--- If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see <http://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html Permissions for the Amazon SNS Topic> in the AWS Config Developer Guide.
+-- | The Amazon Resource Name (ARN) of the Amazon SNS topic to which AWS Config sends notifications about configuration changes. If you choose a topic from another account, the topic must have policies that grant access permissions to AWS Config. For more information, see <http://docs.aws.amazon.com/config/latest/developerguide/sns-topic-policy.html Permissions for the Amazon SNS Topic> in the AWS Config Developer Guide.
dcSnsTopicARN :: Lens' DeliveryChannel (Maybe Text)
dcSnsTopicARN = lens _dcSnsTopicARN (\ s a -> s{_dcSnsTopicARN = a});
--- | The name of the delivery channel. By default, AWS Config assigns the name \"default\" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.
+-- | The name of the delivery channel. By default, AWS Config assigns the name "default" when creating the delivery channel. To change the delivery channel name, you must use the DeleteDeliveryChannel action to delete your current delivery channel, and then you must use the PutDeliveryChannel command to create a delivery channel that has the desired name.
dcName :: Lens' DeliveryChannel (Maybe Text)
dcName = lens _dcName (\ s a -> s{_dcName = a});
@@ -1178,9 +1173,7 @@ dcName = lens _dcName (\ s a -> s{_dcName = a});
dcConfigSnapshotDeliveryProperties :: Lens' DeliveryChannel (Maybe ConfigSnapshotDeliveryProperties)
dcConfigSnapshotDeliveryProperties = lens _dcConfigSnapshotDeliveryProperties (\ s a -> s{_dcConfigSnapshotDeliveryProperties = a});
--- | The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files.
---
--- If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see <http://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html Permissions for the Amazon S3 Bucket> in the AWS Config Developer Guide.
+-- | The name of the Amazon S3 bucket to which AWS Config delivers configuration snapshots and configuration history files. If you specify a bucket that belongs to another AWS account, that bucket must have policies that grant access permissions to AWS Config. For more information, see <http://docs.aws.amazon.com/config/latest/developerguide/s3-bucket-policy.html Permissions for the Amazon S3 Bucket> in the AWS Config Developer Guide.
dcS3BucketName :: Lens' DeliveryChannel (Maybe Text)
dcS3BucketName = lens _dcS3BucketName (\ s a -> s{_dcS3BucketName = a});
@@ -1211,7 +1204,9 @@ instance ToJSON DeliveryChannel where
-- | The status of a specified delivery channel.
--
--- Valid values: 'Success' | 'Failure'
+--
+-- Valid values: @Success@ | @Failure@
+--
--
-- /See:/ 'deliveryChannelStatus' smart constructor.
data DeliveryChannelStatus = DeliveryChannelStatus'
@@ -1225,13 +1220,13 @@ data DeliveryChannelStatus = DeliveryChannelStatus'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'dcsConfigSnapshotDeliveryInfo'
+-- * 'dcsConfigSnapshotDeliveryInfo' - A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.
--
--- * 'dcsConfigStreamDeliveryInfo'
+-- * 'dcsConfigStreamDeliveryInfo' - A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.
--
--- * 'dcsConfigHistoryDeliveryInfo'
+-- * 'dcsConfigHistoryDeliveryInfo' - A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.
--
--- * 'dcsName'
+-- * 'dcsName' - The name of the delivery channel.
deliveryChannelStatus
:: DeliveryChannelStatus
deliveryChannelStatus =
@@ -1274,6 +1269,8 @@ instance NFData DeliveryChannelStatus
-- | Identifies an AWS resource and indicates whether it complies with the AWS Config rule that it was evaluated against.
--
+--
+--
-- /See:/ 'evaluation' smart constructor.
data Evaluation = Evaluation'
{ _eAnnotation :: !(Maybe Text)
@@ -1287,15 +1284,15 @@ data Evaluation = Evaluation'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'eAnnotation'
+-- * 'eAnnotation' - Supplementary information about how the evaluation determined the compliance.
--
--- * 'eComplianceResourceType'
+-- * 'eComplianceResourceType' - The type of AWS resource that was evaluated.
--
--- * 'eComplianceResourceId'
+-- * 'eComplianceResourceId' - The ID of the AWS resource that was evaluated.
--
--- * 'eComplianceType'
+-- * 'eComplianceType' - Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against. For the @Evaluation@ data type, AWS Config supports only the @COMPLIANT@ , @NON_COMPLIANT@ , and @NOT_APPLICABLE@ values. AWS Config does not support the @INSUFFICIENT_DATA@ value for this data type. Similarly, AWS Config does not accept @INSUFFICIENT_DATA@ as the value for @ComplianceType@ from a @PutEvaluations@ request. For example, an AWS Lambda function for a custom Config rule cannot pass an @INSUFFICIENT_DATA@ value to AWS Config.
--
--- * 'eOrderingTimestamp'
+-- * 'eOrderingTimestamp' - The time of the event in AWS Config that triggered the evaluation. For event-based evaluations, the time indicates when AWS Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when AWS Config delivered the configuration snapshot that triggered the evaluation.
evaluation
:: Text -- ^ 'eComplianceResourceType'
-> Text -- ^ 'eComplianceResourceId'
@@ -1323,11 +1320,7 @@ eComplianceResourceType = lens _eComplianceResourceType (\ s a -> s{_eCompliance
eComplianceResourceId :: Lens' Evaluation Text
eComplianceResourceId = lens _eComplianceResourceId (\ s a -> s{_eComplianceResourceId = a});
--- | Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against.
---
--- For the 'Evaluation' data type, AWS Config supports only the 'COMPLIANT', 'NON_COMPLIANT', and 'NOT_APPLICABLE' values. AWS Config does not support the 'INSUFFICIENT_DATA' value for this data type.
---
--- Similarly, AWS Config does not accept 'INSUFFICIENT_DATA' as the value for 'ComplianceType' from a 'PutEvaluations' request. For example, an AWS Lambda function for a custom Config rule cannot pass an 'INSUFFICIENT_DATA' value to AWS Config.
+-- | Indicates whether the AWS resource complies with the AWS Config rule that it was evaluated against. For the @Evaluation@ data type, AWS Config supports only the @COMPLIANT@ , @NON_COMPLIANT@ , and @NOT_APPLICABLE@ values. AWS Config does not support the @INSUFFICIENT_DATA@ value for this data type. Similarly, AWS Config does not accept @INSUFFICIENT_DATA@ as the value for @ComplianceType@ from a @PutEvaluations@ request. For example, an AWS Lambda function for a custom Config rule cannot pass an @INSUFFICIENT_DATA@ value to AWS Config.
eComplianceType :: Lens' Evaluation ComplianceType
eComplianceType = lens _eComplianceType (\ s a -> s{_eComplianceType = a});
@@ -1365,6 +1358,8 @@ instance ToJSON Evaluation where
-- | The details of an AWS Config evaluation. Provides the AWS resource that was evaluated, the compliance of the resource, related timestamps, and supplementary information.
--
+--
+--
-- /See:/ 'evaluationResult' smart constructor.
data EvaluationResult = EvaluationResult'
{ _erEvaluationResultIdentifier :: !(Maybe EvaluationResultIdentifier)
@@ -1379,17 +1374,17 @@ data EvaluationResult = EvaluationResult'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'erEvaluationResultIdentifier'
+-- * 'erEvaluationResultIdentifier' - Uniquely identifies the evaluation result.
--
--- * 'erAnnotation'
+-- * 'erAnnotation' - Supplementary information about how the evaluation determined the compliance.
--
--- * 'erConfigRuleInvokedTime'
+-- * 'erConfigRuleInvokedTime' - The time when the AWS Config rule evaluated the AWS resource.
--
--- * 'erResultRecordedTime'
+-- * 'erResultRecordedTime' - The time when AWS Config recorded the evaluation result.
--
--- * 'erResultToken'
+-- * 'erResultToken' - An encrypted token that associates an evaluation with an AWS Config rule. The token identifies the rule, the AWS resource being evaluated, and the event that triggered the evaluation.
--
--- * 'erComplianceType'
+-- * 'erComplianceType' - Indicates whether the AWS resource complies with the AWS Config rule that evaluated it. For the @EvaluationResult@ data type, AWS Config supports only the @COMPLIANT@ , @NON_COMPLIANT@ , and @NOT_APPLICABLE@ values. AWS Config does not support the @INSUFFICIENT_DATA@ value for the @EvaluationResult@ data type.
evaluationResult
:: EvaluationResult
evaluationResult =
@@ -1422,9 +1417,7 @@ erResultRecordedTime = lens _erResultRecordedTime (\ s a -> s{_erResultRecordedT
erResultToken :: Lens' EvaluationResult (Maybe Text)
erResultToken = lens _erResultToken (\ s a -> s{_erResultToken = a});
--- | Indicates whether the AWS resource complies with the AWS Config rule that evaluated it.
---
--- For the 'EvaluationResult' data type, AWS Config supports only the 'COMPLIANT', 'NON_COMPLIANT', and 'NOT_APPLICABLE' values. AWS Config does not support the 'INSUFFICIENT_DATA' value for the 'EvaluationResult' data type.
+-- | Indicates whether the AWS resource complies with the AWS Config rule that evaluated it. For the @EvaluationResult@ data type, AWS Config supports only the @COMPLIANT@ , @NON_COMPLIANT@ , and @NOT_APPLICABLE@ values. AWS Config does not support the @INSUFFICIENT_DATA@ value for the @EvaluationResult@ data type.
erComplianceType :: Lens' EvaluationResult (Maybe ComplianceType)
erComplianceType = lens _erComplianceType (\ s a -> s{_erComplianceType = a});
@@ -1446,6 +1439,8 @@ instance NFData EvaluationResult
-- | Uniquely identifies an evaluation result.
--
+--
+--
-- /See:/ 'evaluationResultIdentifier' smart constructor.
data EvaluationResultIdentifier = EvaluationResultIdentifier'
{ _eriEvaluationResultQualifier :: !(Maybe EvaluationResultQualifier)
@@ -1456,9 +1451,9 @@ data EvaluationResultIdentifier = EvaluationResultIdentifier'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'eriEvaluationResultQualifier'
+-- * 'eriEvaluationResultQualifier' - Identifies an AWS Config rule used to evaluate an AWS resource, and provides the type and ID of the evaluated resource.
--
--- * 'eriOrderingTimestamp'
+-- * 'eriOrderingTimestamp' - The time of the event that triggered the evaluation of your AWS resources. The time can indicate when AWS Config delivered a configuration item change notification, or it can indicate when AWS Config delivered the configuration snapshot, depending on which event triggered the evaluation.
evaluationResultIdentifier
:: EvaluationResultIdentifier
evaluationResultIdentifier =
@@ -1489,6 +1484,8 @@ instance NFData EvaluationResultIdentifier
-- | Identifies an AWS Config rule that evaluated an AWS resource, and provides the type and ID of the resource that the rule evaluated.
--
+--
+--
-- /See:/ 'evaluationResultQualifier' smart constructor.
data EvaluationResultQualifier = EvaluationResultQualifier'
{ _erqResourceId :: !(Maybe Text)
@@ -1500,11 +1497,11 @@ data EvaluationResultQualifier = EvaluationResultQualifier'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'erqResourceId'
+-- * 'erqResourceId' - The ID of the evaluated AWS resource.
--
--- * 'erqResourceType'
+-- * 'erqResourceType' - The type of AWS resource that was evaluated.
--
--- * 'erqConfigRuleName'
+-- * 'erqConfigRuleName' - The name of the AWS Config rule that was used in the evaluation.
evaluationResultQualifier
:: EvaluationResultQualifier
evaluationResultQualifier =
@@ -1540,19 +1537,21 @@ instance NFData EvaluationResultQualifier
-- | Specifies the types of AWS resource for which AWS Config records configuration changes.
--
+--
-- In the recording group, you specify whether all supported types or specific types of resources are recorded.
--
-- By default, AWS Config records configuration changes for all supported types of regional resources that AWS Config discovers in the region in which it is running. Regional resources are tied to a region and can be used only in that region. Examples of regional resources are EC2 instances and EBS volumes.
--
-- You can also have AWS Config record configuration changes for supported types of global resources (for example, IAM resources). Global resources are not tied to an individual region and can be used in all regions.
--
--- The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.
+-- /Important:/ The configuration details for any global resource are the same in all regions. If you customize AWS Config in multiple regions to record global resources, it will create multiple configuration items each time a global resource changes: one configuration item for each region. These configuration items will contain identical data. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources, unless you want the configuration items to be available in multiple regions.
--
--- If you don\'t want AWS Config to record all resources, you can specify which types of resources it will record with the 'resourceTypes' parameter.
+-- If you don't want AWS Config to record all resources, you can specify which types of resources it will record with the @resourceTypes@ parameter.
--
--- For a list of supported resource types, see <http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources Supported resource types>.
+-- For a list of supported resource types, see <http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources Supported resource types> .
+--
+-- For more information, see <http://docs.aws.amazon.com/config/latest/developerguide/select-resources.html Selecting Which Resources AWS Config Records> .
--
--- For more information, see <http://docs.aws.amazon.com/config/latest/developerguide/select-resources.html Selecting Which Resources AWS Config Records>.
--
-- /See:/ 'recordingGroup' smart constructor.
data RecordingGroup = RecordingGroup'
@@ -1565,11 +1564,11 @@ data RecordingGroup = RecordingGroup'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'rgAllSupported'
+-- * 'rgAllSupported' - Specifies whether AWS Config records configuration changes for every supported type of regional resource. If you set this option to @true@ , when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type. If you set this option to @true@ , you cannot enumerate a list of @resourceTypes@ .
--
--- * 'rgIncludeGlobalResourceTypes'
+-- * 'rgIncludeGlobalResourceTypes' - Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records. Before you can set this option to @true@ , you must set the @allSupported@ option to @true@ . If you set this option to @true@ , when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type. The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.
--
--- * 'rgResourceTypes'
+-- * 'rgResourceTypes' - A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, @AWS::EC2::Instance@ or @AWS::CloudTrail::Trail@ ). Before you can set this option to @true@ , you must set the @allSupported@ option to @false@ . If you set this option to @true@ , when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group. For a list of valid @resourceTypes@ values, see the __resourceType Value__ column in <http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources Supported AWS Resource Types> .
recordingGroup
:: RecordingGroup
recordingGroup =
@@ -1579,31 +1578,15 @@ recordingGroup =
, _rgResourceTypes = Nothing
}
--- | Specifies whether AWS Config records configuration changes for every supported type of regional resource.
---
--- If you set this option to 'true', when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type.
---
--- If you set this option to 'true', you cannot enumerate a list of 'resourceTypes'.
+-- | Specifies whether AWS Config records configuration changes for every supported type of regional resource. If you set this option to @true@ , when AWS Config adds support for a new type of regional resource, it automatically starts recording resources of that type. If you set this option to @true@ , you cannot enumerate a list of @resourceTypes@ .
rgAllSupported :: Lens' RecordingGroup (Maybe Bool)
rgAllSupported = lens _rgAllSupported (\ s a -> s{_rgAllSupported = a});
--- | Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.
---
--- Before you can set this option to 'true', you must set the 'allSupported' option to 'true'.
---
--- If you set this option to 'true', when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type.
---
--- The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.
+-- | Specifies whether AWS Config includes all supported types of global resources (for example, IAM resources) with the resources that it records. Before you can set this option to @true@ , you must set the @allSupported@ option to @true@ . If you set this option to @true@ , when AWS Config adds support for a new type of global resource, it automatically starts recording resources of that type. The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing AWS Config in only one region to record global resources.
rgIncludeGlobalResourceTypes :: Lens' RecordingGroup (Maybe Bool)
rgIncludeGlobalResourceTypes = lens _rgIncludeGlobalResourceTypes (\ s a -> s{_rgIncludeGlobalResourceTypes = a});
--- | A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, 'AWS::EC2::Instance' or 'AWS::CloudTrail::Trail').
---
--- Before you can set this option to 'true', you must set the 'allSupported' option to 'false'.
---
--- If you set this option to 'true', when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group.
---
--- For a list of valid 'resourceTypes' values, see the __resourceType Value__ column in <http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources Supported AWS Resource Types>.
+-- | A comma-separated list that specifies the types of AWS resources for which AWS Config records configuration changes (for example, @AWS::EC2::Instance@ or @AWS::CloudTrail::Trail@ ). Before you can set this option to @true@ , you must set the @allSupported@ option to @false@ . If you set this option to @true@ , when AWS Config adds support for a new type of resource, it will not record resources of that type unless you manually add that type to your recording group. For a list of valid @resourceTypes@ values, see the __resourceType Value__ column in <http://docs.aws.amazon.com/config/latest/developerguide/resource-config-reference.html#supported-resources Supported AWS Resource Types> .
rgResourceTypes :: Lens' RecordingGroup [ResourceType]
rgResourceTypes = lens _rgResourceTypes (\ s a -> s{_rgResourceTypes = a}) . _Default . _Coerce;
@@ -1631,6 +1614,8 @@ instance ToJSON RecordingGroup where
-- | The relationship of the related resource to the main resource.
--
+--
+--
-- /See:/ 'relationship' smart constructor.
data Relationship = Relationship'
{ _rResourceId :: !(Maybe Text)
@@ -1643,13 +1628,13 @@ data Relationship = Relationship'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'rResourceId'
+-- * 'rResourceId' - The ID of the related resource (for example, @sg-xxxxxx@ ).
--
--- * 'rResourceType'
+-- * 'rResourceType' - The resource type of the related resource.
--
--- * 'rResourceName'
+-- * 'rResourceName' - The custom name of the related resource, if available.
--
--- * 'rRelationshipName'
+-- * 'rRelationshipName' - The type of relationship with the related resource.
relationship
:: Relationship
relationship =
@@ -1660,7 +1645,7 @@ relationship =
, _rRelationshipName = Nothing
}
--- | The ID of the related resource (for example, 'sg-xxxxxx').
+-- | The ID of the related resource (for example, @sg-xxxxxx@ ).
rResourceId :: Lens' Relationship (Maybe Text)
rResourceId = lens _rResourceId (\ s a -> s{_rResourceId = a});
@@ -1691,6 +1676,8 @@ instance NFData Relationship
-- | The details that identify a resource that is discovered by AWS Config, including the resource type, ID, and (if available) the custom resource name.
--
+--
+--
-- /See:/ 'resourceIdentifier' smart constructor.
data ResourceIdentifier = ResourceIdentifier'
{ _riResourceId :: !(Maybe Text)
@@ -1703,13 +1690,13 @@ data ResourceIdentifier = ResourceIdentifier'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'riResourceId'
+-- * 'riResourceId' - The ID of the resource (for example., @sg-xxxxxx@ ).
--
--- * 'riResourceType'
+-- * 'riResourceType' - The type of resource.
--
--- * 'riResourceName'
+-- * 'riResourceName' - The custom name of the resource (if available).
--
--- * 'riResourceDeletionTime'
+-- * 'riResourceDeletionTime' - The time that the resource was deleted.
resourceIdentifier
:: ResourceIdentifier
resourceIdentifier =
@@ -1720,7 +1707,7 @@ resourceIdentifier =
, _riResourceDeletionTime = Nothing
}
--- | The ID of the resource (for example., 'sg-xxxxxx').
+-- | The ID of the resource (for example., @sg-xxxxxx@ ).
riResourceId :: Lens' ResourceIdentifier (Maybe Text)
riResourceId = lens _riResourceId (\ s a -> s{_riResourceId = a});
@@ -1751,6 +1738,8 @@ instance NFData ResourceIdentifier
-- | Defines which resources trigger an evaluation for an AWS Config rule. The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.
--
+--
+--
-- /See:/ 'scope' smart constructor.
data Scope = Scope'
{ _sComplianceResourceTypes :: !(Maybe [Text])
@@ -1763,13 +1752,13 @@ data Scope = Scope'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'sComplianceResourceTypes'
+-- * 'sComplianceResourceTypes' - The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for @ComplianceResourceId@ .
--
--- * 'sComplianceResourceId'
+-- * 'sComplianceResourceId' - The IDs of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for @ComplianceResourceTypes@ .
--
--- * 'sTagValue'
+-- * 'sTagValue' - The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for @TagValue@ , you must also specify a value for @TagKey@ .
--
--- * 'sTagKey'
+-- * 'sTagKey' - The tag key that is applied to only those AWS resources that you want you want to trigger an evaluation for the rule.
scope
:: Scope
scope =
@@ -1780,15 +1769,15 @@ scope =
, _sTagKey = Nothing
}
--- | The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for 'ComplianceResourceId'.
+-- | The resource types of only those AWS resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for @ComplianceResourceId@ .
sComplianceResourceTypes :: Lens' Scope [Text]
sComplianceResourceTypes = lens _sComplianceResourceTypes (\ s a -> s{_sComplianceResourceTypes = a}) . _Default . _Coerce;
--- | The IDs of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for 'ComplianceResourceTypes'.
+-- | The IDs of the only AWS resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for @ComplianceResourceTypes@ .
sComplianceResourceId :: Lens' Scope (Maybe Text)
sComplianceResourceId = lens _sComplianceResourceId (\ s a -> s{_sComplianceResourceId = a});
--- | The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for 'TagValue', you must also specify a value for 'TagKey'.
+-- | The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule. If you specify a value for @TagValue@ , you must also specify a value for @TagKey@ .
sTagValue :: Lens' Scope (Maybe Text)
sTagValue = lens _sTagValue (\ s a -> s{_sTagValue = a});
@@ -1823,6 +1812,8 @@ instance ToJSON Scope where
-- | Provides the AWS Config rule owner (AWS or customer), the rule identifier, and the events that trigger the evaluation of your AWS resources.
--
+--
+--
-- /See:/ 'source' smart constructor.
data Source = Source'
{ _sSourceIdentifier :: !(Maybe Text)
@@ -1834,11 +1825,11 @@ data Source = Source'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'sSourceIdentifier'
+-- * 'sSourceIdentifier' - For AWS Config managed rules, a predefined identifier from a list. For example, @IAM_PASSWORD_POLICY@ is a managed rule. To reference a managed rule, see <http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html Using AWS Managed Config Rules> . For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as @arn:aws:lambda:us-east-1:123456789012:function:custom_rule_name@ .
--
--- * 'sOwner'
+-- * 'sOwner' - Indicates whether AWS or the customer owns and manages the AWS Config rule.
--
--- * 'sSourceDetails'
+-- * 'sSourceDetails' - Provides the source and type of the event that causes AWS Config to evaluate your AWS resources.
source
:: Source
source =
@@ -1848,9 +1839,7 @@ source =
, _sSourceDetails = Nothing
}
--- | For AWS managed Config rules, a pre-defined identifier from a list. To reference the list, see <http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html Using AWS Managed Config Rules>.
---
--- For custom Config rules, the identifier is the Amazon Resource Name (ARN) of the rule\'s AWS Lambda function.
+-- | For AWS Config managed rules, a predefined identifier from a list. For example, @IAM_PASSWORD_POLICY@ is a managed rule. To reference a managed rule, see <http://docs.aws.amazon.com/config/latest/developerguide/evaluate-config_use-managed-rules.html Using AWS Managed Config Rules> . For custom rules, the identifier is the Amazon Resource Name (ARN) of the rule's AWS Lambda function, such as @arn:aws:lambda:us-east-1:123456789012:function:custom_rule_name@ .
sSourceIdentifier :: Lens' Source (Maybe Text)
sSourceIdentifier = lens _sSourceIdentifier (\ s a -> s{_sSourceIdentifier = a});
@@ -1882,7 +1871,9 @@ instance ToJSON Source where
("Owner" .=) <$> _sOwner,
("SourceDetails" .=) <$> _sSourceDetails])
--- | Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for 'SourceDetail' only for custom rules.
+-- | Provides the source and the message types that trigger AWS Config to evaluate your AWS resources against a rule. It also provides the frequency with which you want AWS Config to run evaluations for the rule if the trigger type is periodic. You can specify the parameter values for @SourceDetail@ only for custom rules.
+--
+--
--
-- /See:/ 'sourceDetail' smart constructor.
data SourceDetail = SourceDetail'
@@ -1895,11 +1886,11 @@ data SourceDetail = SourceDetail'
--
-- Use one of the following lenses to modify other fields as desired:
--
--- * 'sdMessageType'
+-- * 'sdMessageType' - The type of notification that triggers AWS Config to run an evaluation. You can specify the following notification types: @ConfigurationItemChangeNotification@ - Triggers an evaluation when AWS Config delivers a configuration item change notification. @ScheduledNotification@ - Triggers a periodic evaluation at the frequency specified for @MaximumExecutionFrequency@ . @ConfigurationSnapshotDeliveryCompleted@ - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.
--
--- * 'sdMaximumExecutionFrequency'
+-- * 'sdMaximumExecutionFrequency' - The frequency that you want AWS Config to run evaluations for a rule that is triggered periodically. If you specify a value for @MaximumExecutionFrequency@ , then @MessageType@ must use the @ScheduledNotification@ value.
--
--- * 'sdEventSource'
+-- * 'sdEventSource' - The source of the event, such as an AWS service, that triggers AWS Config to evaluate your AWS resources.
sourceDetail
:: SourceDetail
sourceDetail =
@@ -1909,17 +1900,11 @@ sourceDetail =
, _sdEventSource = Nothing
}
--- | The type of notification that triggers AWS Config to run an evaluation. You can specify the following notification types:
---
--- 'ConfigurationItemChangeNotification' - Triggers an evaluation when AWS Config delivers a configuration item change notification.
---
--- 'ScheduledNotification' - Triggers a periodic evaluation at the frequency specified for 'MaximumExecutionFrequency'.
---
--- 'ConfigurationSnapshotDeliveryCompleted' - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.
+-- | The type of notification that triggers AWS Config to run an evaluation. You can specify the following notification types: @ConfigurationItemChangeNotification@ - Triggers an evaluation when AWS Config delivers a configuration item change notification. @ScheduledNotification@ - Triggers a periodic evaluation at the frequency specified for @MaximumExecutionFrequency@ . @ConfigurationSnapshotDeliveryCompleted@ - Triggers a periodic evaluation when AWS Config delivers a configuration snapshot.
sdMessageType :: Lens' SourceDetail (Maybe MessageType)
sdMessageType = lens _sdMessageType (\ s a -> s{_sdMessageType = a});
--- | The frequency that you want AWS Config to run evaluations for a rule that is triggered periodically. If you specify a value for 'MaximumExecutionFrequency', then 'MessageType' must use the 'ScheduledNotification' value.
+-- | The frequency that you want AWS Config to run evaluations for a rule that is triggered periodically. If you specify a value for @MaximumExecutionFrequency@ , then @MessageType@ must use the @ScheduledNotification@ value.
sdMaximumExecutionFrequency :: Lens' SourceDetail (Maybe MaximumExecutionFrequency)
sdMaximumExecutionFrequency = lens _sdMaximumExecutionFrequency (\ s a -> s{_sdMaximumExecutionFrequency = a});
diff --git a/gen/Network/AWS/Config/Types/Sum.hs b/gen/Network/AWS/Config/Types/Sum.hs
index 5d433d1..cd5ef49 100644
--- a/gen/Network/AWS/Config/Types/Sum.hs
+++ b/gen/Network/AWS/Config/Types/Sum.hs
@@ -357,6 +357,7 @@ data ResourceType
| AWSRDSDBSnapshot
| AWSRDSDBSubnetGroup
| AWSRDSEventSubscription
+ | AWSS3Bucket
deriving (Eq,Ord,Read,Show,Enum,Bounded,Data,Typeable,Generic)
instance FromText ResourceType where
@@ -387,8 +388,9 @@ instance FromText ResourceType where
"aws::rds::dbsnapshot" -> pure AWSRDSDBSnapshot
"aws::rds::dbsubnetgroup" -> pure AWSRDSDBSubnetGroup
"aws::rds::eventsubscription" -> pure AWSRDSEventSubscription
+ "aws::s3::bucket" -> pure AWSS3Bucket
e -> fromTextError $ "Failure parsing ResourceType from value: '" <> e
- <> "'. Accepted values: aws::acm::certificate, aws::cloudtrail::trail, aws::ec2::customergateway, aws::ec2::eip, aws::ec2::host, aws::ec2::instance, aws::ec2::internetgateway, aws::ec2::networkacl, aws::ec2::networkinterface, aws::ec2::routetable, aws::ec2::securitygroup, aws::ec2::subnet, aws::ec2::vpc, aws::ec2::vpnconnection, aws::ec2::vpngateway, aws::ec2::volume, aws::elasticloadbalancingv2::loadbalancer, aws::iam::group, aws::iam::policy, aws::iam::role, aws::iam::user, aws::rds::dbinstance, aws::rds::dbsecuritygroup, aws::rds::dbsnapshot, aws::rds::dbsubnetgroup, aws::rds::eventsubscription"
+ <> "'. Accepted values: aws::acm::certificate, aws::cloudtrail::trail, aws::ec2::customergateway, aws::ec2::eip, aws::ec2::host, aws::ec2::instance, aws::ec2::internetgateway, aws::ec2::networkacl, aws::ec2::networkinterface, aws::ec2::routetable, aws::ec2::securitygroup, aws::ec2::subnet, aws::ec2::vpc, aws::ec2::vpnconnection, aws::ec2::vpngateway, aws::ec2::volume, aws::elasticloadbalancingv2::loadbalancer, aws::iam::group, aws::iam::policy, aws::iam::role, aws::iam::user, aws::rds::dbinstance, aws::rds::dbsecuritygroup, aws::rds::dbsnapshot, aws::rds::dbsubnetgroup, aws::rds::eventsubscription, aws::s3::bucket"
instance ToText ResourceType where
toText = \case
@@ -418,6 +420,7 @@ instance ToText ResourceType where
AWSRDSDBSnapshot -> "AWS::RDS::DBSnapshot"
AWSRDSDBSubnetGroup -> "AWS::RDS::DBSubnetGroup"
AWSRDSEventSubscription -> "AWS::RDS::EventSubscription"
+ AWSS3Bucket -> "AWS::S3::Bucket"
instance Hashable ResourceType
instance NFData ResourceType