Regenerating all service haddock documentation

amazonka-apigateway/README.md

@@ -15,11 +15,7 @@
 
 Amazon API Gateway
 
-Amazon API Gateway helps developers deliver robust, secure and scalable
-mobile and web application backends. Amazon API Gateway allows
-developers to securely connect mobile and web applications to APIs that
-run on AWS Lambda, Amazon EC2, or other publicly addressable web
-services that are hosted outside of AWS.
+Amazon API Gateway helps developers deliver robust, secure and scalable mobile and web application backends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
 
 Documentation is available via [Hackage](http://hackage.haskell.org/package/amazonka-apigateway)
 and the [AWS API Reference](https://aws.amazon.com/documentation/).

amazonka-apigateway/amazonka-apigateway.cabal

@@ -15,11 +15,7 @@ extra-source-files:    README.md fixture/*.yaml fixture/*.proto
 description:
     Amazon API Gateway
 
-    Amazon API Gateway helps developers deliver robust, secure and scalable
-    mobile and web application backends. Amazon API Gateway allows
-    developers to securely connect mobile and web applications to APIs that
-    run on AWS Lambda, Amazon EC2, or other publicly addressable web
-    services that are hosted outside of AWS.
+    Amazon API Gateway helps developers deliver robust, secure and scalable mobile and web application backends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
     .
     The types from this library are intended to be used with
     <http://hackage.haskell.org/package/amazonka amazonka>, which provides

amazonka-apigateway/gen/Network/AWS/APIGateway.hs

@@ -13,11 +13,7 @@
 --
 -- Amazon API Gateway
 --
--- Amazon API Gateway helps developers deliver robust, secure and scalable
--- mobile and web application backends. Amazon API Gateway allows
--- developers to securely connect mobile and web applications to APIs that
--- run on AWS Lambda, Amazon EC2, or other publicly addressable web
--- services that are hosted outside of AWS.
+-- Amazon API Gateway helps developers deliver robust, secure and scalable mobile and web application backends. Amazon API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.
 module Network.AWS.APIGateway
     (
     -- * Service Configuration

amazonka-apigateway/gen/Network/AWS/APIGateway/CreateAuthorizer.hs

@@ -121,8 +121,7 @@ caIdentityValidationExpression = lens _caIdentityValidationExpression (\ s a ->
 caAuthorizerResultTtlInSeconds :: Lens' CreateAuthorizer (Maybe Int)
 caAuthorizerResultTtlInSeconds = lens _caAuthorizerResultTtlInSeconds (\ s a -> s{_caAuthorizerResultTtlInSeconds = a});
 
--- | Optional customer-defined field, used in Swagger imports\/exports. Has
--- no functional impact.
+-- | Optional customer-defined field, used in Swagger imports\/exports. Has no functional impact.
 caAuthType :: Lens' CreateAuthorizer (Maybe Text)
 caAuthType = lens _caAuthType (\ s a -> s{_caAuthType = a});
 
@@ -142,8 +141,7 @@ caName = lens _caName (\ s a -> s{_caName = a});
 caType :: Lens' CreateAuthorizer AuthorizerType
 caType = lens _caType (\ s a -> s{_caType = a});
 
--- | [Required] Specifies the authorizer\'s Uniform Resource Identifier
--- (URI).
+-- | [Required] Specifies the authorizer\'s Uniform Resource Identifier (URI).
 caAuthorizerURI :: Lens' CreateAuthorizer Text
 caAuthorizerURI = lens _caAuthorizerURI (\ s a -> s{_caAuthorizerURI = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/CreateBasePathMapping.hs

@@ -79,16 +79,11 @@ createBasePathMapping pDomainName_ pRestAPIId_ =
     , _cbpmRestAPIId = pRestAPIId_
     }
 
--- | The name of the API\'s stage that you want to use for this mapping.
--- Leave this blank if you do not want callers to explicitly specify the
--- stage name after any base path name.
+-- | The name of the API\'s stage that you want to use for this mapping. Leave this blank if you do not want callers to explicitly specify the stage name after any base path name.
 cbpmStage :: Lens' CreateBasePathMapping (Maybe Text)
 cbpmStage = lens _cbpmStage (\ s a -> s{_cbpmStage = a});
 
--- | The base path name that callers of the API must provide as part of the
--- URL after the domain name. This value must be unique for all of the
--- mappings across a single API. Leave this blank if you do not want
--- callers to specify a base path name after the domain name.
+-- | The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify a base path name after the domain name.
 cbpmBasePath :: Lens' CreateBasePathMapping (Maybe Text)
 cbpmBasePath = lens _cbpmBasePath (\ s a -> s{_cbpmBasePath = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/CreateDeployment.hs

@@ -18,8 +18,7 @@
 -- Stability   : auto-generated
 -- Portability : non-portable (GHC extensions)
 --
--- Creates a < Deployment> resource, which makes a specified < RestApi>
--- callable over the internet.
+-- Creates a < Deployment> resource, which makes a specified < RestApi> callable over the internet.
 module Network.AWS.APIGateway.CreateDeployment
     (
     -- * Creating a Request
@@ -96,38 +95,31 @@ createDeployment pRestAPIId_ pStageName_ =
     , _cdStageName = pStageName_
     }
 
--- | The description of the < Stage> resource for the < Deployment> resource
--- to create.
+-- | The description of the < Stage> resource for the < Deployment> resource to create.
 cdStageDescription :: Lens' CreateDeployment (Maybe Text)
 cdStageDescription = lens _cdStageDescription (\ s a -> s{_cdStageDescription = a});
 
--- | A map that defines the stage variables for the < Stage> resource that is
--- associated with the new deployment. Variable names can have alphanumeric
--- characters, and the values must match '[A-Za-z0-9-._~:\/?#&=,]+'.
+-- | A map that defines the stage variables for the < Stage> resource that is associated with the new deployment. Variable names can have alphanumeric characters, and the values must match '[A-Za-z0-9-._~:\/?#&=,]+'.
 cdVariables :: Lens' CreateDeployment (HashMap Text Text)
 cdVariables = lens _cdVariables (\ s a -> s{_cdVariables = a}) . _Default . _Map;
 
--- | Specifies the cache cluster size for the < Stage> resource specified in
--- the input, if a cache cluster is enabled.
+-- | Specifies the cache cluster size for the < Stage> resource specified in the input, if a cache cluster is enabled.
 cdCacheClusterSize :: Lens' CreateDeployment (Maybe CacheClusterSize)
 cdCacheClusterSize = lens _cdCacheClusterSize (\ s a -> s{_cdCacheClusterSize = a});
 
--- | Enables a cache cluster for the < Stage> resource specified in the
--- input.
+-- | Enables a cache cluster for the < Stage> resource specified in the input.
 cdCacheClusterEnabled :: Lens' CreateDeployment (Maybe Bool)
 cdCacheClusterEnabled = lens _cdCacheClusterEnabled (\ s a -> s{_cdCacheClusterEnabled = a});
 
 -- | The description for the < Deployment> resource to create.
 cdDescription :: Lens' CreateDeployment (Maybe Text)
 cdDescription = lens _cdDescription (\ s a -> s{_cdDescription = a});
 
--- | The < RestApi> resource identifier for the < Deployment> resource to
--- create.
+-- | The < RestApi> resource identifier for the < Deployment> resource to create.
 cdRestAPIId :: Lens' CreateDeployment Text
 cdRestAPIId = lens _cdRestAPIId (\ s a -> s{_cdRestAPIId = a});
 
--- | The name of the < Stage> resource for the < Deployment> resource to
--- create.
+-- | The name of the < Stage> resource for the < Deployment> resource to create.
 cdStageName :: Lens' CreateDeployment Text
 cdStageName = lens _cdStageName (\ s a -> s{_cdStageName = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/CreateDomainName.hs

@@ -96,21 +96,15 @@ cdnDomainName = lens _cdnDomainName (\ s a -> s{_cdnDomainName = a});
 cdnCertificateName :: Lens' CreateDomainName Text
 cdnCertificateName = lens _cdnCertificateName (\ s a -> s{_cdnCertificateName = a});
 
--- | The body of the server certificate provided by your certificate
--- authority.
+-- | The body of the server certificate provided by your certificate authority.
 cdnCertificateBody :: Lens' CreateDomainName Text
 cdnCertificateBody = lens _cdnCertificateBody (\ s a -> s{_cdnCertificateBody = a});
 
 -- | Your certificate\'s private key.
 cdnCertificatePrivateKey :: Lens' CreateDomainName Text
 cdnCertificatePrivateKey = lens _cdnCertificatePrivateKey (\ s a -> s{_cdnCertificatePrivateKey = a});
 
--- | The intermediate certificates and optionally the root certificate, one
--- after the other without any blank lines. If you include the root
--- certificate, your certificate chain must start with intermediate
--- certificates and end with the root certificate. Use the intermediate
--- certificates that were provided by your certificate authority. Do not
--- include any intermediaries that are not in the chain of trust path.
+-- | The intermediate certificates and optionally the root certificate, one after the other without any blank lines. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.
 cdnCertificateChain :: Lens' CreateDomainName Text
 cdnCertificateChain = lens _cdnCertificateChain (\ s a -> s{_cdnCertificateChain = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/CreateModel.hs

@@ -87,8 +87,7 @@ createModel pRestAPIId_ pName_ pContentType_ =
     , _cmContentType = pContentType_
     }
 
--- | The schema for the model. For 'application\/json' models, this should be
--- <http://json-schema.org/documentation.html JSON-schema draft v4> model.
+-- | The schema for the model. For 'application\/json' models, this should be <http://json-schema.org/documentation.html JSON-schema draft v4> model.
 cmSchema :: Lens' CreateModel (Maybe Text)
 cmSchema = lens _cmSchema (\ s a -> s{_cmSchema = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/CreateStage.hs

@@ -18,8 +18,7 @@
 -- Stability   : auto-generated
 -- Portability : non-portable (GHC extensions)
 --
--- Creates a new < Stage> resource that references a pre-existing
--- < Deployment> for the API.
+-- Creates a new < Stage> resource that references a pre-existing < Deployment> for the API.
 module Network.AWS.APIGateway.CreateStage
     (
     -- * Creating a Request
@@ -104,9 +103,7 @@ createStage pRestAPIId_ pStageName_ pDeploymentId_ =
     , _csDeploymentId = pDeploymentId_
     }
 
--- | A map that defines the stage variables for the new < Stage> resource.
--- Variable names can have alphanumeric characters, and the values must
--- match '[A-Za-z0-9-._~:\/?#&=,]+'.
+-- | A map that defines the stage variables for the new < Stage> resource. Variable names can have alphanumeric characters, and the values must match '[A-Za-z0-9-._~:\/?#&=,]+'.
 csVariables :: Lens' CreateStage (HashMap Text Text)
 csVariables = lens _csVariables (\ s a -> s{_csVariables = a}) . _Default . _Map;
 
@@ -122,8 +119,7 @@ csCacheClusterEnabled = lens _csCacheClusterEnabled (\ s a -> s{_csCacheClusterE
 csDescription :: Lens' CreateStage (Maybe Text)
 csDescription = lens _csDescription (\ s a -> s{_csDescription = a});
 
--- | The identifier of the < RestApi> resource for the < Stage> resource to
--- create.
+-- | The identifier of the < RestApi> resource for the < Stage> resource to create.
 csRestAPIId :: Lens' CreateStage Text
 csRestAPIId = lens _csRestAPIId (\ s a -> s{_csRestAPIId = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/DeleteDeployment.hs

@@ -18,8 +18,7 @@
 -- Stability   : auto-generated
 -- Portability : non-portable (GHC extensions)
 --
--- Deletes a < Deployment> resource. Deleting a deployment will only
--- succeed if there are no < Stage> resources associated with it.
+-- Deletes a < Deployment> resource. Deleting a deployment will only succeed if there are no < Stage> resources associated with it.
 module Network.AWS.APIGateway.DeleteDeployment
     (
     -- * Creating a Request
@@ -66,8 +65,7 @@ deleteDeployment pRestAPIId_ pDeploymentId_ =
     , _ddDeploymentId = pDeploymentId_
     }
 
--- | The identifier of the < RestApi> resource for the < Deployment> resource
--- to delete.
+-- | The identifier of the < RestApi> resource for the < Deployment> resource to delete.
 ddRestAPIId :: Lens' DeleteDeployment Text
 ddRestAPIId = lens _ddRestAPIId (\ s a -> s{_ddRestAPIId = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/DeleteStage.hs

@@ -65,8 +65,7 @@ deleteStage pRestAPIId_ pStageName_ =
     , _dsStageName = pStageName_
     }
 
--- | The identifier of the < RestApi> resource for the < Stage> resource to
--- delete.
+-- | The identifier of the < RestApi> resource for the < Stage> resource to delete.
 dsRestAPIId :: Lens' DeleteStage Text
 dsRestAPIId = lens _dsRestAPIId (\ s a -> s{_dsRestAPIId = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/GetAPIKeys.hs

@@ -74,8 +74,7 @@ getAPIKeys =
 gakLimit :: Lens' GetAPIKeys (Maybe Int)
 gakLimit = lens _gakLimit (\ s a -> s{_gakLimit = a});
 
--- | The position of the current < ApiKeys> resource to get information
--- about.
+-- | The position of the current < ApiKeys> resource to get information about.
 gakPosition :: Lens' GetAPIKeys (Maybe Text)
 gakPosition = lens _gakPosition (\ s a -> s{_gakPosition = a});
 
@@ -142,8 +141,7 @@ getAPIKeysResponse pResponseStatus_ =
     , _gakrsResponseStatus = pResponseStatus_
     }
 
--- | The current page of any < ApiKey> resources in the collection of
--- < ApiKey> resources.
+-- | The current page of any < ApiKey> resources in the collection of < ApiKey> resources.
 gakrsItems :: Lens' GetAPIKeysResponse [APIKey]
 gakrsItems = lens _gakrsItems (\ s a -> s{_gakrsItems = a}) . _Default . _Coerce;
 

amazonka-apigateway/gen/Network/AWS/APIGateway/GetAccount.hs

@@ -40,8 +40,7 @@ import           Network.AWS.Prelude
 import           Network.AWS.Request
 import           Network.AWS.Response
 
--- | Requests Amazon API Gateway to get information about the current
--- < Account> resource.
+-- | Requests Amazon API Gateway to get information about the current < Account> resource.
 --
 -- /See:/ 'getAccount' smart constructor.
 data GetAccount =

amazonka-apigateway/gen/Network/AWS/APIGateway/GetAuthorizers.hs

@@ -77,8 +77,7 @@ getAuthorizers pRestAPIId_ =
 gaLimit :: Lens' GetAuthorizers (Maybe Int)
 gaLimit = lens _gaLimit (\ s a -> s{_gaLimit = a});
 
--- | If not all < Authorizer> resources in the response were present, the
--- position will specificy where to start the next page of results.
+-- | If not all < Authorizer> resources in the response were present, the position will specificy where to start the next page of results.
 gaPosition :: Lens' GetAuthorizers (Maybe Text)
 gaPosition = lens _gaPosition (\ s a -> s{_gaPosition = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/GetBasePathMapping.hs

@@ -73,10 +73,7 @@ getBasePathMapping pDomainName_ pBasePath_ =
 gbpmDomainName :: Lens' GetBasePathMapping Text
 gbpmDomainName = lens _gbpmDomainName (\ s a -> s{_gbpmDomainName = a});
 
--- | The base path name that callers of the API must provide as part of the
--- URL after the domain name. This value must be unique for all of the
--- mappings across a single API. Leave this blank if you do not want
--- callers to specify any base path name after the domain name.
+-- | The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Leave this blank if you do not want callers to specify any base path name after the domain name.
 gbpmBasePath :: Lens' GetBasePathMapping Text
 gbpmBasePath = lens _gbpmBasePath (\ s a -> s{_gbpmBasePath = a});
 

amazonka-apigateway/gen/Network/AWS/APIGateway/GetBasePathMappings.hs

@@ -48,8 +48,7 @@ import           Network.AWS.Prelude
 import           Network.AWS.Request
 import           Network.AWS.Response
 
--- | A request to get information about a collection of < BasePathMapping>
--- resources.
+-- | A request to get information about a collection of < BasePathMapping> resources.
 --
 -- /See:/ 'getBasePathMappings' smart constructor.
 data GetBasePathMappings = GetBasePathMappings'
@@ -77,14 +76,11 @@ getBasePathMappings pDomainName_ =
     , _gDomainName = pDomainName_
     }
 
--- | The maximum number of < BasePathMapping> resources in the collection to
--- get information about. The default limit is 25. It should be an integer
--- between 1 - 500.
+-- | The maximum number of < BasePathMapping> resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
 gLimit :: Lens' GetBasePathMappings (Maybe Int)
 gLimit = lens _gLimit (\ s a -> s{_gLimit = a});
 
--- | The position of the current < BasePathMapping> resource in the
--- collection to get information about.
+-- | The position of the current < BasePathMapping> resource in the collection to get information about.
 gPosition :: Lens' GetBasePathMappings (Maybe Text)
 gPosition = lens _gPosition (\ s a -> s{_gPosition = a});
 
@@ -159,8 +155,7 @@ getBasePathMappingsResponse pResponseStatus_ =
     , _gbpmrsResponseStatus = pResponseStatus_
     }
 
--- | The current page of any < BasePathMapping> resources in the collection
--- of base path mapping resources.
+-- | The current page of any < BasePathMapping> resources in the collection of base path mapping resources.
 gbpmrsItems :: Lens' GetBasePathMappingsResponse [BasePathMapping]
 gbpmrsItems = lens _gbpmrsItems (\ s a -> s{_gbpmrsItems = a}) . _Default . _Coerce;
 

amazonka-apigateway/gen/Network/AWS/APIGateway/GetClientCertificate.hs

@@ -45,8 +45,7 @@ import           Network.AWS.Prelude
 import           Network.AWS.Request
 import           Network.AWS.Response
 
--- | A request to get information about the current < ClientCertificate>
--- resource.
+-- | A request to get information about the current < ClientCertificate> resource.
 --
 -- /See:/ 'getClientCertificate' smart constructor.
 newtype GetClientCertificate = GetClientCertificate'

amazonka-apigateway/gen/Network/AWS/APIGateway/GetClientCertificates.hs

@@ -47,8 +47,7 @@ import           Network.AWS.Prelude
 import           Network.AWS.Request
 import           Network.AWS.Response
 
--- | A request to get information about a collection of < ClientCertificate>
--- resources.
+-- | A request to get information about a collection of < ClientCertificate> resources.
 --
 -- /See:/ 'getClientCertificates' smart constructor.
 data GetClientCertificates = GetClientCertificates'
@@ -71,14 +70,11 @@ getClientCertificates =
     , _gccPosition = Nothing
     }
 
--- | The maximum number of < ClientCertificate> resources in the collection
--- to get information about. The default limit is 25. It should be an
--- integer between 1 - 500.
+-- | The maximum number of < ClientCertificate> resources in the collection to get information about. The default limit is 25. It should be an integer between 1 - 500.
 gccLimit :: Lens' GetClientCertificates (Maybe Int)
 gccLimit = lens _gccLimit (\ s a -> s{_gccLimit = a});
 
--- | The position of the current < ClientCertificate> resource in the
--- collection to get information about.
+-- | The position of the current < ClientCertificate> resource in the collection to get information about.
 gccPosition :: Lens' GetClientCertificates (Maybe Text)
 gccPosition = lens _gccPosition (\ s a -> s{_gccPosition = a});
 
@@ -146,8 +142,7 @@ getClientCertificatesResponse pResponseStatus_ =
     , _gccrsResponseStatus = pResponseStatus_
     }
 
--- | The current page of any < ClientCertificate> resources in the collection
--- of < ClientCertificate> resources.
+-- | The current page of any < ClientCertificate> resources in the collection of < ClientCertificate> resources.
 gccrsItems :: Lens' GetClientCertificatesResponse [ClientCertificate]
 gccrsItems = lens _gccrsItems (\ s a -> s{_gccrsItems = a}) . _Default . _Coerce;
 

amazonka-apigateway/gen/Network/AWS/APIGateway/GetDeployment.hs

@@ -45,8 +45,7 @@ import           Network.AWS.Prelude
 import           Network.AWS.Request
 import           Network.AWS.Response
 
--- | Requests Amazon API Gateway to get information about a < Deployment>
--- resource.
+-- | Requests Amazon API Gateway to get information about a < Deployment> resource.
 --
 -- /See:/ 'getDeployment' smart constructor.
 data GetDeployment = GetDeployment'
@@ -71,8 +70,7 @@ getDeployment pRestAPIId_ pDeploymentId_ =
     , _gDeploymentId = pDeploymentId_
     }
 
--- | The identifier of the < RestApi> resource for the < Deployment> resource
--- to get information about.
+-- | The identifier of the < RestApi> resource for the < Deployment> resource to get information about.
 gRestAPIId :: Lens' GetDeployment Text
 gRestAPIId = lens _gRestAPIId (\ s a -> s{_gRestAPIId = a});