Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- GetResource
- GetDeployments (Paginated)
- GetDeployment
- GetDomainNames (Paginated)
- GetClientCertificate
- GetMethodResponse
- GetModels (Paginated)
- GetBasePathMapping
- PutMethodResponse
- DeleteMethodResponse
- UpdateMethodResponse
- DeleteStage
- UpdateStage
- GetRestAPIs (Paginated)
- CreateDeployment
- CreateBasePathMapping
- GetIntegration
- UpdateAccount
- DeleteDeployment
- UpdateDeployment
- DeleteResource
- UpdateResource
- CreateModel
- GetIntegrationResponse
- CreateDomainName
- DeleteModel
- UpdateModel
- DeleteAPIKey
- UpdateAPIKey
- GetRestAPI
- GetStages
- GetMethod
- GetModel
- UpdateRestAPI
- DeleteRestAPI
- TestInvokeMethod
- GetDomainName
- PutIntegrationResponse
- FlushStageCache
- CreateRestAPI
- DeleteIntegrationResponse
- UpdateIntegrationResponse
- DeleteIntegration
- UpdateIntegration
- GenerateClientCertificate
- GetResources (Paginated)
- GetAccount
- PutIntegration
- GetStage
- GetSDK
- GetAPIKeys (Paginated)
- DeleteBasePathMapping
- UpdateBasePathMapping
- DeleteClientCertificate
- UpdateClientCertificate
- CreateStage
- CreateAPIKey
- PutMethod
- UpdateDomainName
- DeleteDomainName
- CreateResource
- DeleteMethod
- UpdateMethod
- GetClientCertificates (Paginated)
- GetModelTemplate
- GetBasePathMappings (Paginated)
- GetAPIKey
- Types
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.
See: AWS API Reference
- aPIGateway :: Service
- _ConflictException :: AsError a => Getting (First ServiceError) a ServiceError
- _NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- _TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError
- _ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError
- _UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError
- _BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError
- _LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.APIGateway.GetResource
- module Network.AWS.APIGateway.GetDeployments
- module Network.AWS.APIGateway.GetDeployment
- module Network.AWS.APIGateway.GetDomainNames
- module Network.AWS.APIGateway.GetClientCertificate
- module Network.AWS.APIGateway.GetMethodResponse
- module Network.AWS.APIGateway.GetModels
- module Network.AWS.APIGateway.GetBasePathMapping
- module Network.AWS.APIGateway.PutMethodResponse
- module Network.AWS.APIGateway.DeleteMethodResponse
- module Network.AWS.APIGateway.UpdateMethodResponse
- module Network.AWS.APIGateway.DeleteStage
- module Network.AWS.APIGateway.UpdateStage
- module Network.AWS.APIGateway.GetRestAPIs
- module Network.AWS.APIGateway.CreateDeployment
- module Network.AWS.APIGateway.CreateBasePathMapping
- module Network.AWS.APIGateway.GetIntegration
- module Network.AWS.APIGateway.UpdateAccount
- module Network.AWS.APIGateway.DeleteDeployment
- module Network.AWS.APIGateway.UpdateDeployment
- module Network.AWS.APIGateway.DeleteResource
- module Network.AWS.APIGateway.UpdateResource
- module Network.AWS.APIGateway.CreateModel
- module Network.AWS.APIGateway.GetIntegrationResponse
- module Network.AWS.APIGateway.CreateDomainName
- module Network.AWS.APIGateway.DeleteModel
- module Network.AWS.APIGateway.UpdateModel
- module Network.AWS.APIGateway.DeleteAPIKey
- module Network.AWS.APIGateway.UpdateAPIKey
- module Network.AWS.APIGateway.GetRestAPI
- module Network.AWS.APIGateway.GetStages
- module Network.AWS.APIGateway.GetMethod
- module Network.AWS.APIGateway.GetModel
- module Network.AWS.APIGateway.UpdateRestAPI
- module Network.AWS.APIGateway.DeleteRestAPI
- module Network.AWS.APIGateway.TestInvokeMethod
- module Network.AWS.APIGateway.GetDomainName
- module Network.AWS.APIGateway.PutIntegrationResponse
- module Network.AWS.APIGateway.FlushStageCache
- module Network.AWS.APIGateway.CreateRestAPI
- module Network.AWS.APIGateway.DeleteIntegrationResponse
- module Network.AWS.APIGateway.UpdateIntegrationResponse
- module Network.AWS.APIGateway.DeleteIntegration
- module Network.AWS.APIGateway.UpdateIntegration
- module Network.AWS.APIGateway.GenerateClientCertificate
- module Network.AWS.APIGateway.GetResources
- module Network.AWS.APIGateway.GetAccount
- module Network.AWS.APIGateway.PutIntegration
- module Network.AWS.APIGateway.GetStage
- module Network.AWS.APIGateway.GetSDK
- module Network.AWS.APIGateway.GetAPIKeys
- module Network.AWS.APIGateway.DeleteBasePathMapping
- module Network.AWS.APIGateway.UpdateBasePathMapping
- module Network.AWS.APIGateway.DeleteClientCertificate
- module Network.AWS.APIGateway.UpdateClientCertificate
- module Network.AWS.APIGateway.CreateStage
- module Network.AWS.APIGateway.CreateAPIKey
- module Network.AWS.APIGateway.PutMethod
- module Network.AWS.APIGateway.UpdateDomainName
- module Network.AWS.APIGateway.DeleteDomainName
- module Network.AWS.APIGateway.CreateResource
- module Network.AWS.APIGateway.DeleteMethod
- module Network.AWS.APIGateway.UpdateMethod
- module Network.AWS.APIGateway.GetClientCertificates
- module Network.AWS.APIGateway.GetModelTemplate
- module Network.AWS.APIGateway.GetBasePathMappings
- module Network.AWS.APIGateway.GetAPIKey
- data CacheClusterSize
- data CacheClusterStatus
- data IntegrationType
- data Op
- data APIKey
- apiKey :: APIKey
- akEnabled :: Lens' APIKey (Maybe Bool)
- akCreatedDate :: Lens' APIKey (Maybe UTCTime)
- akName :: Lens' APIKey (Maybe Text)
- akId :: Lens' APIKey (Maybe Text)
- akStageKeys :: Lens' APIKey [Text]
- akLastUpdatedDate :: Lens' APIKey (Maybe UTCTime)
- akDescription :: Lens' APIKey (Maybe Text)
- data Account
- account :: Account
- aCloudwatchRoleARN :: Lens' Account (Maybe Text)
- aThrottleSettings :: Lens' Account (Maybe ThrottleSettings)
- data BasePathMapping
- basePathMapping :: BasePathMapping
- bpmStage :: Lens' BasePathMapping (Maybe Text)
- bpmBasePath :: Lens' BasePathMapping (Maybe Text)
- bpmRestAPIId :: Lens' BasePathMapping (Maybe Text)
- data ClientCertificate
- clientCertificate :: ClientCertificate
- ccPemEncodedCertificate :: Lens' ClientCertificate (Maybe Text)
- ccClientCertificateId :: Lens' ClientCertificate (Maybe Text)
- ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime)
- ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime)
- ccDescription :: Lens' ClientCertificate (Maybe Text)
- data Deployment
- deployment :: Deployment
- dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot))
- dCreatedDate :: Lens' Deployment (Maybe UTCTime)
- dId :: Lens' Deployment (Maybe Text)
- dDescription :: Lens' Deployment (Maybe Text)
- data DomainName
- domainName :: DomainName
- dnCertificateName :: Lens' DomainName (Maybe Text)
- dnDomainName :: Lens' DomainName (Maybe Text)
- dnCertificateUploadDate :: Lens' DomainName (Maybe UTCTime)
- dnDistributionDomainName :: Lens' DomainName (Maybe Text)
- data Integration
- integration :: Integration
- iHttpMethod :: Lens' Integration (Maybe Text)
- iRequestTemplates :: Lens' Integration (HashMap Text Text)
- iCredentials :: Lens' Integration (Maybe Text)
- iRequestParameters :: Lens' Integration (HashMap Text Text)
- iUri :: Lens' Integration (Maybe Text)
- iIntegrationResponses :: Lens' Integration (HashMap Text IntegrationResponse)
- iCacheNamespace :: Lens' Integration (Maybe Text)
- iType :: Lens' Integration (Maybe IntegrationType)
- iCacheKeyParameters :: Lens' Integration [Text]
- data IntegrationResponse
- integrationResponse :: IntegrationResponse
- iResponseTemplates :: Lens' IntegrationResponse (HashMap Text Text)
- iSelectionPattern :: Lens' IntegrationResponse (Maybe Text)
- iStatusCode :: Lens' IntegrationResponse (Maybe Text)
- iResponseParameters :: Lens' IntegrationResponse (HashMap Text Text)
- data Method
- method :: Method
- mMethodResponses :: Lens' Method (HashMap Text MethodResponse)
- mHttpMethod :: Lens' Method (Maybe Text)
- mRequestModels :: Lens' Method (HashMap Text Text)
- mRequestParameters :: Lens' Method (HashMap Text Bool)
- mAuthorizationType :: Lens' Method (Maybe Text)
- mApiKeyRequired :: Lens' Method (Maybe Bool)
- mMethodIntegration :: Lens' Method (Maybe Integration)
- data MethodResponse
- methodResponse :: MethodResponse
- mResponseModels :: Lens' MethodResponse (HashMap Text Text)
- mStatusCode :: Lens' MethodResponse (Maybe Text)
- mResponseParameters :: Lens' MethodResponse (HashMap Text Bool)
- data MethodSetting
- methodSetting :: MethodSetting
- msCacheTtlInSeconds :: Lens' MethodSetting (Maybe Int)
- msDataTraceEnabled :: Lens' MethodSetting (Maybe Bool)
- msThrottlingBurstLimit :: Lens' MethodSetting (Maybe Int)
- msCacheDataEncrypted :: Lens' MethodSetting (Maybe Bool)
- msLoggingLevel :: Lens' MethodSetting (Maybe Text)
- msCachingEnabled :: Lens' MethodSetting (Maybe Bool)
- msMetricsEnabled :: Lens' MethodSetting (Maybe Bool)
- msThrottlingRateLimit :: Lens' MethodSetting (Maybe Double)
- data MethodSnapshot
- methodSnapshot :: MethodSnapshot
- msAuthorizationType :: Lens' MethodSnapshot (Maybe Text)
- msApiKeyRequired :: Lens' MethodSnapshot (Maybe Bool)
- data Model
- model :: Model
- mSchema :: Lens' Model (Maybe Text)
- mName :: Lens' Model (Maybe Text)
- mId :: Lens' Model (Maybe Text)
- mDescription :: Lens' Model (Maybe Text)
- mContentType :: Lens' Model (Maybe Text)
- data PatchOperation
- patchOperation :: PatchOperation
- poOp :: Lens' PatchOperation (Maybe Op)
- poPath :: Lens' PatchOperation (Maybe Text)
- poValue :: Lens' PatchOperation (Maybe Text)
- poFrom :: Lens' PatchOperation (Maybe Text)
- data Resource
- resource :: Resource
- rPathPart :: Lens' Resource (Maybe Text)
- rPath :: Lens' Resource (Maybe Text)
- rId :: Lens' Resource (Maybe Text)
- rResourceMethods :: Lens' Resource (HashMap Text Method)
- rParentId :: Lens' Resource (Maybe Text)
- data RestAPI
- restAPI :: RestAPI
- raCreatedDate :: Lens' RestAPI (Maybe UTCTime)
- raName :: Lens' RestAPI (Maybe Text)
- raId :: Lens' RestAPI (Maybe Text)
- raDescription :: Lens' RestAPI (Maybe Text)
- data Stage
- stage :: Stage
- sDeploymentId :: Lens' Stage (Maybe Text)
- sVariables :: Lens' Stage (HashMap Text Text)
- sClientCertificateId :: Lens' Stage (Maybe Text)
- sCreatedDate :: Lens' Stage (Maybe UTCTime)
- sCacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus)
- sMethodSettings :: Lens' Stage (HashMap Text MethodSetting)
- sLastUpdatedDate :: Lens' Stage (Maybe UTCTime)
- sCacheClusterSize :: Lens' Stage (Maybe CacheClusterSize)
- sCacheClusterEnabled :: Lens' Stage (Maybe Bool)
- sStageName :: Lens' Stage (Maybe Text)
- sDescription :: Lens' Stage (Maybe Text)
- data StageKey
- stageKey :: StageKey
- skRestAPIId :: Lens' StageKey (Maybe Text)
- skStageName :: Lens' StageKey (Maybe Text)
- data ThrottleSettings
- throttleSettings :: ThrottleSettings
- tsBurstLimit :: Lens' ThrottleSettings (Maybe Int)
- tsRateLimit :: Lens' ThrottleSettings (Maybe Double)
Service Configuration
API version '2015-07-09' of the Amazon API Gateway SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by APIGateway
.
ConflictException
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for ConflictException' errors.
NotFoundException
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for NotFoundException' errors.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for TooManyRequestsException' errors.
ServiceUnavailableException
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for ServiceUnavailableException' errors.
UnauthorizedException
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for UnauthorizedException' errors.
BadRequestException
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for BadRequestException' errors.
LimitExceededException
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source
Prism for LimitExceededException' errors.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
GetResource
GetDeployments (Paginated)
GetDeployment
GetDomainNames (Paginated)
GetClientCertificate
GetMethodResponse
GetModels (Paginated)
GetBasePathMapping
PutMethodResponse
DeleteMethodResponse
UpdateMethodResponse
DeleteStage
UpdateStage
GetRestAPIs (Paginated)
CreateDeployment
CreateBasePathMapping
GetIntegration
UpdateAccount
DeleteDeployment
UpdateDeployment
DeleteResource
UpdateResource
CreateModel
GetIntegrationResponse
CreateDomainName
DeleteModel
UpdateModel
DeleteAPIKey
UpdateAPIKey
GetRestAPI
GetStages
GetMethod
GetModel
UpdateRestAPI
DeleteRestAPI
TestInvokeMethod
GetDomainName
PutIntegrationResponse
FlushStageCache
CreateRestAPI
DeleteIntegrationResponse
UpdateIntegrationResponse
DeleteIntegration
UpdateIntegration
GenerateClientCertificate
GetResources (Paginated)
GetAccount
PutIntegration
GetStage
GetSDK
GetAPIKeys (Paginated)
DeleteBasePathMapping
UpdateBasePathMapping
DeleteClientCertificate
UpdateClientCertificate
CreateStage
CreateAPIKey
PutMethod
UpdateDomainName
DeleteDomainName
CreateResource
DeleteMethod
UpdateMethod
GetClientCertificates (Paginated)
GetModelTemplate
GetBasePathMappings (Paginated)
GetAPIKey
Types
CacheClusterSize
data CacheClusterSize Source
Returns the size of the CacheCluster.
CacheClusterStatus
data CacheClusterStatus Source
Returns the status of the CacheCluster.
IntegrationType
data IntegrationType Source
The integration type. Possible values are HTTP, AWS, or Mock.
Op
APIKey
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
See: apiKey
smart constructor.
Creates a value of APIKey
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
akCreatedDate :: Lens' APIKey (Maybe UTCTime) Source
The date when the API Key was created, in ISO 8601 format.
akStageKeys :: Lens' APIKey [Text] Source
A list of Stage resources that are associated with the ApiKey resource.
akLastUpdatedDate :: Lens' APIKey (Maybe UTCTime) Source
When the API Key was last updated, in ISO 8601 format.
Account
Represents an AWS account that is associated with Amazon API Gateway.
See: account
smart constructor.
Creates a value of Account
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aCloudwatchRoleARN :: Lens' Account (Maybe Text) Source
Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.
aThrottleSettings :: Lens' Account (Maybe ThrottleSettings) Source
Specifies the application programming interface (API) throttle settings for the current Account resource.
BasePathMapping
data BasePathMapping Source
Represents the base path that callers of the API that must provide as part of the URL after the domain name.
See: basePathMapping
smart constructor.
basePathMapping :: BasePathMapping Source
Creates a value of BasePathMapping
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bpmBasePath :: Lens' BasePathMapping (Maybe Text) Source
The base path name that callers of the API must provide as part of the URL after the domain name.
bpmRestAPIId :: Lens' BasePathMapping (Maybe Text) Source
The name of the API.
ClientCertificate
data ClientCertificate Source
See: clientCertificate
smart constructor.
clientCertificate :: ClientCertificate Source
Creates a value of ClientCertificate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccPemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) Source
Undocumented member.
ccClientCertificateId :: Lens' ClientCertificate (Maybe Text) Source
Undocumented member.
ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime) Source
Undocumented member.
ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source
Undocumented member.
ccDescription :: Lens' ClientCertificate (Maybe Text) Source
Undocumented member.
Deployment
data Deployment Source
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
See: deployment
smart constructor.
deployment :: Deployment Source
Creates a value of Deployment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot)) Source
Gets a summary of the RestApi at the date and time that the deployment resource was created.
dCreatedDate :: Lens' Deployment (Maybe UTCTime) Source
The date and time that the deployment resource was created.
dDescription :: Lens' Deployment (Maybe Text) Source
The description for the deployment resource.
DomainName
data DomainName Source
Represents a domain name that is contained in a simpler, more intuitive URL that can be called.
See: domainName
smart constructor.
domainName :: DomainName Source
Creates a value of DomainName
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dnCertificateName :: Lens' DomainName (Maybe Text) Source
The name of the certificate.
dnDomainName :: Lens' DomainName (Maybe Text) Source
The name of the DomainName resource.
dnCertificateUploadDate :: Lens' DomainName (Maybe UTCTime) Source
The date when the certificate was uploaded, in ISO 8601 format.
dnDistributionDomainName :: Lens' DomainName (Maybe Text) Source
The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.
Integration
data Integration Source
Represents a HTTP, AWS, or Mock integration.
See: integration
smart constructor.
integration :: Integration Source
Creates a value of Integration
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iHttpMethod :: Lens' Integration (Maybe Text) Source
Specifies the integration's HTTP method type.
iRequestTemplates :: Lens' Integration (HashMap Text Text) Source
Specifies the integration's request templates.
iCredentials :: Lens' Integration (Maybe Text) Source
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string 'arn:aws:iam::\\*:user\/\\*'. To use resource-based permissions on supported AWS services, specify null.
iRequestParameters :: Lens' Integration (HashMap Text Text) Source
Represents requests parameters that are sent with the backend request.
Request parameters are represented as a key/value map, with a
destination as the key and a source as the value. A source must match an
existing method request parameter, or a static value. Static values must
be enclosed with single quotes, and be pre-encoded based on their
destination in the request. The destination must match the pattern
'integration.request.{location}.{name}', where location
is either
querystring, path, or header. name
must be a valid, unique parameter
name.
iUri :: Lens' Integration (Maybe Text) Source
Specifies the integration's Uniform Resource Identifier (URI). For HTTP
integrations, the URI must be a fully formed, encoded HTTP(S) URL
according to the
RFC-3986 specification. For AWS
integrations, the URI should be of the form
'arn:aws:apigateway:{region}:{service}:{path|action}/{service_api}'.
Region
and service
are used to determine the right endpoint. For AWS
services that use the 'Action=' query string parameter, service_api
should be a valid action for the desired service. For RESTful AWS
service APIs, path
is used to indicate that the remaining substring in
the URI should be treated as the path to the resource, including the
initial \/
.
iIntegrationResponses :: Lens' Integration (HashMap Text IntegrationResponse) Source
Specifies the integration's responses.
iCacheNamespace :: Lens' Integration (Maybe Text) Source
Specifies the integration's cache namespace.
iType :: Lens' Integration (Maybe IntegrationType) Source
Specifies the integration's type.
iCacheKeyParameters :: Lens' Integration [Text] Source
Specifies the integration's cache key parameters.
IntegrationResponse
data IntegrationResponse Source
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the backend response.
See: integrationResponse
smart constructor.
integrationResponse :: IntegrationResponse Source
Creates a value of IntegrationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iResponseTemplates :: Lens' IntegrationResponse (HashMap Text Text) Source
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
iSelectionPattern :: Lens' IntegrationResponse (Maybe Text) Source
Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.
iStatusCode :: Lens' IntegrationResponse (Maybe Text) Source
Specifies the status code that is used to map the integration response to an existing MethodResponse.
iResponseParameters :: Lens' IntegrationResponse (HashMap Text Text) Source
Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the Method. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern 'integration.response.header.{name}'.
Method
Represents a method.
See: method
smart constructor.
Creates a value of Method
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mMethodResponses :: Lens' Method (HashMap Text MethodResponse) Source
Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.
mRequestModels :: Lens' Method (HashMap Text Text) Source
Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.
mRequestParameters :: Lens' Method (HashMap Text Bool) Source
Represents request parameters that can be accepted by Amazon API
Gateway. Request parameters are represented as a key/value map, with a
source as the key and a Boolean flag as the value. The Boolean flag is
used to specify whether the parameter is required. A source must match
the pattern 'method.request.{location}.{name}', where location
is
either querystring, path, or header. name
is a valid, unique parameter
name. Sources specified here are available to the integration for
mapping to integration request parameters or templates.
mApiKeyRequired :: Lens' Method (Maybe Bool) Source
Specifies whether the method requires a valid ApiKey.
mMethodIntegration :: Lens' Method (Maybe Integration) Source
The method's integration.
MethodResponse
data MethodResponse Source
Represents a method response. Amazon API Gateway sends back the status code to the caller as the HTTP status code. Parameters and models can be used to transform the response from the method's integration.
See: methodResponse
smart constructor.
methodResponse :: MethodResponse Source
Creates a value of MethodResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mResponseModels :: Lens' MethodResponse (HashMap Text Text) Source
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
mStatusCode :: Lens' MethodResponse (Maybe Text) Source
The method response's status code.
mResponseParameters :: Lens' MethodResponse (HashMap Text Bool) Source
Represents response parameters that can be sent back to the caller by
Amazon API Gateway. Response parameters are represented as a key/value
map, with a destination as the key and a boolean flag as the value,
which is used to specify whether the parameter is required. A
destination must match the pattern 'method.response.header.{name}',
where name
is a valid, unique header name. Destinations specified here
are available to the integration for mapping from integration response
parameters.
MethodSetting
data MethodSetting Source
Specifies the method setting properties.
See: methodSetting
smart constructor.
methodSetting :: MethodSetting Source
Creates a value of MethodSetting
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
msCacheTtlInSeconds :: Lens' MethodSetting (Maybe Int) Source
Specifies the time to live (TTL) in seconds, for cached responses. The higher a the TTL, the longer the response will be cached. The PATCH path for this setting is '/{method_setting_key}/caching/ttlInSeconds', and the value is an integer.
msDataTraceEnabled :: Lens' MethodSetting (Maybe Bool) Source
Specifies the whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is '/{method_setting_key}/logging/dataTrace', and the value is a Boolean.
msThrottlingBurstLimit :: Lens' MethodSetting (Maybe Int) Source
Specifies the throttling burst limit. The PATCH path for this setting is '/{method_setting_key}/throttling/burstLimit', and the value is an integer.
msCacheDataEncrypted :: Lens' MethodSetting (Maybe Bool) Source
Specifies whether the cached responses are encrypted. The PATCH path for this setting is '/{method_setting_key}/caching/dataEncrypted', and the value is a Boolean.
msLoggingLevel :: Lens' MethodSetting (Maybe Text) Source
Specifies the logging level for this method, which effects the log
entries pushed to Amazon CloudWatch Logs. The PATCH path for this
setting is '/{method_setting_key}/logging/loglevel', and the
available levels are OFF
, ERROR
, and INFO
.
msCachingEnabled :: Lens' MethodSetting (Maybe Bool) Source
Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is '/{method_setting_key}/caching/enabled', and the value is a Boolean.
msMetricsEnabled :: Lens' MethodSetting (Maybe Bool) Source
Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is '/{method_setting_key}/metrics/enabled', and the value is a Boolean.
msThrottlingRateLimit :: Lens' MethodSetting (Maybe Double) Source
Specifies the throttling rate limit. The PATCH path for this setting is '/{method_setting_key}/throttling/rateLimit', and the value is a double.
MethodSnapshot
data MethodSnapshot Source
Represents a summary of a Method resource, given a particular date and time.
See: methodSnapshot
smart constructor.
methodSnapshot :: MethodSnapshot Source
Creates a value of MethodSnapshot
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
msAuthorizationType :: Lens' MethodSnapshot (Maybe Text) Source
Specifies the type of authorization used for the method.
msApiKeyRequired :: Lens' MethodSnapshot (Maybe Bool) Source
Specifies whether the method requires a valid ApiKey.
Model
Represents the structure of a request or response payload for a method.
See: model
smart constructor.
Creates a value of Model
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mSchema :: Lens' Model (Maybe Text) Source
The schema for the model. For 'application\/json' models, this should be JSON-schema draft v4 model.
PatchOperation
data PatchOperation Source
A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.
See: patchOperation
smart constructor.
patchOperation :: PatchOperation Source
Creates a value of PatchOperation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
poOp :: Lens' PatchOperation (Maybe Op) Source
A patch operation whose value indicates the operation to perform. Its value MUST be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors.
poPath :: Lens' PatchOperation (Maybe Text) Source
Operation objects MUST have exactly one "path" member. That member's value is a string containing a `JSON-Pointer` value that references a location within the target document (the "target location") where the operation is performed.
poFrom :: Lens' PatchOperation (Maybe Text) Source
The "move" and "copy" operation object MUST contain a "from" member, which is a string containing a 'JSON Pointer' value that references the location in the target document to move the value from.
Resource
Represents a resource.
See: resource
smart constructor.
rResourceMethods :: Lens' Resource (HashMap Text Method) Source
Map of methods for this resource, which is included only if requested using the embed option.
RestAPI
Represents a REST API.
See: restAPI
smart constructor.
Creates a value of RestAPI
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
raCreatedDate :: Lens' RestAPI (Maybe UTCTime) Source
The date when the API was created, in ISO 8601 format.
raId :: Lens' RestAPI (Maybe Text) Source
The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.
Stage
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
See: stage
smart constructor.
Creates a value of Stage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sDeploymentId :: Lens' Stage (Maybe Text) Source
The identifier of the Deployment that the stage points to.
sVariables :: Lens' Stage (HashMap Text Text) Source
A map that defines the stage variables for a Stage resource. Variable names can have alphabetic characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
sCreatedDate :: Lens' Stage (Maybe UTCTime) Source
The date and time that the stage was created, in ISO 8601 format.
sCacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source
The status of the cache cluster for the stage, if enabled.
sMethodSettings :: Lens' Stage (HashMap Text MethodSetting) Source
A map that defines the method settings for a Stage resource. Keys are
defined as '{resource_path}/{http_method}' for an individual method
override, or \\*\/\\*
for the settings applied to all methods in the
stage.
sLastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source
The date and time that information about the stage was last updated, in ISO 8601 format.
sCacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source
The size of the cache cluster for the stage, if enabled.
sCacheClusterEnabled :: Lens' Stage (Maybe Bool) Source
Specifies whether a cache cluster is enabled for the stage.
sStageName :: Lens' Stage (Maybe Text) Source
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
StageKey
A reference to a unique stage identified in the format '{restApiId}/{stage}'.
See: stageKey
smart constructor.
Creates a value of StageKey
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
skRestAPIId :: Lens' StageKey (Maybe Text) Source
A list of Stage resources that are associated with the ApiKey resource.
skStageName :: Lens' StageKey (Maybe Text) Source
The stage name in the RestApi that the stage key references.
ThrottleSettings
data ThrottleSettings Source
Returns the throttle settings.
See: throttleSettings
smart constructor.
throttleSettings :: ThrottleSettings Source
Creates a value of ThrottleSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsBurstLimit :: Lens' ThrottleSettings (Maybe Int) Source
Returns the burstLimit when ThrottleSettings is called.
tsRateLimit :: Lens' ThrottleSettings (Maybe Double) Source
Returns the rateLimit when ThrottleSettings is called.