Copyright | (c) 2013-2016 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
- AuthorizerType
- CacheClusterSize
- CacheClusterStatus
- IntegrationType
- Op
- PutMode
- UnauthorizedCacheControlHeaderStrategy
- APIKey
- Account
- Authorizer
- BasePathMapping
- ClientCertificate
- Deployment
- DomainName
- Integration
- IntegrationResponse
- Method
- MethodResponse
- MethodSetting
- MethodSnapshot
- Model
- PatchOperation
- Resource
- RestAPI
- Stage
- StageKey
- ThrottleSettings
- 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
- data AuthorizerType = Token
- data CacheClusterSize
- data CacheClusterStatus
- data IntegrationType
- data Op
- data PutMode
- data UnauthorizedCacheControlHeaderStrategy
- 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 Authorizer
- authorizer :: Authorizer
- aAuthorizerURI :: Lens' Authorizer (Maybe Text)
- aIdentityValidationExpression :: Lens' Authorizer (Maybe Text)
- aName :: Lens' Authorizer (Maybe Text)
- aId :: Lens' Authorizer (Maybe Text)
- aAuthorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int)
- aAuthType :: Lens' Authorizer (Maybe Text)
- aType :: Lens' Authorizer (Maybe AuthorizerType)
- aIdentitySource :: Lens' Authorizer (Maybe Text)
- aAuthorizerCredentials :: Lens' Authorizer (Maybe Text)
- 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)
- mAuthorizerId :: Lens' Method (Maybe Text)
- 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)
- msRequireAuthorizationForCacheControl :: Lens' MethodSetting (Maybe Bool)
- msCachingEnabled :: Lens' MethodSetting (Maybe Bool)
- msMetricsEnabled :: Lens' MethodSetting (Maybe Bool)
- msThrottlingRateLimit :: Lens' MethodSetting (Maybe Double)
- msUnauthorizedCacheControlHeaderStrategy :: Lens' MethodSetting (Maybe UnauthorizedCacheControlHeaderStrategy)
- 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
- raWarnings :: Lens' RestAPI [Text]
- 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
apiGateway :: Service Source #
API version '2015-07-09' of the Amazon API Gateway SDK configuration.
Errors
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for ConflictException' errors.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for NotFoundException' errors.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for TooManyRequestsException' errors.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for ServiceUnavailableException' errors.
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for UnauthorizedException' errors.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for BadRequestException' errors.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Prism for LimitExceededException' errors.
AuthorizerType
data AuthorizerType Source #
The authorizer type. Only current value is TOKEN.
CacheClusterSize
data CacheClusterSize Source #
Returns the size of the CacheCluster.
CacheClusterStatus
data CacheClusterStatus Source #
Returns the status of the CacheCluster.
IntegrationType
data IntegrationType Source #
Op
Bounded Op Source # | |
Enum Op Source # | |
Eq Op Source # | |
Data Op Source # | |
Ord Op Source # | |
Read Op Source # | |
Show Op Source # | |
Generic Op Source # | |
Hashable Op Source # | |
ToJSON Op Source # | |
NFData Op Source # | |
ToQuery Op Source # | |
ToHeader Op Source # | |
ToByteString Op Source # | |
FromText Op Source # | |
ToText Op Source # | |
type Rep Op Source # | |
PutMode
UnauthorizedCacheControlHeaderStrategy
APIKey
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:
akEnabled :: Lens' APIKey (Maybe Bool) Source #
Specifies whether the API Key can be used by callers.
akCreatedDate :: Lens' APIKey (Maybe UTCTime) Source #
The date when the API Key was created, in ISO 8601 format.
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.
Authorizer
data Authorizer Source #
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
See: authorizer
smart constructor.
authorizer :: Authorizer Source #
Creates a value of Authorizer
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
aAuthorizerURI :: Lens' Authorizer (Maybe Text) Source #
- Required
- Specifies the authorizer's Uniform Resource Identifier
(URI). For TOKEN authorizers, this must be a well-formed Lambda function
URI. The URI should be of the form
'arn:aws:apigateway:{region}:lambda:path/{service_api}'.
Region
is used to determine the right endpoint. In this case,path
is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial\/
. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations
aIdentityValidationExpression :: Lens' Authorizer (Maybe Text) Source #
A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.
aAuthorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) Source #
The TTL in seconds of cached authorizer results. If greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
aAuthType :: Lens' Authorizer (Maybe Text) Source #
Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.
aType :: Lens' Authorizer (Maybe AuthorizerType) Source #
- Required
- The type of the authorizer. Currently, the only valid type is TOKEN.
aIdentitySource :: Lens' Authorizer (Maybe Text) Source #
- Required
- The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.
aAuthorizerCredentials :: Lens' Authorizer (Maybe Text) Source #
Specifies the credentials required for the authorizer, if any. Two options are available. To specify an IAM Role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
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 #
Represents a Client Certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
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 #
The PEM-encoded public key of the Client Certificate, that can be used to configure certificate authentication in the integration endpoint .
ccClientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #
The identifier of the Client Certificate.
ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime) Source #
The date when the Client Certificate was created, in ISO 8601 format.
ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #
The date when the Client Certificate will expire, in ISO 8601 format.
ccDescription :: Lens' ClientCertificate (Maybe Text) Source #
The description of the Client Certificate.
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}:{subdomain.service|service}:{path|action}/{service_api}'.
Region
, subdomain
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.
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 MethodResponse. 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.
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.
mAuthorizerId :: Lens' Method (Maybe Text) Source #
Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.
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:
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
.
msRequireAuthorizationForCacheControl :: Lens' MethodSetting (Maybe Bool) Source #
Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is '/{method_setting_key}/caching/requireAuthorizationForCacheControl', and the value is a Boolean.
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.
msUnauthorizedCacheControlHeaderStrategy :: Lens' MethodSetting (Maybe UnauthorizedCacheControlHeaderStrategy) Source #
Specifies the strategy on how to handle the unauthorized requests for
cache invalidation. The PATCH path for this setting is
'/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy',
and the available values are FAIL_WITH_403
,
SUCCEED_WITH_RESPONSE_HEADER
, SUCCEED_WITHOUT_RESPONSE_HEADER
.
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 the request uses the embed query 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
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 alphanumeric 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:
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.