Regenerating all services with updated HTML->Haddock conversion

amazonka-apigateway/README.md

@@ -13,22 +13,23 @@
 
 ## Description
 
-Amazon API Gateway
-
-Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. 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/).
 
 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.APIGateway](http://hackage.haskell.org/package/amazonka-apigateway/docs/Network-AWS-APIGateway.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).

amazonka-apigateway/amazonka-apigateway.cabal

@@ -13,22 +13,19 @@ build-type:            Simple
 cabal-version:         >= 1.10
 extra-source-files:    README.md fixture/*.yaml fixture/*.proto src/.gitkeep
 description:
-    Amazon API Gateway
-
-    Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. 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
-    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.APIGateway" or <https://aws.amazon.com/documentation/ the AWS Documentation>
+    See "Network.AWS.APIGateway" or <https://aws.amazon.com/documentation/ the AWS documentation>
     to get started.
 
 source-repository head

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

@@ -11,9 +11,10 @@
 -- Stability   : auto-generated
 -- Portability : non-portable (GHC extensions)
 --
--- Amazon API Gateway
+-- __Amazon API Gateway__
 --
 -- Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. 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/CreateAPIKey.hs

@@ -18,7 +18,8 @@
 -- Stability   : auto-generated
 -- Portability : non-portable (GHC extensions)
 --
--- Create an < ApiKey> resource.
+-- Create an 'ApiKey' resource.
+--
 --
 -- <http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-api-key.html AWS CLI>
 module Network.AWS.APIGateway.CreateAPIKey
@@ -55,7 +56,9 @@ import           Network.AWS.Prelude
 import           Network.AWS.Request
 import           Network.AWS.Response
 
--- | Request to create an < ApiKey> resource.
+-- | Request to create an 'ApiKey' resource.
+--
+--
 --
 -- /See:/ 'createAPIKey' smart constructor.
 data CreateAPIKey = CreateAPIKey'
@@ -71,17 +74,17 @@ data CreateAPIKey = CreateAPIKey'
 --
 -- Use one of the following lenses to modify other fields as desired:
 --
--- * 'cakEnabled'
+-- * 'cakEnabled' - Specifies whether the 'ApiKey' can be used by callers.
 --
--- * 'cakValue'
+-- * 'cakValue' - Specifies a value of the API key.
 --
--- * 'cakGenerateDistinctId'
+-- * 'cakGenerateDistinctId' - Specifies whether (@true@ ) or not (@false@ ) the key identifier is distinct from the created API key value.
 --
--- * 'cakName'
+-- * 'cakName' - The name of the 'ApiKey' .
 --
--- * 'cakStageKeys'
+-- * 'cakStageKeys' - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
 --
--- * 'cakDescription'
+-- * 'cakDescription' - The description of the 'ApiKey' .
 createAPIKey
     :: CreateAPIKey
 createAPIKey =
@@ -94,27 +97,27 @@ createAPIKey =
     , _cakDescription = Nothing
     }
 
--- | Specifies whether the < ApiKey> can be used by callers.
+-- | Specifies whether the 'ApiKey' can be used by callers.
 cakEnabled :: Lens' CreateAPIKey (Maybe Bool)
 cakEnabled = lens _cakEnabled (\ s a -> s{_cakEnabled = a});
 
 -- | Specifies a value of the API key.
 cakValue :: Lens' CreateAPIKey (Maybe Text)
 cakValue = lens _cakValue (\ s a -> s{_cakValue = a});
 
--- | Specifies whether ('true') or not ('false') the key identifier is distinct from the created API key value.
+-- | Specifies whether (@true@ ) or not (@false@ ) the key identifier is distinct from the created API key value.
 cakGenerateDistinctId :: Lens' CreateAPIKey (Maybe Bool)
 cakGenerateDistinctId = lens _cakGenerateDistinctId (\ s a -> s{_cakGenerateDistinctId = a});
 
--- | The name of the < ApiKey>.
+-- | The name of the 'ApiKey' .
 cakName :: Lens' CreateAPIKey (Maybe Text)
 cakName = lens _cakName (\ s a -> s{_cakName = a});
 
 -- | DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
 cakStageKeys :: Lens' CreateAPIKey [StageKey]
 cakStageKeys = lens _cakStageKeys (\ s a -> s{_cakStageKeys = a}) . _Default . _Coerce;
 
--- | The description of the < ApiKey>.
+-- | The description of the 'ApiKey' .
 cakDescription :: Lens' CreateAPIKey (Maybe Text)
 cakDescription = lens _cakDescription (\ s a -> s{_cakDescription = a});
 

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

@@ -18,7 +18,8 @@
 -- Stability   : auto-generated
 -- Portability : non-portable (GHC extensions)
 --
--- Adds a new < Authorizer> resource to an existing < RestApi> resource.
+-- Adds a new 'Authorizer' resource to an existing 'RestApi' resource.
+--
 --
 -- <http://docs.aws.amazon.com/cli/latest/reference/apigateway/create-authorizer.html AWS CLI>
 module Network.AWS.APIGateway.CreateAuthorizer
@@ -61,7 +62,9 @@ import           Network.AWS.Prelude
 import           Network.AWS.Request
 import           Network.AWS.Response
 
--- | Request to add a new < Authorizer> to an existing < RestApi> resource.
+-- | Request to add a new 'Authorizer' to an existing 'RestApi' resource.
+--
+--
 --
 -- /See:/ 'createAuthorizer' smart constructor.
 data CreateAuthorizer = CreateAuthorizer'
@@ -81,25 +84,25 @@ data CreateAuthorizer = CreateAuthorizer'
 --
 -- Use one of the following lenses to modify other fields as desired:
 --
--- * 'caAuthorizerURI'
+-- * 'caAuthorizerURI' - [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
 --
--- * 'caIdentityValidationExpression'
+-- * 'caIdentityValidationExpression' - A validation expression for the incoming identity.
 --
--- * 'caProviderARNs'
+-- * 'caProviderARNs' - A list of the Cognito Your User Pool authorizer's provider ARNs.
 --
--- * 'caAuthorizerResultTtlInSeconds'
+-- * 'caAuthorizerResultTtlInSeconds' - The TTL of cached authorizer results.
 --
--- * 'caAuthType'
+-- * 'caAuthType' - Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
 --
--- * 'caAuthorizerCredentials'
+-- * 'caAuthorizerCredentials' - Specifies the credentials required for the authorizer, if any.
 --
--- * 'caRestAPIId'
+-- * 'caRestAPIId' - The 'RestApi' identifier under which the 'Authorizer' will be created.
 --
--- * 'caName'
+-- * 'caName' - [Required] The name of the authorizer.
 --
--- * 'caType'
+-- * 'caType' - [Required] The type of the authorizer.
 --
--- * 'caIdentitySource'
+-- * 'caIdentitySource' - [Required] The source of the identity in an incoming request.
 createAuthorizer
     :: Text -- ^ 'caRestAPIId'
     -> Text -- ^ 'caName'
@@ -120,31 +123,31 @@ createAuthorizer pRestAPIId_ pName_ pType_ pIdentitySource_ =
     , _caIdentitySource = pIdentitySource_
     }
 
--- | [Required] Specifies the authorizer\'s Uniform Resource Identifier (URI).
+-- | [Required] Specifies the authorizer's Uniform Resource Identifier (URI).
 caAuthorizerURI :: Lens' CreateAuthorizer (Maybe Text)
 caAuthorizerURI = lens _caAuthorizerURI (\ s a -> s{_caAuthorizerURI = a});
 
 -- | A validation expression for the incoming identity.
 caIdentityValidationExpression :: Lens' CreateAuthorizer (Maybe Text)
 caIdentityValidationExpression = lens _caIdentityValidationExpression (\ s a -> s{_caIdentityValidationExpression = a});
 
--- | A list of the Cognito Your User Pool authorizer\'s provider ARNs.
+-- | A list of the Cognito Your User Pool authorizer's provider ARNs.
 caProviderARNs :: Lens' CreateAuthorizer [Text]
 caProviderARNs = lens _caProviderARNs (\ s a -> s{_caProviderARNs = a}) . _Default . _Coerce;
 
 -- | The TTL of cached authorizer results.
 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});
 
 -- | Specifies the credentials required for the authorizer, if any.
 caAuthorizerCredentials :: Lens' CreateAuthorizer (Maybe Text)
 caAuthorizerCredentials = lens _caAuthorizerCredentials (\ s a -> s{_caAuthorizerCredentials = a});
 
--- | The < RestApi> identifier under which the < Authorizer> will be created.
+-- | The 'RestApi' identifier under which the 'Authorizer' will be created.
 caRestAPIId :: Lens' CreateAuthorizer Text
 caRestAPIId = lens _caRestAPIId (\ s a -> s{_caRestAPIId = a});
 

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

@@ -18,7 +18,9 @@
 -- Stability   : auto-generated
 -- Portability : non-portable (GHC extensions)
 --
--- Creates a new < BasePathMapping> resource.
+-- Creates a new 'BasePathMapping' resource.
+--
+--
 module Network.AWS.APIGateway.CreateBasePathMapping
     (
     -- * Creating a Request
@@ -46,7 +48,9 @@ import           Network.AWS.Prelude
 import           Network.AWS.Request
 import           Network.AWS.Response
 
--- | Requests Amazon API Gateway to create a new < BasePathMapping> resource.
+-- | Requests Amazon API Gateway to create a new 'BasePathMapping' resource.
+--
+--
 --
 -- /See:/ 'createBasePathMapping' smart constructor.
 data CreateBasePathMapping = CreateBasePathMapping'
@@ -60,13 +64,13 @@ data CreateBasePathMapping = CreateBasePathMapping'
 --
 -- Use one of the following lenses to modify other fields as desired:
 --
--- * 'cbpmStage'
+-- * 'cbpmStage' - 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.
 --
--- * 'cbpmBasePath'
+-- * 'cbpmBasePath' - 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.
 --
--- * 'cbpmDomainName'
+-- * 'cbpmDomainName' - The domain name of the 'BasePathMapping' resource to create.
 --
--- * 'cbpmRestAPIId'
+-- * 'cbpmRestAPIId' - The name of the API that you want to apply this mapping to.
 createBasePathMapping
     :: Text -- ^ 'cbpmDomainName'
     -> Text -- ^ 'cbpmRestAPIId'
@@ -79,15 +83,15 @@ 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.
 cbpmBasePath :: Lens' CreateBasePathMapping (Maybe Text)
 cbpmBasePath = lens _cbpmBasePath (\ s a -> s{_cbpmBasePath = a});
 
--- | The domain name of the < BasePathMapping> resource to create.
+-- | The domain name of the 'BasePathMapping' resource to create.
 cbpmDomainName :: Lens' CreateBasePathMapping Text
 cbpmDomainName = lens _cbpmDomainName (\ s a -> s{_cbpmDomainName = a});
 

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

@@ -18,7 +18,9 @@
 -- 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
@@ -50,7 +52,9 @@ import           Network.AWS.Prelude
 import           Network.AWS.Request
 import           Network.AWS.Response
 
--- | Requests Amazon API Gateway to create a < Deployment> resource.
+-- | Requests Amazon API Gateway to create a 'Deployment' resource.
+--
+--
 --
 -- /See:/ 'createDeployment' smart constructor.
 data CreateDeployment = CreateDeployment'
@@ -67,19 +71,19 @@ data CreateDeployment = CreateDeployment'
 --
 -- Use one of the following lenses to modify other fields as desired:
 --
--- * 'cdStageDescription'
+-- * 'cdStageDescription' - The description of the 'Stage' resource for the 'Deployment' resource to create.
 --
--- * 'cdVariables'
+-- * 'cdVariables' - A map that defines the stage variables for the 'Stage' resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match @[A-Za-z0-9-._~:/?#&=,]+@ .
 --
--- * 'cdCacheClusterSize'
+-- * 'cdCacheClusterSize' - Specifies the cache cluster size for the 'Stage' resource specified in the input, if a cache cluster is enabled.
 --
--- * 'cdCacheClusterEnabled'
+-- * 'cdCacheClusterEnabled' - Enables a cache cluster for the 'Stage' resource specified in the input.
 --
--- * 'cdDescription'
+-- * 'cdDescription' - The description for the 'Deployment' resource to create.
 --
--- * 'cdRestAPIId'
+-- * 'cdRestAPIId' - The 'RestApi' resource identifier for the 'Deployment' resource to create.
 --
--- * 'cdStageName'
+-- * 'cdStageName' - The name of the 'Stage' resource for the 'Deployment' resource to create.
 createDeployment
     :: Text -- ^ 'cdRestAPIId'
     -> Text -- ^ 'cdStageName'
@@ -95,31 +99,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 and underscore 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 and underscore 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.
+-- | 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});