| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.APIGateway.Types
Contents
- Service Configuration
- Errors
- ApiKeySourceType
- ApiKeysFormat
- AuthorizerType
- CacheClusterSize
- CacheClusterStatus
- ConnectionType
- ContentHandlingStrategy
- DocumentationPartType
- DomainNameStatus
- EndpointType
- GatewayResponseType
- IntegrationType
- LocationStatusType
- Op
- PutMode
- QuotaPeriodType
- SecurityPolicy
- UnauthorizedCacheControlHeaderStrategy
- VpcLinkStatus
- AccessLogSettings
- Account
- ApiKey
- ApiStage
- Authorizer
- BasePathMapping
- CanarySettings
- ClientCertificate
- Deployment
- DeploymentCanarySettings
- DocumentationPart
- DocumentationPartLocation
- DocumentationVersion
- DomainName
- EndpointConfiguration
- GatewayResponse
- Integration
- IntegrationResponse
- Method
- MethodResponse
- MethodSetting
- MethodSnapshot
- Model
- MutualTlsAuthentication
- MutualTlsAuthenticationInput
- PatchOperation
- QuotaSettings
- RequestValidator
- Resource
- RestApi
- SdkConfigurationProperty
- SdkType
- Stage
- StageKey
- ThrottleSettings
- TlsConfig
- Usage
- UsagePlan
- UsagePlanKey
- VpcLink
Description
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _ServiceUnavailableException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- newtype ApiKeySourceType where
- ApiKeySourceType' { }
- pattern ApiKeySourceType_AUTHORIZER :: ApiKeySourceType
- pattern ApiKeySourceType_HEADER :: ApiKeySourceType
- newtype ApiKeysFormat where
- ApiKeysFormat' { }
- pattern ApiKeysFormat_Csv :: ApiKeysFormat
- newtype AuthorizerType where
- AuthorizerType' { }
- pattern AuthorizerType_COGNITO_USER_POOLS :: AuthorizerType
- pattern AuthorizerType_REQUEST :: AuthorizerType
- pattern AuthorizerType_TOKEN :: AuthorizerType
- newtype CacheClusterSize where
- CacheClusterSize' { }
- pattern CacheClusterSize_ :: CacheClusterSize
- newtype CacheClusterStatus where
- CacheClusterStatus' { }
- pattern CacheClusterStatus_AVAILABLE :: CacheClusterStatus
- pattern CacheClusterStatus_CREATE_IN_PROGRESS :: CacheClusterStatus
- pattern CacheClusterStatus_DELETE_IN_PROGRESS :: CacheClusterStatus
- pattern CacheClusterStatus_FLUSH_IN_PROGRESS :: CacheClusterStatus
- pattern CacheClusterStatus_NOT_AVAILABLE :: CacheClusterStatus
- newtype ConnectionType where
- ConnectionType' { }
- pattern ConnectionType_INTERNET :: ConnectionType
- pattern ConnectionType_VPC_LINK :: ConnectionType
- newtype ContentHandlingStrategy where
- newtype DocumentationPartType where
- DocumentationPartType' { }
- pattern DocumentationPartType_API :: DocumentationPartType
- pattern DocumentationPartType_AUTHORIZER :: DocumentationPartType
- pattern DocumentationPartType_METHOD :: DocumentationPartType
- pattern DocumentationPartType_MODEL :: DocumentationPartType
- pattern DocumentationPartType_PATH_PARAMETER :: DocumentationPartType
- pattern DocumentationPartType_QUERY_PARAMETER :: DocumentationPartType
- pattern DocumentationPartType_REQUEST_BODY :: DocumentationPartType
- pattern DocumentationPartType_REQUEST_HEADER :: DocumentationPartType
- pattern DocumentationPartType_RESOURCE :: DocumentationPartType
- pattern DocumentationPartType_RESPONSE :: DocumentationPartType
- pattern DocumentationPartType_RESPONSE_BODY :: DocumentationPartType
- pattern DocumentationPartType_RESPONSE_HEADER :: DocumentationPartType
- newtype DomainNameStatus where
- DomainNameStatus' { }
- pattern DomainNameStatus_AVAILABLE :: DomainNameStatus
- pattern DomainNameStatus_PENDING :: DomainNameStatus
- pattern DomainNameStatus_PENDING_CERTIFICATE_REIMPORT :: DomainNameStatus
- pattern DomainNameStatus_PENDING_OWNERSHIP_VERIFICATION :: DomainNameStatus
- pattern DomainNameStatus_UPDATING :: DomainNameStatus
- newtype EndpointType where
- EndpointType' { }
- pattern EndpointType_EDGE :: EndpointType
- pattern EndpointType_PRIVATE :: EndpointType
- pattern EndpointType_REGIONAL :: EndpointType
- newtype GatewayResponseType where
- GatewayResponseType' { }
- pattern GatewayResponseType_ACCESS_DENIED :: GatewayResponseType
- pattern GatewayResponseType_API_CONFIGURATION_ERROR :: GatewayResponseType
- pattern GatewayResponseType_AUTHORIZER_CONFIGURATION_ERROR :: GatewayResponseType
- pattern GatewayResponseType_AUTHORIZER_FAILURE :: GatewayResponseType
- pattern GatewayResponseType_BAD_REQUEST_BODY :: GatewayResponseType
- pattern GatewayResponseType_BAD_REQUEST_PARAMETERS :: GatewayResponseType
- pattern GatewayResponseType_DEFAULT_4XX :: GatewayResponseType
- pattern GatewayResponseType_DEFAULT_5XX :: GatewayResponseType
- pattern GatewayResponseType_EXPIRED_TOKEN :: GatewayResponseType
- pattern GatewayResponseType_INTEGRATION_FAILURE :: GatewayResponseType
- pattern GatewayResponseType_INTEGRATION_TIMEOUT :: GatewayResponseType
- pattern GatewayResponseType_INVALID_API_KEY :: GatewayResponseType
- pattern GatewayResponseType_INVALID_SIGNATURE :: GatewayResponseType
- pattern GatewayResponseType_MISSING_AUTHENTICATION_TOKEN :: GatewayResponseType
- pattern GatewayResponseType_QUOTA_EXCEEDED :: GatewayResponseType
- pattern GatewayResponseType_REQUEST_TOO_LARGE :: GatewayResponseType
- pattern GatewayResponseType_RESOURCE_NOT_FOUND :: GatewayResponseType
- pattern GatewayResponseType_THROTTLED :: GatewayResponseType
- pattern GatewayResponseType_UNAUTHORIZED :: GatewayResponseType
- pattern GatewayResponseType_UNSUPPORTED_MEDIA_TYPE :: GatewayResponseType
- pattern GatewayResponseType_WAF_FILTERED :: GatewayResponseType
- newtype IntegrationType where
- IntegrationType' { }
- pattern IntegrationType_AWS :: IntegrationType
- pattern IntegrationType_AWS_PROXY :: IntegrationType
- pattern IntegrationType_HTTP :: IntegrationType
- pattern IntegrationType_HTTP_PROXY :: IntegrationType
- pattern IntegrationType_MOCK :: IntegrationType
- newtype LocationStatusType where
- newtype Op where
- newtype PutMode where
- PutMode' {
- fromPutMode :: Text
- pattern PutMode_Merge :: PutMode
- pattern PutMode_Overwrite :: PutMode
- PutMode' {
- newtype QuotaPeriodType where
- QuotaPeriodType' { }
- pattern QuotaPeriodType_DAY :: QuotaPeriodType
- pattern QuotaPeriodType_MONTH :: QuotaPeriodType
- pattern QuotaPeriodType_WEEK :: QuotaPeriodType
- newtype SecurityPolicy where
- SecurityPolicy' { }
- pattern SecurityPolicy_TLS_1_0 :: SecurityPolicy
- pattern SecurityPolicy_TLS_1_2 :: SecurityPolicy
- newtype UnauthorizedCacheControlHeaderStrategy where
- UnauthorizedCacheControlHeaderStrategy' { }
- pattern UnauthorizedCacheControlHeaderStrategy_FAIL_WITH_403 :: UnauthorizedCacheControlHeaderStrategy
- pattern UnauthorizedCacheControlHeaderStrategy_SUCCEED_WITHOUT_RESPONSE_HEADER :: UnauthorizedCacheControlHeaderStrategy
- pattern UnauthorizedCacheControlHeaderStrategy_SUCCEED_WITH_RESPONSE_HEADER :: UnauthorizedCacheControlHeaderStrategy
- newtype VpcLinkStatus where
- VpcLinkStatus' { }
- pattern VpcLinkStatus_AVAILABLE :: VpcLinkStatus
- pattern VpcLinkStatus_DELETING :: VpcLinkStatus
- pattern VpcLinkStatus_FAILED :: VpcLinkStatus
- pattern VpcLinkStatus_PENDING :: VpcLinkStatus
- data AccessLogSettings = AccessLogSettings' {}
- newAccessLogSettings :: AccessLogSettings
- accessLogSettings_destinationArn :: Lens' AccessLogSettings (Maybe Text)
- accessLogSettings_format :: Lens' AccessLogSettings (Maybe Text)
- data Account = Account' {}
- newAccount :: Account
- account_apiKeyVersion :: Lens' Account (Maybe Text)
- account_cloudwatchRoleArn :: Lens' Account (Maybe Text)
- account_features :: Lens' Account (Maybe [Text])
- account_throttleSettings :: Lens' Account (Maybe ThrottleSettings)
- data ApiKey = ApiKey' {}
- newApiKey :: ApiKey
- apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime)
- apiKey_customerId :: Lens' ApiKey (Maybe Text)
- apiKey_description :: Lens' ApiKey (Maybe Text)
- apiKey_enabled :: Lens' ApiKey (Maybe Bool)
- apiKey_id :: Lens' ApiKey (Maybe Text)
- apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime)
- apiKey_name :: Lens' ApiKey (Maybe Text)
- apiKey_stageKeys :: Lens' ApiKey (Maybe [Text])
- apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text))
- apiKey_value :: Lens' ApiKey (Maybe Text)
- data ApiStage = ApiStage' {}
- newApiStage :: ApiStage
- apiStage_apiId :: Lens' ApiStage (Maybe Text)
- apiStage_stage :: Lens' ApiStage (Maybe Text)
- apiStage_throttle :: Lens' ApiStage (Maybe (HashMap Text ThrottleSettings))
- data Authorizer = Authorizer' {}
- newAuthorizer :: Authorizer
- authorizer_authType :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerCredentials :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int)
- authorizer_authorizerUri :: Lens' Authorizer (Maybe Text)
- authorizer_id :: Lens' Authorizer (Maybe Text)
- authorizer_identitySource :: Lens' Authorizer (Maybe Text)
- authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text)
- authorizer_name :: Lens' Authorizer (Maybe Text)
- authorizer_providerARNs :: Lens' Authorizer (Maybe [Text])
- authorizer_type :: Lens' Authorizer (Maybe AuthorizerType)
- data BasePathMapping = BasePathMapping' {}
- newBasePathMapping :: BasePathMapping
- basePathMapping_basePath :: Lens' BasePathMapping (Maybe Text)
- basePathMapping_restApiId :: Lens' BasePathMapping (Maybe Text)
- basePathMapping_stage :: Lens' BasePathMapping (Maybe Text)
- data CanarySettings = CanarySettings' {}
- newCanarySettings :: CanarySettings
- canarySettings_deploymentId :: Lens' CanarySettings (Maybe Text)
- canarySettings_percentTraffic :: Lens' CanarySettings (Maybe Double)
- canarySettings_stageVariableOverrides :: Lens' CanarySettings (Maybe (HashMap Text Text))
- canarySettings_useStageCache :: Lens' CanarySettings (Maybe Bool)
- data ClientCertificate = ClientCertificate' {}
- newClientCertificate :: ClientCertificate
- clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text)
- clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime)
- clientCertificate_description :: Lens' ClientCertificate (Maybe Text)
- clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime)
- clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text)
- clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text))
- data Deployment = Deployment' {
- apiSummary :: Maybe (HashMap Text (HashMap Text MethodSnapshot))
- createdDate :: Maybe POSIX
- description :: Maybe Text
- id :: Maybe Text
- newDeployment :: Deployment
- deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot)))
- deployment_createdDate :: Lens' Deployment (Maybe UTCTime)
- deployment_description :: Lens' Deployment (Maybe Text)
- deployment_id :: Lens' Deployment (Maybe Text)
- data DeploymentCanarySettings = DeploymentCanarySettings' {}
- newDeploymentCanarySettings :: DeploymentCanarySettings
- deploymentCanarySettings_percentTraffic :: Lens' DeploymentCanarySettings (Maybe Double)
- deploymentCanarySettings_stageVariableOverrides :: Lens' DeploymentCanarySettings (Maybe (HashMap Text Text))
- deploymentCanarySettings_useStageCache :: Lens' DeploymentCanarySettings (Maybe Bool)
- data DocumentationPart = DocumentationPart' {}
- newDocumentationPart :: DocumentationPart
- documentationPart_id :: Lens' DocumentationPart (Maybe Text)
- documentationPart_location :: Lens' DocumentationPart (Maybe DocumentationPartLocation)
- documentationPart_properties :: Lens' DocumentationPart (Maybe Text)
- data DocumentationPartLocation = DocumentationPartLocation' {}
- newDocumentationPartLocation :: DocumentationPartType -> DocumentationPartLocation
- documentationPartLocation_method :: Lens' DocumentationPartLocation (Maybe Text)
- documentationPartLocation_name :: Lens' DocumentationPartLocation (Maybe Text)
- documentationPartLocation_path :: Lens' DocumentationPartLocation (Maybe Text)
- documentationPartLocation_statusCode :: Lens' DocumentationPartLocation (Maybe Text)
- documentationPartLocation_type :: Lens' DocumentationPartLocation DocumentationPartType
- data DocumentationVersion = DocumentationVersion' {
- createdDate :: Maybe POSIX
- description :: Maybe Text
- version :: Maybe Text
- newDocumentationVersion :: DocumentationVersion
- documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime)
- documentationVersion_description :: Lens' DocumentationVersion (Maybe Text)
- documentationVersion_version :: Lens' DocumentationVersion (Maybe Text)
- data DomainName = DomainName' {
- certificateArn :: Maybe Text
- certificateName :: Maybe Text
- certificateUploadDate :: Maybe POSIX
- distributionDomainName :: Maybe Text
- distributionHostedZoneId :: Maybe Text
- domainName :: Maybe Text
- domainNameStatus :: Maybe DomainNameStatus
- domainNameStatusMessage :: Maybe Text
- endpointConfiguration :: Maybe EndpointConfiguration
- mutualTlsAuthentication :: Maybe MutualTlsAuthentication
- ownershipVerificationCertificateArn :: Maybe Text
- regionalCertificateArn :: Maybe Text
- regionalCertificateName :: Maybe Text
- regionalDomainName :: Maybe Text
- regionalHostedZoneId :: Maybe Text
- securityPolicy :: Maybe SecurityPolicy
- tags :: Maybe (HashMap Text Text)
- newDomainName :: DomainName
- domainName_certificateArn :: Lens' DomainName (Maybe Text)
- domainName_certificateName :: Lens' DomainName (Maybe Text)
- domainName_certificateUploadDate :: Lens' DomainName (Maybe UTCTime)
- domainName_distributionDomainName :: Lens' DomainName (Maybe Text)
- domainName_distributionHostedZoneId :: Lens' DomainName (Maybe Text)
- domainName_domainName :: Lens' DomainName (Maybe Text)
- domainName_domainNameStatus :: Lens' DomainName (Maybe DomainNameStatus)
- domainName_domainNameStatusMessage :: Lens' DomainName (Maybe Text)
- domainName_endpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration)
- domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication)
- domainName_ownershipVerificationCertificateArn :: Lens' DomainName (Maybe Text)
- domainName_regionalCertificateArn :: Lens' DomainName (Maybe Text)
- domainName_regionalCertificateName :: Lens' DomainName (Maybe Text)
- domainName_regionalDomainName :: Lens' DomainName (Maybe Text)
- domainName_regionalHostedZoneId :: Lens' DomainName (Maybe Text)
- domainName_securityPolicy :: Lens' DomainName (Maybe SecurityPolicy)
- domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text))
- data EndpointConfiguration = EndpointConfiguration' {
- types :: Maybe [EndpointType]
- vpcEndpointIds :: Maybe [Text]
- newEndpointConfiguration :: EndpointConfiguration
- endpointConfiguration_types :: Lens' EndpointConfiguration (Maybe [EndpointType])
- endpointConfiguration_vpcEndpointIds :: Lens' EndpointConfiguration (Maybe [Text])
- data GatewayResponse = GatewayResponse' {}
- newGatewayResponse :: GatewayResponse
- gatewayResponse_defaultResponse :: Lens' GatewayResponse (Maybe Bool)
- gatewayResponse_responseParameters :: Lens' GatewayResponse (Maybe (HashMap Text Text))
- gatewayResponse_responseTemplates :: Lens' GatewayResponse (Maybe (HashMap Text Text))
- gatewayResponse_responseType :: Lens' GatewayResponse (Maybe GatewayResponseType)
- gatewayResponse_statusCode :: Lens' GatewayResponse (Maybe Text)
- data Integration = Integration' {
- cacheKeyParameters :: Maybe [Text]
- cacheNamespace :: Maybe Text
- connectionId :: Maybe Text
- connectionType :: Maybe ConnectionType
- contentHandling :: Maybe ContentHandlingStrategy
- credentials :: Maybe Text
- httpMethod :: Maybe Text
- integrationResponses :: Maybe (HashMap Text IntegrationResponse)
- passthroughBehavior :: Maybe Text
- requestParameters :: Maybe (HashMap Text Text)
- requestTemplates :: Maybe (HashMap Text Text)
- timeoutInMillis :: Maybe Int
- tlsConfig :: Maybe TlsConfig
- type' :: Maybe IntegrationType
- uri :: Maybe Text
- newIntegration :: Integration
- integration_cacheKeyParameters :: Lens' Integration (Maybe [Text])
- integration_cacheNamespace :: Lens' Integration (Maybe Text)
- integration_connectionId :: Lens' Integration (Maybe Text)
- integration_connectionType :: Lens' Integration (Maybe ConnectionType)
- integration_contentHandling :: Lens' Integration (Maybe ContentHandlingStrategy)
- integration_credentials :: Lens' Integration (Maybe Text)
- integration_httpMethod :: Lens' Integration (Maybe Text)
- integration_integrationResponses :: Lens' Integration (Maybe (HashMap Text IntegrationResponse))
- integration_passthroughBehavior :: Lens' Integration (Maybe Text)
- integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text))
- integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text))
- integration_timeoutInMillis :: Lens' Integration (Maybe Int)
- integration_tlsConfig :: Lens' Integration (Maybe TlsConfig)
- integration_type :: Lens' Integration (Maybe IntegrationType)
- integration_uri :: Lens' Integration (Maybe Text)
- data IntegrationResponse = IntegrationResponse' {}
- newIntegrationResponse :: IntegrationResponse
- integrationResponse_contentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy)
- integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text))
- integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text))
- integrationResponse_selectionPattern :: Lens' IntegrationResponse (Maybe Text)
- integrationResponse_statusCode :: Lens' IntegrationResponse (Maybe Text)
- data Method = Method' {
- apiKeyRequired :: Maybe Bool
- authorizationScopes :: Maybe [Text]
- authorizationType :: Maybe Text
- authorizerId :: Maybe Text
- httpMethod :: Maybe Text
- methodIntegration :: Maybe Integration
- methodResponses :: Maybe (HashMap Text MethodResponse)
- operationName :: Maybe Text
- requestModels :: Maybe (HashMap Text Text)
- requestParameters :: Maybe (HashMap Text Bool)
- requestValidatorId :: Maybe Text
- newMethod :: Method
- method_apiKeyRequired :: Lens' Method (Maybe Bool)
- method_authorizationScopes :: Lens' Method (Maybe [Text])
- method_authorizationType :: Lens' Method (Maybe Text)
- method_authorizerId :: Lens' Method (Maybe Text)
- method_httpMethod :: Lens' Method (Maybe Text)
- method_methodIntegration :: Lens' Method (Maybe Integration)
- method_methodResponses :: Lens' Method (Maybe (HashMap Text MethodResponse))
- method_operationName :: Lens' Method (Maybe Text)
- method_requestModels :: Lens' Method (Maybe (HashMap Text Text))
- method_requestParameters :: Lens' Method (Maybe (HashMap Text Bool))
- method_requestValidatorId :: Lens' Method (Maybe Text)
- data MethodResponse = MethodResponse' {
- responseModels :: Maybe (HashMap Text Text)
- responseParameters :: Maybe (HashMap Text Bool)
- statusCode :: Maybe Text
- newMethodResponse :: MethodResponse
- methodResponse_responseModels :: Lens' MethodResponse (Maybe (HashMap Text Text))
- methodResponse_responseParameters :: Lens' MethodResponse (Maybe (HashMap Text Bool))
- methodResponse_statusCode :: Lens' MethodResponse (Maybe Text)
- data MethodSetting = MethodSetting' {
- cacheDataEncrypted :: Maybe Bool
- cacheTtlInSeconds :: Maybe Int
- cachingEnabled :: Maybe Bool
- dataTraceEnabled :: Maybe Bool
- loggingLevel :: Maybe Text
- metricsEnabled :: Maybe Bool
- requireAuthorizationForCacheControl :: Maybe Bool
- throttlingBurstLimit :: Maybe Int
- throttlingRateLimit :: Maybe Double
- unauthorizedCacheControlHeaderStrategy :: Maybe UnauthorizedCacheControlHeaderStrategy
- newMethodSetting :: MethodSetting
- methodSetting_cacheDataEncrypted :: Lens' MethodSetting (Maybe Bool)
- methodSetting_cacheTtlInSeconds :: Lens' MethodSetting (Maybe Int)
- methodSetting_cachingEnabled :: Lens' MethodSetting (Maybe Bool)
- methodSetting_dataTraceEnabled :: Lens' MethodSetting (Maybe Bool)
- methodSetting_loggingLevel :: Lens' MethodSetting (Maybe Text)
- methodSetting_metricsEnabled :: Lens' MethodSetting (Maybe Bool)
- methodSetting_requireAuthorizationForCacheControl :: Lens' MethodSetting (Maybe Bool)
- methodSetting_throttlingBurstLimit :: Lens' MethodSetting (Maybe Int)
- methodSetting_throttlingRateLimit :: Lens' MethodSetting (Maybe Double)
- methodSetting_unauthorizedCacheControlHeaderStrategy :: Lens' MethodSetting (Maybe UnauthorizedCacheControlHeaderStrategy)
- data MethodSnapshot = MethodSnapshot' {}
- newMethodSnapshot :: MethodSnapshot
- methodSnapshot_apiKeyRequired :: Lens' MethodSnapshot (Maybe Bool)
- methodSnapshot_authorizationType :: Lens' MethodSnapshot (Maybe Text)
- data Model = Model' {}
- newModel :: Model
- model_contentType :: Lens' Model (Maybe Text)
- model_description :: Lens' Model (Maybe Text)
- model_id :: Lens' Model (Maybe Text)
- model_name :: Lens' Model (Maybe Text)
- model_schema :: Lens' Model (Maybe Text)
- data MutualTlsAuthentication = MutualTlsAuthentication' {}
- newMutualTlsAuthentication :: MutualTlsAuthentication
- mutualTlsAuthentication_truststoreUri :: Lens' MutualTlsAuthentication (Maybe Text)
- mutualTlsAuthentication_truststoreVersion :: Lens' MutualTlsAuthentication (Maybe Text)
- mutualTlsAuthentication_truststoreWarnings :: Lens' MutualTlsAuthentication (Maybe [Text])
- data MutualTlsAuthenticationInput = MutualTlsAuthenticationInput' {}
- newMutualTlsAuthenticationInput :: MutualTlsAuthenticationInput
- mutualTlsAuthenticationInput_truststoreUri :: Lens' MutualTlsAuthenticationInput (Maybe Text)
- mutualTlsAuthenticationInput_truststoreVersion :: Lens' MutualTlsAuthenticationInput (Maybe Text)
- data PatchOperation = PatchOperation' {}
- newPatchOperation :: PatchOperation
- patchOperation_from :: Lens' PatchOperation (Maybe Text)
- patchOperation_op :: Lens' PatchOperation (Maybe Op)
- patchOperation_path :: Lens' PatchOperation (Maybe Text)
- patchOperation_value :: Lens' PatchOperation (Maybe Text)
- data QuotaSettings = QuotaSettings' {}
- newQuotaSettings :: QuotaSettings
- quotaSettings_limit :: Lens' QuotaSettings (Maybe Int)
- quotaSettings_offset :: Lens' QuotaSettings (Maybe Int)
- quotaSettings_period :: Lens' QuotaSettings (Maybe QuotaPeriodType)
- data RequestValidator = RequestValidator' {}
- newRequestValidator :: RequestValidator
- requestValidator_id :: Lens' RequestValidator (Maybe Text)
- requestValidator_name :: Lens' RequestValidator (Maybe Text)
- requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool)
- requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool)
- data Resource = Resource' {}
- newResource :: Resource
- resource_id :: Lens' Resource (Maybe Text)
- resource_parentId :: Lens' Resource (Maybe Text)
- resource_path :: Lens' Resource (Maybe Text)
- resource_pathPart :: Lens' Resource (Maybe Text)
- resource_resourceMethods :: Lens' Resource (Maybe (HashMap Text Method))
- data RestApi = RestApi' {
- apiKeySource :: Maybe ApiKeySourceType
- binaryMediaTypes :: Maybe [Text]
- createdDate :: Maybe POSIX
- description :: Maybe Text
- disableExecuteApiEndpoint :: Maybe Bool
- endpointConfiguration :: Maybe EndpointConfiguration
- id :: Maybe Text
- minimumCompressionSize :: Maybe Int
- name :: Maybe Text
- policy :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- version :: Maybe Text
- warnings :: Maybe [Text]
- newRestApi :: RestApi
- restApi_apiKeySource :: Lens' RestApi (Maybe ApiKeySourceType)
- restApi_binaryMediaTypes :: Lens' RestApi (Maybe [Text])
- restApi_createdDate :: Lens' RestApi (Maybe UTCTime)
- restApi_description :: Lens' RestApi (Maybe Text)
- restApi_disableExecuteApiEndpoint :: Lens' RestApi (Maybe Bool)
- restApi_endpointConfiguration :: Lens' RestApi (Maybe EndpointConfiguration)
- restApi_id :: Lens' RestApi (Maybe Text)
- restApi_minimumCompressionSize :: Lens' RestApi (Maybe Int)
- restApi_name :: Lens' RestApi (Maybe Text)
- restApi_policy :: Lens' RestApi (Maybe Text)
- restApi_tags :: Lens' RestApi (Maybe (HashMap Text Text))
- restApi_version :: Lens' RestApi (Maybe Text)
- restApi_warnings :: Lens' RestApi (Maybe [Text])
- data SdkConfigurationProperty = SdkConfigurationProperty' {
- defaultValue :: Maybe Text
- description :: Maybe Text
- friendlyName :: Maybe Text
- name :: Maybe Text
- required :: Maybe Bool
- newSdkConfigurationProperty :: SdkConfigurationProperty
- sdkConfigurationProperty_defaultValue :: Lens' SdkConfigurationProperty (Maybe Text)
- sdkConfigurationProperty_description :: Lens' SdkConfigurationProperty (Maybe Text)
- sdkConfigurationProperty_friendlyName :: Lens' SdkConfigurationProperty (Maybe Text)
- sdkConfigurationProperty_name :: Lens' SdkConfigurationProperty (Maybe Text)
- sdkConfigurationProperty_required :: Lens' SdkConfigurationProperty (Maybe Bool)
- data SdkType = SdkType' {}
- newSdkType :: SdkType
- sdkType_configurationProperties :: Lens' SdkType (Maybe [SdkConfigurationProperty])
- sdkType_description :: Lens' SdkType (Maybe Text)
- sdkType_friendlyName :: Lens' SdkType (Maybe Text)
- sdkType_id :: Lens' SdkType (Maybe Text)
- data Stage = Stage' {
- accessLogSettings :: Maybe AccessLogSettings
- cacheClusterEnabled :: Maybe Bool
- cacheClusterSize :: Maybe CacheClusterSize
- cacheClusterStatus :: Maybe CacheClusterStatus
- canarySettings :: Maybe CanarySettings
- clientCertificateId :: Maybe Text
- createdDate :: Maybe POSIX
- deploymentId :: Maybe Text
- description :: Maybe Text
- documentationVersion :: Maybe Text
- lastUpdatedDate :: Maybe POSIX
- methodSettings :: Maybe (HashMap Text MethodSetting)
- stageName :: Maybe Text
- tags :: Maybe (HashMap Text Text)
- tracingEnabled :: Maybe Bool
- variables :: Maybe (HashMap Text Text)
- webAclArn :: Maybe Text
- newStage :: Stage
- stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings)
- stage_cacheClusterEnabled :: Lens' Stage (Maybe Bool)
- stage_cacheClusterSize :: Lens' Stage (Maybe CacheClusterSize)
- stage_cacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus)
- stage_canarySettings :: Lens' Stage (Maybe CanarySettings)
- stage_clientCertificateId :: Lens' Stage (Maybe Text)
- stage_createdDate :: Lens' Stage (Maybe UTCTime)
- stage_deploymentId :: Lens' Stage (Maybe Text)
- stage_description :: Lens' Stage (Maybe Text)
- stage_documentationVersion :: Lens' Stage (Maybe Text)
- stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime)
- stage_methodSettings :: Lens' Stage (Maybe (HashMap Text MethodSetting))
- stage_stageName :: Lens' Stage (Maybe Text)
- stage_tags :: Lens' Stage (Maybe (HashMap Text Text))
- stage_tracingEnabled :: Lens' Stage (Maybe Bool)
- stage_variables :: Lens' Stage (Maybe (HashMap Text Text))
- stage_webAclArn :: Lens' Stage (Maybe Text)
- data StageKey = StageKey' {}
- newStageKey :: StageKey
- stageKey_restApiId :: Lens' StageKey (Maybe Text)
- stageKey_stageName :: Lens' StageKey (Maybe Text)
- data ThrottleSettings = ThrottleSettings' {}
- newThrottleSettings :: ThrottleSettings
- throttleSettings_burstLimit :: Lens' ThrottleSettings (Maybe Int)
- throttleSettings_rateLimit :: Lens' ThrottleSettings (Maybe Double)
- data TlsConfig = TlsConfig' {}
- newTlsConfig :: TlsConfig
- tlsConfig_insecureSkipVerification :: Lens' TlsConfig (Maybe Bool)
- data Usage = Usage' {}
- newUsage :: Usage
- usage_endDate :: Lens' Usage (Maybe Text)
- usage_items :: Lens' Usage (Maybe (HashMap Text [[Integer]]))
- usage_position :: Lens' Usage (Maybe Text)
- usage_startDate :: Lens' Usage (Maybe Text)
- usage_usagePlanId :: Lens' Usage (Maybe Text)
- data UsagePlan = UsagePlan' {}
- newUsagePlan :: UsagePlan
- usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage])
- usagePlan_description :: Lens' UsagePlan (Maybe Text)
- usagePlan_id :: Lens' UsagePlan (Maybe Text)
- usagePlan_name :: Lens' UsagePlan (Maybe Text)
- usagePlan_productCode :: Lens' UsagePlan (Maybe Text)
- usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings)
- usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text))
- usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings)
- data UsagePlanKey = UsagePlanKey' {}
- newUsagePlanKey :: UsagePlanKey
- usagePlanKey_id :: Lens' UsagePlanKey (Maybe Text)
- usagePlanKey_name :: Lens' UsagePlanKey (Maybe Text)
- usagePlanKey_type :: Lens' UsagePlanKey (Maybe Text)
- usagePlanKey_value :: Lens' UsagePlanKey (Maybe Text)
- data VpcLink = VpcLink' {}
- newVpcLink :: VpcLink
- vpcLink_description :: Lens' VpcLink (Maybe Text)
- vpcLink_id :: Lens' VpcLink (Maybe Text)
- vpcLink_name :: Lens' VpcLink (Maybe Text)
- vpcLink_status :: Lens' VpcLink (Maybe VpcLinkStatus)
- vpcLink_statusMessage :: Lens' VpcLink (Maybe Text)
- vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text))
- vpcLink_targetArns :: Lens' VpcLink (Maybe [Text])
Service Configuration
defaultService :: Service Source #
API version 2015-07-09 of the Amazon API Gateway SDK configuration.
Errors
_BadRequestException :: AsError a => Fold a ServiceError Source #
The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
_ConflictException :: AsError a => Fold a ServiceError Source #
The request configuration has conflicts. For details, see the accompanying error message.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
The request exceeded the rate limit. Retry after the specified time period.
_NotFoundException :: AsError a => Fold a ServiceError Source #
The requested resource is not found. Make sure that the request URI is correct.
_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #
The requested service is not available. For details see the accompanying error message. Retry after the specified time period.
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
The request has reached its throttling limit. Retry after the specified time period.
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
The request is denied because the caller has insufficient permissions.
ApiKeySourceType
newtype ApiKeySourceType Source #
Constructors
| ApiKeySourceType' | |
Fields | |
Bundled Patterns
| pattern ApiKeySourceType_AUTHORIZER :: ApiKeySourceType | |
| pattern ApiKeySourceType_HEADER :: ApiKeySourceType |
Instances
ApiKeysFormat
newtype ApiKeysFormat Source #
Constructors
| ApiKeysFormat' | |
Fields | |
Bundled Patterns
| pattern ApiKeysFormat_Csv :: ApiKeysFormat |
Instances
AuthorizerType
newtype AuthorizerType Source #
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.
Constructors
| AuthorizerType' | |
Fields | |
Bundled Patterns
| pattern AuthorizerType_COGNITO_USER_POOLS :: AuthorizerType | |
| pattern AuthorizerType_REQUEST :: AuthorizerType | |
| pattern AuthorizerType_TOKEN :: AuthorizerType |
Instances
CacheClusterSize
newtype CacheClusterSize Source #
Returns the size of the CacheCluster.
Constructors
| CacheClusterSize' | |
Fields | |
Bundled Patterns
| pattern CacheClusterSize_ :: CacheClusterSize |
Instances
CacheClusterStatus
newtype CacheClusterStatus Source #
Returns the status of the CacheCluster.
Constructors
| CacheClusterStatus' | |
Fields | |
Bundled Patterns
Instances
ConnectionType
newtype ConnectionType Source #
Constructors
| ConnectionType' | |
Fields | |
Bundled Patterns
| pattern ConnectionType_INTERNET :: ConnectionType | |
| pattern ConnectionType_VPC_LINK :: ConnectionType |
Instances
ContentHandlingStrategy
newtype ContentHandlingStrategy Source #
Constructors
| ContentHandlingStrategy' | |
Fields | |
Bundled Patterns
| pattern ContentHandlingStrategy_CONVERT_TO_BINARY :: ContentHandlingStrategy | |
| pattern ContentHandlingStrategy_CONVERT_TO_TEXT :: ContentHandlingStrategy |
Instances
DocumentationPartType
newtype DocumentationPartType Source #
Constructors
| DocumentationPartType' | |
Fields | |
Bundled Patterns
Instances
DomainNameStatus
newtype DomainNameStatus Source #
Constructors
| DomainNameStatus' | |
Fields | |
Bundled Patterns
| pattern DomainNameStatus_AVAILABLE :: DomainNameStatus | |
| pattern DomainNameStatus_PENDING :: DomainNameStatus | |
| pattern DomainNameStatus_PENDING_CERTIFICATE_REIMPORT :: DomainNameStatus | |
| pattern DomainNameStatus_PENDING_OWNERSHIP_VERIFICATION :: DomainNameStatus | |
| pattern DomainNameStatus_UPDATING :: DomainNameStatus |
Instances
EndpointType
newtype EndpointType Source #
The endpoint type. The valid values are EDGE for edge-optimized API
setup, most suitable for mobile applications; REGIONAL for regional
API endpoint setup, most suitable for calling from AWS Region; and
PRIVATE for private APIs.
Constructors
| EndpointType' | |
Fields | |
Bundled Patterns
| pattern EndpointType_EDGE :: EndpointType | |
| pattern EndpointType_PRIVATE :: EndpointType | |
| pattern EndpointType_REGIONAL :: EndpointType |
Instances
GatewayResponseType
newtype GatewayResponseType Source #
Constructors
| GatewayResponseType' | |
Fields | |
Bundled Patterns
Instances
IntegrationType
newtype IntegrationType Source #
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.
Constructors
| IntegrationType' | |
Fields | |
Bundled Patterns
| pattern IntegrationType_AWS :: IntegrationType | |
| pattern IntegrationType_AWS_PROXY :: IntegrationType | |
| pattern IntegrationType_HTTP :: IntegrationType | |
| pattern IntegrationType_HTTP_PROXY :: IntegrationType | |
| pattern IntegrationType_MOCK :: IntegrationType |
Instances
LocationStatusType
newtype LocationStatusType Source #
Constructors
| LocationStatusType' | |
Fields | |
Bundled Patterns
| pattern LocationStatusType_DOCUMENTED :: LocationStatusType | |
| pattern LocationStatusType_UNDOCUMENTED :: LocationStatusType |
Instances
Op
Bundled Patterns
| pattern Op_Add :: Op | |
| pattern Op_Copy :: Op | |
| pattern Op_Move :: Op | |
| pattern Op_Remove :: Op | |
| pattern Op_Replace :: Op | |
| pattern Op_Test :: Op |
Instances
PutMode
Constructors
| PutMode' | |
Fields
| |
Bundled Patterns
| pattern PutMode_Merge :: PutMode | |
| pattern PutMode_Overwrite :: PutMode |
Instances
QuotaPeriodType
newtype QuotaPeriodType Source #
Constructors
| QuotaPeriodType' | |
Fields | |
Bundled Patterns
| pattern QuotaPeriodType_DAY :: QuotaPeriodType | |
| pattern QuotaPeriodType_MONTH :: QuotaPeriodType | |
| pattern QuotaPeriodType_WEEK :: QuotaPeriodType |
Instances
SecurityPolicy
newtype SecurityPolicy Source #
Constructors
| SecurityPolicy' | |
Fields | |
Bundled Patterns
| pattern SecurityPolicy_TLS_1_0 :: SecurityPolicy | |
| pattern SecurityPolicy_TLS_1_2 :: SecurityPolicy |
Instances
UnauthorizedCacheControlHeaderStrategy
newtype UnauthorizedCacheControlHeaderStrategy Source #
Constructors
| UnauthorizedCacheControlHeaderStrategy' | |
Bundled Patterns
Instances
VpcLinkStatus
newtype VpcLinkStatus Source #
Constructors
| VpcLinkStatus' | |
Fields | |
Bundled Patterns
| pattern VpcLinkStatus_AVAILABLE :: VpcLinkStatus | |
| pattern VpcLinkStatus_DELETING :: VpcLinkStatus | |
| pattern VpcLinkStatus_FAILED :: VpcLinkStatus | |
| pattern VpcLinkStatus_PENDING :: VpcLinkStatus |
Instances
AccessLogSettings
data AccessLogSettings Source #
Access log settings, including the access log format and access log destination ARN.
See: newAccessLogSettings smart constructor.
Constructors
| AccessLogSettings' | |
Fields
| |
Instances
newAccessLogSettings :: AccessLogSettings Source #
Create a value of AccessLogSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:destinationArn:AccessLogSettings', accessLogSettings_destinationArn - The Amazon Resource Name (ARN) of the CloudWatch Logs log group or
Kinesis Data Firehose delivery stream to receive access logs. If you
specify a Kinesis Data Firehose delivery stream, the stream name must
begin with amazon-apigateway-.
$sel:format:AccessLogSettings', accessLogSettings_format - A single line format of the access logs of data, as specified by
selected $context variables. The format must include at least
$context.requestId.
accessLogSettings_destinationArn :: Lens' AccessLogSettings (Maybe Text) Source #
The Amazon Resource Name (ARN) of the CloudWatch Logs log group or
Kinesis Data Firehose delivery stream to receive access logs. If you
specify a Kinesis Data Firehose delivery stream, the stream name must
begin with amazon-apigateway-.
accessLogSettings_format :: Lens' AccessLogSettings (Maybe Text) Source #
A single line format of the access logs of data, as specified by
selected $context variables. The format must include at least
$context.requestId.
Account
Represents an AWS account that is associated with API Gateway.
See: newAccount smart constructor.
Constructors
| Account' | |
Fields
| |
Instances
| FromJSON Account Source # | |
| Generic Account Source # | |
| Read Account Source # | |
| Show Account Source # | |
| NFData Account Source # | |
Defined in Amazonka.APIGateway.Types.Account | |
| Eq Account Source # | |
| Hashable Account Source # | |
Defined in Amazonka.APIGateway.Types.Account | |
| type Rep Account Source # | |
Defined in Amazonka.APIGateway.Types.Account type Rep Account = D1 ('MetaData "Account" "Amazonka.APIGateway.Types.Account" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Account'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiKeyVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "cloudwatchRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "features") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "throttleSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings))))) | |
newAccount :: Account Source #
Create a value of Account with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiKeyVersion:Account', account_apiKeyVersion - The version of the API keys used for the account.
$sel:cloudwatchRoleArn:Account', account_cloudwatchRoleArn - The ARN of an Amazon CloudWatch role for the current Account.
$sel:features:Account', account_features - A list of features supported for the account. When usage plans are
enabled, the features list will include an entry of "UsagePlans".
$sel:throttleSettings:Account', account_throttleSettings - Specifies the API request limits configured for the current Account.
account_apiKeyVersion :: Lens' Account (Maybe Text) Source #
The version of the API keys used for the account.
account_cloudwatchRoleArn :: Lens' Account (Maybe Text) Source #
The ARN of an Amazon CloudWatch role for the current Account.
account_features :: Lens' Account (Maybe [Text]) Source #
A list of features supported for the account. When usage plans are
enabled, the features list will include an entry of "UsagePlans".
account_throttleSettings :: Lens' Account (Maybe ThrottleSettings) Source #
Specifies the API request limits configured for the current Account.
ApiKey
A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.
See: newApiKey smart constructor.
Constructors
| ApiKey' | |
Fields
| |
Instances
Create a value of ApiKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.
$sel:customerId:ApiKey', apiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS
SaaS Marketplace.
$sel:description:ApiKey', apiKey_description - The description of the API Key.
$sel:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.
$sel:id:ApiKey', apiKey_id - The identifier of the API Key.
$sel:lastUpdatedDate:ApiKey', apiKey_lastUpdatedDate - The timestamp when the API Key was last updated.
$sel:name:ApiKey', apiKey_name - The name of the API Key.
$sel:stageKeys:ApiKey', apiKey_stageKeys - A list of Stage resources that are associated with the ApiKey resource.
$sel:tags:ApiKey', apiKey_tags - The collection of tags. Each tag element is associated with a given
resource.
$sel:value:ApiKey', apiKey_value - The value of the API Key.
apiKey_createdDate :: Lens' ApiKey (Maybe UTCTime) Source #
The timestamp when the API Key was created.
apiKey_customerId :: Lens' ApiKey (Maybe Text) Source #
An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
apiKey_enabled :: Lens' ApiKey (Maybe Bool) Source #
Specifies whether the API Key can be used by callers.
apiKey_lastUpdatedDate :: Lens' ApiKey (Maybe UTCTime) Source #
The timestamp when the API Key was last updated.
apiKey_stageKeys :: Lens' ApiKey (Maybe [Text]) Source #
A list of Stage resources that are associated with the ApiKey resource.
apiKey_tags :: Lens' ApiKey (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
ApiStage
API stage name of the associated API stage in a usage plan.
See: newApiStage smart constructor.
Constructors
| ApiStage' | |
Instances
| FromJSON ApiStage Source # | |
| ToJSON ApiStage Source # | |
Defined in Amazonka.APIGateway.Types.ApiStage | |
| Generic ApiStage Source # | |
| Read ApiStage Source # | |
| Show ApiStage Source # | |
| NFData ApiStage Source # | |
Defined in Amazonka.APIGateway.Types.ApiStage | |
| Eq ApiStage Source # | |
| Hashable ApiStage Source # | |
Defined in Amazonka.APIGateway.Types.ApiStage | |
| type Rep ApiStage Source # | |
Defined in Amazonka.APIGateway.Types.ApiStage type Rep ApiStage = D1 ('MetaData "ApiStage" "Amazonka.APIGateway.Types.ApiStage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ApiStage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ThrottleSettings)))))) | |
newApiStage :: ApiStage Source #
Create a value of ApiStage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiId:ApiStage', apiStage_apiId - API Id of the associated API stage in a usage plan.
$sel:stage:ApiStage', apiStage_stage - API stage name of the associated API stage in a usage plan.
$sel:throttle:ApiStage', apiStage_throttle - Map containing method level throttling information for API stage in a
usage plan.
apiStage_apiId :: Lens' ApiStage (Maybe Text) Source #
API Id of the associated API stage in a usage plan.
apiStage_stage :: Lens' ApiStage (Maybe Text) Source #
API stage name of the associated API stage in a usage plan.
apiStage_throttle :: Lens' ApiStage (Maybe (HashMap Text ThrottleSettings)) Source #
Map containing method level throttling information for API stage in a usage plan.
Authorizer
data Authorizer Source #
Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.
See: newAuthorizer smart constructor.
Constructors
| Authorizer' | |
Fields
| |
Instances
newAuthorizer :: Authorizer Source #
Create a value of Authorizer with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:authType:Authorizer', authorizer_authType - Optional customer-defined field, used in OpenAPI imports and exports
without functional impact.
$sel:authorizerCredentials:Authorizer', authorizer_authorizerCredentials - 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.
$sel:authorizerResultTtlInSeconds:Authorizer', authorizer_authorizerResultTtlInSeconds - 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.
$sel:authorizerUri:Authorizer', authorizer_authorizerUri - 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:path/2015-03-31/functions/arn: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-31/functions/[FunctionARN]/invocations.
$sel:id:Authorizer', authorizer_id - The identifier for the authorizer resource.
$sel:identitySource:Authorizer', authorizer_identitySource - 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.
$sel:identityValidationExpression:Authorizer', authorizer_identityValidationExpression - A validation expression for the incoming identity token. For TOKEN
authorizers, this value is a regular expression. For
COGNITO_USER_POOLS authorizers, 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.
$sel:name:Authorizer', authorizer_name - The name of the authorizer.
$sel:providerARNs:Authorizer', authorizer_providerARNs - 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.
$sel:type':Authorizer', authorizer_type - 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.
authorizer_authType :: Lens' Authorizer (Maybe Text) Source #
Optional customer-defined field, used in OpenAPI imports and exports without functional impact.
authorizer_authorizerCredentials :: Lens' Authorizer (Maybe Text) Source #
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.
authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) Source #
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.
authorizer_authorizerUri :: Lens' Authorizer (Maybe Text) Source #
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:path/2015-03-31/functions/arn: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-31/functions/[FunctionARN]/invocations.
authorizer_id :: Lens' Authorizer (Maybe Text) Source #
The identifier for the authorizer resource.
authorizer_identitySource :: Lens' Authorizer (Maybe Text) Source #
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.
authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text) Source #
A validation expression for the incoming identity token. For TOKEN
authorizers, this value is a regular expression. For
COGNITO_USER_POOLS authorizers, 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.
authorizer_name :: Lens' Authorizer (Maybe Text) Source #
The name of the authorizer.
authorizer_providerARNs :: Lens' Authorizer (Maybe [Text]) Source #
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.
authorizer_type :: Lens' Authorizer (Maybe AuthorizerType) Source #
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.
BasePathMapping
data BasePathMapping Source #
Represents the base path that callers of the API must provide as part of the URL after the domain name.
See: newBasePathMapping smart constructor.
Constructors
| BasePathMapping' | |
Instances
newBasePathMapping :: BasePathMapping Source #
Create a value of BasePathMapping with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:basePath:BasePathMapping', basePathMapping_basePath - The base path name that callers of the API must provide as part of the
URL after the domain name.
$sel:restApiId:BasePathMapping', basePathMapping_restApiId - The string identifier of the associated RestApi.
$sel:stage:BasePathMapping', basePathMapping_stage - The name of the associated stage.
basePathMapping_basePath :: Lens' BasePathMapping (Maybe Text) Source #
The base path name that callers of the API must provide as part of the URL after the domain name.
basePathMapping_restApiId :: Lens' BasePathMapping (Maybe Text) Source #
The string identifier of the associated RestApi.
basePathMapping_stage :: Lens' BasePathMapping (Maybe Text) Source #
The name of the associated stage.
CanarySettings
data CanarySettings Source #
Configuration settings of a canary deployment.
See: newCanarySettings smart constructor.
Constructors
| CanarySettings' | |
Fields
| |
Instances
newCanarySettings :: CanarySettings Source #
Create a value of CanarySettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deploymentId:CanarySettings', canarySettings_deploymentId - The ID of the canary deployment.
$sel:percentTraffic:CanarySettings', canarySettings_percentTraffic - The percent (0-100) of traffic diverted to a canary deployment.
$sel:stageVariableOverrides:CanarySettings', canarySettings_stageVariableOverrides - 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.
$sel:useStageCache:CanarySettings', canarySettings_useStageCache - A Boolean flag to indicate whether the canary deployment uses the stage
cache or not.
canarySettings_deploymentId :: Lens' CanarySettings (Maybe Text) Source #
The ID of the canary deployment.
canarySettings_percentTraffic :: Lens' CanarySettings (Maybe Double) Source #
The percent (0-100) of traffic diverted to a canary deployment.
canarySettings_stageVariableOverrides :: Lens' CanarySettings (Maybe (HashMap Text Text)) Source #
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.
canarySettings_useStageCache :: Lens' CanarySettings (Maybe Bool) Source #
A Boolean flag to indicate whether the canary deployment uses the stage cache or not.
ClientCertificate
data ClientCertificate Source #
Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.
See: newClientCertificate smart constructor.
Constructors
| ClientCertificate' | |
Fields
| |
Instances
newClientCertificate :: ClientCertificate Source #
Create a value of ClientCertificate with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientCertificateId:ClientCertificate', clientCertificate_clientCertificateId - The identifier of the client certificate.
$sel:createdDate:ClientCertificate', clientCertificate_createdDate - The timestamp when the client certificate was created.
$sel:description:ClientCertificate', clientCertificate_description - The description of the client certificate.
$sel:expirationDate:ClientCertificate', clientCertificate_expirationDate - The timestamp when the client certificate will expire.
$sel:pemEncodedCertificate:ClientCertificate', clientCertificate_pemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used
to configure certificate authentication in the integration endpoint .
$sel:tags:ClientCertificate', clientCertificate_tags - The collection of tags. Each tag element is associated with a given
resource.
clientCertificate_clientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #
The identifier of the client certificate.
clientCertificate_createdDate :: Lens' ClientCertificate (Maybe UTCTime) Source #
The timestamp when the client certificate was created.
clientCertificate_description :: Lens' ClientCertificate (Maybe Text) Source #
The description of the client certificate.
clientCertificate_expirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #
The timestamp when the client certificate will expire.
clientCertificate_pemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) Source #
The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
clientCertificate_tags :: Lens' ClientCertificate (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
Deployment
data Deployment Source #
An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.
See: newDeployment smart constructor.
Constructors
| Deployment' | |
Fields
| |
Instances
newDeployment :: Deployment Source #
Create a value of Deployment with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiSummary:Deployment', deployment_apiSummary - A summary of the RestApi at the date and time that the deployment
resource was created.
$sel:createdDate:Deployment', deployment_createdDate - The date and time that the deployment resource was created.
$sel:description:Deployment', deployment_description - The description for the deployment resource.
$sel:id:Deployment', deployment_id - The identifier for the deployment resource.
deployment_apiSummary :: Lens' Deployment (Maybe (HashMap Text (HashMap Text MethodSnapshot))) Source #
A summary of the RestApi at the date and time that the deployment resource was created.
deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #
The date and time that the deployment resource was created.
deployment_description :: Lens' Deployment (Maybe Text) Source #
The description for the deployment resource.
deployment_id :: Lens' Deployment (Maybe Text) Source #
The identifier for the deployment resource.
DeploymentCanarySettings
data DeploymentCanarySettings Source #
The input configuration for a canary deployment.
See: newDeploymentCanarySettings smart constructor.
Constructors
| DeploymentCanarySettings' | |
Fields
| |
Instances
newDeploymentCanarySettings :: DeploymentCanarySettings Source #
Create a value of DeploymentCanarySettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:percentTraffic:DeploymentCanarySettings', deploymentCanarySettings_percentTraffic - The percentage (0.0-100.0) of traffic routed to the canary deployment.
$sel:stageVariableOverrides:DeploymentCanarySettings', deploymentCanarySettings_stageVariableOverrides - 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.
$sel:useStageCache:DeploymentCanarySettings', deploymentCanarySettings_useStageCache - A Boolean flag to indicate whether the canary release deployment uses
the stage cache or not.
deploymentCanarySettings_percentTraffic :: Lens' DeploymentCanarySettings (Maybe Double) Source #
The percentage (0.0-100.0) of traffic routed to the canary deployment.
deploymentCanarySettings_stageVariableOverrides :: Lens' DeploymentCanarySettings (Maybe (HashMap Text Text)) Source #
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.
deploymentCanarySettings_useStageCache :: Lens' DeploymentCanarySettings (Maybe Bool) Source #
A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.
DocumentationPart
data DocumentationPart Source #
A documentation part for a targeted API entity.
See: newDocumentationPart smart constructor.
Constructors
| DocumentationPart' | |
Fields
| |
Instances
newDocumentationPart :: DocumentationPart Source #
Create a value of DocumentationPart with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:DocumentationPart', documentationPart_id - The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart is created.
$sel:location:DocumentationPart', documentationPart_location - 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.
$sel:properties:DocumentationPart', documentationPart_properties - 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
OpenAPI-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
OpenAPI extension of x-amazon-apigateway-documentation.
documentationPart_id :: Lens' DocumentationPart (Maybe Text) Source #
The DocumentationPart identifier, generated by API Gateway when the
DocumentationPart is created.
documentationPart_location :: Lens' DocumentationPart (Maybe DocumentationPartLocation) Source #
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.
documentationPart_properties :: Lens' DocumentationPart (Maybe Text) Source #
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
OpenAPI-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
OpenAPI extension of x-amazon-apigateway-documentation.
DocumentationPartLocation
data DocumentationPartLocation Source #
Specifies the target API entity to which the documentation applies.
See: newDocumentationPartLocation smart constructor.
Constructors
| DocumentationPartLocation' | |
Fields
| |
Instances
newDocumentationPartLocation Source #
Create a value of DocumentationPartLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:method:DocumentationPartLocation', documentationPartLocation_method - 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.
$sel:name:DocumentationPartLocation', documentationPartLocation_name - 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.
$sel:path:DocumentationPartLocation', documentationPartLocation_path - 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.
$sel:statusCode:DocumentationPartLocation', documentationPartLocation_statusCode - 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.
$sel:type':DocumentationPartLocation', documentationPartLocation_type - 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, and RESPONSE_BODY. Content inheritance
does not apply to any entity of the API, AUTHORIZER, METHOD,
MODEL, REQUEST_BODY, or RESOURCE type.
documentationPartLocation_method :: Lens' DocumentationPartLocation (Maybe Text) Source #
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.
documentationPartLocation_name :: Lens' DocumentationPartLocation (Maybe Text) Source #
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.
documentationPartLocation_path :: Lens' DocumentationPartLocation (Maybe Text) Source #
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.
documentationPartLocation_statusCode :: Lens' DocumentationPartLocation (Maybe Text) Source #
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.
documentationPartLocation_type :: Lens' DocumentationPartLocation DocumentationPartType Source #
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, and RESPONSE_BODY. Content inheritance
does not apply to any entity of the API, AUTHORIZER, METHOD,
MODEL, REQUEST_BODY, or RESOURCE type.
DocumentationVersion
data DocumentationVersion Source #
A snapshot of the documentation of an API.
See: newDocumentationVersion smart constructor.
Constructors
| DocumentationVersion' | |
Fields
| |
Instances
newDocumentationVersion :: DocumentationVersion Source #
Create a value of DocumentationVersion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdDate:DocumentationVersion', documentationVersion_createdDate - The date when the API documentation snapshot is created.
$sel:description:DocumentationVersion', documentationVersion_description - The description of the API documentation snapshot.
$sel:version:DocumentationVersion', documentationVersion_version - The version identifier of the API documentation snapshot.
documentationVersion_createdDate :: Lens' DocumentationVersion (Maybe UTCTime) Source #
The date when the API documentation snapshot is created.
documentationVersion_description :: Lens' DocumentationVersion (Maybe Text) Source #
The description of the API documentation snapshot.
documentationVersion_version :: Lens' DocumentationVersion (Maybe Text) Source #
The version identifier of the API documentation snapshot.
DomainName
data DomainName Source #
Represents a custom domain name as a user-friendly host name of an API (RestApi).
See: newDomainName smart constructor.
Constructors
| DomainName' | |
Fields
| |
Instances
newDomainName :: DomainName Source #
Create a value of DomainName with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificateArn:DomainName', domainName_certificateArn - 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.
$sel:certificateName:DomainName', domainName_certificateName - The name of the certificate that will be used by edge-optimized endpoint
for this domain name.
$sel:certificateUploadDate:DomainName', domainName_certificateUploadDate - The timestamp when the certificate that was used by edge-optimized
endpoint for this domain name was uploaded.
$sel:distributionDomainName:DomainName', domainName_distributionDomainName - 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.
$sel:distributionHostedZoneId:DomainName', domainName_distributionHostedZoneId - 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.
$sel:domainName:DomainName', domainName_domainName - The custom domain name as an API host name, for example,
my-api.example.com.
$sel:domainNameStatus:DomainName', domainName_domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE
and UPDATING. If the status is UPDATING, the domain cannot be
modified further until the existing operation is complete. If it is
AVAILABLE, the domain can be updated.
$sel:domainNameStatusMessage:DomainName', domainName_domainNameStatusMessage - An optional text message containing detailed information about status of
the DomainName migration.
$sel:endpointConfiguration:DomainName', domainName_endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types
of the domain name.
$sel:mutualTlsAuthentication:DomainName', domainName_mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. If
specified, API Gateway performs two-way authentication between the
client and the server. Clients must present a trusted certificate to
access your API.
$sel:ownershipVerificationCertificateArn:DomainName', domainName_ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of
your custom domain. Only required when configuring mutual TLS and using
an ACM imported or private CA certificate ARN as the
regionalCertificateArn.
$sel:regionalCertificateArn:DomainName', domainName_regionalCertificateArn - 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.
$sel:regionalCertificateName:DomainName', domainName_regionalCertificateName - The name of the certificate that will be used for validating the
regional domain name.
$sel:regionalDomainName:DomainName', domainName_regionalDomainName - 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.
$sel:regionalHostedZoneId:DomainName', domainName_regionalHostedZoneId - 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.
$sel:securityPolicy:DomainName', domainName_securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this
DomainName. The valid values are TLS_1_0 and TLS_1_2.
$sel:tags:DomainName', domainName_tags - The collection of tags. Each tag element is associated with a given
resource.
domainName_certificateArn :: Lens' DomainName (Maybe Text) Source #
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.
domainName_certificateName :: Lens' DomainName (Maybe Text) Source #
The name of the certificate that will be used by edge-optimized endpoint for this domain name.
domainName_certificateUploadDate :: Lens' DomainName (Maybe UTCTime) Source #
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
domainName_distributionDomainName :: Lens' DomainName (Maybe Text) Source #
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.
domainName_distributionHostedZoneId :: Lens' DomainName (Maybe Text) Source #
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.
domainName_domainName :: Lens' DomainName (Maybe Text) Source #
The custom domain name as an API host name, for example,
my-api.example.com.
domainName_domainNameStatus :: Lens' DomainName (Maybe DomainNameStatus) Source #
The status of the DomainName migration. The valid values are AVAILABLE
and UPDATING. If the status is UPDATING, the domain cannot be
modified further until the existing operation is complete. If it is
AVAILABLE, the domain can be updated.
domainName_domainNameStatusMessage :: Lens' DomainName (Maybe Text) Source #
An optional text message containing detailed information about status of the DomainName migration.
domainName_endpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration) Source #
The endpoint configuration of this DomainName showing the endpoint types of the domain name.
domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication) Source #
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
domainName_ownershipVerificationCertificateArn :: Lens' DomainName (Maybe Text) Source #
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.
domainName_regionalCertificateArn :: Lens' DomainName (Maybe Text) Source #
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.
domainName_regionalCertificateName :: Lens' DomainName (Maybe Text) Source #
The name of the certificate that will be used for validating the regional domain name.
domainName_regionalDomainName :: Lens' DomainName (Maybe Text) Source #
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.
domainName_regionalHostedZoneId :: Lens' DomainName (Maybe Text) Source #
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.
domainName_securityPolicy :: Lens' DomainName (Maybe SecurityPolicy) Source #
The Transport Layer Security (TLS) version + cipher suite for this
DomainName. The valid values are TLS_1_0 and TLS_1_2.
domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
EndpointConfiguration
data EndpointConfiguration Source #
The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.
See: newEndpointConfiguration smart constructor.
Constructors
| EndpointConfiguration' | |
Fields
| |
Instances
newEndpointConfiguration :: EndpointConfiguration Source #
Create a value of EndpointConfiguration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:types:EndpointConfiguration', endpointConfiguration_types - 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. For a private API, the endpoint
type is PRIVATE.
$sel:vpcEndpointIds:EndpointConfiguration', endpointConfiguration_vpcEndpointIds - A list of VpcEndpointIds of an API (RestApi) against which to create
Route53 ALIASes. It is only supported for PRIVATE endpoint type.
endpointConfiguration_types :: Lens' EndpointConfiguration (Maybe [EndpointType]) Source #
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. For a private API, the endpoint
type is PRIVATE.
endpointConfiguration_vpcEndpointIds :: Lens' EndpointConfiguration (Maybe [Text]) Source #
A list of VpcEndpointIds of an API (RestApi) against which to create
Route53 ALIASes. It is only supported for PRIVATE endpoint type.
GatewayResponse
data GatewayResponse Source #
A gateway response of a given response type and status code, with optional response parameters and mapping templates.
See: newGatewayResponse smart constructor.
Constructors
| GatewayResponse' | |
Fields
| |
Instances
newGatewayResponse :: GatewayResponse Source #
Create a value of GatewayResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultResponse:GatewayResponse', gatewayResponse_defaultResponse - 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.
$sel:responseParameters:GatewayResponse', gatewayResponse_responseParameters - Response parameters (paths, query strings and headers) of the
GatewayResponse as a string-to-string map of key-value pairs.
$sel:responseTemplates:GatewayResponse', gatewayResponse_responseTemplates - Response templates of the GatewayResponse as a string-to-string map of
key-value pairs.
$sel:responseType:GatewayResponse', gatewayResponse_responseType - The response type of the associated GatewayResponse.
$sel:statusCode:GatewayResponse', gatewayResponse_statusCode - The HTTP status code for this GatewayResponse.
gatewayResponse_defaultResponse :: Lens' GatewayResponse (Maybe Bool) Source #
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.
gatewayResponse_responseParameters :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #
Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.
gatewayResponse_responseTemplates :: Lens' GatewayResponse (Maybe (HashMap Text Text)) Source #
Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
gatewayResponse_responseType :: Lens' GatewayResponse (Maybe GatewayResponseType) Source #
The response type of the associated GatewayResponse.
gatewayResponse_statusCode :: Lens' GatewayResponse (Maybe Text) Source #
The HTTP status code for this GatewayResponse.
Integration
data Integration Source #
Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.
See: newIntegration smart constructor.
Constructors
| Integration' | |
Fields
| |
Instances
newIntegration :: Integration Source #
Create a value of Integration with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cacheKeyParameters:Integration', integration_cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be
valid values for cacheKeyParameters, these parameters must also be
specified for Method requestParameters.
$sel:cacheNamespace:Integration', integration_cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway
uses the resource ID as the cacheNamespace. You can specify the same
cacheNamespace across resources to return the same cached data for
requests to different resources.
$sel:connectionId:Integration', integration_connectionId - The ID of the VpcLink used for the integration when
connectionType=VPC_LINK and undefined, otherwise.
$sel:connectionType:Integration', integration_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.
Integration, integration_contentHandling - Specifies how to handle request payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
following behaviors:
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 passthroughBehavior is configured to
support payload pass-through.
$sel:credentials:Integration', integration_credentials - 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.
$sel:httpMethod:Integration', integration_httpMethod - Specifies the integration's HTTP method type.
$sel:integrationResponses:Integration', integration_integrationResponses - Specifies the integration's responses.
$sel:passthroughBehavior:Integration', integration_passthroughBehavior - 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.
$sel:requestParameters:Integration', integration_requestParameters - 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.
$sel:requestTemplates:Integration', integration_requestTemplates - 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.
$sel:timeoutInMillis:Integration', integration_timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is
29,000 milliseconds or 29 seconds.
$sel:tlsConfig:Integration', integration_tlsConfig - Specifies the TLS configuration for an integration.
$sel:type':Integration', integration_type - Specifies an API method integration type. The valid value is one of the
following:
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.
$sel:uri:Integration', integration_uri - 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 Amazon Web Services service (e.g., s3); and
{subdomain} is a designated subdomain supported by certain Amazon Web
Services service for fast host-name lookup. action can be used for an
Amazon Web Services 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 Amazon
Web Services service resource, including the region of the integrated
Amazon Web Services 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}
integration_cacheKeyParameters :: Lens' Integration (Maybe [Text]) Source #
A list of request parameters whose values API Gateway caches. To be
valid values for cacheKeyParameters, these parameters must also be
specified for Method requestParameters.
integration_cacheNamespace :: Lens' Integration (Maybe Text) Source #
Specifies a group of related cached parameters. By default, API Gateway
uses the resource ID as the cacheNamespace. You can specify the same
cacheNamespace across resources to return the same cached data for
requests to different resources.
integration_connectionId :: Lens' Integration (Maybe Text) Source #
The ID of the VpcLink used for the integration when
connectionType=VPC_LINK and undefined, otherwise.
integration_connectionType :: Lens' Integration (Maybe ConnectionType) Source #
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.
integration_contentHandling :: Lens' Integration (Maybe ContentHandlingStrategy) Source #
Specifies how to handle request payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
following behaviors:
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 passthroughBehavior is configured to
support payload pass-through.
integration_credentials :: Lens' Integration (Maybe Text) Source #
Specifies the credentials required for the integration, if any. For AWS
integrations, three options are available. To specify an IAM Role for
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.
integration_httpMethod :: Lens' Integration (Maybe Text) Source #
Specifies the integration's HTTP method type.
integration_integrationResponses :: Lens' Integration (Maybe (HashMap Text IntegrationResponse)) Source #
Specifies the integration's responses.
integration_passthroughBehavior :: Lens' Integration (Maybe Text) Source #
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.
integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text)) Source #
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.
integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text)) Source #
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.
integration_timeoutInMillis :: Lens' Integration (Maybe Int) Source #
Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.
integration_tlsConfig :: Lens' Integration (Maybe TlsConfig) Source #
Specifies the TLS configuration for an integration.
integration_type :: Lens' Integration (Maybe IntegrationType) Source #
Specifies an API method integration type. The valid value is one of the following:
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.
integration_uri :: Lens' Integration (Maybe Text) Source #
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 Amazon Web Services service (e.g., s3); and
{subdomain} is a designated subdomain supported by certain Amazon Web
Services service for fast host-name lookup. action can be used for an
Amazon Web Services 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 Amazon
Web Services service resource, including the region of the integrated
Amazon Web Services 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}
IntegrationResponse
data IntegrationResponse Source #
Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.
See: newIntegrationResponse smart constructor.
Constructors
| IntegrationResponse' | |
Fields
| |
Instances
newIntegrationResponse :: IntegrationResponse Source #
Create a value of IntegrationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentHandling:IntegrationResponse', integrationResponse_contentHandling - Specifies how to handle response payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
$sel:responseParameters:IntegrationResponse', integrationResponse_responseParameters - 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.
$sel:responseTemplates:IntegrationResponse', integrationResponse_responseTemplates - 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.
$sel:selectionPattern:IntegrationResponse', integrationResponse_selectionPattern - 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.
$sel:statusCode:IntegrationResponse', integrationResponse_statusCode - Specifies the status code that is used to map the integration response
to an existing MethodResponse.
integrationResponse_contentHandling :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) Source #
Specifies how to handle response payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
following behaviors:
If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.
integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #
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.
integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #
Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.
integrationResponse_selectionPattern :: Lens' IntegrationResponse (Maybe Text) Source #
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.
integrationResponse_statusCode :: Lens' IntegrationResponse (Maybe Text) Source #
Specifies the status code that is used to map the integration response to an existing MethodResponse.
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.
See: newMethod smart constructor.
Constructors
| Method' | |
Fields
| |
Instances
Create a value of Method with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiKeyRequired:Method', method_apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke
this method.
$sel:authorizationScopes:Method', method_authorizationScopes - 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.
$sel:authorizationType:Method', method_authorizationType - 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.
$sel:authorizerId:Method', method_authorizerId - The identifier of an Authorizer to use on this method. The
authorizationType must be CUSTOM.
Method, method_httpMethod - The method's HTTP verb.
$sel:methodIntegration:Method', method_methodIntegration - 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.
$sel:methodResponses:Method', method_methodResponses - Gets a method response associated with a given HTTP status code.
$sel:operationName:Method', method_operationName - A human-friendly operation identifier for the method. For example, you
can assign the operationName of ListPets for the GET /pets method
in the PetStore example.
$sel:requestModels:Method', method_requestModels - 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).
Method, method_requestParameters - 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.
$sel:requestValidatorId:Method', method_requestValidatorId - The identifier of a RequestValidator for request validation.
method_apiKeyRequired :: Lens' Method (Maybe Bool) Source #
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
method_authorizationScopes :: Lens' Method (Maybe [Text]) Source #
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.
method_authorizationType :: Lens' Method (Maybe Text) Source #
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.
method_authorizerId :: Lens' Method (Maybe Text) Source #
The identifier of an Authorizer to use on this method. The
authorizationType must be CUSTOM.
method_methodIntegration :: Lens' Method (Maybe Integration) Source #
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.
method_methodResponses :: Lens' Method (Maybe (HashMap Text MethodResponse)) Source #
Gets a method response associated with a given HTTP status code.
method_operationName :: Lens' Method (Maybe Text) Source #
A human-friendly operation identifier for the method. For example, you
can assign the operationName of ListPets for the GET /pets method
in the PetStore example.
method_requestModels :: Lens' Method (Maybe (HashMap Text Text)) Source #
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).
method_requestParameters :: Lens' Method (Maybe (HashMap Text Bool)) Source #
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.
method_requestValidatorId :: Lens' Method (Maybe Text) Source #
The identifier of a RequestValidator for request validation.
MethodResponse
data MethodResponse Source #
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.
See: newMethodResponse smart constructor.
Constructors
| MethodResponse' | |
Fields
| |
Instances
newMethodResponse :: MethodResponse Source #
Create a value of MethodResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:responseModels:MethodResponse', methodResponse_responseModels - Specifies the Model resources used for the response's content-type.
Response models are represented as a key/value map, with a content-type
as the key and a Model name as the value.
$sel:responseParameters:MethodResponse', methodResponse_responseParameters - 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.)
$sel:statusCode:MethodResponse', methodResponse_statusCode - The method response's status code.
methodResponse_responseModels :: Lens' MethodResponse (Maybe (HashMap Text Text)) Source #
Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.
methodResponse_responseParameters :: Lens' MethodResponse (Maybe (HashMap Text Bool)) Source #
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.)
methodResponse_statusCode :: Lens' MethodResponse (Maybe Text) Source #
The method response's status code.
MethodSetting
data MethodSetting Source #
Specifies the method setting properties.
See: newMethodSetting smart constructor.
Constructors
| MethodSetting' | |
Fields
| |
Instances
newMethodSetting :: MethodSetting Source #
Create a value of MethodSetting with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:cacheDataEncrypted:MethodSetting', methodSetting_cacheDataEncrypted - 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.
$sel:cacheTtlInSeconds:MethodSetting', methodSetting_cacheTtlInSeconds - 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.
$sel:cachingEnabled:MethodSetting', methodSetting_cachingEnabled - 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.
$sel:dataTraceEnabled:MethodSetting', methodSetting_dataTraceEnabled - Specifies whether data trace logging is enabled for this method, which
affects 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.
$sel:loggingLevel:MethodSetting', methodSetting_loggingLevel - Specifies the logging level for this method, which affects 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. Choose ERROR to write
only error-level entries to CloudWatch Logs, or choose INFO to include
all ERROR events as well as extra informational events.
$sel:metricsEnabled:MethodSetting', methodSetting_metricsEnabled - 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.
$sel:requireAuthorizationForCacheControl:MethodSetting', methodSetting_requireAuthorizationForCacheControl - 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.
$sel:throttlingBurstLimit:MethodSetting', methodSetting_throttlingBurstLimit - Specifies the throttling burst limit. The PATCH path for this setting is
/{method_setting_key}/throttling/burstLimit, and the value is an
integer.
$sel:throttlingRateLimit:MethodSetting', methodSetting_throttlingRateLimit - Specifies the throttling rate limit. The PATCH path for this setting is
/{method_setting_key}/throttling/rateLimit, and the value is a
double.
$sel:unauthorizedCacheControlHeaderStrategy:MethodSetting', methodSetting_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.
methodSetting_cacheDataEncrypted :: Lens' MethodSetting (Maybe Bool) Source #
Specifies whether the cached responses are encrypted. The PATCH path for
this setting is /{method_setting_key}/caching/dataEncrypted, and
the value is a Boolean.
methodSetting_cacheTtlInSeconds :: Lens' MethodSetting (Maybe Int) Source #
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.
methodSetting_cachingEnabled :: Lens' MethodSetting (Maybe Bool) Source #
Specifies whether responses should be cached and returned for requests.
A cache cluster must be enabled on the stage for responses to be cached.
The PATCH path for this setting is
/{method_setting_key}/caching/enabled, and the value is a Boolean.
methodSetting_dataTraceEnabled :: Lens' MethodSetting (Maybe Bool) Source #
Specifies whether data trace logging is enabled for this method, which
affects 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.
methodSetting_loggingLevel :: Lens' MethodSetting (Maybe Text) Source #
Specifies the logging level for this method, which affects 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. Choose ERROR to write
only error-level entries to CloudWatch Logs, or choose INFO to include
all ERROR events as well as extra informational events.
methodSetting_metricsEnabled :: Lens' MethodSetting (Maybe Bool) Source #
Specifies whether Amazon CloudWatch metrics are enabled for this method.
The PATCH path for this setting is
/{method_setting_key}/metrics/enabled, and the value is a Boolean.
methodSetting_requireAuthorizationForCacheControl :: Lens' MethodSetting (Maybe Bool) Source #
Specifies whether authorization is required for a cache invalidation
request. The PATCH path for this setting is
/{method_setting_key}/caching/requireAuthorizationForCacheControl,
and the value is a Boolean.
methodSetting_throttlingBurstLimit :: Lens' MethodSetting (Maybe Int) Source #
Specifies the throttling burst limit. The PATCH path for this setting is
/{method_setting_key}/throttling/burstLimit, and the value is an
integer.
methodSetting_throttlingRateLimit :: Lens' MethodSetting (Maybe Double) Source #
Specifies the throttling rate limit. The PATCH path for this setting is
/{method_setting_key}/throttling/rateLimit, and the value is a
double.
methodSetting_unauthorizedCacheControlHeaderStrategy :: Lens' MethodSetting (Maybe UnauthorizedCacheControlHeaderStrategy) Source #
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 Source #
Represents a summary of a Method resource, given a particular date and time.
See: newMethodSnapshot smart constructor.
Constructors
| MethodSnapshot' | |
Fields
| |
Instances
newMethodSnapshot :: MethodSnapshot Source #
Create a value of MethodSnapshot with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiKeyRequired:MethodSnapshot', methodSnapshot_apiKeyRequired - Specifies whether the method requires a valid ApiKey.
$sel:authorizationType:MethodSnapshot', methodSnapshot_authorizationType - 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.
methodSnapshot_apiKeyRequired :: Lens' MethodSnapshot (Maybe Bool) Source #
Specifies whether the method requires a valid ApiKey.
methodSnapshot_authorizationType :: Lens' MethodSnapshot (Maybe Text) Source #
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.
Model
Represents the data structure of a method's request or response payload.
See: newModel smart constructor.
Constructors
| Model' | |
Fields
| |
Instances
Create a value of Model with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:contentType:Model', model_contentType - The content-type for the model.
$sel:description:Model', model_description - The description of the model.
$sel:id:Model', model_id - The identifier for the model resource.
$sel:name:Model', model_name - The name of the model. Must be an alphanumeric string.
$sel:schema:Model', model_schema - 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.
model_name :: Lens' Model (Maybe Text) Source #
The name of the model. Must be an alphanumeric string.
model_schema :: Lens' Model (Maybe Text) Source #
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.
MutualTlsAuthentication
data MutualTlsAuthentication Source #
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
See: newMutualTlsAuthentication smart constructor.
Constructors
| MutualTlsAuthentication' | |
Fields
| |
Instances
newMutualTlsAuthentication :: MutualTlsAuthentication Source #
Create a value of MutualTlsAuthentication with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:truststoreUri:MutualTlsAuthentication', mutualTlsAuthentication_truststoreUri - An Amazon S3 URL that specifies the truststore for mutual TLS
authentication, for example s3://bucket-name/key-name. The
truststore can contain certificates from public or private certificate
authorities. To update the truststore, upload a new version to S3, and
then update your custom domain name to use the new version. To update
the truststore, you must have permissions to access the S3 object.
$sel:truststoreVersion:MutualTlsAuthentication', mutualTlsAuthentication_truststoreVersion - The version of the S3 object that contains your truststore. To specify a
version, you must have versioning enabled for the S3 bucket.
$sel:truststoreWarnings:MutualTlsAuthentication', mutualTlsAuthentication_truststoreWarnings - A list of warnings that API Gateway returns while processing your
truststore. Invalid certificates produce warnings. Mutual TLS is still
enabled, but some clients might not be able to access your API. To
resolve warnings, upload a new truststore to S3, and then update you
domain name to use the new version.
mutualTlsAuthentication_truststoreUri :: Lens' MutualTlsAuthentication (Maybe Text) Source #
An Amazon S3 URL that specifies the truststore for mutual TLS
authentication, for example s3://bucket-name/key-name. The
truststore can contain certificates from public or private certificate
authorities. To update the truststore, upload a new version to S3, and
then update your custom domain name to use the new version. To update
the truststore, you must have permissions to access the S3 object.
mutualTlsAuthentication_truststoreVersion :: Lens' MutualTlsAuthentication (Maybe Text) Source #
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
mutualTlsAuthentication_truststoreWarnings :: Lens' MutualTlsAuthentication (Maybe [Text]) Source #
A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.
MutualTlsAuthenticationInput
data MutualTlsAuthenticationInput Source #
The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.
See: newMutualTlsAuthenticationInput smart constructor.
Constructors
| MutualTlsAuthenticationInput' | |
Fields
| |
Instances
newMutualTlsAuthenticationInput :: MutualTlsAuthenticationInput Source #
Create a value of MutualTlsAuthenticationInput with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:truststoreUri:MutualTlsAuthenticationInput', mutualTlsAuthenticationInput_truststoreUri - An Amazon S3 URL that specifies the truststore for mutual TLS
authentication, for example s3://bucket-name/key-name. The
truststore can contain certificates from public or private certificate
authorities. To update the truststore, upload a new version to S3, and
then update your custom domain name to use the new version. To update
the truststore, you must have permissions to access the S3 object.
$sel:truststoreVersion:MutualTlsAuthenticationInput', mutualTlsAuthenticationInput_truststoreVersion - The version of the S3 object that contains your truststore. To specify a
version, you must have versioning enabled for the S3 bucket
mutualTlsAuthenticationInput_truststoreUri :: Lens' MutualTlsAuthenticationInput (Maybe Text) Source #
An Amazon S3 URL that specifies the truststore for mutual TLS
authentication, for example s3://bucket-name/key-name. The
truststore can contain certificates from public or private certificate
authorities. To update the truststore, upload a new version to S3, and
then update your custom domain name to use the new version. To update
the truststore, you must have permissions to access the S3 object.
mutualTlsAuthenticationInput_truststoreVersion :: Lens' MutualTlsAuthenticationInput (Maybe Text) Source #
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket
PatchOperation
data PatchOperation Source #
For more information about supported patch operations, see Patch Operations.
See: newPatchOperation smart constructor.
Constructors
| PatchOperation' | |
Fields
| |
Instances
newPatchOperation :: PatchOperation Source #
Create a value of PatchOperation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:from:PatchOperation', patchOperation_from - 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":"/canarySettings/deploymentId" and
"path":"/deploymentId".
$sel:op:PatchOperation', patchOperation_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..
$sel:path:PatchOperation', patchOperation_path - 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 /name/child~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.
$sel:value:PatchOperation', patchOperation_value - 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": ...}'.
patchOperation_from :: Lens' PatchOperation (Maybe Text) Source #
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":"/canarySettings/deploymentId" and "path":"/deploymentId".
patchOperation_op :: Lens' PatchOperation (Maybe Op) Source #
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..
patchOperation_path :: Lens' PatchOperation (Maybe Text) Source #
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 /name/child~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.
patchOperation_value :: Lens' PatchOperation (Maybe Text) Source #
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": ...}'.
QuotaSettings
data QuotaSettings Source #
Quotas configured for a usage plan.
See: newQuotaSettings smart constructor.
Constructors
| QuotaSettings' | |
Fields
| |
Instances
newQuotaSettings :: QuotaSettings Source #
Create a value of QuotaSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:limit:QuotaSettings', quotaSettings_limit - The target maximum number of requests that can be made in a given time
period.
$sel:offset:QuotaSettings', quotaSettings_offset - The number of requests subtracted from the given limit in the initial
time period.
$sel:period:QuotaSettings', quotaSettings_period - The time period in which the limit applies. Valid values are "DAY",
"WEEK" or "MONTH".
quotaSettings_limit :: Lens' QuotaSettings (Maybe Int) Source #
The target maximum number of requests that can be made in a given time period.
quotaSettings_offset :: Lens' QuotaSettings (Maybe Int) Source #
The number of requests subtracted from the given limit in the initial time period.
quotaSettings_period :: Lens' QuotaSettings (Maybe QuotaPeriodType) Source #
The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".
RequestValidator
data RequestValidator Source #
A set of validation rules for incoming Method requests.
See: newRequestValidator smart constructor.
Constructors
| RequestValidator' | |
Fields
| |
Instances
newRequestValidator :: RequestValidator Source #
Create a value of RequestValidator with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:RequestValidator', requestValidator_id - The identifier of this RequestValidator.
$sel:name:RequestValidator', requestValidator_name - The name of this RequestValidator
$sel:validateRequestBody:RequestValidator', requestValidator_validateRequestBody - A Boolean flag to indicate whether to validate a request body according
to the configured Model schema.
$sel:validateRequestParameters:RequestValidator', requestValidator_validateRequestParameters - A Boolean flag to indicate whether to validate request parameters
(true) or not (false).
requestValidator_id :: Lens' RequestValidator (Maybe Text) Source #
The identifier of this RequestValidator.
requestValidator_name :: Lens' RequestValidator (Maybe Text) Source #
The name of this RequestValidator
requestValidator_validateRequestBody :: Lens' RequestValidator (Maybe Bool) Source #
A Boolean flag to indicate whether to validate a request body according to the configured Model schema.
requestValidator_validateRequestParameters :: Lens' RequestValidator (Maybe Bool) Source #
A Boolean flag to indicate whether to validate request parameters
(true) or not (false).
Resource
Represents an API resource.
See: newResource smart constructor.
Constructors
| Resource' | |
Fields
| |
Instances
newResource :: Resource Source #
Create a value of Resource with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:Resource', resource_id - The resource's identifier.
$sel:parentId:Resource', resource_parentId - The parent resource's identifier.
$sel:path:Resource', resource_path - The full path for this resource.
$sel:pathPart:Resource', resource_pathPart - The last path segment for this resource.
$sel:resourceMethods:Resource', resource_resourceMethods - Gets an API resource's method of a given HTTP verb.
resource_resourceMethods :: Lens' Resource (Maybe (HashMap Text Method)) Source #
Gets an API resource's method of a given HTTP verb.
RestApi
Represents a REST API.
See: newRestApi smart constructor.
Constructors
| RestApi' | |
Fields
| |
Instances
newRestApi :: RestApi Source #
Create a value of RestApi with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiKeySource:RestApi', restApi_apiKeySource - 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.
$sel:binaryMediaTypes:RestApi', restApi_binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the
RestApi supports only UTF-8-encoded text payloads.
$sel:createdDate:RestApi', restApi_createdDate - The timestamp when the API was created.
$sel:description:RestApi', restApi_description - The API's description.
$sel:disableExecuteApiEndpoint:RestApi', restApi_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default
execute-api endpoint. By default, clients can invoke your API with the
default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke
your API, disable the default endpoint.
$sel:endpointConfiguration:RestApi', restApi_endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of
the API.
$sel:id:RestApi', restApi_id - The API's identifier. This identifier is unique across all of your APIs
in API Gateway.
$sel:minimumCompressionSize:RestApi', restApi_minimumCompressionSize - 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.
$sel:name:RestApi', restApi_name - The API's name.
$sel:policy:RestApi', restApi_policy - A stringified JSON policy document that applies to this RestApi
regardless of the caller and Method configuration.
$sel:tags:RestApi', restApi_tags - The collection of tags. Each tag element is associated with a given
resource.
$sel:version:RestApi', restApi_version - A version identifier for the API.
$sel:warnings:RestApi', restApi_warnings - The warning messages reported when failonwarnings is turned on during
API import.
restApi_apiKeySource :: Lens' RestApi (Maybe ApiKeySourceType) Source #
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.
restApi_binaryMediaTypes :: Lens' RestApi (Maybe [Text]) Source #
The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.
restApi_createdDate :: Lens' RestApi (Maybe UTCTime) Source #
The timestamp when the API was created.
restApi_disableExecuteApiEndpoint :: Lens' RestApi (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default
execute-api endpoint. By default, clients can invoke your API with the
default https://{api_id}.execute-api.{region}.amazonaws.com
endpoint. To require that clients use a custom domain name to invoke
your API, disable the default endpoint.
restApi_endpointConfiguration :: Lens' RestApi (Maybe EndpointConfiguration) Source #
The endpoint configuration of this RestApi showing the endpoint types of the API.
restApi_id :: Lens' RestApi (Maybe Text) Source #
The API's identifier. This identifier is unique across all of your APIs in API Gateway.
restApi_minimumCompressionSize :: Lens' RestApi (Maybe Int) Source #
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.
restApi_policy :: Lens' RestApi (Maybe Text) Source #
A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.
restApi_tags :: Lens' RestApi (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
restApi_warnings :: Lens' RestApi (Maybe [Text]) Source #
The warning messages reported when failonwarnings is turned on during
API import.
SdkConfigurationProperty
data SdkConfigurationProperty Source #
A configuration property of an SDK type.
See: newSdkConfigurationProperty smart constructor.
Constructors
| SdkConfigurationProperty' | |
Fields
| |
Instances
newSdkConfigurationProperty :: SdkConfigurationProperty Source #
Create a value of SdkConfigurationProperty with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:defaultValue:SdkConfigurationProperty', sdkConfigurationProperty_defaultValue - The default value of an SdkType configuration property.
$sel:description:SdkConfigurationProperty', sdkConfigurationProperty_description - The description of an SdkType configuration property.
$sel:friendlyName:SdkConfigurationProperty', sdkConfigurationProperty_friendlyName - The user-friendly name of an SdkType configuration property.
$sel:name:SdkConfigurationProperty', sdkConfigurationProperty_name - The name of a an SdkType configuration property.
$sel:required:SdkConfigurationProperty', sdkConfigurationProperty_required - A boolean flag of an SdkType configuration property to indicate if the
associated SDK configuration property is required (true) or not
(false).
sdkConfigurationProperty_defaultValue :: Lens' SdkConfigurationProperty (Maybe Text) Source #
The default value of an SdkType configuration property.
sdkConfigurationProperty_description :: Lens' SdkConfigurationProperty (Maybe Text) Source #
The description of an SdkType configuration property.
sdkConfigurationProperty_friendlyName :: Lens' SdkConfigurationProperty (Maybe Text) Source #
The user-friendly name of an SdkType configuration property.
sdkConfigurationProperty_name :: Lens' SdkConfigurationProperty (Maybe Text) Source #
The name of a an SdkType configuration property.
sdkConfigurationProperty_required :: Lens' SdkConfigurationProperty (Maybe Bool) Source #
A boolean flag of an SdkType configuration property to indicate if the
associated SDK configuration property is required (true) or not
(false).
SdkType
A type of SDK that API Gateway can generate.
See: newSdkType smart constructor.
Constructors
| SdkType' | |
Fields
| |
Instances
| FromJSON SdkType Source # | |
| Generic SdkType Source # | |
| Read SdkType Source # | |
| Show SdkType Source # | |
| NFData SdkType Source # | |
Defined in Amazonka.APIGateway.Types.SdkType | |
| Eq SdkType Source # | |
| Hashable SdkType Source # | |
Defined in Amazonka.APIGateway.Types.SdkType | |
| type Rep SdkType Source # | |
Defined in Amazonka.APIGateway.Types.SdkType type Rep SdkType = D1 ('MetaData "SdkType" "Amazonka.APIGateway.Types.SdkType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "SdkType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configurationProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SdkConfigurationProperty])) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "friendlyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) | |
newSdkType :: SdkType Source #
Create a value of SdkType with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationProperties:SdkType', sdkType_configurationProperties - A list of configuration properties of an SdkType.
SdkType, sdkType_description - The description of an SdkType.
SdkType, sdkType_friendlyName - The user-friendly name of an SdkType instance.
$sel:id:SdkType', sdkType_id - The identifier of an SdkType instance.
sdkType_configurationProperties :: Lens' SdkType (Maybe [SdkConfigurationProperty]) Source #
A list of configuration properties of an SdkType.
sdkType_friendlyName :: Lens' SdkType (Maybe Text) Source #
The user-friendly name of an SdkType instance.
Stage
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
See: newStage smart constructor.
Constructors
| Stage' | |
Fields
| |
Instances
Create a value of Stage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessLogSettings:Stage', stage_accessLogSettings - Settings for logging access in this stage.
$sel:cacheClusterEnabled:Stage', stage_cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.
$sel:cacheClusterSize:Stage', stage_cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a
cache size, see
Enabling API caching to enhance responsiveness.
$sel:cacheClusterStatus:Stage', stage_cacheClusterStatus - The status of the cache cluster for the stage, if enabled.
$sel:canarySettings:Stage', stage_canarySettings - Settings for the canary deployment in this stage.
$sel:clientCertificateId:Stage', stage_clientCertificateId - The identifier of a client certificate for an API stage.
$sel:createdDate:Stage', stage_createdDate - The timestamp when the stage was created.
Stage, stage_deploymentId - The identifier of the Deployment that the stage points to.
$sel:description:Stage', stage_description - The stage's description.
$sel:documentationVersion:Stage', stage_documentationVersion - The version of the associated API documentation.
$sel:lastUpdatedDate:Stage', stage_lastUpdatedDate - The timestamp when the stage last updated.
$sel:methodSettings:Stage', stage_methodSettings - 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.
$sel:stageName:Stage', stage_stageName - The name of the stage is the first path segment in the Uniform Resource
Identifier (URI) of a call to API Gateway. Stage names can only contain
alphanumeric characters, hyphens, and underscores. Maximum length is 128
characters.
$sel:tags:Stage', stage_tags - The collection of tags. Each tag element is associated with a given
resource.
$sel:tracingEnabled:Stage', stage_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.
$sel:variables:Stage', stage_variables - 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-._~:/?#&=,]+.
$sel:webAclArn:Stage', stage_webAclArn - The ARN of the WebAcl associated with the Stage.
stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
stage_cacheClusterEnabled :: Lens' Stage (Maybe Bool) Source #
Specifies whether a cache cluster is enabled for the stage.
stage_cacheClusterSize :: Lens' Stage (Maybe CacheClusterSize) Source #
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
stage_cacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus) Source #
The status of the cache cluster for the stage, if enabled.
stage_canarySettings :: Lens' Stage (Maybe CanarySettings) Source #
Settings for the canary deployment in this stage.
stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #
The identifier of a client certificate for an API stage.
stage_deploymentId :: Lens' Stage (Maybe Text) Source #
The identifier of the Deployment that the stage points to.
stage_documentationVersion :: Lens' Stage (Maybe Text) Source #
The version of the associated API documentation.
stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #
The timestamp when the stage last updated.
stage_methodSettings :: Lens' Stage (Maybe (HashMap Text MethodSetting)) Source #
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.
stage_stageName :: Lens' Stage (Maybe Text) Source #
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
stage_tags :: Lens' Stage (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
stage_tracingEnabled :: Lens' Stage (Maybe Bool) Source #
Specifies whether active tracing with X-ray is enabled for the Stage.
stage_variables :: Lens' Stage (Maybe (HashMap Text Text)) Source #
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-._~:/?#&=,]+.
stage_webAclArn :: Lens' Stage (Maybe Text) Source #
The ARN of the WebAcl associated with the Stage.
StageKey
A reference to a unique stage identified in the format
{restApiId}/{stage}.
See: newStageKey smart constructor.
Constructors
| StageKey' | |
Instances
| ToJSON StageKey Source # | |
Defined in Amazonka.APIGateway.Types.StageKey | |
| Generic StageKey Source # | |
| Read StageKey Source # | |
| Show StageKey Source # | |
| NFData StageKey Source # | |
Defined in Amazonka.APIGateway.Types.StageKey | |
| Eq StageKey Source # | |
| Hashable StageKey Source # | |
Defined in Amazonka.APIGateway.Types.StageKey | |
| type Rep StageKey Source # | |
Defined in Amazonka.APIGateway.Types.StageKey type Rep StageKey = D1 ('MetaData "StageKey" "Amazonka.APIGateway.Types.StageKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "StageKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) | |
newStageKey :: StageKey Source #
Create a value of StageKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:restApiId:StageKey', stageKey_restApiId - The string identifier of the associated RestApi.
$sel:stageName:StageKey', stageKey_stageName - The stage name associated with the stage key.
stageKey_restApiId :: Lens' StageKey (Maybe Text) Source #
The string identifier of the associated RestApi.
stageKey_stageName :: Lens' StageKey (Maybe Text) Source #
The stage name associated with the stage key.
ThrottleSettings
data ThrottleSettings Source #
The API request rate limits.
See: newThrottleSettings smart constructor.
Constructors
| ThrottleSettings' | |
Instances
newThrottleSettings :: ThrottleSettings Source #
Create a value of ThrottleSettings with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:burstLimit:ThrottleSettings', throttleSettings_burstLimit - The API target request burst rate limit. This allows more requests
through for a period of time than the target rate limit.
$sel:rateLimit:ThrottleSettings', throttleSettings_rateLimit - The API target request rate limit.
throttleSettings_burstLimit :: Lens' ThrottleSettings (Maybe Int) Source #
The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.
throttleSettings_rateLimit :: Lens' ThrottleSettings (Maybe Double) Source #
The API target request rate limit.
TlsConfig
Specifies the TLS configuration for an integration.
See: newTlsConfig smart constructor.
Constructors
| TlsConfig' | |
Fields
| |
Instances
| FromJSON TlsConfig Source # | |
| ToJSON TlsConfig Source # | |
Defined in Amazonka.APIGateway.Types.TlsConfig | |
| Generic TlsConfig Source # | |
| Read TlsConfig Source # | |
| Show TlsConfig Source # | |
| NFData TlsConfig Source # | |
Defined in Amazonka.APIGateway.Types.TlsConfig | |
| Eq TlsConfig Source # | |
| Hashable TlsConfig Source # | |
Defined in Amazonka.APIGateway.Types.TlsConfig | |
| type Rep TlsConfig Source # | |
Defined in Amazonka.APIGateway.Types.TlsConfig type Rep TlsConfig = D1 ('MetaData "TlsConfig" "Amazonka.APIGateway.Types.TlsConfig" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TlsConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "insecureSkipVerification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) | |
newTlsConfig :: TlsConfig Source #
Create a value of TlsConfig with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:insecureSkipVerification:TlsConfig', tlsConfig_insecureSkipVerification - Specifies whether or not API Gateway skips verification that the
certificate for an integration endpoint is issued by a supported
certificate authority. This isn’t recommended, but it enables you to use
certificates that are signed by private certificate authorities, or
certificates that are self-signed. If enabled, API Gateway still
performs basic certificate validation, which includes checking the
certificate's expiration date, hostname, and presence of a root
certificate authority. Supported only for HTTP and HTTP_PROXY
integrations.
Enabling insecureSkipVerification isn't recommended, especially for
integrations with public HTTPS endpoints. If you enable
insecureSkipVerification, you increase the risk of man-in-the-middle
attacks.
tlsConfig_insecureSkipVerification :: Lens' TlsConfig (Maybe Bool) Source #
Specifies whether or not API Gateway skips verification that the
certificate for an integration endpoint is issued by a supported
certificate authority. This isn’t recommended, but it enables you to use
certificates that are signed by private certificate authorities, or
certificates that are self-signed. If enabled, API Gateway still
performs basic certificate validation, which includes checking the
certificate's expiration date, hostname, and presence of a root
certificate authority. Supported only for HTTP and HTTP_PROXY
integrations.
Enabling insecureSkipVerification isn't recommended, especially for
integrations with public HTTPS endpoints. If you enable
insecureSkipVerification, you increase the risk of man-in-the-middle
attacks.
Usage
Represents the usage data of a usage plan.
See: newUsage smart constructor.
Constructors
| Usage' | |
Fields
| |
Instances
Create a value of Usage with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endDate:Usage', usage_endDate - The ending date of the usage data.
$sel:items:Usage', usage_items - 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].
$sel:position:Usage', usage_position - Undocumented member.
$sel:startDate:Usage', usage_startDate - The starting date of the usage data.
$sel:usagePlanId:Usage', usage_usagePlanId - The plan Id associated with this usage data.
usage_items :: Lens' Usage (Maybe (HashMap Text [[Integer]])) Source #
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 used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.
See: newUsagePlan smart constructor.
Constructors
| UsagePlan' | |
Fields
| |
Instances
newUsagePlan :: UsagePlan Source #
Create a value of UsagePlan with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiStages:UsagePlan', usagePlan_apiStages - The associated API stages of a usage plan.
$sel:description:UsagePlan', usagePlan_description - The description of a usage plan.
$sel:id:UsagePlan', usagePlan_id - The identifier of a UsagePlan resource.
$sel:name:UsagePlan', usagePlan_name - The name of a usage plan.
$sel:productCode:UsagePlan', usagePlan_productCode - The AWS Markeplace product identifier to associate with the usage plan
as a SaaS product on AWS Marketplace.
$sel:quota:UsagePlan', usagePlan_quota - The target maximum number of permitted requests per a given unit time
interval.
$sel:tags:UsagePlan', usagePlan_tags - The collection of tags. Each tag element is associated with a given
resource.
UsagePlan, usagePlan_throttle - A map containing method level throttling information for API stage in a
usage plan.
usagePlan_apiStages :: Lens' UsagePlan (Maybe [ApiStage]) Source #
The associated API stages of a usage plan.
usagePlan_productCode :: Lens' UsagePlan (Maybe Text) Source #
The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.
usagePlan_quota :: Lens' UsagePlan (Maybe QuotaSettings) Source #
The target maximum number of permitted requests per a given unit time interval.
usagePlan_tags :: Lens' UsagePlan (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
usagePlan_throttle :: Lens' UsagePlan (Maybe ThrottleSettings) Source #
A map containing method level throttling information for API stage in a usage plan.
UsagePlanKey
data UsagePlanKey Source #
Represents a usage plan key to identify a plan customer.
See: newUsagePlanKey smart constructor.
Constructors
| UsagePlanKey' | |
Instances
newUsagePlanKey :: UsagePlanKey Source #
Create a value of UsagePlanKey with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:id:UsagePlanKey', usagePlanKey_id - The Id of a usage plan key.
$sel:name:UsagePlanKey', usagePlanKey_name - The name of a usage plan key.
$sel:type':UsagePlanKey', usagePlanKey_type - The type of a usage plan key. Currently, the valid key type is
API_KEY.
$sel:value:UsagePlanKey', usagePlanKey_value - The value of a usage plan key.
usagePlanKey_id :: Lens' UsagePlanKey (Maybe Text) Source #
The Id of a usage plan key.
usagePlanKey_name :: Lens' UsagePlanKey (Maybe Text) Source #
The name of a usage plan key.
usagePlanKey_type :: Lens' UsagePlanKey (Maybe Text) Source #
The type of a usage plan key. Currently, the valid key type is
API_KEY.
usagePlanKey_value :: Lens' UsagePlanKey (Maybe Text) Source #
The value of a usage plan key.
VpcLink
An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).
See: newVpcLink smart constructor.
Constructors
| VpcLink' | |
Fields
| |
Instances
newVpcLink :: VpcLink Source #
Create a value of VpcLink with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:description:VpcLink', vpcLink_description - The description of the VPC link.
$sel:id:VpcLink', vpcLink_id - The identifier of the VpcLink. It is used in an Integration to reference
this VpcLink.
$sel:name:VpcLink', vpcLink_name - The name used to label and identify the VPC link.
$sel:status:VpcLink', vpcLink_status - 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.
$sel:statusMessage:VpcLink', vpcLink_statusMessage - A description about the VPC link status.
$sel:tags:VpcLink', vpcLink_tags - The collection of tags. Each tag element is associated with a given
resource.
$sel:targetArns:VpcLink', vpcLink_targetArns - The ARN of the network load balancer of the VPC targeted by the VPC
link. The network load balancer must be owned by the same AWS account of
the API owner.
vpcLink_id :: Lens' VpcLink (Maybe Text) Source #
The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.
vpcLink_name :: Lens' VpcLink (Maybe Text) Source #
The name used to label and identify the VPC link.
vpcLink_status :: Lens' VpcLink (Maybe VpcLinkStatus) Source #
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.
vpcLink_statusMessage :: Lens' VpcLink (Maybe Text) Source #
A description about the VPC link status.