| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.APIGateway.Types
Contents
- Service Configuration
- Errors
- APIKeySourceType
- APIKeysFormat
- AuthorizerType
- CacheClusterSize
- CacheClusterStatus
- ConnectionType
- ContentHandlingStrategy
- DocumentationPartType
- EndpointType
- GatewayResponseType
- IntegrationType
- LocationStatusType
- Op
- PutMode
- QuotaPeriodType
- UnauthorizedCacheControlHeaderStrategy
- VPCLinkStatus
- APIKey
- APIStage
- AccessLogSettings
- Account
- Authorizer
- BasePathMapping
- CanarySettings
- ClientCertificate
- Deployment
- DeploymentCanarySettings
- DocumentationPart
- DocumentationPartLocation
- DocumentationVersion
- DomainName
- EndpointConfiguration
- GatewayResponse
- Integration
- IntegrationResponse
- Method
- MethodResponse
- MethodSetting
- MethodSnapshot
- Model
- PatchOperation
- QuotaSettings
- RequestValidator
- Resource
- RestAPI
- SDKConfigurationProperty
- SDKType
- Stage
- StageKey
- ThrottleSettings
- Usage
- UsagePlan
- UsagePlanKey
- VPCLink
Description
- 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 APIKeySourceType
- = Authorizer
- | Header
- data APIKeysFormat = CSV
- data AuthorizerType
- data CacheClusterSize
- data CacheClusterStatus
- data ConnectionType
- data ContentHandlingStrategy
- data DocumentationPartType
- data EndpointType
- data GatewayResponseType
- = APIConfigurationError
- | AccessDenied
- | AuthorizerConfigurationError
- | AuthorizerFailure
- | BadRequestBody
- | BadRequestParameters
- | Default4XX
- | Default5XX
- | ExpiredToken
- | IntegrationFailure
- | IntegrationTimeout
- | InvalidAPIKey
- | InvalidSignature
- | MissingAuthenticationToken
- | QuotaExceeded
- | RequestTooLarge
- | ResourceNotFound
- | Throttled
- | Unauthorized
- | UnsupportedMediaType
- data IntegrationType
- data LocationStatusType
- data Op
- data PutMode
- data QuotaPeriodType
- data UnauthorizedCacheControlHeaderStrategy
- data VPCLinkStatus
- data APIKey
- apiKey :: APIKey
- akEnabled :: Lens' APIKey (Maybe Bool)
- akValue :: Lens' APIKey (Maybe Text)
- akCustomerId :: Lens' APIKey (Maybe Text)
- 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 APIStage
- apiStage :: APIStage
- asStage :: Lens' APIStage (Maybe Text)
- asApiId :: Lens' APIStage (Maybe Text)
- data AccessLogSettings
- accessLogSettings :: AccessLogSettings
- alsFormat :: Lens' AccessLogSettings (Maybe Text)
- alsDestinationARN :: Lens' AccessLogSettings (Maybe Text)
- data Account
- account :: Account
- aApiKeyVersion :: Lens' Account (Maybe Text)
- aCloudwatchRoleARN :: Lens' Account (Maybe Text)
- aFeatures :: Lens' Account [Text]
- aThrottleSettings :: Lens' Account (Maybe ThrottleSettings)
- data Authorizer
- authorizer :: Authorizer
- aAuthorizerURI :: Lens' Authorizer (Maybe Text)
- aIdentityValidationExpression :: Lens' Authorizer (Maybe Text)
- aProviderARNs :: Lens' Authorizer [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 CanarySettings
- canarySettings :: CanarySettings
- csDeploymentId :: Lens' CanarySettings (Maybe Text)
- csStageVariableOverrides :: Lens' CanarySettings (HashMap Text Text)
- csUseStageCache :: Lens' CanarySettings (Maybe Bool)
- csPercentTraffic :: Lens' CanarySettings (Maybe Double)
- 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 DeploymentCanarySettings
- deploymentCanarySettings :: DeploymentCanarySettings
- dcsStageVariableOverrides :: Lens' DeploymentCanarySettings (HashMap Text Text)
- dcsUseStageCache :: Lens' DeploymentCanarySettings (Maybe Bool)
- dcsPercentTraffic :: Lens' DeploymentCanarySettings (Maybe Double)
- data DocumentationPart
- documentationPart :: DocumentationPart
- dpLocation :: Lens' DocumentationPart (Maybe DocumentationPartLocation)
- dpId :: Lens' DocumentationPart (Maybe Text)
- dpProperties :: Lens' DocumentationPart (Maybe Text)
- data DocumentationPartLocation
- documentationPartLocation :: DocumentationPartType -> DocumentationPartLocation
- dplPath :: Lens' DocumentationPartLocation (Maybe Text)
- dplName :: Lens' DocumentationPartLocation (Maybe Text)
- dplMethod :: Lens' DocumentationPartLocation (Maybe Text)
- dplStatusCode :: Lens' DocumentationPartLocation (Maybe Text)
- dplType :: Lens' DocumentationPartLocation DocumentationPartType
- data DocumentationVersion
- documentationVersion :: DocumentationVersion
- dvCreatedDate :: Lens' DocumentationVersion (Maybe UTCTime)
- dvVersion :: Lens' DocumentationVersion (Maybe Text)
- dvDescription :: Lens' DocumentationVersion (Maybe Text)
- data DomainName
- domainName :: DomainName
- dnRegionalHostedZoneId :: Lens' DomainName (Maybe Text)
- dnCertificateName :: Lens' DomainName (Maybe Text)
- dnRegionalCertificateARN :: Lens' DomainName (Maybe Text)
- dnCertificateARN :: Lens' DomainName (Maybe Text)
- dnDistributionHostedZoneId :: Lens' DomainName (Maybe Text)
- dnDomainName :: Lens' DomainName (Maybe Text)
- dnRegionalCertificateName :: Lens' DomainName (Maybe Text)
- dnRegionalDomainName :: Lens' DomainName (Maybe Text)
- dnCertificateUploadDate :: Lens' DomainName (Maybe UTCTime)
- dnDistributionDomainName :: Lens' DomainName (Maybe Text)
- dnEndpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration)
- data EndpointConfiguration
- endpointConfiguration :: EndpointConfiguration
- ecTypes :: Lens' EndpointConfiguration [EndpointType]
- data GatewayResponse
- gatewayResponse :: GatewayResponse
- gDefaultResponse :: Lens' GatewayResponse (Maybe Bool)
- gResponseTemplates :: Lens' GatewayResponse (HashMap Text Text)
- gResponseType :: Lens' GatewayResponse (Maybe GatewayResponseType)
- gStatusCode :: Lens' GatewayResponse (Maybe Text)
- gResponseParameters :: Lens' GatewayResponse (HashMap Text Text)
- data Integration
- integration :: Integration
- iHttpMethod :: Lens' Integration (Maybe Text)
- iRequestTemplates :: Lens' Integration (HashMap Text Text)
- iCredentials :: Lens' Integration (Maybe Text)
- iConnectionId :: Lens' Integration (Maybe Text)
- iRequestParameters :: Lens' Integration (HashMap Text Text)
- iContentHandling :: Lens' Integration (Maybe ContentHandlingStrategy)
- iPassthroughBehavior :: Lens' Integration (Maybe Text)
- iUri :: Lens' Integration (Maybe Text)
- iIntegrationResponses :: Lens' Integration (HashMap Text IntegrationResponse)
- iCacheNamespace :: Lens' Integration (Maybe Text)
- iTimeoutInMillis :: Lens' Integration (Maybe Int)
- iType :: Lens' Integration (Maybe IntegrationType)
- iConnectionType :: Lens' Integration (Maybe ConnectionType)
- iCacheKeyParameters :: Lens' Integration [Text]
- data IntegrationResponse
- integrationResponse :: IntegrationResponse
- intContentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy)
- intResponseTemplates :: Lens' IntegrationResponse (HashMap Text Text)
- intSelectionPattern :: Lens' IntegrationResponse (Maybe Text)
- intStatusCode :: Lens' IntegrationResponse (Maybe Text)
- intResponseParameters :: Lens' IntegrationResponse (HashMap Text Text)
- data Method
- method :: Method
- mMethodResponses :: Lens' Method (HashMap Text MethodResponse)
- mHttpMethod :: Lens' Method (Maybe Text)
- mAuthorizationScopes :: Lens' Method [Text]
- mRequestValidatorId :: Lens' Method (Maybe Text)
- mRequestModels :: Lens' Method (HashMap Text Text)
- mRequestParameters :: Lens' Method (HashMap Text Bool)
- mAuthorizerId :: Lens' Method (Maybe Text)
- mOperationName :: 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 QuotaSettings
- quotaSettings :: QuotaSettings
- qsOffset :: Lens' QuotaSettings (Maybe Int)
- qsPeriod :: Lens' QuotaSettings (Maybe QuotaPeriodType)
- qsLimit :: Lens' QuotaSettings (Maybe Int)
- data RequestValidator
- requestValidator :: RequestValidator
- rvValidateRequestParameters :: Lens' RequestValidator (Maybe Bool)
- rvName :: Lens' RequestValidator (Maybe Text)
- rvValidateRequestBody :: Lens' RequestValidator (Maybe Bool)
- rvId :: Lens' RequestValidator (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
- raMinimumCompressionSize :: Lens' RestAPI (Maybe Int)
- raBinaryMediaTypes :: Lens' RestAPI [Text]
- raWarnings :: Lens' RestAPI [Text]
- raCreatedDate :: Lens' RestAPI (Maybe UTCTime)
- raName :: Lens' RestAPI (Maybe Text)
- raVersion :: Lens' RestAPI (Maybe Text)
- raApiKeySource :: Lens' RestAPI (Maybe APIKeySourceType)
- raId :: Lens' RestAPI (Maybe Text)
- raPolicy :: Lens' RestAPI (Maybe Text)
- raEndpointConfiguration :: Lens' RestAPI (Maybe EndpointConfiguration)
- raDescription :: Lens' RestAPI (Maybe Text)
- data SDKConfigurationProperty
- sdkConfigurationProperty :: SDKConfigurationProperty
- scpFriendlyName :: Lens' SDKConfigurationProperty (Maybe Text)
- scpRequired :: Lens' SDKConfigurationProperty (Maybe Bool)
- scpName :: Lens' SDKConfigurationProperty (Maybe Text)
- scpDefaultValue :: Lens' SDKConfigurationProperty (Maybe Text)
- scpDescription :: Lens' SDKConfigurationProperty (Maybe Text)
- data SDKType
- sdkType :: SDKType
- stFriendlyName :: Lens' SDKType (Maybe Text)
- stConfigurationProperties :: Lens' SDKType [SDKConfigurationProperty]
- stId :: Lens' SDKType (Maybe Text)
- stDescription :: Lens' SDKType (Maybe Text)
- data Stage
- stage :: Stage
- sDeploymentId :: Lens' Stage (Maybe Text)
- sVariables :: Lens' Stage (HashMap Text Text)
- sAccessLogSettings :: Lens' Stage (Maybe AccessLogSettings)
- sDocumentationVersion :: Lens' Stage (Maybe 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)
- sCanarySettings :: Lens' Stage (Maybe CanarySettings)
- sCacheClusterEnabled :: Lens' Stage (Maybe Bool)
- sStageName :: Lens' Stage (Maybe Text)
- sDescription :: Lens' Stage (Maybe Text)
- sTags :: Lens' Stage (HashMap Text 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)
- data Usage
- usage :: Usage
- uUsagePlanId :: Lens' Usage (Maybe Text)
- uEndDate :: Lens' Usage (Maybe Text)
- uItems :: Lens' Usage (HashMap Text [[Integer]])
- uStartDate :: Lens' Usage (Maybe Text)
- uPosition :: Lens' Usage (Maybe Text)
- data UsagePlan
- usagePlan :: UsagePlan
- upApiStages :: Lens' UsagePlan [APIStage]
- upName :: Lens' UsagePlan (Maybe Text)
- upId :: Lens' UsagePlan (Maybe Text)
- upThrottle :: Lens' UsagePlan (Maybe ThrottleSettings)
- upQuota :: Lens' UsagePlan (Maybe QuotaSettings)
- upDescription :: Lens' UsagePlan (Maybe Text)
- upProductCode :: Lens' UsagePlan (Maybe Text)
- data UsagePlanKey
- usagePlanKey :: UsagePlanKey
- upkValue :: Lens' UsagePlanKey (Maybe Text)
- upkName :: Lens' UsagePlanKey (Maybe Text)
- upkId :: Lens' UsagePlanKey (Maybe Text)
- upkType :: Lens' UsagePlanKey (Maybe Text)
- data VPCLink
- vpcLink :: VPCLink
- vlStatus :: Lens' VPCLink (Maybe VPCLinkStatus)
- vlTargetARNs :: Lens' VPCLink [Text]
- vlName :: Lens' VPCLink (Maybe Text)
- vlStatusMessage :: Lens' VPCLink (Maybe Text)
- vlId :: Lens' VPCLink (Maybe Text)
- vlDescription :: Lens' VPCLink (Maybe Text)
Service Configuration
apiGateway :: Service #
API version 2015-07-09 of the Amazon API Gateway SDK configuration.
Errors
_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError #
The request configuration has conflicts. For details, see the accompanying error message.
_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError #
The requested resource is not found. Make sure that the request URI is correct.
_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError #
The request has reached its throttling limit. Retry after the specified time period.
_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError #
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError #
The request is denied because the caller has insufficient permissions.
_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError #
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError #
The request exceeded the rate limit. Retry after the specified time period.
APIKeySourceType
data APIKeySourceType #
Constructors
| Authorizer | |
| Header |
Instances
APIKeysFormat
data APIKeysFormat #
Constructors
| CSV |
Instances
AuthorizerType
data AuthorizerType #
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
Instances
CacheClusterSize
data CacheClusterSize #
Returns the size of the CacheCluster .
Instances
CacheClusterStatus
data CacheClusterStatus #
Returns the status of the CacheCluster .
Instances
ConnectionType
data ConnectionType #
Instances
ContentHandlingStrategy
data ContentHandlingStrategy #
Constructors
| ConvertToBinary | |
| ConvertToText |
Instances
DocumentationPartType
data DocumentationPartType #
Constructors
| DPTAPI | |
| DPTAuthorizer | |
| DPTMethod | |
| DPTModel | |
| DPTPathParameter | |
| DPTQueryParameter | |
| DPTRequestBody | |
| DPTRequestHeader | |
| DPTResource | |
| DPTResponse | |
| DPTResponseBody | |
| DPTResponseHeader |
Instances
EndpointType
data EndpointType #
The endpoint type. The valid value is EDGE for edge-optimized API setup, most suitable for mobile applications, REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region
Instances
GatewayResponseType
data GatewayResponseType #
Constructors
Instances
IntegrationType
data IntegrationType #
The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any AWS service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration.
Instances
LocationStatusType
data LocationStatusType #
Constructors
| Documented | |
| Undocumented |
Instances
Op
PutMode
Instances
QuotaPeriodType
data QuotaPeriodType #
Instances
UnauthorizedCacheControlHeaderStrategy
VPCLinkStatus
data VPCLinkStatus #
Constructors
| VLSAvailable | |
| VLSDeleting | |
| VLSFailed | |
| VLSPending |
Instances
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- Specifies whether the API Key can be used by callers.akValue- The value of the API Key.akCustomerId- An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.akCreatedDate- The timestamp when the API Key was created.akName- The name of the API Key.akId- The identifier of the API Key.akStageKeys- A list ofStageresources that are associated with theApiKeyresource.akLastUpdatedDate- The timestamp when the API Key was last updated.akDescription- The description of the API Key.
akCustomerId :: Lens' APIKey (Maybe Text) #
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
akStageKeys :: Lens' APIKey [Text] #
A list of Stage resources that are associated with the ApiKey resource.
APIStage
API stage name of the associated API stage in a usage plan.
See: apiStage smart constructor.
AccessLogSettings
data AccessLogSettings #
Access log settings, including the access log format and access log destination ARN.
See: accessLogSettings smart constructor.
accessLogSettings :: AccessLogSettings #
Creates a value of AccessLogSettings with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
alsFormat- A single line format of the access logs of data, as specified by selected http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference context variables> . The format must include at least> context.requestId.alsDestinationARN- The ARN of the CloudWatch Logs log group to receive access logs.
alsFormat :: Lens' AccessLogSettings (Maybe Text) #
A single line format of the access logs of data, as specified by selected http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#context-variable-reference context variables> . The format must include at least > context.requestId .
alsDestinationARN :: Lens' AccessLogSettings (Maybe Text) #
The ARN of the CloudWatch Logs log group to receive access logs.
Account
Represents an AWS account that is associated with API Gateway.
To view the account info, call GET on this resource.
Error Codes The following exception may be thrown when the request fails.
- UnauthorizedException * NotFoundException * TooManyRequestsException
For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes
Example: Get the information about an account.
Request
@GET account HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response
The successful response returns a 200 OK@ status code and a payload similar to the following:
@{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "account" }, "account:update": { "href": "account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } } @ In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.
API Gateway Limits Developer Guide , AWS CLI
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:
aApiKeyVersion- The version of the API keys used for the account.aCloudwatchRoleARN- The ARN of an Amazon CloudWatch role for the currentAccount.aFeatures- A list of features supported for the account. When usage plans are enabled, the features list will include an entry ofUsagePlans.aThrottleSettings- Specifies the API request limits configured for the currentAccount.
aCloudwatchRoleARN :: Lens' Account (Maybe Text) #
The ARN of an Amazon CloudWatch role for the current Account .
aFeatures :: Lens' Account [Text] #
A list of features supported for the account. When usage plans are enabled, the features list will include an entry of UsagePlans .
aThrottleSettings :: Lens' Account (Maybe ThrottleSettings) #
Specifies the API request limits configured for the current Account .
Authorizer
data Authorizer #
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.
Instances
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- Specifies the authorizer's Uniform Resource Identifier (URI). ForTOKENorREQUESTauthorizers, this must be a well-formed Lambda function URI, for example,arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}invocations. In general, the URI has this formarn:aws:apigateway:{region}:lambda:path/{service_api}, where{region}is the same as the region hosting the Lambda function,pathindicates 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 form2015-03-31functions[FunctionARN]invocations.aIdentityValidationExpression- A validation expression for the incoming identity token. ForTOKENauthorizers, this value is a regular expression. API Gateway will match theaudfield of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to theREQUESTauthorizer.aProviderARNs- A list of the Amazon Cognito user pool ARNs for theCOGNITO_USER_POOLSauthorizer. Each element is of this format:arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For aTOKENorREQUESTauthorizer, this is not defined.aName- [Required] The name of the authorizer.aId- The identifier for the authorizer resource.aAuthorizerResultTtlInSeconds- The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is 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- Optional customer-defined field, used in Swagger imports and exports without functional impact.aType- The authorizer type. Valid values areTOKENfor a Lambda function using a single authorization token submitted in a custom header,REQUESTfor a Lambda function using incoming request parameters, andCOGNITO_USER_POOLSfor using an Amazon Cognito user pool.aIdentitySource- The identity source for which authorization is requested. * For aTOKENorCOGNITO_USER_POOLSauthorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name isAuth, the header mapping expression ismethod.request.header.Auth. * For theREQUESTauthorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if anAuthheader, aNamequery string parameter are defined as identity sources, this value ismethod.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of theREQUESTauthorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.aAuthorizerCredentials- Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.
aAuthorizerURI :: Lens' Authorizer (Maybe Text) #
Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates 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-31functions[FunctionARN]invocations .
aIdentityValidationExpression :: Lens' Authorizer (Maybe Text) #
A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
aProviderARNs :: Lens' Authorizer [Text] #
A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id} . For a TOKEN or REQUEST authorizer, this is not defined.
aAuthorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) #
The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is 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) #
Optional customer-defined field, used in Swagger imports and exports without functional impact.
aType :: Lens' Authorizer (Maybe AuthorizerType) #
The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
aIdentitySource :: Lens' Authorizer (Maybe Text) #
The identity source for which authorization is requested. * For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth , the header mapping expression is method.request.header.Auth . * For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name . These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.
aAuthorizerCredentials :: Lens' Authorizer (Maybe Text) #
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for 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 #
Represents the base path that callers of the API must provide as part of the URL after the domain name.
A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account .Use Custom Domain Names
See: basePathMapping smart constructor.
basePathMapping :: BasePathMapping #
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:
bpmStage- The name of the associated stage.bpmBasePath- The base path name that callers of the API must provide as part of the URL after the domain name.bpmRestAPIId- The string identifier of the associatedRestApi.
bpmBasePath :: Lens' BasePathMapping (Maybe Text) #
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) #
The string identifier of the associated RestApi .
CanarySettings
data CanarySettings #
Configuration settings of a canary deployment.
See: canarySettings smart constructor.
canarySettings :: CanarySettings #
Creates a value of CanarySettings with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
csDeploymentId- The ID of the canary deployment.csStageVariableOverrides- Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.csUseStageCache- A Boolean flag to indicate whether the canary deployment uses the stage cache or not.csPercentTraffic- The percent (0-100) of traffic diverted to a canary deployment.
csDeploymentId :: Lens' CanarySettings (Maybe Text) #
The ID of the canary deployment.
csStageVariableOverrides :: Lens' CanarySettings (HashMap Text Text) #
Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.
csUseStageCache :: Lens' CanarySettings (Maybe Bool) #
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
csPercentTraffic :: Lens' CanarySettings (Maybe Double) #
The percent (0-100) of traffic diverted to a canary deployment.
ClientCertificate
data ClientCertificate #
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.Use Client-Side Certificate
See: clientCertificate smart constructor.
clientCertificate :: ClientCertificate #
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- The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .ccClientCertificateId- The identifier of the client certificate.ccCreatedDate- The timestamp when the client certificate was created.ccExpirationDate- The timestamp when the client certificate will expire.ccDescription- The description of the client certificate.
ccPemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) #
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
ccClientCertificateId :: Lens' ClientCertificate (Maybe Text) #
The identifier of the client certificate.
ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime) #
The timestamp when the client certificate was created.
ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime) #
The timestamp when the client certificate will expire.
ccDescription :: Lens' ClientCertificate (Maybe Text) #
The description of the client certificate.
Deployment
data Deployment #
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.
To create a deployment, call POST on the Deployments resource of a RestApi . To view, update, or delete a deployment, call GET , PATCH , or DELETE on the specified deployment resource (restapis{restapi_id}deployments{deployment_id} ).RestApi , Deployments , Stage , AWS CLI , AWS SDKs
See: deployment smart constructor.
Instances
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- A summary of theRestApiat the date and time that the deployment resource was created.dCreatedDate- The date and time that the deployment resource was created.dId- The identifier for the deployment resource.dDescription- The description for the deployment resource.
dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot)) #
A summary of the RestApi at the date and time that the deployment resource was created.
dCreatedDate :: Lens' Deployment (Maybe UTCTime) #
The date and time that the deployment resource was created.
dDescription :: Lens' Deployment (Maybe Text) #
The description for the deployment resource.
DeploymentCanarySettings
data DeploymentCanarySettings #
The input configuration for a canary deployment.
See: deploymentCanarySettings smart constructor.
Instances
deploymentCanarySettings :: DeploymentCanarySettings #
Creates a value of DeploymentCanarySettings with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcsStageVariableOverrides- A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.dcsUseStageCache- A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.dcsPercentTraffic- The percentage (0.0-100.0) of traffic routed to the canary deployment.
dcsStageVariableOverrides :: Lens' DeploymentCanarySettings (HashMap Text Text) #
A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.
dcsUseStageCache :: Lens' DeploymentCanarySettings (Maybe Bool) #
A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
dcsPercentTraffic :: Lens' DeploymentCanarySettings (Maybe Double) #
The percentage (0.0-100.0) of traffic routed to the canary deployment.
DocumentationPart
data DocumentationPart #
A documentation part for a targeted API entity.
A documentation part consists of a content map (properties ) and a target (location ). The target specifies an API entity to which the documentation content applies. The supported API entity types are API , AUTHORIZER , MODEL , RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . Valid location fields depend on the API entity type. All valid fields are not required.
The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.
Documenting an API , DocumentationParts
See: documentationPart smart constructor.
documentationPart :: DocumentationPart #
Creates a value of DocumentationPart with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dpLocation- The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.dpId- TheDocumentationPartidentifier, generated by API Gateway when theDocumentationPartis created.dpProperties- A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g.,"{ "description": "The API does ..." }". Only Swagger-compliant documentation-related fields from thepropertiesmap are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension ofx-amazon-apigateway-documentation.
dpLocation :: Lens' DocumentationPart (Maybe DocumentationPartLocation) #
The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
dpId :: Lens' DocumentationPart (Maybe Text) #
The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.
dpProperties :: Lens' DocumentationPart (Maybe Text) #
A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ "description": "The API does ..." }" . Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation .
DocumentationPartLocation
data DocumentationPartLocation #
Specifies the target API entity to which the documentation applies.
See: documentationPartLocation smart constructor.
Instances
Arguments
| :: DocumentationPartType | |
| -> DocumentationPartLocation |
Creates a value of DocumentationPartLocation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dplPath- The URL path of the target. It is a valid field for the API entity types ofRESOURCE,METHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. The default value is/for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the otherlocationattributes, the child entity'spathattribute must match that of the parent entity as a prefix.dplName- The name of the targeted API entity. It is a valid and required field for the API entity types ofAUTHORIZER,MODEL,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODYandRESPONSE_HEADER. It is an invalid field for any other entity type.dplMethod- The HTTP verb of a method. It is a valid field for the API entity types ofMETHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. The default value is*for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the otherlocationattributes, the child entity'smethodattribute must match that of the parent entity exactly.dplStatusCode- The HTTP status code of a response. It is a valid field for the API entity types ofRESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. The default value is*for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the otherlocationattributes, the child entity'sstatusCodeattribute must match that of the parent entity exactly.dplType- [Required] The type of API entity to which the documentation content applies. Valid values areAPI,AUTHORIZER,MODEL,RESOURCE,METHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. Content inheritance does not apply to any entity of theAPI,AUTHORIZER,METHOD,MODEL,REQUEST_BODY, orRESOURCEtype.
dplPath :: Lens' DocumentationPartLocation (Maybe Text) #
The URL path of the target. It is a valid field for the API entity types of RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.
dplName :: Lens' DocumentationPartLocation (Maybe Text) #
The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER , MODEL , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY and RESPONSE_HEADER . It is an invalid field for any other entity type.
dplMethod :: Lens' DocumentationPartLocation (Maybe Text) #
The HTTP verb of a method. It is a valid field for the API entity types of METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.
dplStatusCode :: Lens' DocumentationPartLocation (Maybe Text) #
The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.
dplType :: Lens' DocumentationPartLocation DocumentationPartType #
- Required
- The type of API entity to which the documentation content applies. Valid values are
API,AUTHORIZER,MODEL,RESOURCE,METHOD,PATH_PARAMETER,QUERY_PARAMETER,REQUEST_HEADER,REQUEST_BODY,RESPONSE,RESPONSE_HEADER, andRESPONSE_BODY. Content inheritance does not apply to any entity of theAPI,AUTHORIZER,METHOD,MODEL,REQUEST_BODY, orRESOURCEtype.
DocumentationVersion
data DocumentationVersion #
A snapshot of the documentation of an API.
Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.
Documenting an API , DocumentationPart , DocumentationVersions
See: documentationVersion smart constructor.
documentationVersion :: DocumentationVersion #
Creates a value of DocumentationVersion with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dvCreatedDate- The date when the API documentation snapshot is created.dvVersion- The version identifier of the API documentation snapshot.dvDescription- The description of the API documentation snapshot.
dvCreatedDate :: Lens' DocumentationVersion (Maybe UTCTime) #
The date when the API documentation snapshot is created.
dvVersion :: Lens' DocumentationVersion (Maybe Text) #
The version identifier of the API documentation snapshot.
dvDescription :: Lens' DocumentationVersion (Maybe Text) #
The description of the API documentation snapshot.
DomainName
data DomainName #
Represents a custom domain name as a user-friendly host name of an API (RestApi ).
When you deploy an API, API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/ . When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi , where myApi is the base path mapping (BasePathMapping ) of your API under the custom domain name.
Set a Custom Host Name for an API
See: domainName smart constructor.
Instances
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:
dnRegionalHostedZoneId- The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway .dnCertificateName- The name of the certificate that will be used by edge-optimized endpoint for this domain name.dnRegionalCertificateARN- The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.dnCertificateARN- The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.dnDistributionHostedZoneId- The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value isZ2FDTNDATAQYW2for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway .dnDomainName- The custom domain name as an API host name, for example,my-api.example.com.dnRegionalCertificateName- The name of the certificate that will be used for validating the regional domain name.dnRegionalDomainName- The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.dnCertificateUploadDate- The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.dnDistributionDomainName- The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation .dnEndpointConfiguration- The endpoint configuration of thisDomainNameshowing the endpoint types of the domain name.
dnRegionalHostedZoneId :: Lens' DomainName (Maybe Text) #
The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway .
dnCertificateName :: Lens' DomainName (Maybe Text) #
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
dnRegionalCertificateARN :: Lens' DomainName (Maybe Text) #
The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
dnCertificateARN :: Lens' DomainName (Maybe Text) #
The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
dnDistributionHostedZoneId :: Lens' DomainName (Maybe Text) #
The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway .
dnDomainName :: Lens' DomainName (Maybe Text) #
The custom domain name as an API host name, for example, my-api.example.com .
dnRegionalCertificateName :: Lens' DomainName (Maybe Text) #
The name of the certificate that will be used for validating the regional domain name.
dnRegionalDomainName :: Lens' DomainName (Maybe Text) #
The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.
dnCertificateUploadDate :: Lens' DomainName (Maybe UTCTime) #
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
dnDistributionDomainName :: Lens' DomainName (Maybe Text) #
The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation .
dnEndpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration) #
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
EndpointConfiguration
data EndpointConfiguration #
The endpoint configuration to indicate the types of endpoints an API (RestApi ) or its custom domain name (DomainName ) has.
See: endpointConfiguration smart constructor.
Instances
endpointConfiguration :: EndpointConfiguration #
Creates a value of EndpointConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ecTypes- A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type isEDGE. For a regional API and its custom domain name, the endpoint type isREGIONAL.
ecTypes :: Lens' EndpointConfiguration [EndpointType] #
A list of endpoint types of an API (RestApi ) or its custom domain name (DomainName ). For an edge-optimized API and its custom domain name, the endpoint type is EDGE . For a regional API and its custom domain name, the endpoint type is REGIONAL .
GatewayResponse
data GatewayResponse #
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
For more information about valid gateway response types, see Gateway Response Types Supported by API Gateway Example: Get a Gateway Response of a given response type
Request
This example shows how to get a gateway response of the MISSING_AUTHENTICATION_TOKEN type.
@GET restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN HTTP1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: applicationjson X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}20170503us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45 @ The response type is specified as a URL path.
Response
The successful operation returns the 200 OK status code and a payload similar to the following:
@{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "restapiso81lxiseflgatewayresponses{response_type}", "templated": true }, "gatewayresponse:update": { "href": "restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{n "message": $context.error.messageString,n "type": "$context.error.responseType",n "stage": "$context.stage",n "resourcePath": "$context.resourcePath",n "stageVariables.a": "$stageVariables.a",n "statusCode": "'404'"n}" }, "responseType": MISSING_AUTHENTICATION_TOKEN, "statusCode": "404" } @
See: gatewayResponse smart constructor.
gatewayResponse :: GatewayResponse #
Creates a value of GatewayResponse with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gDefaultResponse- A Boolean flag to indicate whether thisGatewayResponseis the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.gResponseTemplates- Response templates of theGatewayResponseas a string-to-string map of key-value pairs.gResponseType- The response type of the associatedGatewayResponse. Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPEgStatusCode- The HTTP status code for thisGatewayResponse.gResponseParameters- Response parameters (paths, query strings and headers) of theGatewayResponseas a string-to-string map of key-value pairs.
gDefaultResponse :: Lens' GatewayResponse (Maybe Bool) #
A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true ) or not (false ). A default gateway response is one generated by API Gateway without any customization by an API developer.
gResponseTemplates :: Lens' GatewayResponse (HashMap Text Text) #
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
gResponseType :: Lens' GatewayResponse (Maybe GatewayResponseType) #
The response type of the associated GatewayResponse . Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPE
gStatusCode :: Lens' GatewayResponse (Maybe Text) #
The HTTP status code for this GatewayResponse .
gResponseParameters :: Lens' GatewayResponse (HashMap Text Text) #
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
Integration
data Integration #
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
In the API Gateway console, the built-in Lambda integration is an AWS integration.Creating an API
See: integration smart constructor.
Instances
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- Specifies the integration's HTTP method type.iRequestTemplates- Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.iCredentials- Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for 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 stringarn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.iConnectionId- The (@id@ ) of theVpcLinkused for the integration whenconnectionType=VPC_LINKand undefined, otherwise.iRequestParameters- A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern ofmethod.request.{location}.{name}, wherelocationisquerystring,path, orheaderandnamemust be a valid and unique method request parameter name.iContentHandling- Specifies how to handle request payload content type conversions. Supported values areCONVERT_TO_BINARYandCONVERT_TO_TEXT, with the following behaviors: *CONVERT_TO_BINARY: Converts a request payload from a Base64-encoded string to the corresponding binary blob. *CONVERT_TO_TEXT: Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that thepassthroughBehaviorsis configured to support payload pass-through.iPassthroughBehavior- Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified inrequestTemplates. The valid value is one of the following: *WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. *WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP415 Unsupported Media Typeresponse. *NEVER: rejects the method request with an HTTP415 Unsupported Media Typeresponse when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.iUri- Specifies Uniform Resource Identifier (URI) of the integration endpoint. * ForHTTPorHTTP_PROXYintegrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, whereconnectionTypeis notVPC_LINK, or private integration, whereconnectionTypeisVPC_LINK. For a private HTTP integration, the URI is not used for routing. * ForAWSorAWS_PROXYintegrations, the URI is of the formarn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here,{Region}is the API Gateway region (e.g.,us-east-1);{service}is the name of the integrated AWS service (e.g.,s3); and{subdomain}is a designated subdomain supported by certain AWS service for fast host-name lookup.actioncan be used for an AWS service action-based API, using anAction={name}&{p1}={v1}&p2={v2}...query string. The ensuing{service_api}refers to a supported action{name}plus any required input parameters. Alternatively,pathcan be used for an AWS service path-based API. The ensuingservice_apirefers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API ofGetObject, theurican be eitherarn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key}orarn:aws:apigateway:us-west-2:s3:path{bucket}{key}iIntegrationResponses- Specifies the integration's responses. Example: Get integration responses of a method Request @GET restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160607us-east-1apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}Response The successful response returns200 OKstatus and a payload as follows:{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3Cname%3E%3Cstream%3E#end%3CkinesisStreams%3E")n" }, "statusCode": "200" }@ Creating an APIiCacheNamespace- Specifies the integration's cache namespace.iTimeoutInMillis- Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.iType- Specifies an API method integration type. The valid value is one of the following: *AWS: for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. *AWS_PROXY: for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration. *HTTP: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration. *HTTP_PROXY: for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration. *MOCK: for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend. For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with aconnectionTypeofVPC_LINKis referred to as a private integration and uses aVpcLinkto connect API Gateway to a network load balancer of a VPC.iConnectionType- The type of the network connection to the integration endpoint. The valid value isINTERNETfor connections through the public routable internet orVPC_LINKfor private connections between API Gateway and a network load balancer in a VPC. The default value isINTERNET.iCacheKeyParameters- Specifies the integration's cache key parameters.
iHttpMethod :: Lens' Integration (Maybe Text) #
Specifies the integration's HTTP method type.
iRequestTemplates :: Lens' Integration (HashMap Text Text) #
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
iCredentials :: Lens' Integration (Maybe Text) #
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for 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.
iConnectionId :: Lens' Integration (Maybe Text) #
The (@id@ ) of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.
iRequestParameters :: Lens' Integration (HashMap Text Text) #
A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name must be a valid and unique method request parameter name.
iContentHandling :: Lens' Integration (Maybe ContentHandlingStrategy) #
Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a request payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
iPassthroughBehavior :: Lens' Integration (Maybe Text) #
Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates . The valid value is one of the following: * WHEN_NO_MATCH : passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. * WHEN_NO_TEMPLATES : passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. * NEVER : rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
iUri :: Lens' Integration (Maybe Text) #
Specifies Uniform Resource Identifier (URI) of the integration endpoint. * For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification , for either standard integration, where connectionType is not VPC_LINK , or private integration, where connectionType is VPC_LINK . For a private HTTP integration, the URI is not used for routing. * For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api} . Here, {Region} is the API Gateway region (e.g., us-east-1 ); {service} is the name of the integrated AWS service (e.g., s3 ); and {subdomain} is a designated subdomain supported by certain AWS service for fast host-name lookup. action can be used for an AWS service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an AWS service resource, including the region of the integrated AWS service, if applicable. For example, for integration with the S3 API of GetObject , the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path{bucket}{key}
iIntegrationResponses :: Lens' Integration (HashMap Text IntegrationResponse) #
Specifies the integration's responses. Example: Get integration responses of a method Request @GET restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160607us-east-1apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns 200 OK status and a payload as follows: { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3Cname%3E%3Cstream%3E#end%3CkinesisStreams%3E")n" }, "statusCode": "200" } @ Creating an API
iCacheNamespace :: Lens' Integration (Maybe Text) #
Specifies the integration's cache namespace.
iTimeoutInMillis :: Lens' Integration (Maybe Int) #
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
iType :: Lens' Integration (Maybe IntegrationType) #
Specifies an API method integration type. The valid value is one of the following: * AWS : for integrating the API method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. * AWS_PROXY : for integrating the API method request with the Lambda function-invoking action with the client request passed through as-is. This integration is also referred to as the Lambda proxy integration. * HTTP : for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC. This integration is also referred to as the HTTP custom integration. * HTTP_PROXY : for integrating the API method request with an HTTP endpoint, including a private HTTP endpoint within a VPC, with the client request passed through as-is. This is also referred to as the HTTP proxy integration. * MOCK : for integrating the API method request with API Gateway as a "loop-back" endpoint without invoking any backend. For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https ), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.
iConnectionType :: Lens' Integration (Maybe ConnectionType) #
The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET .
iCacheKeyParameters :: Lens' Integration [Text] #
Specifies the integration's cache key parameters.
IntegrationResponse
data IntegrationResponse #
Represents an integration response. The status code must map to an existing MethodResponse , and parameters and templates can be used to transform the back-end response.
See: integrationResponse smart constructor.
integrationResponse :: IntegrationResponse #
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:
intContentHandling- Specifies how to handle response payload content type conversions. Supported values areCONVERT_TO_BINARYandCONVERT_TO_TEXT, with the following behaviors: *CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob. *CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.intResponseTemplates- 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.intSelectionPattern- Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the.+regex to match error response. However, make sure that the error response does not contain any newline (n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.intStatusCode- Specifies the status code that is used to map the integration response to an existingMethodResponse.intResponseParameters- A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern ofmethod.response.header.{name}, wherenameis a valid and unique header name. The mapped non-static value must match the pattern ofintegration.response.header.{name}orintegration.response.body.{JSON-expression}, wherenameis a valid and unique response header name andJSON-expressionis a valid JSON expression without the>prefix.
intContentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) #
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a response payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a response payload from a binary blob to a Base64-encoded string. If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
intResponseTemplates :: Lens' IntegrationResponse (HashMap Text Text) #
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.
intSelectionPattern :: Lens' IntegrationResponse (Maybe Text) #
Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (n ) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.
intStatusCode :: Lens' IntegrationResponse (Maybe Text) #
Specifies the status code that is used to map the integration response to an existing MethodResponse .
intResponseParameters :: Lens' IntegrationResponse (HashMap Text Text) #
A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name} , where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression} , where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the > prefix.
Method
Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.
Example: Retrive the GET method on a specified resource
Request
The following example request retrieves the information about the GET method on an API resource (3kzxbg5sa2 ) of an API (fugvjdxtri ).
@GET restapisfugvjdxtriresources3kzxbg5sa2methodsGET HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160603us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response
The successful response returns a 200 OK@ status code and a payload similar to the following:
@{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET", "name": GET, "title": GET }, "integration:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "method:integration": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "method:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "methodresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses{status_code}", "templated": true } }, "apiKeyRequired": true, "authorizationType": NONE, "httpMethod": GET, "_embedded": { "method:integration": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integration:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integrationresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:roleapigAwsProxyRole", "httpMethod": POST, "passthroughBehavior": WHEN_NO_MATCH, "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "applicationjson": "{n}" }, "type": AWS, "uri": "arn:aws:apigateway:us-east-1:kinesis:actionListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" }, "methodresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" } }, "responseModels": { "applicationjson": Empty }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } } In the example above, the response template for the 200 OK response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as %3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E@ and the output is decoded using the http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-reference util.urlDecode()> helper function.
MethodResponse , Integration , IntegrationResponse , Resource , Set up an API's 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- Gets a method response associated with a given HTTP status code. The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is aMethodResponseresource that specifies the response returned to the caller from the back end through the integration response. Example: Get a 200 OK response of a GET method Request @GET restapisuojnr9hd57resources0cjtchmethodsGETresponses200 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160613us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}Response The successful response returns a200 OKstatus code and a payload similar to the following:{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETresponses200", "title": "200" }, "methodresponse:delete": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETresponses200" }, "methodresponse:update": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETresponses200" } }, "responseModels": { "application/json": Empty }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }@ AWS CLImHttpMethod- The method's HTTP verb.mAuthorizationScopes- A list of authorization scopes configured on the method. The scopes are used with aCOGNITO_USER_POOLSauthorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.mRequestValidatorId- The identifier of aRequestValidatorfor request validation.mRequestModels- A key-value map specifying data schemas, represented byModelresources, (as the mapped value) of the request payloads of given content types (as the mapping key).mRequestParameters- A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern ofmethod.request.{location}.{name}, wherelocationisquerystring,path, orheaderandnameis a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available inIntegrationto be mapped to integration request parameters or templates.mAuthorizerId- The identifier of anAuthorizerto use on this method. TheauthorizationTypemust beCUSTOM.mOperationName- A human-friendly operation identifier for the method. For example, you can assign theoperationNameofListPetsfor theGET /petsmethod in PetStore example.mAuthorizationType- The method's authorization type. Valid values areNONEfor open access,AWS_IAMfor using AWS IAM permissions,CUSTOMfor using a custom authorizer, orCOGNITO_USER_POOLSfor using a Cognito user pool.mApiKeyRequired- A boolean flag specifying whether a validApiKeyis required to invoke this method.mMethodIntegration- Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end. Example: Request @GET restapisuojnr9hd57resources0cjtchmethodsGETintegration HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160613us-east-1apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}Response The successful response returns a200 OKstatus code and a payload similar to the following:{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegration" }, "integration:delete": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegration" }, "integration:responses": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses200", "name": "200", "title": "200" }, "integration:update": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegration" }, "integrationresponse:put": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:roleapigAwsProxyRole", "httpMethod": POST, "passthroughBehavior": WHEN_NO_MATCH, "requestTemplates": { "applicationjson": "{n "a": "$input.params(@ AWS CLIoperand1)",n "b": "$input.params(operand2)", n "op": "$input.params(operator)" n}" }, "type": AWS, "uri": "arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:123456789012:function:Calcinvocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "applicationjson": "#set($res = $input.path($))n{n "result": "$res.a, $res.b, $res.op => $res.c",n "a" : "$res.a",n "b" : "$res.b",n "op" : "$res.op",n "c" : "$res.c"n}" }, "selectionPattern": "", "statusCode": "200" } } }
mMethodResponses :: Lens' Method (HashMap Text MethodResponse) #
Gets a method response associated with a given HTTP status code. The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response. Example: Get a 200 OK response of a GET method Request @GET restapisuojnr9hd57resources0cjtchmethodsGETresponses200 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160613us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK status code and a payload similar to the following: { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETresponses200", "title": "200" }, "methodresponse:delete": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETresponses200" }, "methodresponse:update": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETresponses200" } }, "responseModels": { "application/json": Empty }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" } @ AWS CLI
mAuthorizationScopes :: Lens' Method [Text] #
A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.
mRequestValidatorId :: Lens' Method (Maybe Text) #
The identifier of a RequestValidator for request validation.
mRequestModels :: Lens' Method (HashMap Text Text) #
A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).
mRequestParameters :: Lens' Method (HashMap Text Bool) #
A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true ) or optional (false ). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.
mAuthorizerId :: Lens' Method (Maybe Text) #
The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM .
mOperationName :: Lens' Method (Maybe Text) #
A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in PetStore example.
mAuthorizationType :: Lens' Method (Maybe Text) #
The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
mApiKeyRequired :: Lens' Method (Maybe Bool) #
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
mMethodIntegration :: Lens' Method (Maybe Integration) #
Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end. Example: Request @GET restapisuojnr9hd57resources0cjtchmethodsGETintegration HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160613us-east-1apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK status code and a payload similar to the following: { "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegration" }, "integration:delete": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegration" }, "integration:responses": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses200", "name": "200", "title": "200" }, "integration:update": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegration" }, "integrationresponse:put": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:roleapigAwsProxyRole", "httpMethod": POST, "passthroughBehavior": WHEN_NO_MATCH, "requestTemplates": { "applicationjson": "{n "a": "$input.params( @ AWS CLIoperand1)",n "b": "$input.params(operand2)", n "op": "$input.params(operator)" n}" }, "type": AWS, "uri": "arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:123456789012:function:Calcinvocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisuojnr9hd57resources0cjtchmethodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "applicationjson": "#set($res = $input.path($))n{n "result": "$res.a, $res.b, $res.op => $res.c",n "a" : "$res.a",n "b" : "$res.b",n "op" : "$res.op",n "c" : "$res.c"n}" }, "selectionPattern": "", "statusCode": "200" } } }
MethodResponse
data MethodResponse #
Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.
Example: A MethodResponse instance of an API Request The example request retrieves a MethodResponse of the 200 status code.
@GET restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160603us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response
The successful response returns 200 OK@ status and a payload as follows:
@{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "title": "200" }, "methodresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" }, "methodresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" } }, "responseModels": { "application/json": Empty }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } @
Method , IntegrationResponse , Integration Creating an API
See: methodResponse smart constructor.
methodResponse :: MethodResponse #
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- Specifies theModelresources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and aModelname as the value.mStatusCode- The method response's status code.mResponseParameters- A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the patternmethod.response.header.{name}, wherenameis a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API'sIntegrationResponse. The integration response data that can be mapped include an integration response header expressed inintegration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g.,'application/json'), or a JSON expression from the back-end response payload in the form ofintegration.response.body.{JSON-expression}, whereJSON-expressionis a valid JSON expression without the>prefix.)
mStatusCode :: Lens' MethodResponse (Maybe Text) #
The method response's status code.
mResponseParameters :: Lens' MethodResponse (HashMap Text Bool) #
A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name} , where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse . The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name} , a static value enclosed within a pair of single quotes (e.g., 'application/json' ), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression} , where JSON-expression is a valid JSON expression without the > prefix.)
MethodSetting
data MethodSetting #
Specifies the method setting properties.
See: methodSetting smart constructor.
methodSetting :: MethodSetting #
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- Specifies the time to live (TTL), in seconds, for cached responses. The higher 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- Specifies 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- Specifies the throttling burst limit. The PATCH path for this setting is{method_setting_key}throttling/burstLimit, and the value is an integer.msCacheDataEncrypted- 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- 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 areOFF,ERROR, andINFO.msRequireAuthorizationForCacheControl- 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- 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- 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- Specifies the throttling rate limit. The PATCH path for this setting is{method_setting_key}throttling/rateLimit, and the value is a double.msUnauthorizedCacheControlHeaderStrategy- Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is{method_setting_key}caching/unauthorizedCacheControlHeaderStrategy, and the available values areFAIL_WITH_403,SUCCEED_WITH_RESPONSE_HEADER,SUCCEED_WITHOUT_RESPONSE_HEADER.
msCacheTtlInSeconds :: Lens' MethodSetting (Maybe Int) #
Specifies the time to live (TTL), in seconds, for cached responses. The higher 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) #
Specifies 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) #
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) #
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) #
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) #
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) #
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) #
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) #
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) #
Specifies how to handle 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 #
Represents a summary of a Method resource, given a particular date and time.
See: methodSnapshot smart constructor.
methodSnapshot :: MethodSnapshot #
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- The method's authorization type. Valid values areNONEfor open access,AWS_IAMfor using AWS IAM permissions,CUSTOMfor using a custom authorizer, orCOGNITO_USER_POOLSfor using a Cognito user pool.msApiKeyRequired- Specifies whether the method requires a validApiKey.
msAuthorizationType :: Lens' MethodSnapshot (Maybe Text) #
The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.
msApiKeyRequired :: Lens' MethodSnapshot (Maybe Bool) #
Specifies whether the method requires a valid ApiKey .
Model
Represents the data structure of a method's request or response payload.
A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.
A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.
Method , MethodResponse , Models and Mappings
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- The schema for the model. Forapplication/jsonmodels, this should be JSON schema draft 4 model. Do not include "*" characters in the description of any properties because such "*" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.mName- The name of the model. Must be an alphanumeric string.mId- The identifier for the model resource.mDescription- The description of the model.mContentType- The content-type for the model.
mSchema :: Lens' Model (Maybe Text) #
The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "*" characters in the description of any properties because such "*" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.
PatchOperation
data PatchOperation #
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 #
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- An update operation to be performed with this PATCH request. The valid value can beadd,remove,replaceorcopy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.poPath- Theopoperation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of{"name":"value"}, the path for this property is/name. If thenameproperty value is a JSON object (e.g.,{"name": {"child/name": "child-value"}}), the path for thechild/nameproperty will benamechild~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Eachopoperation can have only onepathassociated with it.poValue- The new target value of the update operation. It is applicable for theaddorreplaceoperation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters .poFrom- Thecopyupdate operation's source as identified by aJSON-Pointervalue referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on aStageresource with"op":"copy","from":"canarySettingsdeploymentId"and"path":"/deploymentId".
poOp :: Lens' PatchOperation (Maybe Op) #
An update operation to be performed with this PATCH request. The valid value can be add , remove , replace or copy . Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.
poPath :: Lens' PatchOperation (Maybe Text) #
The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"} , the path for this property is /name . If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}} ), the path for the child/name property will be namechild~1name . Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.
poValue :: Lens' PatchOperation (Maybe Text) #
The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'. In a Windows shell, see Using JSON for Parameters .
poFrom :: Lens' PatchOperation (Maybe Text) #
The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy" , "from":"canarySettingsdeploymentId" and "path":"/deploymentId" .
QuotaSettings
data QuotaSettings #
Quotas configured for a usage plan.
See: quotaSettings smart constructor.
quotaSettings :: QuotaSettings #
Creates a value of QuotaSettings with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
qsOffset :: Lens' QuotaSettings (Maybe Int) #
The number of requests subtracted from the given limit in the initial time period.
qsLimit :: Lens' QuotaSettings (Maybe Int) #
The maximum number of requests that can be made in a given time period.
RequestValidator
data RequestValidator #
A set of validation rules for incoming Method requests.
In Swagger, a RequestValidator of an API is defined by the x-amazon-apigateway-request-validators.requestValidator object. It the referenced using the x-amazon-apigateway-request-validator property.
Enable Basic Request Validation in API Gateway
See: requestValidator smart constructor.
requestValidator :: RequestValidator #
Creates a value of RequestValidator with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rvValidateRequestParameters- A Boolean flag to indicate whether to validate request parameters (true) or not (false).rvName- The name of thisRequestValidatorrvValidateRequestBody- A Boolean flag to indicate whether to validate a request body according to the configuredModelschema.rvId- The identifier of thisRequestValidator.
rvValidateRequestParameters :: Lens' RequestValidator (Maybe Bool) #
A Boolean flag to indicate whether to validate request parameters (true ) or not (false ).
rvName :: Lens' RequestValidator (Maybe Text) #
The name of this RequestValidator
rvValidateRequestBody :: Lens' RequestValidator (Maybe Bool) #
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
rvId :: Lens' RequestValidator (Maybe Text) #
The identifier of this RequestValidator .
Resource
Creates a value of Resource with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rPathPart- The last path segment for this resource.rPath- The full path for this resource.rId- The resource's identifier.rResourceMethods- Gets an API resource's method of a given HTTP verb. The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the200 OKresponse of theGET restapis{restapi_id}resources{resource_id}orGET restapis{restapi_id}resources{resource_id}?embed=methodsrequest. Example: Get the GET method of an API resource Request @GET restapisfugvjdxtriresources3kzxbg5sa2methodsGET HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20170223us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}Response{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET", "name": GET, "title": GET }, "integration:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "method:integration": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "method:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "methodresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": NONE, "httpMethod": GET, "_embedded": { "method:integration": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integration:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integrationresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:roleapigAwsProxyRole", "httpMethod": POST, "passthroughBehavior": WHEN_NO_MATCH, "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "applicationjson": "{n}" }, "type": AWS, "uri": "arn:aws:apigateway:us-east-1:kinesis:actionListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3Cname%3E%3Cstream%3E#end%3CkinesisStreams%3E")n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" }, "methodresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" } }, "responseModels": { "application/json": Empty }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }If theOPTIONSis enabled on the resource, you can follow the example here to get that method. Just replace theGETof the last path segment in the request URL withOPTIONS@ .rParentId- The parent resource's identifier.
rResourceMethods :: Lens' Resource (HashMap Text Method) #
Gets an API resource's method of a given HTTP verb. The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the 200 OK response of the GET restapis{restapi_id}resources{resource_id} or GET restapis{restapi_id}resources{resource_id}?embed=methods request. Example: Get the GET method of an API resource Request @GET restapisfugvjdxtriresources3kzxbg5sa2methodsGET HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20170223T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20170223us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response { "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET", "name": GET, "title": GET }, "integration:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "method:integration": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "method:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "method:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGET" }, "methodresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": NONE, "httpMethod": GET, "_embedded": { "method:integration": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integration:responses": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integration:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegration" }, "integrationresponse:put": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:roleapigAwsProxyRole", "httpMethod": POST, "passthroughBehavior": WHEN_NO_MATCH, "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "applicationjson": "{n}" }, "type": AWS, "uri": "arn:aws:apigateway:us-east-1:kinesis:actionListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3Cname%3E%3Cstream%3E#end%3CkinesisStreams%3E")n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" }, "methodresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETresponses200" } }, "responseModels": { "application/json": Empty }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } } If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS@ .
RestAPI
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:
raMinimumCompressionSize- A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.raBinaryMediaTypes- The list of binary media types supported by theRestApi. By default, theRestApisupports only UTF-8-encoded text payloads.raWarnings- The warning messages reported whenfailonwarningsis turned on during API import.raCreatedDate- The timestamp when the API was created.raName- The API's name.raVersion- A version identifier for the API.raApiKeySource- The source of the API key for metering requests according to a usage plan. Valid values are: *HEADERto read the API key from theX-API-Keyheader of a request. *AUTHORIZERto read the API key from theUsageIdentifierKeyfrom a custom authorizer.raId- The API's identifier. This identifier is unique across all of your APIs in API Gateway.raPolicy-MethodraEndpointConfiguration- The endpoint configuration of thisRestApishowing the endpoint types of the API.raDescription- The API's description.
raMinimumCompressionSize :: Lens' RestAPI (Maybe Int) #
A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.
raBinaryMediaTypes :: Lens' RestAPI [Text] #
The list of binary media types supported by the RestApi . By default, the RestApi supports only UTF-8-encoded text payloads.
raWarnings :: Lens' RestAPI [Text] #
The warning messages reported when failonwarnings is turned on during API import.
raApiKeySource :: Lens' RestAPI (Maybe APIKeySourceType) #
The source of the API key for metering requests according to a usage plan. Valid values are: * HEADER to read the API key from the X-API-Key header of a request. * AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.
raId :: Lens' RestAPI (Maybe Text) #
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
raEndpointConfiguration :: Lens' RestAPI (Maybe EndpointConfiguration) #
The endpoint configuration of this RestApi showing the endpoint types of the API.
SDKConfigurationProperty
data SDKConfigurationProperty #
A configuration property of an SDK type.
See: sdkConfigurationProperty smart constructor.
Instances
sdkConfigurationProperty :: SDKConfigurationProperty #
Creates a value of SDKConfigurationProperty with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scpFriendlyName- The user-friendly name of anSdkTypeconfiguration property.scpRequired- A boolean flag of anSdkTypeconfiguration property to indicate if the associated SDK configuration property is required (true) or not (false).scpName- The name of a anSdkTypeconfiguration property.scpDefaultValue- The default value of anSdkTypeconfiguration property.scpDescription- The description of anSdkTypeconfiguration property.
scpFriendlyName :: Lens' SDKConfigurationProperty (Maybe Text) #
The user-friendly name of an SdkType configuration property.
scpRequired :: Lens' SDKConfigurationProperty (Maybe Bool) #
A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true ) or not (false ).
scpName :: Lens' SDKConfigurationProperty (Maybe Text) #
The name of a an SdkType configuration property.
scpDefaultValue :: Lens' SDKConfigurationProperty (Maybe Text) #
The default value of an SdkType configuration property.
scpDescription :: Lens' SDKConfigurationProperty (Maybe Text) #
The description of an SdkType configuration property.
SDKType
A type of SDK that API Gateway can generate.
See: sdkType smart constructor.
Creates a value of SDKType with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
stFriendlyName- The user-friendly name of anSdkTypeinstance.stConfigurationProperties- A list of configuration properties of anSdkType.stId- The identifier of anSdkTypeinstance.stDescription- The description of anSdkType.
stConfigurationProperties :: Lens' SDKType [SDKConfigurationProperty] #
A list of configuration properties of an SdkType .
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- The identifier of theDeploymentthat the stage points to.sVariables- A map that defines the stage variables for aStageresource. Variable names can have alphanumeric and underscore characters, and the values must match[A-Za-z0-9-._~:/?#&=,]+.sAccessLogSettings- Settings for logging access in this stage.sDocumentationVersion- The version of the associated API documentation.sClientCertificateId- The identifier of a client certificate for an API stage.sCreatedDate- The timestamp when the stage was created.sCacheClusterStatus- The status of the cache cluster for the stage, if enabled.sMethodSettings- A map that defines the method settings for aStageresource. Keys (designated as/{method_setting_keybelow) are method paths defined as{resource_path}/{http_method}for an individual method override, or**for overriding all methods in the stage.sLastUpdatedDate- The timestamp when the stage last updated.sCacheClusterSize- The size of the cache cluster for the stage, if enabled.sCanarySettings- Settings for the canary deployment in this stage.sCacheClusterEnabled- Specifies whether a cache cluster is enabled for the stage.sStageName- The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.sDescription- The stage's description.sTags- The collection of tags. Each tag element is associated with a given resource.
sDeploymentId :: Lens' Stage (Maybe Text) #
The identifier of the Deployment that the stage points to.
sVariables :: Lens' Stage (HashMap Text Text) #
A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+ .
sAccessLogSettings :: Lens' Stage (Maybe AccessLogSettings) #
Settings for logging access in this stage.
sClientCertificateId :: Lens' Stage (Maybe Text) #
The identifier of a client certificate for an API stage.
sCacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) #
The status of the cache cluster for the stage, if enabled.
sMethodSettings :: Lens' Stage (HashMap Text MethodSetting) #
A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or ** for overriding all methods in the stage.
sCacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) #
The size of the cache cluster for the stage, if enabled.
sCanarySettings :: Lens' Stage (Maybe CanarySettings) #
Settings for the canary deployment in this stage.
sCacheClusterEnabled :: Lens' Stage (Maybe Bool) #
Specifies whether a cache cluster is enabled for the stage.
sStageName :: Lens' Stage (Maybe Text) #
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
sTags :: Lens' Stage (HashMap Text Text) #
The collection of tags. Each tag element is associated with a given resource.
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- The string identifier of the associatedRestApi.skStageName- The stage name associated with the stage key.
ThrottleSettings
data ThrottleSettings #
The API request rate limits.
See: throttleSettings smart constructor.
throttleSettings :: ThrottleSettings #
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- The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.tsRateLimit- The API request steady-state rate limit.
tsBurstLimit :: Lens' ThrottleSettings (Maybe Int) #
The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.
tsRateLimit :: Lens' ThrottleSettings (Maybe Double) #
The API request steady-state rate limit.
Usage
Represents the usage data of a usage plan.
Create and Use Usage Plans , Manage Usage in a Usage Plan
See: usage smart constructor.
Creates a value of Usage with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
uUsagePlanId- The plan Id associated with this usage data.uEndDate- The ending date of the usage data.uItems- The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example,{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where{api_key}stands for an API key value and the daily log entry is of the format[used quota, remaining quota].uStartDate- The starting date of the usage data.uPosition- Undocumented member.
uItems :: Lens' Usage (HashMap Text [[Integer]]) #
The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]} , where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota] .
UsagePlan
Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.
In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.
See: usagePlan smart constructor.
Creates a value of UsagePlan with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upApiStages- The associated API stages of a usage plan.upName- The name of a usage plan.upId- The identifier of aUsagePlanresource.upThrottle- The request throttle limits of a usage plan.upQuota- The maximum number of permitted requests per a given unit time interval.upDescription- The description of a usage plan.upProductCode- The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
upApiStages :: Lens' UsagePlan [APIStage] #
The associated API stages of a usage plan.
upThrottle :: Lens' UsagePlan (Maybe ThrottleSettings) #
The request throttle limits of a usage plan.
upQuota :: Lens' UsagePlan (Maybe QuotaSettings) #
The maximum number of permitted requests per a given unit time interval.
upProductCode :: Lens' UsagePlan (Maybe Text) #
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
UsagePlanKey
data UsagePlanKey #
Represents a usage plan key to identify a plan customer.
To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey .
See: usagePlanKey smart constructor.
Instances
usagePlanKey :: UsagePlanKey #
Creates a value of UsagePlanKey with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upkType :: Lens' UsagePlanKey (Maybe Text) #
The type of a usage plan key. Currently, the valid key type is API_KEY .
VPCLink
A API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
To enable access to a resource in an Amazon Virtual Private Cloud through Amazon API Gateway, you, as an API developer, create a VpcLink resource targeted for one or more network load balancers of the VPC and then integrate an API method with a private integration that uses the VpcLink . The private integration has an integration type of HTTP or HTTP_PROXY and has a connection type of VPC_LINK . The integration uses the connectionId property to identify the VpcLink used.
See: vpcLink smart constructor.
Creates a value of VPCLink with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vlStatus- The status of the VPC link. The valid values areAVAILABLE,PENDING,DELETING, orFAILED. Deploying an API will wait if the status isPENDINGand will fail if the status isDELETING.vlTargetARNs- The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.vlName- The name used to label and identify the VPC link.vlStatusMessage- A description about the VPC link status.vlId- The identifier of theVpcLink. It is used in anIntegrationto reference thisVpcLink.vlDescription- The description of the VPC link.
vlStatus :: Lens' VPCLink (Maybe VPCLinkStatus) #
The status of the VPC link. The valid values are AVAILABLE , PENDING , DELETING , or FAILED . Deploying an API will wait if the status is PENDING and will fail if the status is DELETING .
vlTargetARNs :: Lens' VPCLink [Text] #
The ARNs of network load balancers of the VPC targeted by the VPC link. The network load balancers must be owned by the same AWS account of the API owner.