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 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateApi
- CreateApiMapping
- CreateAuthorizer
- CreateDeployment
- CreateDomainName
- CreateIntegration
- CreateIntegrationResponse
- CreateModel
- CreateRoute
- CreateRouteResponse
- CreateStage
- CreateVpcLink
- DeleteAccessLogSettings
- DeleteApi
- DeleteApiMapping
- DeleteAuthorizer
- DeleteCorsConfiguration
- DeleteDeployment
- DeleteDomainName
- DeleteIntegration
- DeleteIntegrationResponse
- DeleteModel
- DeleteRoute
- DeleteRouteRequestParameter
- DeleteRouteResponse
- DeleteRouteSettings
- DeleteStage
- DeleteVpcLink
- ExportApi
- GetApi
- GetApiMapping
- GetApiMappings
- GetApis (Paginated)
- GetAuthorizer
- GetAuthorizers (Paginated)
- GetDeployment
- GetDeployments (Paginated)
- GetDomainName
- GetDomainNames (Paginated)
- GetIntegration
- GetIntegrationResponse
- GetIntegrationResponses (Paginated)
- GetIntegrations (Paginated)
- GetModel
- GetModelTemplate
- GetModels (Paginated)
- GetRoute
- GetRouteResponse
- GetRouteResponses (Paginated)
- GetRoutes (Paginated)
- GetStage
- GetStages (Paginated)
- GetTags
- GetVpcLink
- GetVpcLinks
- ImportApi
- ReimportApi
- ResetAuthorizersCache
- TagResource
- UntagResource
- UpdateApi
- UpdateApiMapping
- UpdateAuthorizer
- UpdateDeployment
- UpdateDomainName
- UpdateIntegration
- UpdateIntegrationResponse
- UpdateModel
- UpdateRoute
- UpdateRouteResponse
- UpdateStage
- UpdateVpcLink
- Types
- AuthorizationType
- AuthorizerType
- ConnectionType
- ContentHandlingStrategy
- DeploymentStatus
- DomainNameStatus
- EndpointType
- IntegrationType
- LoggingLevel
- PassthroughBehavior
- ProtocolType
- SecurityPolicy
- VpcLinkStatus
- VpcLinkVersion
- AccessLogSettings
- Api
- ApiMapping
- Authorizer
- Cors
- Deployment
- DomainName
- DomainNameConfiguration
- Integration
- IntegrationResponse
- JWTConfiguration
- Model
- MutualTlsAuthentication
- MutualTlsAuthenticationInput
- ParameterConstraints
- Route
- RouteResponse
- RouteSettings
- Stage
- TlsConfig
- TlsConfigInput
- VpcLink
Derived from API version 2018-11-29
of the AWS service descriptions, licensed under Apache 2.0.
Amazon API Gateway V2
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _BadRequestException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _TooManyRequestsException :: AsError a => Fold a ServiceError
- data CreateApi = CreateApi' (Maybe Text) (Maybe Cors) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) ProtocolType Text
- newCreateApi :: ProtocolType -> Text -> CreateApi
- data CreateApiResponse = CreateApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int
- newCreateApiResponse :: Int -> CreateApiResponse
- data CreateApiMapping = CreateApiMapping' (Maybe Text) Text Text Text
- newCreateApiMapping :: Text -> Text -> Text -> CreateApiMapping
- data CreateApiMappingResponse = CreateApiMappingResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateApiMappingResponse :: Int -> CreateApiMappingResponse
- data CreateAuthorizer = CreateAuthorizer' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe JWTConfiguration) Text AuthorizerType [Text] Text
- newCreateAuthorizer :: Text -> AuthorizerType -> Text -> CreateAuthorizer
- data CreateAuthorizerResponse = CreateAuthorizerResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) (Maybe Text) Int
- newCreateAuthorizerResponse :: Int -> CreateAuthorizerResponse
- data CreateDeployment = CreateDeployment' (Maybe Text) (Maybe Text) Text
- newCreateDeployment :: Text -> CreateDeployment
- data CreateDeploymentResponse = CreateDeploymentResponse' (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe DeploymentStatus) (Maybe Text) (Maybe Text) Int
- newCreateDeploymentResponse :: Int -> CreateDeploymentResponse
- data CreateDomainName = CreateDomainName' (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthenticationInput) (Maybe (HashMap Text Text)) Text
- newCreateDomainName :: Text -> CreateDomainName
- data CreateDomainNameResponse = CreateDomainNameResponse' (Maybe Text) (Maybe Text) (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthentication) (Maybe (HashMap Text Text)) Int
- newCreateDomainNameResponse :: Int -> CreateDomainNameResponse
- data CreateIntegration = CreateIntegration' (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfigInput) Text IntegrationType
- newCreateIntegration :: Text -> IntegrationType -> CreateIntegration
- data CreateIntegrationResponse' = CreateIntegrationResponse'' (Maybe Bool) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfig) Int
- newCreateIntegrationResponse' :: Int -> CreateIntegrationResponse'
- data CreateIntegrationResponse = CreateIntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text
- newCreateIntegrationResponse :: Text -> Text -> Text -> CreateIntegrationResponse
- data CreateIntegrationResponseResponse = CreateIntegrationResponseResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int
- newCreateIntegrationResponseResponse :: Int -> CreateIntegrationResponseResponse
- data CreateModel = CreateModel' (Maybe Text) (Maybe Text) Text Text Text
- newCreateModel :: Text -> Text -> Text -> CreateModel
- data CreateModelResponse = CreateModelResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateModelResponse :: Int -> CreateModelResponse
- data CreateRoute = CreateRoute' (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) Text Text
- newCreateRoute :: Text -> Text -> CreateRoute
- data CreateRouteResponse' = CreateRouteResponse'' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newCreateRouteResponse' :: Int -> CreateRouteResponse'
- data CreateRouteResponse = CreateRouteResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) Text Text Text
- newCreateRouteResponse :: Text -> Text -> Text -> CreateRouteResponse
- data CreateRouteResponseResponse = CreateRouteResponseResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) Int
- newCreateRouteResponseResponse :: Int -> CreateRouteResponseResponse
- data CreateStage = CreateStage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Text) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe (HashMap Text RouteSettings)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text Text
- newCreateStage :: Text -> Text -> CreateStage
- data CreateStageResponse = CreateStageResponse' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe (HashMap Text RouteSettings)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Int
- newCreateStageResponse :: Int -> CreateStageResponse
- data CreateVpcLink = CreateVpcLink' (Maybe [Text]) (Maybe (HashMap Text Text)) [Text] Text
- newCreateVpcLink :: Text -> CreateVpcLink
- data CreateVpcLinkResponse = CreateVpcLinkResponse' (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe VpcLinkVersion) Int
- newCreateVpcLinkResponse :: Int -> CreateVpcLinkResponse
- data DeleteAccessLogSettings = DeleteAccessLogSettings' Text Text
- newDeleteAccessLogSettings :: Text -> Text -> DeleteAccessLogSettings
- data DeleteAccessLogSettingsResponse = DeleteAccessLogSettingsResponse' {
- newDeleteAccessLogSettingsResponse :: DeleteAccessLogSettingsResponse
- data DeleteApi = DeleteApi' Text
- newDeleteApi :: Text -> DeleteApi
- data DeleteApiResponse = DeleteApiResponse' {
- newDeleteApiResponse :: DeleteApiResponse
- data DeleteApiMapping = DeleteApiMapping' Text Text
- newDeleteApiMapping :: Text -> Text -> DeleteApiMapping
- data DeleteApiMappingResponse = DeleteApiMappingResponse' {
- newDeleteApiMappingResponse :: DeleteApiMappingResponse
- data DeleteAuthorizer = DeleteAuthorizer' Text Text
- newDeleteAuthorizer :: Text -> Text -> DeleteAuthorizer
- data DeleteAuthorizerResponse = DeleteAuthorizerResponse' {
- newDeleteAuthorizerResponse :: DeleteAuthorizerResponse
- data DeleteCorsConfiguration = DeleteCorsConfiguration' Text
- newDeleteCorsConfiguration :: Text -> DeleteCorsConfiguration
- data DeleteCorsConfigurationResponse = DeleteCorsConfigurationResponse' {
- newDeleteCorsConfigurationResponse :: DeleteCorsConfigurationResponse
- data DeleteDeployment = DeleteDeployment' Text Text
- newDeleteDeployment :: Text -> Text -> DeleteDeployment
- data DeleteDeploymentResponse = DeleteDeploymentResponse' {
- newDeleteDeploymentResponse :: DeleteDeploymentResponse
- data DeleteDomainName = DeleteDomainName' Text
- newDeleteDomainName :: Text -> DeleteDomainName
- data DeleteDomainNameResponse = DeleteDomainNameResponse' {
- newDeleteDomainNameResponse :: DeleteDomainNameResponse
- data DeleteIntegration = DeleteIntegration' Text Text
- newDeleteIntegration :: Text -> Text -> DeleteIntegration
- data DeleteIntegrationResponse' = DeleteIntegrationResponse'' {
- newDeleteIntegrationResponse' :: DeleteIntegrationResponse'
- data DeleteIntegrationResponse = DeleteIntegrationResponse' Text Text Text
- newDeleteIntegrationResponse :: Text -> Text -> Text -> DeleteIntegrationResponse
- data DeleteIntegrationResponseResponse = DeleteIntegrationResponseResponse' {
- newDeleteIntegrationResponseResponse :: DeleteIntegrationResponseResponse
- data DeleteModel = DeleteModel' Text Text
- newDeleteModel :: Text -> Text -> DeleteModel
- data DeleteModelResponse = DeleteModelResponse' {
- newDeleteModelResponse :: DeleteModelResponse
- data DeleteRoute = DeleteRoute' Text Text
- newDeleteRoute :: Text -> Text -> DeleteRoute
- data DeleteRouteResponse' = DeleteRouteResponse'' {
- newDeleteRouteResponse' :: DeleteRouteResponse'
- data DeleteRouteRequestParameter = DeleteRouteRequestParameter' Text Text Text
- newDeleteRouteRequestParameter :: Text -> Text -> Text -> DeleteRouteRequestParameter
- data DeleteRouteRequestParameterResponse = DeleteRouteRequestParameterResponse' {
- newDeleteRouteRequestParameterResponse :: DeleteRouteRequestParameterResponse
- data DeleteRouteResponse = DeleteRouteResponse' Text Text Text
- newDeleteRouteResponse :: Text -> Text -> Text -> DeleteRouteResponse
- data DeleteRouteResponseResponse = DeleteRouteResponseResponse' {
- newDeleteRouteResponseResponse :: DeleteRouteResponseResponse
- data DeleteRouteSettings = DeleteRouteSettings' Text Text Text
- newDeleteRouteSettings :: Text -> Text -> Text -> DeleteRouteSettings
- data DeleteRouteSettingsResponse = DeleteRouteSettingsResponse' {
- newDeleteRouteSettingsResponse :: DeleteRouteSettingsResponse
- data DeleteStage = DeleteStage' Text Text
- newDeleteStage :: Text -> Text -> DeleteStage
- data DeleteStageResponse = DeleteStageResponse' {
- newDeleteStageResponse :: DeleteStageResponse
- data DeleteVpcLink = DeleteVpcLink' Text
- newDeleteVpcLink :: Text -> DeleteVpcLink
- data DeleteVpcLinkResponse = DeleteVpcLinkResponse' Int
- newDeleteVpcLinkResponse :: Int -> DeleteVpcLinkResponse
- data ExportApi = ExportApi' (Maybe Text) (Maybe Bool) (Maybe Text) Text Text Text
- newExportApi :: Text -> Text -> Text -> ExportApi
- data ExportApiResponse = ExportApiResponse' (Maybe ByteString) Int
- newExportApiResponse :: Int -> ExportApiResponse
- data GetApi = GetApi' Text
- newGetApi :: Text -> GetApi
- data GetApiResponse = GetApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int
- newGetApiResponse :: Int -> GetApiResponse
- data GetApiMapping = GetApiMapping' Text Text
- newGetApiMapping :: Text -> Text -> GetApiMapping
- data GetApiMappingResponse = GetApiMappingResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetApiMappingResponse :: Int -> GetApiMappingResponse
- data GetApiMappings = GetApiMappings' (Maybe Text) (Maybe Text) Text
- newGetApiMappings :: Text -> GetApiMappings
- data GetApiMappingsResponse = GetApiMappingsResponse' (Maybe [ApiMapping]) (Maybe Text) Int
- newGetApiMappingsResponse :: Int -> GetApiMappingsResponse
- data GetApis = GetApis' (Maybe Text) (Maybe Text)
- newGetApis :: GetApis
- data GetApisResponse = GetApisResponse' (Maybe [Api]) (Maybe Text) Int
- newGetApisResponse :: Int -> GetApisResponse
- data GetAuthorizer = GetAuthorizer' Text Text
- newGetAuthorizer :: Text -> Text -> GetAuthorizer
- data GetAuthorizerResponse = GetAuthorizerResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) (Maybe Text) Int
- newGetAuthorizerResponse :: Int -> GetAuthorizerResponse
- data GetAuthorizers = GetAuthorizers' (Maybe Text) (Maybe Text) Text
- newGetAuthorizers :: Text -> GetAuthorizers
- data GetAuthorizersResponse = GetAuthorizersResponse' (Maybe [Authorizer]) (Maybe Text) Int
- newGetAuthorizersResponse :: Int -> GetAuthorizersResponse
- data GetDeployment = GetDeployment' Text Text
- newGetDeployment :: Text -> Text -> GetDeployment
- data GetDeploymentResponse = GetDeploymentResponse' (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe DeploymentStatus) (Maybe Text) (Maybe Text) Int
- newGetDeploymentResponse :: Int -> GetDeploymentResponse
- data GetDeployments = GetDeployments' (Maybe Text) (Maybe Text) Text
- newGetDeployments :: Text -> GetDeployments
- data GetDeploymentsResponse = GetDeploymentsResponse' (Maybe [Deployment]) (Maybe Text) Int
- newGetDeploymentsResponse :: Int -> GetDeploymentsResponse
- data GetDomainName = GetDomainName' Text
- newGetDomainName :: Text -> GetDomainName
- data GetDomainNameResponse = GetDomainNameResponse' (Maybe Text) (Maybe Text) (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthentication) (Maybe (HashMap Text Text)) Int
- newGetDomainNameResponse :: Int -> GetDomainNameResponse
- data GetDomainNames = GetDomainNames' (Maybe Text) (Maybe Text)
- newGetDomainNames :: GetDomainNames
- data GetDomainNamesResponse = GetDomainNamesResponse' (Maybe [DomainName]) (Maybe Text) Int
- newGetDomainNamesResponse :: Int -> GetDomainNamesResponse
- data GetIntegration = GetIntegration' Text Text
- newGetIntegration :: Text -> Text -> GetIntegration
- data GetIntegrationResponse' = GetIntegrationResponse'' (Maybe Bool) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfig) Int
- newGetIntegrationResponse' :: Int -> GetIntegrationResponse'
- data GetIntegrationResponse = GetIntegrationResponse' Text Text Text
- newGetIntegrationResponse :: Text -> Text -> Text -> GetIntegrationResponse
- data GetIntegrationResponseResponse = GetIntegrationResponseResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int
- newGetIntegrationResponseResponse :: Int -> GetIntegrationResponseResponse
- data GetIntegrationResponses = GetIntegrationResponses' (Maybe Text) (Maybe Text) Text Text
- newGetIntegrationResponses :: Text -> Text -> GetIntegrationResponses
- data GetIntegrationResponsesResponse = GetIntegrationResponsesResponse' (Maybe [IntegrationResponse]) (Maybe Text) Int
- newGetIntegrationResponsesResponse :: Int -> GetIntegrationResponsesResponse
- data GetIntegrations = GetIntegrations' (Maybe Text) (Maybe Text) Text
- newGetIntegrations :: Text -> GetIntegrations
- data GetIntegrationsResponse = GetIntegrationsResponse' (Maybe [Integration]) (Maybe Text) Int
- newGetIntegrationsResponse :: Int -> GetIntegrationsResponse
- data GetModel = GetModel' Text Text
- newGetModel :: Text -> Text -> GetModel
- data GetModelResponse = GetModelResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetModelResponse :: Int -> GetModelResponse
- data GetModelTemplate = GetModelTemplate' Text Text
- newGetModelTemplate :: Text -> Text -> GetModelTemplate
- data GetModelTemplateResponse = GetModelTemplateResponse' (Maybe Text) Int
- newGetModelTemplateResponse :: Int -> GetModelTemplateResponse
- data GetModels = GetModels' (Maybe Text) (Maybe Text) Text
- newGetModels :: Text -> GetModels
- data GetModelsResponse = GetModelsResponse' (Maybe [Model]) (Maybe Text) Int
- newGetModelsResponse :: Int -> GetModelsResponse
- data GetRoute = GetRoute' Text Text
- newGetRoute :: Text -> Text -> GetRoute
- data GetRouteResponse' = GetRouteResponse'' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetRouteResponse' :: Int -> GetRouteResponse'
- data GetRouteResponse = GetRouteResponse' Text Text Text
- newGetRouteResponse :: Text -> Text -> Text -> GetRouteResponse
- data GetRouteResponseResponse = GetRouteResponseResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) Int
- newGetRouteResponseResponse :: Int -> GetRouteResponseResponse
- data GetRouteResponses = GetRouteResponses' (Maybe Text) (Maybe Text) Text Text
- newGetRouteResponses :: Text -> Text -> GetRouteResponses
- data GetRouteResponsesResponse = GetRouteResponsesResponse' (Maybe [RouteResponse]) (Maybe Text) Int
- newGetRouteResponsesResponse :: Int -> GetRouteResponsesResponse
- data GetRoutes = GetRoutes' (Maybe Text) (Maybe Text) Text
- newGetRoutes :: Text -> GetRoutes
- data GetRoutesResponse = GetRoutesResponse' (Maybe [Route]) (Maybe Text) Int
- newGetRoutesResponse :: Int -> GetRoutesResponse
- data GetStage = GetStage' Text Text
- newGetStage :: Text -> Text -> GetStage
- data GetStageResponse = GetStageResponse' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe (HashMap Text RouteSettings)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Int
- newGetStageResponse :: Int -> GetStageResponse
- data GetStages = GetStages' (Maybe Text) (Maybe Text) Text
- newGetStages :: Text -> GetStages
- data GetStagesResponse = GetStagesResponse' (Maybe [Stage]) (Maybe Text) Int
- newGetStagesResponse :: Int -> GetStagesResponse
- data GetTags = GetTags' Text
- newGetTags :: Text -> GetTags
- data GetTagsResponse = GetTagsResponse' (Maybe (HashMap Text Text)) Int
- newGetTagsResponse :: Int -> GetTagsResponse
- data GetVpcLink = GetVpcLink' Text
- newGetVpcLink :: Text -> GetVpcLink
- data GetVpcLinkResponse = GetVpcLinkResponse' (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe VpcLinkVersion) Int
- newGetVpcLinkResponse :: Int -> GetVpcLinkResponse
- data GetVpcLinks = GetVpcLinks' (Maybe Text) (Maybe Text)
- newGetVpcLinks :: GetVpcLinks
- data GetVpcLinksResponse = GetVpcLinksResponse' (Maybe [VpcLink]) (Maybe Text) Int
- newGetVpcLinksResponse :: Int -> GetVpcLinksResponse
- data ImportApi = ImportApi' (Maybe Text) (Maybe Bool) Text
- newImportApi :: Text -> ImportApi
- data ImportApiResponse = ImportApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int
- newImportApiResponse :: Int -> ImportApiResponse
- data ReimportApi = ReimportApi' (Maybe Text) (Maybe Bool) Text Text
- newReimportApi :: Text -> Text -> ReimportApi
- data ReimportApiResponse = ReimportApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int
- newReimportApiResponse :: Int -> ReimportApiResponse
- data ResetAuthorizersCache = ResetAuthorizersCache' Text Text
- newResetAuthorizersCache :: Text -> Text -> ResetAuthorizersCache
- data ResetAuthorizersCacheResponse = ResetAuthorizersCacheResponse' {
- newResetAuthorizersCacheResponse :: ResetAuthorizersCacheResponse
- data TagResource = TagResource' (Maybe (HashMap Text Text)) Text
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateApi = UpdateApi' (Maybe Text) (Maybe Cors) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newUpdateApi :: Text -> UpdateApi
- data UpdateApiResponse = UpdateApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int
- newUpdateApiResponse :: Int -> UpdateApiResponse
- data UpdateApiMapping = UpdateApiMapping' (Maybe Text) (Maybe Text) Text Text Text
- newUpdateApiMapping :: Text -> Text -> Text -> UpdateApiMapping
- data UpdateApiMappingResponse = UpdateApiMappingResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateApiMappingResponse :: Int -> UpdateApiMappingResponse
- data UpdateAuthorizer = UpdateAuthorizer' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) (Maybe Text) Text Text
- newUpdateAuthorizer :: Text -> Text -> UpdateAuthorizer
- data UpdateAuthorizerResponse = UpdateAuthorizerResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) (Maybe Text) Int
- newUpdateAuthorizerResponse :: Int -> UpdateAuthorizerResponse
- data UpdateDeployment = UpdateDeployment' (Maybe Text) Text Text
- newUpdateDeployment :: Text -> Text -> UpdateDeployment
- data UpdateDeploymentResponse = UpdateDeploymentResponse' (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe DeploymentStatus) (Maybe Text) (Maybe Text) Int
- newUpdateDeploymentResponse :: Int -> UpdateDeploymentResponse
- data UpdateDomainName = UpdateDomainName' (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthenticationInput) Text
- newUpdateDomainName :: Text -> UpdateDomainName
- data UpdateDomainNameResponse = UpdateDomainNameResponse' (Maybe Text) (Maybe Text) (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthentication) (Maybe (HashMap Text Text)) Int
- newUpdateDomainNameResponse :: Int -> UpdateDomainNameResponse
- data UpdateIntegration = UpdateIntegration' (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfigInput) Text Text
- newUpdateIntegration :: Text -> Text -> UpdateIntegration
- data UpdateIntegrationResponse' = UpdateIntegrationResponse'' (Maybe Bool) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfig) Int
- newUpdateIntegrationResponse' :: Int -> UpdateIntegrationResponse'
- data UpdateIntegrationResponse = UpdateIntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text
- newUpdateIntegrationResponse :: Text -> Text -> Text -> UpdateIntegrationResponse
- data UpdateIntegrationResponseResponse = UpdateIntegrationResponseResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int
- newUpdateIntegrationResponseResponse :: Int -> UpdateIntegrationResponseResponse
- data UpdateModel = UpdateModel' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newUpdateModel :: Text -> Text -> UpdateModel
- data UpdateModelResponse = UpdateModelResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateModelResponse :: Int -> UpdateModelResponse
- data UpdateRoute = UpdateRoute' (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text
- newUpdateRoute :: Text -> Text -> UpdateRoute
- data UpdateRouteResponse' = UpdateRouteResponse'' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int
- newUpdateRouteResponse' :: Int -> UpdateRouteResponse'
- data UpdateRouteResponse = UpdateRouteResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) Text Text Text
- newUpdateRouteResponse :: Text -> Text -> Text -> UpdateRouteResponse
- data UpdateRouteResponseResponse = UpdateRouteResponseResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) Int
- newUpdateRouteResponseResponse :: Int -> UpdateRouteResponseResponse
- data UpdateStage = UpdateStage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Text) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe (HashMap Text RouteSettings)) (Maybe (HashMap Text Text)) Text Text
- newUpdateStage :: Text -> Text -> UpdateStage
- data UpdateStageResponse = UpdateStageResponse' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe (HashMap Text RouteSettings)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Int
- newUpdateStageResponse :: Int -> UpdateStageResponse
- data UpdateVpcLink = UpdateVpcLink' (Maybe Text) Text
- newUpdateVpcLink :: Text -> UpdateVpcLink
- data UpdateVpcLinkResponse = UpdateVpcLinkResponse' (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe VpcLinkVersion) Int
- newUpdateVpcLinkResponse :: Int -> UpdateVpcLinkResponse
- newtype AuthorizationType where
- AuthorizationType' { }
- pattern AuthorizationType_AWS_IAM :: AuthorizationType
- pattern AuthorizationType_CUSTOM :: AuthorizationType
- pattern AuthorizationType_JWT :: AuthorizationType
- pattern AuthorizationType_NONE :: AuthorizationType
- newtype AuthorizerType where
- AuthorizerType' { }
- pattern AuthorizerType_JWT :: AuthorizerType
- pattern AuthorizerType_REQUEST :: AuthorizerType
- newtype ConnectionType where
- ConnectionType' { }
- pattern ConnectionType_INTERNET :: ConnectionType
- pattern ConnectionType_VPC_LINK :: ConnectionType
- newtype ContentHandlingStrategy where
- newtype DeploymentStatus where
- DeploymentStatus' { }
- pattern DeploymentStatus_DEPLOYED :: DeploymentStatus
- pattern DeploymentStatus_FAILED :: DeploymentStatus
- pattern DeploymentStatus_PENDING :: DeploymentStatus
- newtype DomainNameStatus where
- newtype EndpointType where
- EndpointType' { }
- pattern EndpointType_EDGE :: EndpointType
- pattern EndpointType_REGIONAL :: EndpointType
- 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 LoggingLevel where
- LoggingLevel' { }
- pattern LoggingLevel_ERROR :: LoggingLevel
- pattern LoggingLevel_INFO :: LoggingLevel
- pattern LoggingLevel_OFF :: LoggingLevel
- newtype PassthroughBehavior where
- newtype ProtocolType where
- ProtocolType' { }
- pattern ProtocolType_HTTP :: ProtocolType
- pattern ProtocolType_WEBSOCKET :: ProtocolType
- newtype SecurityPolicy where
- SecurityPolicy' { }
- pattern SecurityPolicy_TLS_1_0 :: SecurityPolicy
- pattern SecurityPolicy_TLS_1_2 :: SecurityPolicy
- newtype VpcLinkStatus where
- VpcLinkStatus' { }
- pattern VpcLinkStatus_AVAILABLE :: VpcLinkStatus
- pattern VpcLinkStatus_DELETING :: VpcLinkStatus
- pattern VpcLinkStatus_FAILED :: VpcLinkStatus
- pattern VpcLinkStatus_INACTIVE :: VpcLinkStatus
- pattern VpcLinkStatus_PENDING :: VpcLinkStatus
- newtype VpcLinkVersion where
- VpcLinkVersion' { }
- pattern VpcLinkVersion_V2 :: VpcLinkVersion
- data AccessLogSettings = AccessLogSettings' (Maybe Text) (Maybe Text)
- newAccessLogSettings :: AccessLogSettings
- data Api = Api' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Text Text ProtocolType
- newApi :: Text -> Text -> ProtocolType -> Api
- data ApiMapping = ApiMapping' (Maybe Text) (Maybe Text) Text Text
- newApiMapping :: Text -> Text -> ApiMapping
- data Authorizer = Authorizer' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) Text
- newAuthorizer :: Text -> Authorizer
- data Cors = Cors' (Maybe Bool) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe Int)
- newCors :: Cors
- data Deployment = Deployment' (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe DeploymentStatus) (Maybe Text) (Maybe Text)
- newDeployment :: Deployment
- data DomainName = DomainName' (Maybe Text) (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthentication) (Maybe (HashMap Text Text)) Text
- newDomainName :: Text -> DomainName
- data DomainNameConfiguration = DomainNameConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointType) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy)
- newDomainNameConfiguration :: DomainNameConfiguration
- data Integration = Integration' (Maybe Bool) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfig)
- newIntegration :: Integration
- data IntegrationResponse = IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text
- newIntegrationResponse :: Text -> IntegrationResponse
- data JWTConfiguration = JWTConfiguration' (Maybe [Text]) (Maybe Text)
- newJWTConfiguration :: JWTConfiguration
- data Model = Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newModel :: Text -> Model
- data MutualTlsAuthentication = MutualTlsAuthentication' (Maybe Text) (Maybe Text) (Maybe [Text])
- newMutualTlsAuthentication :: MutualTlsAuthentication
- data MutualTlsAuthenticationInput = MutualTlsAuthenticationInput' (Maybe Text) (Maybe Text)
- newMutualTlsAuthenticationInput :: MutualTlsAuthenticationInput
- data ParameterConstraints = ParameterConstraints' (Maybe Bool)
- newParameterConstraints :: ParameterConstraints
- data Route = Route' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newRoute :: Text -> Route
- data RouteResponse = RouteResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) Text
- newRouteResponse :: Text -> RouteResponse
- data RouteSettings = RouteSettings' (Maybe Bool) (Maybe Bool) (Maybe LoggingLevel) (Maybe Int) (Maybe Double)
- newRouteSettings :: RouteSettings
- data Stage = Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe (HashMap Text RouteSettings)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text
- newStage :: Text -> Stage
- data TlsConfig = TlsConfig' (Maybe Text)
- newTlsConfig :: TlsConfig
- data TlsConfigInput = TlsConfigInput' (Maybe Text)
- newTlsConfigInput :: TlsConfigInput
- data VpcLink = VpcLink' (Maybe ISO8601) (Maybe (HashMap Text Text)) (Maybe VpcLinkStatus) (Maybe Text) (Maybe VpcLinkVersion) Text [Text] [Text] Text
- newVpcLink :: Text -> Text -> VpcLink
Service Configuration
defaultService :: Service Source #
API version 2018-11-29
of the Amazon ApiGatewayV2 SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by ApiGatewayV2
.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
Prism for AccessDeniedException' errors.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
The request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request. See the accompanying error message for details.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
The resource specified in the request was not found. See the message field for more information.
TooManyRequestsException
_TooManyRequestsException :: AsError a => Fold a ServiceError Source #
A limit has been exceeded. See the accompanying error message for details.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateApi
Creates a new Api resource to represent an API.
See: newCreateApi
smart constructor.
CreateApi' (Maybe Text) (Maybe Cors) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) ProtocolType Text |
Instances
Create a value of CreateApi
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:
CreateApi
, createApi_apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
CreateApi
, createApi_corsConfiguration
- A CORS configuration. Supported only for HTTP APIs. See
Configuring CORS
for more information.
CreateApi
, createApi_credentialsArn
- This property is part of quick create. It specifies the credentials
required for the integration, if any. For a Lambda integration, 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
arn:aws:iam::*:user/*. To use resource-based permissions on supported
AWS services, specify null. Currently, this property is not used for
HTTP integrations. Supported only for HTTP APIs.
CreateApi
, createApi_description
- The description of the API.
CreateApi
, createApi_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.
CreateApi
, createApi_disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
CreateApi
, createApi_routeKey
- This property is part of quick create. If you don't specify a routeKey,
a default route of $default is created. The $default route acts as a
catch-all for any request made to your API, for a particular stage. The
$default route key can't be modified. You can add routes after creating
the API, and you can update the route keys of additional routes.
Supported only for HTTP APIs.
CreateApi
, createApi_routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.
CreateApi
, createApi_tags
- The collection of tags. Each tag element is associated with a given
resource.
CreateApi
, createApi_target
- This property is part of quick create. Quick create produces an API with
an integration, a default catch-all route, and a default stage which is
configured to automatically deploy changes. For HTTP integrations,
specify a fully qualified URL. For Lambda integrations, specify a
function ARN. The type of the integration will be HTTP_PROXY or
AWS_PROXY, respectively. Supported only for HTTP APIs.
CreateApi
, createApi_version
- A version identifier for the API.
CreateApi
, createApi_protocolType
- The API protocol.
CreateApi
, createApi_name
- The name of the API.
data CreateApiResponse Source #
See: newCreateApiResponse
smart constructor.
CreateApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int |
Instances
Create a value of CreateApiResponse
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:
CreateApiResponse
, createApiResponse_apiEndpoint
- The URI of the API, of the form
{api-id}.execute-api.{region}.amazonaws.com. The stage name is typically
appended to this URI to form a complete path to a deployed API stage.
CreateApiResponse
, createApiResponse_apiGatewayManaged
- Specifies whether an API is managed by API Gateway. You can't update or
delete a managed API by using API Gateway. A managed API can be deleted
only through the tooling or service that created it.
CreateApiResponse
, createApiResponse_apiId
- The API ID.
CreateApi
, createApiResponse_apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
CreateApi
, createApiResponse_corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.
CreateApiResponse
, createApiResponse_createdDate
- The timestamp when the API was created.
CreateApi
, createApiResponse_description
- The description of the API.
CreateApi
, createApiResponse_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.
CreateApi
, createApiResponse_disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
CreateApiResponse
, createApiResponse_importInfo
- The validation information during API import. This may include
particular properties of your OpenAPI definition which are ignored
during import. Supported only for HTTP APIs.
CreateApi
, createApiResponse_name
- The name of the API.
CreateApi
, createApiResponse_protocolType
- The API protocol.
CreateApi
, createApiResponse_routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.
CreateApi
, createApiResponse_tags
- A collection of tags associated with the API.
CreateApi
, createApiResponse_version
- A version identifier for the API.
CreateApiResponse
, createApiResponse_warnings
- The warning messages reported when failonwarnings is turned on during
API import.
$sel:httpStatus:CreateApiResponse'
, createApiResponse_httpStatus
- The response's http status code.
CreateApiMapping
data CreateApiMapping Source #
Creates a new ApiMapping resource to represent an API mapping.
See: newCreateApiMapping
smart constructor.
Instances
Create a value of CreateApiMapping
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:
CreateApiMapping
, createApiMapping_apiMappingKey
- The API mapping key.
CreateApiMapping
, createApiMapping_domainName
- The domain name.
CreateApiMapping
, createApiMapping_stage
- The API stage.
CreateApiMapping
, createApiMapping_apiId
- The API identifier.
data CreateApiMappingResponse Source #
See: newCreateApiMappingResponse
smart constructor.
Instances
newCreateApiMappingResponse Source #
Create a value of CreateApiMappingResponse
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:
CreateApiMapping
, createApiMappingResponse_apiId
- The API identifier.
CreateApiMappingResponse
, createApiMappingResponse_apiMappingId
- The API mapping identifier.
CreateApiMapping
, createApiMappingResponse_apiMappingKey
- The API mapping key.
CreateApiMapping
, createApiMappingResponse_stage
- The API stage.
$sel:httpStatus:CreateApiMappingResponse'
, createApiMappingResponse_httpStatus
- The response's http status code.
CreateAuthorizer
data CreateAuthorizer Source #
Creates a new Authorizer resource to represent an authorizer.
See: newCreateAuthorizer
smart constructor.
CreateAuthorizer' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe JWTConfiguration) Text AuthorizerType [Text] Text |
Instances
Create a value of CreateAuthorizer
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:
CreateAuthorizer
, createAuthorizer_authorizerCredentialsArn
- 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, don't specify this parameter.
Supported only for REQUEST authorizers.
CreateAuthorizer
, createAuthorizer_authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda
authorizer. Required for HTTP API Lambda authorizers. Supported values
are 1.0 and 2.0. To learn more, see
Working with AWS Lambda authorizers for HTTP APIs.
CreateAuthorizer
, createAuthorizer_authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. If it
equals 0, authorization caching is disabled. If it is greater than 0,
API Gateway caches authorizer responses. The maximum value is 3600, or 1
hour. Supported only for HTTP API Lambda authorizers.
CreateAuthorizer
, createAuthorizer_authorizerUri
- The authorizer's Uniform Resource Identifier (URI). For 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.
Supported only for REQUEST authorizers.
CreateAuthorizer
, createAuthorizer_enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple
format. By default, a Lambda authorizer must return an IAM policy. If
enabled, the Lambda authorizer can return a boolean value instead of an
IAM policy. Supported only for HTTP APIs. To learn more, see
Working with AWS Lambda authorizers for HTTP APIs
CreateAuthorizer
, createAuthorizer_identityValidationExpression
- This parameter is not used.
CreateAuthorizer
, createAuthorizer_jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT
authorizer type. Supported only for HTTP APIs.
CreateAuthorizer
, createAuthorizer_apiId
- The API identifier.
CreateAuthorizer
, createAuthorizer_authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using
incoming request parameters. Specify JWT to use JSON Web Tokens
(supported only for HTTP APIs).
CreateAuthorizer
, createAuthorizer_identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
CreateAuthorizer
, createAuthorizer_name
- The name of the authorizer.
data CreateAuthorizerResponse Source #
See: newCreateAuthorizerResponse
smart constructor.
CreateAuthorizerResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) (Maybe Text) Int |
Instances
newCreateAuthorizerResponse Source #
Create a value of CreateAuthorizerResponse
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:
CreateAuthorizer
, createAuthorizerResponse_authorizerCredentialsArn
- 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, don't specify this parameter.
Supported only for REQUEST authorizers.
CreateAuthorizerResponse
, createAuthorizerResponse_authorizerId
- The authorizer identifier.
CreateAuthorizer
, createAuthorizerResponse_authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda
authorizer. Required for HTTP API Lambda authorizers. Supported values
are 1.0 and 2.0. To learn more, see
Working with AWS Lambda authorizers for HTTP APIs.
CreateAuthorizer
, createAuthorizerResponse_authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. If it
equals 0, authorization caching is disabled. If it is greater than 0,
API Gateway caches authorizer responses. The maximum value is 3600, or 1
hour. Supported only for HTTP API Lambda authorizers.
CreateAuthorizer
, createAuthorizerResponse_authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using
incoming request parameters. Specify JWT to use JSON Web Tokens
(supported only for HTTP APIs).
CreateAuthorizer
, createAuthorizerResponse_authorizerUri
- The authorizer's Uniform Resource Identifier (URI). For 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.
Supported only for REQUEST authorizers.
CreateAuthorizer
, createAuthorizerResponse_enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple
format. If enabled, the Lambda authorizer can return a boolean value
instead of an IAM policy. Supported only for HTTP APIs. To learn more,
see
Working with AWS Lambda authorizers for HTTP APIs
CreateAuthorizer
, createAuthorizerResponse_identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
CreateAuthorizer
, createAuthorizerResponse_identityValidationExpression
- The validation expression does not apply to the REQUEST authorizer.
CreateAuthorizer
, createAuthorizerResponse_jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT
authorizer type. Supported only for HTTP APIs.
CreateAuthorizer
, createAuthorizerResponse_name
- The name of the authorizer.
$sel:httpStatus:CreateAuthorizerResponse'
, createAuthorizerResponse_httpStatus
- The response's http status code.
CreateDeployment
data CreateDeployment Source #
Creates a new Deployment resource to represent a deployment.
See: newCreateDeployment
smart constructor.
Instances
Create a value of CreateDeployment
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:
CreateDeployment
, createDeployment_description
- The description for the deployment resource.
CreateDeployment
, createDeployment_stageName
- The name of the Stage resource for the Deployment resource to create.
CreateDeployment
, createDeployment_apiId
- The API identifier.
data CreateDeploymentResponse Source #
See: newCreateDeploymentResponse
smart constructor.
CreateDeploymentResponse' (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe DeploymentStatus) (Maybe Text) (Maybe Text) Int |
Instances
newCreateDeploymentResponse Source #
Create a value of CreateDeploymentResponse
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:
CreateDeploymentResponse
, createDeploymentResponse_autoDeployed
- Specifies whether a deployment was automatically released.
CreateDeploymentResponse
, createDeploymentResponse_createdDate
- The date and time when the Deployment resource was created.
CreateDeploymentResponse
, createDeploymentResponse_deploymentId
- The identifier for the deployment.
CreateDeploymentResponse
, createDeploymentResponse_deploymentStatus
- The status of the deployment: PENDING, FAILED, or SUCCEEDED.
CreateDeploymentResponse
, createDeploymentResponse_deploymentStatusMessage
- May contain additional feedback on the status of an API deployment.
CreateDeployment
, createDeploymentResponse_description
- The description for the deployment.
$sel:httpStatus:CreateDeploymentResponse'
, createDeploymentResponse_httpStatus
- The response's http status code.
CreateDomainName
data CreateDomainName Source #
Creates a new DomainName resource to represent a domain name.
See: newCreateDomainName
smart constructor.
CreateDomainName' (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthenticationInput) (Maybe (HashMap Text Text)) Text |
Instances
Create a value of CreateDomainName
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:
CreateDomainName
, createDomainName_domainNameConfigurations
- The domain name configurations.
CreateDomainName
, createDomainName_mutualTlsAuthentication
- The mutual TLS authentication configuration for a custom domain name.
CreateDomainName
, createDomainName_tags
- The collection of tags associated with a domain name.
CreateDomainName
, createDomainName_domainName
- The domain name.
data CreateDomainNameResponse Source #
See: newCreateDomainNameResponse
smart constructor.
CreateDomainNameResponse' (Maybe Text) (Maybe Text) (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthentication) (Maybe (HashMap Text Text)) Int |
Instances
newCreateDomainNameResponse Source #
Create a value of CreateDomainNameResponse
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:
CreateDomainNameResponse
, createDomainNameResponse_apiMappingSelectionExpression
- The API mapping selection expression.
CreateDomainName
, createDomainNameResponse_domainName
- The name of the DomainName resource.
CreateDomainName
, createDomainNameResponse_domainNameConfigurations
- The domain name configurations.
CreateDomainName
, createDomainNameResponse_mutualTlsAuthentication
- The mutual TLS authentication configuration for a custom domain name.
CreateDomainName
, createDomainNameResponse_tags
- The collection of tags associated with a domain name.
$sel:httpStatus:CreateDomainNameResponse'
, createDomainNameResponse_httpStatus
- The response's http status code.
CreateIntegration
data CreateIntegration Source #
Creates a new Integration resource to represent an integration.
See: newCreateIntegration
smart constructor.
CreateIntegration' (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfigInput) Text IntegrationType |
Instances
Create a value of CreateIntegration
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:
CreateIntegration
, createIntegration_connectionId
- The ID of the VPC link for a private integration. Supported only for
HTTP APIs.
CreateIntegration
, createIntegration_connectionType
- The type of the network connection to the integration endpoint. Specify
INTERNET for connections through the public routable internet or
VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.
CreateIntegration
, createIntegration_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
CreateIntegration
, createIntegration_credentialsArn
- 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.
CreateIntegration
, createIntegration_description
- The description of the integration.
CreateIntegration
, createIntegration_integrationMethod
- Specifies the integration's HTTP method type.
CreateIntegration
, createIntegration_integrationSubtype
- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS
service action to invoke. To learn more, see
Integration subtype reference.
CreateIntegration
, createIntegration_integrationUri
- For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
CreateIntegration
, createIntegration_passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the
Content-Type header in the request, and the available mapping templates
specified as the requestTemplates property on the Integration resource.
There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
CreateIntegration
, createIntegration_payloadFormatVersion
- Specifies the format of the payload sent to an integration. Required for
HTTP APIs.
CreateIntegration
, createIntegration_requestParameters
- For WebSocket APIs, a key-value map specifying request parameters that
are passed from the method request to the backend. 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 backend. 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.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
CreateIntegration
, createIntegration_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. Supported only for WebSocket APIs.
CreateIntegration
, createIntegration_responseParameters
- Supported only for HTTP APIs. You use response parameters to transform
the HTTP response from a backend integration before returning the
response to clients. Specify a key-value map from a selection key to
response parameters. The selection key must be a valid HTTP status code
within the range of 200-599. Response parameters are a key-value map.
The key must match pattern <action>:<header>.<location> or
overwrite.statuscode. The action can be append, overwrite or remove. The
value can be a static value, or map to response data, stage variables,
or context variables that are evaluated at runtime. To learn more, see
Transforming API requests and responses.
CreateIntegration
, createIntegration_templateSelectionExpression
- The template selection expression for the integration.
CreateIntegration
, createIntegration_timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and
between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is
29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
CreateIntegration
, createIntegration_tlsConfig
- The TLS configuration for a private integration. If you specify a TLS
configuration, private integration traffic uses the HTTPS protocol.
Supported only for HTTP APIs.
CreateIntegration
, createIntegration_apiId
- The API identifier.
CreateIntegration
, createIntegration_integrationType
- The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
data CreateIntegrationResponse' Source #
See: newCreateIntegrationResponse'
smart constructor.
CreateIntegrationResponse'' (Maybe Bool) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfig) Int |
Instances
newCreateIntegrationResponse' Source #
Create a value of CreateIntegrationResponse'
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:
CreateIntegrationResponse'
, createIntegrationResponse'_apiGatewayManaged
- Specifies whether an integration is managed by API Gateway. If you
created an API using using quick create, the resulting integration is
managed by API Gateway. You can update a managed integration, but you
can't delete it.
CreateIntegration
, createIntegrationResponse'_connectionId
- The ID of the VPC link for a private integration. Supported only for
HTTP APIs.
CreateIntegration
, createIntegrationResponse'_connectionType
- The type of the network connection to the integration endpoint. Specify
INTERNET for connections through the public routable internet or
VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.
CreateIntegration
, createIntegrationResponse'_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
CreateIntegration
, createIntegrationResponse'_credentialsArn
- 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.
CreateIntegration
, createIntegrationResponse'_description
- Represents the description of an integration.
CreateIntegrationResponse'
, createIntegrationResponse'_integrationId
- Represents the identifier of an integration.
CreateIntegration
, createIntegrationResponse'_integrationMethod
- Specifies the integration's HTTP method type.
CreateIntegrationResponse'
, createIntegrationResponse'_integrationResponseSelectionExpression
- The integration response selection expression for the integration.
Supported only for WebSocket APIs. See
Integration Response Selection Expressions.
CreateIntegration
, createIntegrationResponse'_integrationSubtype
- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS
service action to invoke. To learn more, see
Integration subtype reference.
CreateIntegration
, createIntegrationResponse'_integrationType
- The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
CreateIntegration
, createIntegrationResponse'_integrationUri
- For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
CreateIntegration
, createIntegrationResponse'_passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the
Content-Type header in the request, and the available mapping templates
specified as the requestTemplates property on the Integration resource.
There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
CreateIntegration
, createIntegrationResponse'_payloadFormatVersion
- Specifies the format of the payload sent to an integration. Required for
HTTP APIs.
CreateIntegration
, createIntegrationResponse'_requestParameters
- For WebSocket APIs, a key-value map specifying request parameters that
are passed from the method request to the backend. 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 backend. 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.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
CreateIntegration
, createIntegrationResponse'_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. Supported only for WebSocket APIs.
CreateIntegration
, createIntegrationResponse'_responseParameters
- Supported only for HTTP APIs. You use response parameters to transform
the HTTP response from a backend integration before returning the
response to clients. Specify a key-value map from a selection key to
response parameters. The selection key must be a valid HTTP status code
within the range of 200-599. Response parameters are a key-value map.
The key must match pattern <action>:<header>.<location> or
overwrite.statuscode. The action can be append, overwrite or remove. The
value can be a static value, or map to response data, stage variables,
or context variables that are evaluated at runtime. To learn more, see
Transforming API requests and responses.
CreateIntegration
, createIntegrationResponse'_templateSelectionExpression
- The template selection expression for the integration. Supported only
for WebSocket APIs.
CreateIntegration
, createIntegrationResponse'_timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and
between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is
29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
CreateIntegration
, createIntegrationResponse'_tlsConfig
- The TLS configuration for a private integration. If you specify a TLS
configuration, private integration traffic uses the HTTPS protocol.
Supported only for HTTP APIs.
$sel:httpStatus:CreateIntegrationResponse''
, createIntegrationResponse'_httpStatus
- The response's http status code.
CreateIntegrationResponse
data CreateIntegrationResponse Source #
Creates a new IntegrationResponse resource to represent an integration response.
See: newCreateIntegrationResponse
smart constructor.
CreateIntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text |
Instances
newCreateIntegrationResponse Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateIntegrationResponse |
Create a value of CreateIntegrationResponse
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:
CreateIntegrationResponse
, createIntegrationResponse_contentHandlingStrategy
- Specifies how to handle response payload content type conversions.
Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the
following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
CreateIntegrationResponse
, createIntegrationResponse_responseParameters
- A key-value map specifying response parameters that are passed to the
method response from the backend. 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.
CreateIntegrationResponse
, createIntegrationResponse_responseTemplates
- The collection of response templates for the integration response as a
string-to-string map of key-value pairs. Response templates are
represented as a key/value map, with a content-type as the key and a
template as the value.
CreateIntegrationResponse
, createIntegrationResponse_templateSelectionExpression
- The template selection expression for the integration response.
Supported only for WebSocket APIs.
CreateIntegrationResponse
, createIntegrationResponse_apiId
- The API identifier.
CreateIntegrationResponse
, createIntegrationResponse_integrationId
- The integration ID.
CreateIntegrationResponse
, createIntegrationResponse_integrationResponseKey
- The integration response key.
data CreateIntegrationResponseResponse Source #
See: newCreateIntegrationResponseResponse
smart constructor.
CreateIntegrationResponseResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int |
Instances
newCreateIntegrationResponseResponse Source #
Create a value of CreateIntegrationResponseResponse
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:
CreateIntegrationResponse
, createIntegrationResponseResponse_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
CreateIntegrationResponseResponse
, createIntegrationResponseResponse_integrationResponseId
- The integration response ID.
CreateIntegrationResponse
, createIntegrationResponseResponse_integrationResponseKey
- The integration response key.
CreateIntegrationResponse
, createIntegrationResponseResponse_responseParameters
- A key-value map specifying response parameters that are passed to the
method response from the backend. 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.
CreateIntegrationResponse
, createIntegrationResponseResponse_responseTemplates
- The collection of response templates for the integration response as a
string-to-string map of key-value pairs. Response templates are
represented as a key/value map, with a content-type as the key and a
template as the value.
CreateIntegrationResponse
, createIntegrationResponseResponse_templateSelectionExpression
- The template selection expressions for the integration response.
$sel:httpStatus:CreateIntegrationResponseResponse'
, createIntegrationResponseResponse_httpStatus
- The response's http status code.
CreateModel
data CreateModel Source #
Creates a new Model.
See: newCreateModel
smart constructor.
Instances
Create a value of CreateModel
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:
CreateModel
, createModel_contentType
- The content-type for the model, for example, "application/json".
CreateModel
, createModel_description
- The description of the model.
CreateModel
, createModel_apiId
- The API identifier.
CreateModel
, createModel_schema
- The schema for the model. For application/json models, this should be
JSON schema draft 4 model.
CreateModel
, createModel_name
- The name of the model. Must be alphanumeric.
data CreateModelResponse Source #
See: newCreateModelResponse
smart constructor.
Instances
newCreateModelResponse Source #
Create a value of CreateModelResponse
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:
CreateModel
, createModelResponse_contentType
- The content-type for the model, for example, "application/json".
CreateModel
, createModelResponse_description
- The description of the model.
CreateModelResponse
, createModelResponse_modelId
- The model identifier.
CreateModel
, createModelResponse_name
- The name of the model. Must be alphanumeric.
CreateModel
, createModelResponse_schema
- The schema for the model. For application/json models, this should be
JSON schema draft 4 model.
$sel:httpStatus:CreateModelResponse'
, createModelResponse_httpStatus
- The response's http status code.
CreateRoute
data CreateRoute Source #
Creates a new Route resource to represent a route.
See: newCreateRoute
smart constructor.
CreateRoute' (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) Text Text |
Instances
Create a value of CreateRoute
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:
CreateRoute
, createRoute_apiKeyRequired
- Specifies whether an API key is required for the route. Supported only
for WebSocket APIs.
CreateRoute
, createRoute_authorizationScopes
- The authorization scopes supported by this route.
CreateRoute
, createRoute_authorizationType
- The authorization type for the route. For WebSocket APIs, valid values
are NONE for open access, AWS_IAM for using AWS IAM permissions, and
CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are
NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using
AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
CreateRoute
, createRoute_authorizerId
- The identifier of the Authorizer resource to be associated with this
route. The authorizer identifier is generated by API Gateway when you
created the authorizer.
CreateRoute
, createRoute_modelSelectionExpression
- The model selection expression for the route. Supported only for
WebSocket APIs.
CreateRoute
, createRoute_operationName
- The operation name for the route.
CreateRoute
, createRoute_requestModels
- The request models for the route. Supported only for WebSocket APIs.
CreateRoute
, createRoute_requestParameters
- The request parameters for the route. Supported only for WebSocket APIs.
CreateRoute
, createRoute_routeResponseSelectionExpression
- The route response selection expression for the route. Supported only
for WebSocket APIs.
CreateRoute
, createRoute_target
- The target for the route.
CreateRoute
, createRoute_apiId
- The API identifier.
CreateRoute
, createRoute_routeKey
- The route key for the route.
data CreateRouteResponse' Source #
See: newCreateRouteResponse'
smart constructor.
CreateRouteResponse'' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newCreateRouteResponse' Source #
Create a value of CreateRouteResponse'
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:
CreateRouteResponse'
, createRouteResponse'_apiGatewayManaged
- Specifies whether a route is managed by API Gateway. If you created an
API using quick create, the $default route is managed by API Gateway.
You can't modify the $default route key.
CreateRoute
, createRouteResponse'_apiKeyRequired
- Specifies whether an API key is required for this route. Supported only
for WebSocket APIs.
CreateRoute
, createRouteResponse'_authorizationScopes
- A list of authorization scopes configured on a route. The scopes are
used with a JWT authorizer to authorize the method invocation. The
authorization works by matching the route scopes against the scopes
parsed from the access token in the incoming request. The method
invocation is authorized if any route scope matches a claimed scope in
the access token. Otherwise, the invocation is not authorized. When the
route scope is configured, the client must provide an access token
instead of an identity token for authorization purposes.
CreateRoute
, createRouteResponse'_authorizationType
- The authorization type for the route. For WebSocket APIs, valid values
are NONE for open access, AWS_IAM for using AWS IAM permissions, and
CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are
NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using
AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
CreateRoute
, createRouteResponse'_authorizerId
- The identifier of the Authorizer resource to be associated with this
route. The authorizer identifier is generated by API Gateway when you
created the authorizer.
CreateRoute
, createRouteResponse'_modelSelectionExpression
- The model selection expression for the route. Supported only for
WebSocket APIs.
CreateRoute
, createRouteResponse'_operationName
- The operation name for the route.
CreateRoute
, createRouteResponse'_requestModels
- The request models for the route. Supported only for WebSocket APIs.
CreateRoute
, createRouteResponse'_requestParameters
- The request parameters for the route. Supported only for WebSocket APIs.
CreateRouteResponse'
, createRouteResponse'_routeId
- The route ID.
CreateRoute
, createRouteResponse'_routeKey
- The route key for the route.
CreateRoute
, createRouteResponse'_routeResponseSelectionExpression
- The route response selection expression for the route. Supported only
for WebSocket APIs.
CreateRoute
, createRouteResponse'_target
- The target for the route.
$sel:httpStatus:CreateRouteResponse''
, createRouteResponse'_httpStatus
- The response's http status code.
CreateRouteResponse
data CreateRouteResponse Source #
Creates a new RouteResponse resource to represent a route response.
See: newCreateRouteResponse
smart constructor.
CreateRouteResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) Text Text Text |
Instances
newCreateRouteResponse Source #
:: Text | |
-> Text | |
-> Text | |
-> CreateRouteResponse |
Create a value of CreateRouteResponse
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:
CreateRouteResponse
, createRouteResponse_modelSelectionExpression
- The model selection expression for the route response. Supported only
for WebSocket APIs.
CreateRouteResponse
, createRouteResponse_responseModels
- The response models for the route response.
CreateRouteResponse
, createRouteResponse_responseParameters
- The route response parameters.
CreateRouteResponse
, createRouteResponse_apiId
- The API identifier.
CreateRouteResponse
, createRouteResponse_routeId
- The route ID.
CreateRouteResponse
, createRouteResponse_routeResponseKey
- The route response key.
data CreateRouteResponseResponse Source #
See: newCreateRouteResponseResponse
smart constructor.
CreateRouteResponseResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) Int |
Instances
newCreateRouteResponseResponse Source #
Create a value of CreateRouteResponseResponse
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:
CreateRouteResponse
, createRouteResponseResponse_modelSelectionExpression
- Represents the model selection expression of a route response. Supported
only for WebSocket APIs.
CreateRouteResponse
, createRouteResponseResponse_responseModels
- Represents the response models of a route response.
CreateRouteResponse
, createRouteResponseResponse_responseParameters
- Represents the response parameters of a route response.
CreateRouteResponseResponse
, createRouteResponseResponse_routeResponseId
- Represents the identifier of a route response.
CreateRouteResponse
, createRouteResponseResponse_routeResponseKey
- Represents the route response key of a route response.
$sel:httpStatus:CreateRouteResponseResponse'
, createRouteResponseResponse_httpStatus
- The response's http status code.
CreateStage
data CreateStage Source #
Creates a new Stage resource to represent a stage.
See: newCreateStage
smart constructor.
CreateStage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Text) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe (HashMap Text RouteSettings)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text Text |
Instances
Create a value of CreateStage
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:
CreateStage
, createStage_accessLogSettings
- Settings for logging access in this stage.
CreateStage
, createStage_autoDeploy
- Specifies whether updates to an API automatically trigger a new
deployment. The default value is false.
CreateStage
, createStage_clientCertificateId
- The identifier of a client certificate for a Stage. Supported only for
WebSocket APIs.
CreateStage
, createStage_defaultRouteSettings
- The default route settings for the stage.
CreateStage
, createStage_deploymentId
- The deployment identifier of the API stage.
CreateStage
, createStage_description
- The description for the API stage.
CreateStage
, createStage_routeSettings
- Route settings for the stage, by routeKey.
CreateStage
, createStage_stageVariables
- A map that defines the stage variables for a Stage. Variable names can
have alphanumeric and underscore characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+.
CreateStage
, createStage_tags
- The collection of tags. Each tag element is associated with a given
resource.
CreateStage
, createStage_apiId
- The API identifier.
CreateStage
, createStage_stageName
- The name of the stage.
data CreateStageResponse Source #
See: newCreateStageResponse
smart constructor.
CreateStageResponse' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe (HashMap Text RouteSettings)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Int |
Instances
newCreateStageResponse Source #
Create a value of CreateStageResponse
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:
CreateStage
, createStageResponse_accessLogSettings
- Settings for logging access in this stage.
CreateStageResponse
, createStageResponse_apiGatewayManaged
- Specifies whether a stage is managed by API Gateway. If you created an
API using quick create, the $default stage is managed by API Gateway.
You can't modify the $default stage.
CreateStage
, createStageResponse_autoDeploy
- Specifies whether updates to an API automatically trigger a new
deployment. The default value is false.
CreateStage
, createStageResponse_clientCertificateId
- The identifier of a client certificate for a Stage. Supported only for
WebSocket APIs.
CreateStageResponse
, createStageResponse_createdDate
- The timestamp when the stage was created.
CreateStage
, createStageResponse_defaultRouteSettings
- Default route settings for the stage.
CreateStage
, createStageResponse_deploymentId
- The identifier of the Deployment that the Stage is associated with.
Can't be updated if autoDeploy is enabled.
CreateStage
, createStageResponse_description
- The description of the stage.
CreateStageResponse
, createStageResponse_lastDeploymentStatusMessage
- Describes the status of the last deployment of a stage. Supported only
for stages with autoDeploy enabled.
CreateStageResponse
, createStageResponse_lastUpdatedDate
- The timestamp when the stage was last updated.
CreateStage
, createStageResponse_routeSettings
- Route settings for the stage, by routeKey.
CreateStage
, createStageResponse_stageName
- The name of the stage.
CreateStage
, createStageResponse_stageVariables
- 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-._~:/?#&=,]+.
CreateStage
, createStageResponse_tags
- The collection of tags. Each tag element is associated with a given
resource.
$sel:httpStatus:CreateStageResponse'
, createStageResponse_httpStatus
- The response's http status code.
CreateVpcLink
data CreateVpcLink Source #
Creates a VPC link
See: newCreateVpcLink
smart constructor.
Instances
Create a value of CreateVpcLink
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:
CreateVpcLink
, createVpcLink_securityGroupIds
- A list of security group IDs for the VPC link.
CreateVpcLink
, createVpcLink_tags
- A list of tags.
CreateVpcLink
, createVpcLink_subnetIds
- A list of subnet IDs to include in the VPC link.
CreateVpcLink
, createVpcLink_name
- The name of the VPC link.
data CreateVpcLinkResponse Source #
See: newCreateVpcLinkResponse
smart constructor.
CreateVpcLinkResponse' (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe VpcLinkVersion) Int |
Instances
newCreateVpcLinkResponse Source #
Create a value of CreateVpcLinkResponse
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:
CreateVpcLinkResponse
, createVpcLinkResponse_createdDate
- The timestamp when the VPC link was created.
CreateVpcLink
, createVpcLinkResponse_name
- The name of the VPC link.
CreateVpcLink
, createVpcLinkResponse_securityGroupIds
- A list of security group IDs for the VPC link.
CreateVpcLink
, createVpcLinkResponse_subnetIds
- A list of subnet IDs to include in the VPC link.
CreateVpcLink
, createVpcLinkResponse_tags
- Tags for the VPC link.
CreateVpcLinkResponse
, createVpcLinkResponse_vpcLinkId
- The ID of the VPC link.
CreateVpcLinkResponse
, createVpcLinkResponse_vpcLinkStatus
- The status of the VPC link.
CreateVpcLinkResponse
, createVpcLinkResponse_vpcLinkStatusMessage
- A message summarizing the cause of the status of the VPC link.
CreateVpcLinkResponse
, createVpcLinkResponse_vpcLinkVersion
- The version of the VPC link.
$sel:httpStatus:CreateVpcLinkResponse'
, createVpcLinkResponse_httpStatus
- The response's http status code.
DeleteAccessLogSettings
data DeleteAccessLogSettings Source #
See: newDeleteAccessLogSettings
smart constructor.
Instances
newDeleteAccessLogSettings Source #
Create a value of DeleteAccessLogSettings
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:
DeleteAccessLogSettings
, deleteAccessLogSettings_stageName
- The stage name. Stage names can only contain alphanumeric characters,
hyphens, and underscores. Maximum length is 128 characters.
DeleteAccessLogSettings
, deleteAccessLogSettings_apiId
- The API identifier.
data DeleteAccessLogSettingsResponse Source #
See: newDeleteAccessLogSettingsResponse
smart constructor.
Instances
newDeleteAccessLogSettingsResponse :: DeleteAccessLogSettingsResponse Source #
Create a value of DeleteAccessLogSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteApi
See: newDeleteApi
smart constructor.
Instances
Create a value of DeleteApi
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:
DeleteApi
, deleteApi_apiId
- The API identifier.
data DeleteApiResponse Source #
See: newDeleteApiResponse
smart constructor.
Instances
Generic DeleteApiResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApi type Rep DeleteApiResponse :: Type -> Type # from :: DeleteApiResponse -> Rep DeleteApiResponse x # to :: Rep DeleteApiResponse x -> DeleteApiResponse # | |
Read DeleteApiResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApi | |
Show DeleteApiResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApi showsPrec :: Int -> DeleteApiResponse -> ShowS # show :: DeleteApiResponse -> String # showList :: [DeleteApiResponse] -> ShowS # | |
NFData DeleteApiResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApi rnf :: DeleteApiResponse -> () # | |
Eq DeleteApiResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApi (==) :: DeleteApiResponse -> DeleteApiResponse -> Bool # (/=) :: DeleteApiResponse -> DeleteApiResponse -> Bool # | |
type Rep DeleteApiResponse Source # | |
newDeleteApiResponse :: DeleteApiResponse Source #
Create a value of DeleteApiResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteApiMapping
data DeleteApiMapping Source #
See: newDeleteApiMapping
smart constructor.
Instances
Create a value of DeleteApiMapping
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:
DeleteApiMapping
, deleteApiMapping_apiMappingId
- The API mapping identifier.
DeleteApiMapping
, deleteApiMapping_domainName
- The domain name.
data DeleteApiMappingResponse Source #
See: newDeleteApiMappingResponse
smart constructor.
Instances
Generic DeleteApiMappingResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApiMapping type Rep DeleteApiMappingResponse :: Type -> Type # | |
Read DeleteApiMappingResponse Source # | |
Show DeleteApiMappingResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApiMapping showsPrec :: Int -> DeleteApiMappingResponse -> ShowS # show :: DeleteApiMappingResponse -> String # showList :: [DeleteApiMappingResponse] -> ShowS # | |
NFData DeleteApiMappingResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApiMapping rnf :: DeleteApiMappingResponse -> () # | |
Eq DeleteApiMappingResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApiMapping | |
type Rep DeleteApiMappingResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteApiMapping |
newDeleteApiMappingResponse :: DeleteApiMappingResponse Source #
Create a value of DeleteApiMappingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteAuthorizer
data DeleteAuthorizer Source #
See: newDeleteAuthorizer
smart constructor.
Instances
Create a value of DeleteAuthorizer
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:
DeleteAuthorizer
, deleteAuthorizer_authorizerId
- The authorizer identifier.
DeleteAuthorizer
, deleteAuthorizer_apiId
- The API identifier.
data DeleteAuthorizerResponse Source #
See: newDeleteAuthorizerResponse
smart constructor.
Instances
Generic DeleteAuthorizerResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteAuthorizer type Rep DeleteAuthorizerResponse :: Type -> Type # | |
Read DeleteAuthorizerResponse Source # | |
Show DeleteAuthorizerResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteAuthorizer showsPrec :: Int -> DeleteAuthorizerResponse -> ShowS # show :: DeleteAuthorizerResponse -> String # showList :: [DeleteAuthorizerResponse] -> ShowS # | |
NFData DeleteAuthorizerResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteAuthorizer rnf :: DeleteAuthorizerResponse -> () # | |
Eq DeleteAuthorizerResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteAuthorizer | |
type Rep DeleteAuthorizerResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteAuthorizer |
newDeleteAuthorizerResponse :: DeleteAuthorizerResponse Source #
Create a value of DeleteAuthorizerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteCorsConfiguration
data DeleteCorsConfiguration Source #
See: newDeleteCorsConfiguration
smart constructor.
Instances
newDeleteCorsConfiguration Source #
Create a value of DeleteCorsConfiguration
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:
DeleteCorsConfiguration
, deleteCorsConfiguration_apiId
- The API identifier.
data DeleteCorsConfigurationResponse Source #
See: newDeleteCorsConfigurationResponse
smart constructor.
Instances
newDeleteCorsConfigurationResponse :: DeleteCorsConfigurationResponse Source #
Create a value of DeleteCorsConfigurationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDeployment
data DeleteDeployment Source #
See: newDeleteDeployment
smart constructor.
Instances
Create a value of DeleteDeployment
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:
DeleteDeployment
, deleteDeployment_apiId
- The API identifier.
DeleteDeployment
, deleteDeployment_deploymentId
- The deployment ID.
data DeleteDeploymentResponse Source #
See: newDeleteDeploymentResponse
smart constructor.
Instances
Generic DeleteDeploymentResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDeployment type Rep DeleteDeploymentResponse :: Type -> Type # | |
Read DeleteDeploymentResponse Source # | |
Show DeleteDeploymentResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDeployment showsPrec :: Int -> DeleteDeploymentResponse -> ShowS # show :: DeleteDeploymentResponse -> String # showList :: [DeleteDeploymentResponse] -> ShowS # | |
NFData DeleteDeploymentResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDeployment rnf :: DeleteDeploymentResponse -> () # | |
Eq DeleteDeploymentResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDeployment | |
type Rep DeleteDeploymentResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDeployment |
newDeleteDeploymentResponse :: DeleteDeploymentResponse Source #
Create a value of DeleteDeploymentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteDomainName
data DeleteDomainName Source #
See: newDeleteDomainName
smart constructor.
Instances
Create a value of DeleteDomainName
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:
DeleteDomainName
, deleteDomainName_domainName
- The domain name.
data DeleteDomainNameResponse Source #
See: newDeleteDomainNameResponse
smart constructor.
Instances
Generic DeleteDomainNameResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDomainName type Rep DeleteDomainNameResponse :: Type -> Type # | |
Read DeleteDomainNameResponse Source # | |
Show DeleteDomainNameResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDomainName showsPrec :: Int -> DeleteDomainNameResponse -> ShowS # show :: DeleteDomainNameResponse -> String # showList :: [DeleteDomainNameResponse] -> ShowS # | |
NFData DeleteDomainNameResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDomainName rnf :: DeleteDomainNameResponse -> () # | |
Eq DeleteDomainNameResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDomainName | |
type Rep DeleteDomainNameResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteDomainName |
newDeleteDomainNameResponse :: DeleteDomainNameResponse Source #
Create a value of DeleteDomainNameResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteIntegration
data DeleteIntegration Source #
See: newDeleteIntegration
smart constructor.
Instances
Create a value of DeleteIntegration
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:
DeleteIntegration
, deleteIntegration_apiId
- The API identifier.
DeleteIntegration
, deleteIntegration_integrationId
- The integration ID.
data DeleteIntegrationResponse' Source #
See: newDeleteIntegrationResponse'
smart constructor.
Instances
newDeleteIntegrationResponse' :: DeleteIntegrationResponse' Source #
Create a value of DeleteIntegrationResponse'
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteIntegrationResponse
data DeleteIntegrationResponse Source #
See: newDeleteIntegrationResponse
smart constructor.
Instances
newDeleteIntegrationResponse Source #
:: Text | |
-> Text | |
-> Text | |
-> DeleteIntegrationResponse |
Create a value of DeleteIntegrationResponse
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:
DeleteIntegrationResponse
, deleteIntegrationResponse_apiId
- The API identifier.
DeleteIntegrationResponse
, deleteIntegrationResponse_integrationResponseId
- The integration response ID.
DeleteIntegrationResponse
, deleteIntegrationResponse_integrationId
- The integration ID.
data DeleteIntegrationResponseResponse Source #
See: newDeleteIntegrationResponseResponse
smart constructor.
Instances
newDeleteIntegrationResponseResponse :: DeleteIntegrationResponseResponse Source #
Create a value of DeleteIntegrationResponseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteModel
data DeleteModel Source #
See: newDeleteModel
smart constructor.
Instances
Create a value of DeleteModel
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:
DeleteModel
, deleteModel_modelId
- The model ID.
DeleteModel
, deleteModel_apiId
- The API identifier.
data DeleteModelResponse Source #
See: newDeleteModelResponse
smart constructor.
Instances
Generic DeleteModelResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteModel type Rep DeleteModelResponse :: Type -> Type # from :: DeleteModelResponse -> Rep DeleteModelResponse x # to :: Rep DeleteModelResponse x -> DeleteModelResponse # | |
Read DeleteModelResponse Source # | |
Show DeleteModelResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteModel showsPrec :: Int -> DeleteModelResponse -> ShowS # show :: DeleteModelResponse -> String # showList :: [DeleteModelResponse] -> ShowS # | |
NFData DeleteModelResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteModel rnf :: DeleteModelResponse -> () # | |
Eq DeleteModelResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteModel (==) :: DeleteModelResponse -> DeleteModelResponse -> Bool # (/=) :: DeleteModelResponse -> DeleteModelResponse -> Bool # | |
type Rep DeleteModelResponse Source # | |
newDeleteModelResponse :: DeleteModelResponse Source #
Create a value of DeleteModelResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteRoute
data DeleteRoute Source #
See: newDeleteRoute
smart constructor.
Instances
Create a value of DeleteRoute
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:
DeleteRoute
, deleteRoute_apiId
- The API identifier.
DeleteRoute
, deleteRoute_routeId
- The route ID.
data DeleteRouteResponse' Source #
See: newDeleteRouteResponse'
smart constructor.
Instances
Generic DeleteRouteResponse' Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteRoute type Rep DeleteRouteResponse' :: Type -> Type # from :: DeleteRouteResponse' -> Rep DeleteRouteResponse' x # to :: Rep DeleteRouteResponse' x -> DeleteRouteResponse' # | |
Read DeleteRouteResponse' Source # | |
Show DeleteRouteResponse' Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteRoute showsPrec :: Int -> DeleteRouteResponse' -> ShowS # show :: DeleteRouteResponse' -> String # showList :: [DeleteRouteResponse'] -> ShowS # | |
NFData DeleteRouteResponse' Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteRoute rnf :: DeleteRouteResponse' -> () # | |
Eq DeleteRouteResponse' Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteRoute (==) :: DeleteRouteResponse' -> DeleteRouteResponse' -> Bool # (/=) :: DeleteRouteResponse' -> DeleteRouteResponse' -> Bool # | |
type Rep DeleteRouteResponse' Source # | |
newDeleteRouteResponse' :: DeleteRouteResponse' Source #
Create a value of DeleteRouteResponse'
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteRouteRequestParameter
data DeleteRouteRequestParameter Source #
See: newDeleteRouteRequestParameter
smart constructor.
Instances
newDeleteRouteRequestParameter Source #
:: Text | |
-> Text | |
-> Text | |
-> DeleteRouteRequestParameter |
Create a value of DeleteRouteRequestParameter
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:requestParameterKey:DeleteRouteRequestParameter'
, deleteRouteRequestParameter_requestParameterKey
- The route request parameter key.
DeleteRouteRequestParameter
, deleteRouteRequestParameter_apiId
- The API identifier.
DeleteRouteRequestParameter
, deleteRouteRequestParameter_routeId
- The route ID.
data DeleteRouteRequestParameterResponse Source #
See: newDeleteRouteRequestParameterResponse
smart constructor.
Instances
Generic DeleteRouteRequestParameterResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteRouteRequestParameter type Rep DeleteRouteRequestParameterResponse :: Type -> Type # | |
Read DeleteRouteRequestParameterResponse Source # | |
Show DeleteRouteRequestParameterResponse Source # | |
NFData DeleteRouteRequestParameterResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteRouteRequestParameter rnf :: DeleteRouteRequestParameterResponse -> () # | |
Eq DeleteRouteRequestParameterResponse Source # | |
type Rep DeleteRouteRequestParameterResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteRouteRequestParameter type Rep DeleteRouteRequestParameterResponse = D1 ('MetaData "DeleteRouteRequestParameterResponse" "Amazonka.ApiGatewayV2.DeleteRouteRequestParameter" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "DeleteRouteRequestParameterResponse'" 'PrefixI 'False) (U1 :: Type -> Type)) |
newDeleteRouteRequestParameterResponse :: DeleteRouteRequestParameterResponse Source #
Create a value of DeleteRouteRequestParameterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteRouteResponse
data DeleteRouteResponse Source #
See: newDeleteRouteResponse
smart constructor.
Instances
newDeleteRouteResponse Source #
:: Text | |
-> Text | |
-> Text | |
-> DeleteRouteResponse |
Create a value of DeleteRouteResponse
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:
DeleteRouteResponse
, deleteRouteResponse_routeResponseId
- The route response ID.
DeleteRouteResponse
, deleteRouteResponse_apiId
- The API identifier.
DeleteRouteResponse
, deleteRouteResponse_routeId
- The route ID.
data DeleteRouteResponseResponse Source #
See: newDeleteRouteResponseResponse
smart constructor.
Instances
newDeleteRouteResponseResponse :: DeleteRouteResponseResponse Source #
Create a value of DeleteRouteResponseResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteRouteSettings
data DeleteRouteSettings Source #
See: newDeleteRouteSettings
smart constructor.
Instances
newDeleteRouteSettings Source #
:: Text | |
-> Text | |
-> Text | |
-> DeleteRouteSettings |
Create a value of DeleteRouteSettings
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:
DeleteRouteSettings
, deleteRouteSettings_stageName
- The stage name. Stage names can only contain alphanumeric characters,
hyphens, and underscores. Maximum length is 128 characters.
DeleteRouteSettings
, deleteRouteSettings_routeKey
- The route key.
DeleteRouteSettings
, deleteRouteSettings_apiId
- The API identifier.
data DeleteRouteSettingsResponse Source #
See: newDeleteRouteSettingsResponse
smart constructor.
Instances
newDeleteRouteSettingsResponse :: DeleteRouteSettingsResponse Source #
Create a value of DeleteRouteSettingsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteStage
data DeleteStage Source #
See: newDeleteStage
smart constructor.
Instances
Create a value of DeleteStage
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:
DeleteStage
, deleteStage_stageName
- The stage name. Stage names can only contain alphanumeric characters,
hyphens, and underscores. Maximum length is 128 characters.
DeleteStage
, deleteStage_apiId
- The API identifier.
data DeleteStageResponse Source #
See: newDeleteStageResponse
smart constructor.
Instances
Generic DeleteStageResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteStage type Rep DeleteStageResponse :: Type -> Type # from :: DeleteStageResponse -> Rep DeleteStageResponse x # to :: Rep DeleteStageResponse x -> DeleteStageResponse # | |
Read DeleteStageResponse Source # | |
Show DeleteStageResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteStage showsPrec :: Int -> DeleteStageResponse -> ShowS # show :: DeleteStageResponse -> String # showList :: [DeleteStageResponse] -> ShowS # | |
NFData DeleteStageResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteStage rnf :: DeleteStageResponse -> () # | |
Eq DeleteStageResponse Source # | |
Defined in Amazonka.ApiGatewayV2.DeleteStage (==) :: DeleteStageResponse -> DeleteStageResponse -> Bool # (/=) :: DeleteStageResponse -> DeleteStageResponse -> Bool # | |
type Rep DeleteStageResponse Source # | |
newDeleteStageResponse :: DeleteStageResponse Source #
Create a value of DeleteStageResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteVpcLink
data DeleteVpcLink Source #
See: newDeleteVpcLink
smart constructor.
Instances
Create a value of DeleteVpcLink
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:
DeleteVpcLink
, deleteVpcLink_vpcLinkId
- The ID of the VPC link.
data DeleteVpcLinkResponse Source #
See: newDeleteVpcLinkResponse
smart constructor.
Instances
newDeleteVpcLinkResponse Source #
Create a value of DeleteVpcLinkResponse
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:httpStatus:DeleteVpcLinkResponse'
, deleteVpcLinkResponse_httpStatus
- The response's http status code.
ExportApi
See: newExportApi
smart constructor.
Instances
Create a value of ExportApi
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:exportVersion:ExportApi'
, exportApi_exportVersion
- The version of the API Gateway export algorithm. API Gateway uses the
latest version by default. Currently, the only supported version is 1.0.
$sel:includeExtensions:ExportApi'
, exportApi_includeExtensions
- Specifies whether to include
API Gateway extensions
in the exported API definition. API Gateway extensions are included by
default.
ExportApi
, exportApi_stageName
- The name of the API stage to export. If you don't specify this
property, a representation of the latest API configuration is exported.
$sel:specification:ExportApi'
, exportApi_specification
- The version of the API specification to use. OAS30, for OpenAPI 3.0, is
the only supported value.
$sel:outputType:ExportApi'
, exportApi_outputType
- The output type of the exported definition file. Valid values are JSON
and YAML.
ExportApi
, exportApi_apiId
- The API identifier.
data ExportApiResponse Source #
See: newExportApiResponse
smart constructor.
Instances
Create a value of ExportApiResponse
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:body:ExportApiResponse'
, exportApiResponse_body
- Undocumented member.
$sel:httpStatus:ExportApiResponse'
, exportApiResponse_httpStatus
- The response's http status code.
GetApi
See: newGetApi
smart constructor.
Instances
ToHeaders GetApi Source # | |
Defined in Amazonka.ApiGatewayV2.GetApi | |
ToPath GetApi Source # | |
Defined in Amazonka.ApiGatewayV2.GetApi toPath :: GetApi -> ByteString # | |
ToQuery GetApi Source # | |
Defined in Amazonka.ApiGatewayV2.GetApi toQuery :: GetApi -> QueryString # | |
AWSRequest GetApi Source # | |
Defined in Amazonka.ApiGatewayV2.GetApi type AWSResponse GetApi # request :: (Service -> Service) -> GetApi -> Request GetApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetApi))) # | |
Generic GetApi Source # | |
Read GetApi Source # | |
Show GetApi Source # | |
NFData GetApi Source # | |
Defined in Amazonka.ApiGatewayV2.GetApi | |
Eq GetApi Source # | |
Hashable GetApi Source # | |
Defined in Amazonka.ApiGatewayV2.GetApi | |
type AWSResponse GetApi Source # | |
Defined in Amazonka.ApiGatewayV2.GetApi | |
type Rep GetApi Source # | |
Defined in Amazonka.ApiGatewayV2.GetApi |
Create a value of GetApi
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:
GetApi
, getApi_apiId
- The API identifier.
data GetApiResponse Source #
See: newGetApiResponse
smart constructor.
GetApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int |
Instances
Create a value of GetApiResponse
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:
GetApiResponse
, getApiResponse_apiEndpoint
- The URI of the API, of the form
{api-id}.execute-api.{region}.amazonaws.com. The stage name is typically
appended to this URI to form a complete path to a deployed API stage.
GetApiResponse
, getApiResponse_apiGatewayManaged
- Specifies whether an API is managed by API Gateway. You can't update or
delete a managed API by using API Gateway. A managed API can be deleted
only through the tooling or service that created it.
GetApi
, getApiResponse_apiId
- The API ID.
GetApiResponse
, getApiResponse_apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
GetApiResponse
, getApiResponse_corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.
GetApiResponse
, getApiResponse_createdDate
- The timestamp when the API was created.
GetApiResponse
, getApiResponse_description
- The description of the API.
GetApiResponse
, getApiResponse_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.
GetApiResponse
, getApiResponse_disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
GetApiResponse
, getApiResponse_importInfo
- The validation information during API import. This may include
particular properties of your OpenAPI definition which are ignored
during import. Supported only for HTTP APIs.
GetApiResponse
, getApiResponse_name
- The name of the API.
GetApiResponse
, getApiResponse_protocolType
- The API protocol.
GetApiResponse
, getApiResponse_routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.
GetApiResponse
, getApiResponse_tags
- A collection of tags associated with the API.
GetApiResponse
, getApiResponse_version
- A version identifier for the API.
GetApiResponse
, getApiResponse_warnings
- The warning messages reported when failonwarnings is turned on during
API import.
$sel:httpStatus:GetApiResponse'
, getApiResponse_httpStatus
- The response's http status code.
GetApiMapping
data GetApiMapping Source #
See: newGetApiMapping
smart constructor.
Instances
Create a value of GetApiMapping
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:
GetApiMapping
, getApiMapping_apiMappingId
- The API mapping identifier.
GetApiMapping
, getApiMapping_domainName
- The domain name.
data GetApiMappingResponse Source #
See: newGetApiMappingResponse
smart constructor.
Instances
newGetApiMappingResponse Source #
Create a value of GetApiMappingResponse
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:
GetApiMappingResponse
, getApiMappingResponse_apiId
- The API identifier.
GetApiMapping
, getApiMappingResponse_apiMappingId
- The API mapping identifier.
GetApiMappingResponse
, getApiMappingResponse_apiMappingKey
- The API mapping key.
GetApiMappingResponse
, getApiMappingResponse_stage
- The API stage.
$sel:httpStatus:GetApiMappingResponse'
, getApiMappingResponse_httpStatus
- The response's http status code.
GetApiMappings
data GetApiMappings Source #
See: newGetApiMappings
smart constructor.
Instances
Create a value of GetApiMappings
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:maxResults:GetApiMappings'
, getApiMappings_maxResults
- The maximum number of elements to be returned for this resource.
GetApiMappings
, getApiMappings_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
GetApiMappings
, getApiMappings_domainName
- The domain name.
data GetApiMappingsResponse Source #
See: newGetApiMappingsResponse
smart constructor.
Instances
newGetApiMappingsResponse Source #
Create a value of GetApiMappingsResponse
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:items:GetApiMappingsResponse'
, getApiMappingsResponse_items
- The elements from this collection.
GetApiMappings
, getApiMappingsResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetApiMappingsResponse'
, getApiMappingsResponse_httpStatus
- The response's http status code.
GetApis (Paginated)
See: newGetApis
smart constructor.
Instances
newGetApis :: GetApis Source #
Create a value of GetApis
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:maxResults:GetApis'
, getApis_maxResults
- The maximum number of elements to be returned for this resource.
GetApis
, getApis_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
data GetApisResponse Source #
See: newGetApisResponse
smart constructor.
Instances
Create a value of GetApisResponse
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:items:GetApisResponse'
, getApisResponse_items
- The elements from this collection.
GetApis
, getApisResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetApisResponse'
, getApisResponse_httpStatus
- The response's http status code.
GetAuthorizer
data GetAuthorizer Source #
See: newGetAuthorizer
smart constructor.
Instances
Create a value of GetAuthorizer
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:
GetAuthorizer
, getAuthorizer_authorizerId
- The authorizer identifier.
GetAuthorizer
, getAuthorizer_apiId
- The API identifier.
data GetAuthorizerResponse Source #
See: newGetAuthorizerResponse
smart constructor.
GetAuthorizerResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) (Maybe Text) Int |
Instances
newGetAuthorizerResponse Source #
Create a value of GetAuthorizerResponse
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:
GetAuthorizerResponse
, getAuthorizerResponse_authorizerCredentialsArn
- 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, don't specify this parameter.
Supported only for REQUEST authorizers.
GetAuthorizer
, getAuthorizerResponse_authorizerId
- The authorizer identifier.
GetAuthorizerResponse
, getAuthorizerResponse_authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda
authorizer. Required for HTTP API Lambda authorizers. Supported values
are 1.0 and 2.0. To learn more, see
Working with AWS Lambda authorizers for HTTP APIs.
GetAuthorizerResponse
, getAuthorizerResponse_authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. If it
equals 0, authorization caching is disabled. If it is greater than 0,
API Gateway caches authorizer responses. The maximum value is 3600, or 1
hour. Supported only for HTTP API Lambda authorizers.
GetAuthorizerResponse
, getAuthorizerResponse_authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using
incoming request parameters. Specify JWT to use JSON Web Tokens
(supported only for HTTP APIs).
GetAuthorizerResponse
, getAuthorizerResponse_authorizerUri
- The authorizer's Uniform Resource Identifier (URI). For 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.
Supported only for REQUEST authorizers.
GetAuthorizerResponse
, getAuthorizerResponse_enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple
format. If enabled, the Lambda authorizer can return a boolean value
instead of an IAM policy. Supported only for HTTP APIs. To learn more,
see
Working with AWS Lambda authorizers for HTTP APIs
GetAuthorizerResponse
, getAuthorizerResponse_identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
GetAuthorizerResponse
, getAuthorizerResponse_identityValidationExpression
- The validation expression does not apply to the REQUEST authorizer.
GetAuthorizerResponse
, getAuthorizerResponse_jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT
authorizer type. Supported only for HTTP APIs.
GetAuthorizerResponse
, getAuthorizerResponse_name
- The name of the authorizer.
$sel:httpStatus:GetAuthorizerResponse'
, getAuthorizerResponse_httpStatus
- The response's http status code.
GetAuthorizers (Paginated)
data GetAuthorizers Source #
See: newGetAuthorizers
smart constructor.
Instances
Create a value of GetAuthorizers
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:maxResults:GetAuthorizers'
, getAuthorizers_maxResults
- The maximum number of elements to be returned for this resource.
GetAuthorizers
, getAuthorizers_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
GetAuthorizers
, getAuthorizers_apiId
- The API identifier.
data GetAuthorizersResponse Source #
See: newGetAuthorizersResponse
smart constructor.
Instances
newGetAuthorizersResponse Source #
Create a value of GetAuthorizersResponse
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:items:GetAuthorizersResponse'
, getAuthorizersResponse_items
- The elements from this collection.
GetAuthorizers
, getAuthorizersResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetAuthorizersResponse'
, getAuthorizersResponse_httpStatus
- The response's http status code.
GetDeployment
data GetDeployment Source #
See: newGetDeployment
smart constructor.
Instances
Create a value of GetDeployment
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:
GetDeployment
, getDeployment_apiId
- The API identifier.
GetDeployment
, getDeployment_deploymentId
- The deployment ID.
data GetDeploymentResponse Source #
See: newGetDeploymentResponse
smart constructor.
GetDeploymentResponse' (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe DeploymentStatus) (Maybe Text) (Maybe Text) Int |
Instances
newGetDeploymentResponse Source #
Create a value of GetDeploymentResponse
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:
GetDeploymentResponse
, getDeploymentResponse_autoDeployed
- Specifies whether a deployment was automatically released.
GetDeploymentResponse
, getDeploymentResponse_createdDate
- The date and time when the Deployment resource was created.
GetDeployment
, getDeploymentResponse_deploymentId
- The identifier for the deployment.
GetDeploymentResponse
, getDeploymentResponse_deploymentStatus
- The status of the deployment: PENDING, FAILED, or SUCCEEDED.
GetDeploymentResponse
, getDeploymentResponse_deploymentStatusMessage
- May contain additional feedback on the status of an API deployment.
GetDeploymentResponse
, getDeploymentResponse_description
- The description for the deployment.
$sel:httpStatus:GetDeploymentResponse'
, getDeploymentResponse_httpStatus
- The response's http status code.
GetDeployments (Paginated)
data GetDeployments Source #
See: newGetDeployments
smart constructor.
Instances
Create a value of GetDeployments
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:maxResults:GetDeployments'
, getDeployments_maxResults
- The maximum number of elements to be returned for this resource.
GetDeployments
, getDeployments_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
GetDeployments
, getDeployments_apiId
- The API identifier.
data GetDeploymentsResponse Source #
See: newGetDeploymentsResponse
smart constructor.
Instances
newGetDeploymentsResponse Source #
Create a value of GetDeploymentsResponse
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:items:GetDeploymentsResponse'
, getDeploymentsResponse_items
- The elements from this collection.
GetDeployments
, getDeploymentsResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetDeploymentsResponse'
, getDeploymentsResponse_httpStatus
- The response's http status code.
GetDomainName
data GetDomainName Source #
See: newGetDomainName
smart constructor.
Instances
Create a value of GetDomainName
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:
GetDomainName
, getDomainName_domainName
- The domain name.
data GetDomainNameResponse Source #
See: newGetDomainNameResponse
smart constructor.
GetDomainNameResponse' (Maybe Text) (Maybe Text) (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthentication) (Maybe (HashMap Text Text)) Int |
Instances
newGetDomainNameResponse Source #
Create a value of GetDomainNameResponse
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:
GetDomainNameResponse
, getDomainNameResponse_apiMappingSelectionExpression
- The API mapping selection expression.
GetDomainName
, getDomainNameResponse_domainName
- The name of the DomainName resource.
GetDomainNameResponse
, getDomainNameResponse_domainNameConfigurations
- The domain name configurations.
GetDomainNameResponse
, getDomainNameResponse_mutualTlsAuthentication
- The mutual TLS authentication configuration for a custom domain name.
GetDomainNameResponse
, getDomainNameResponse_tags
- The collection of tags associated with a domain name.
$sel:httpStatus:GetDomainNameResponse'
, getDomainNameResponse_httpStatus
- The response's http status code.
GetDomainNames (Paginated)
data GetDomainNames Source #
See: newGetDomainNames
smart constructor.
Instances
newGetDomainNames :: GetDomainNames Source #
Create a value of GetDomainNames
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:maxResults:GetDomainNames'
, getDomainNames_maxResults
- The maximum number of elements to be returned for this resource.
GetDomainNames
, getDomainNames_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
data GetDomainNamesResponse Source #
See: newGetDomainNamesResponse
smart constructor.
Instances
newGetDomainNamesResponse Source #
Create a value of GetDomainNamesResponse
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:items:GetDomainNamesResponse'
, getDomainNamesResponse_items
- The elements from this collection.
GetDomainNames
, getDomainNamesResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetDomainNamesResponse'
, getDomainNamesResponse_httpStatus
- The response's http status code.
GetIntegration
data GetIntegration Source #
See: newGetIntegration
smart constructor.
Instances
Create a value of GetIntegration
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:
GetIntegration
, getIntegration_apiId
- The API identifier.
GetIntegration
, getIntegration_integrationId
- The integration ID.
data GetIntegrationResponse' Source #
See: newGetIntegrationResponse'
smart constructor.
GetIntegrationResponse'' (Maybe Bool) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfig) Int |
Instances
newGetIntegrationResponse' Source #
Create a value of GetIntegrationResponse'
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:
GetIntegrationResponse'
, getIntegrationResponse'_apiGatewayManaged
- Specifies whether an integration is managed by API Gateway. If you
created an API using using quick create, the resulting integration is
managed by API Gateway. You can update a managed integration, but you
can't delete it.
GetIntegrationResponse'
, getIntegrationResponse'_connectionId
- The ID of the VPC link for a private integration. Supported only for
HTTP APIs.
GetIntegrationResponse'
, getIntegrationResponse'_connectionType
- The type of the network connection to the integration endpoint. Specify
INTERNET for connections through the public routable internet or
VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.
GetIntegrationResponse'
, getIntegrationResponse'_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
GetIntegrationResponse'
, getIntegrationResponse'_credentialsArn
- 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.
GetIntegrationResponse'
, getIntegrationResponse'_description
- Represents the description of an integration.
GetIntegration
, getIntegrationResponse'_integrationId
- Represents the identifier of an integration.
GetIntegrationResponse'
, getIntegrationResponse'_integrationMethod
- Specifies the integration's HTTP method type.
GetIntegrationResponse'
, getIntegrationResponse'_integrationResponseSelectionExpression
- The integration response selection expression for the integration.
Supported only for WebSocket APIs. See
Integration Response Selection Expressions.
GetIntegrationResponse'
, getIntegrationResponse'_integrationSubtype
- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS
service action to invoke. To learn more, see
Integration subtype reference.
GetIntegrationResponse'
, getIntegrationResponse'_integrationType
- The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
GetIntegrationResponse'
, getIntegrationResponse'_integrationUri
- For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
GetIntegrationResponse'
, getIntegrationResponse'_passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the
Content-Type header in the request, and the available mapping templates
specified as the requestTemplates property on the Integration resource.
There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
GetIntegrationResponse'
, getIntegrationResponse'_payloadFormatVersion
- Specifies the format of the payload sent to an integration. Required for
HTTP APIs.
GetIntegrationResponse'
, getIntegrationResponse'_requestParameters
- For WebSocket APIs, a key-value map specifying request parameters that
are passed from the method request to the backend. 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 backend. 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.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
GetIntegrationResponse'
, getIntegrationResponse'_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. Supported only for WebSocket APIs.
GetIntegrationResponse'
, getIntegrationResponse'_responseParameters
- Supported only for HTTP APIs. You use response parameters to transform
the HTTP response from a backend integration before returning the
response to clients. Specify a key-value map from a selection key to
response parameters. The selection key must be a valid HTTP status code
within the range of 200-599. Response parameters are a key-value map.
The key must match pattern <action>:<header>.<location> or
overwrite.statuscode. The action can be append, overwrite or remove. The
value can be a static value, or map to response data, stage variables,
or context variables that are evaluated at runtime. To learn more, see
Transforming API requests and responses.
GetIntegrationResponse'
, getIntegrationResponse'_templateSelectionExpression
- The template selection expression for the integration. Supported only
for WebSocket APIs.
GetIntegrationResponse'
, getIntegrationResponse'_timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and
between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is
29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
GetIntegrationResponse'
, getIntegrationResponse'_tlsConfig
- The TLS configuration for a private integration. If you specify a TLS
configuration, private integration traffic uses the HTTPS protocol.
Supported only for HTTP APIs.
$sel:httpStatus:GetIntegrationResponse''
, getIntegrationResponse'_httpStatus
- The response's http status code.
GetIntegrationResponse
data GetIntegrationResponse Source #
See: newGetIntegrationResponse
smart constructor.
Instances
newGetIntegrationResponse Source #
:: Text | |
-> Text | |
-> Text | |
-> GetIntegrationResponse |
Create a value of GetIntegrationResponse
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:
GetIntegrationResponse
, getIntegrationResponse_apiId
- The API identifier.
GetIntegrationResponse
, getIntegrationResponse_integrationResponseId
- The integration response ID.
GetIntegrationResponse
, getIntegrationResponse_integrationId
- The integration ID.
data GetIntegrationResponseResponse Source #
See: newGetIntegrationResponseResponse
smart constructor.
GetIntegrationResponseResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int |
Instances
newGetIntegrationResponseResponse Source #
Create a value of GetIntegrationResponseResponse
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:
GetIntegrationResponseResponse
, getIntegrationResponseResponse_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
GetIntegrationResponse
, getIntegrationResponseResponse_integrationResponseId
- The integration response ID.
GetIntegrationResponseResponse
, getIntegrationResponseResponse_integrationResponseKey
- The integration response key.
GetIntegrationResponseResponse
, getIntegrationResponseResponse_responseParameters
- A key-value map specifying response parameters that are passed to the
method response from the backend. 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.
GetIntegrationResponseResponse
, getIntegrationResponseResponse_responseTemplates
- The collection of response templates for the integration response as a
string-to-string map of key-value pairs. Response templates are
represented as a key/value map, with a content-type as the key and a
template as the value.
GetIntegrationResponseResponse
, getIntegrationResponseResponse_templateSelectionExpression
- The template selection expressions for the integration response.
$sel:httpStatus:GetIntegrationResponseResponse'
, getIntegrationResponseResponse_httpStatus
- The response's http status code.
GetIntegrationResponses (Paginated)
data GetIntegrationResponses Source #
See: newGetIntegrationResponses
smart constructor.
Instances
newGetIntegrationResponses Source #
Create a value of GetIntegrationResponses
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:maxResults:GetIntegrationResponses'
, getIntegrationResponses_maxResults
- The maximum number of elements to be returned for this resource.
GetIntegrationResponses
, getIntegrationResponses_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
GetIntegrationResponses
, getIntegrationResponses_integrationId
- The integration ID.
GetIntegrationResponses
, getIntegrationResponses_apiId
- The API identifier.
data GetIntegrationResponsesResponse Source #
See: newGetIntegrationResponsesResponse
smart constructor.
Instances
newGetIntegrationResponsesResponse Source #
Create a value of GetIntegrationResponsesResponse
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:items:GetIntegrationResponsesResponse'
, getIntegrationResponsesResponse_items
- The elements from this collection.
GetIntegrationResponses
, getIntegrationResponsesResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetIntegrationResponsesResponse'
, getIntegrationResponsesResponse_httpStatus
- The response's http status code.
GetIntegrations (Paginated)
data GetIntegrations Source #
See: newGetIntegrations
smart constructor.
Instances
Create a value of GetIntegrations
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:maxResults:GetIntegrations'
, getIntegrations_maxResults
- The maximum number of elements to be returned for this resource.
GetIntegrations
, getIntegrations_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
GetIntegrations
, getIntegrations_apiId
- The API identifier.
data GetIntegrationsResponse Source #
See: newGetIntegrationsResponse
smart constructor.
Instances
newGetIntegrationsResponse Source #
Create a value of GetIntegrationsResponse
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:items:GetIntegrationsResponse'
, getIntegrationsResponse_items
- The elements from this collection.
GetIntegrations
, getIntegrationsResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetIntegrationsResponse'
, getIntegrationsResponse_httpStatus
- The response's http status code.
GetModel
See: newGetModel
smart constructor.
Instances
Create a value of GetModel
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:
GetModel
, getModel_modelId
- The model ID.
GetModel
, getModel_apiId
- The API identifier.
data GetModelResponse Source #
See: newGetModelResponse
smart constructor.
Instances
Create a value of GetModelResponse
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:
GetModelResponse
, getModelResponse_contentType
- The content-type for the model, for example, "application/json".
GetModelResponse
, getModelResponse_description
- The description of the model.
GetModel
, getModelResponse_modelId
- The model identifier.
GetModelResponse
, getModelResponse_name
- The name of the model. Must be alphanumeric.
GetModelResponse
, getModelResponse_schema
- The schema for the model. For application/json models, this should be
JSON schema draft 4 model.
$sel:httpStatus:GetModelResponse'
, getModelResponse_httpStatus
- The response's http status code.
GetModelTemplate
data GetModelTemplate Source #
See: newGetModelTemplate
smart constructor.
Instances
Create a value of GetModelTemplate
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:
GetModelTemplate
, getModelTemplate_modelId
- The model ID.
GetModelTemplate
, getModelTemplate_apiId
- The API identifier.
data GetModelTemplateResponse Source #
See: newGetModelTemplateResponse
smart constructor.
Instances
newGetModelTemplateResponse Source #
Create a value of GetModelTemplateResponse
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:value:GetModelTemplateResponse'
, getModelTemplateResponse_value
- The template value.
$sel:httpStatus:GetModelTemplateResponse'
, getModelTemplateResponse_httpStatus
- The response's http status code.
GetModels (Paginated)
See: newGetModels
smart constructor.
Instances
Create a value of GetModels
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:maxResults:GetModels'
, getModels_maxResults
- The maximum number of elements to be returned for this resource.
GetModels
, getModels_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
GetModels
, getModels_apiId
- The API identifier.
data GetModelsResponse Source #
See: newGetModelsResponse
smart constructor.
Instances
Create a value of GetModelsResponse
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:items:GetModelsResponse'
, getModelsResponse_items
- The elements from this collection.
GetModels
, getModelsResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetModelsResponse'
, getModelsResponse_httpStatus
- The response's http status code.
GetRoute
See: newGetRoute
smart constructor.
Instances
Create a value of GetRoute
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:
GetRoute
, getRoute_apiId
- The API identifier.
GetRoute
, getRoute_routeId
- The route ID.
data GetRouteResponse' Source #
See: newGetRouteResponse'
smart constructor.
GetRouteResponse'' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
Create a value of GetRouteResponse'
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:
GetRouteResponse'
, getRouteResponse'_apiGatewayManaged
- Specifies whether a route is managed by API Gateway. If you created an
API using quick create, the $default route is managed by API Gateway.
You can't modify the $default route key.
GetRouteResponse'
, getRouteResponse'_apiKeyRequired
- Specifies whether an API key is required for this route. Supported only
for WebSocket APIs.
GetRouteResponse'
, getRouteResponse'_authorizationScopes
- A list of authorization scopes configured on a route. The scopes are
used with a JWT authorizer to authorize the method invocation. The
authorization works by matching the route scopes against the scopes
parsed from the access token in the incoming request. The method
invocation is authorized if any route scope matches a claimed scope in
the access token. Otherwise, the invocation is not authorized. When the
route scope is configured, the client must provide an access token
instead of an identity token for authorization purposes.
GetRouteResponse'
, getRouteResponse'_authorizationType
- The authorization type for the route. For WebSocket APIs, valid values
are NONE for open access, AWS_IAM for using AWS IAM permissions, and
CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are
NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using
AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
GetRouteResponse'
, getRouteResponse'_authorizerId
- The identifier of the Authorizer resource to be associated with this
route. The authorizer identifier is generated by API Gateway when you
created the authorizer.
GetRouteResponse'
, getRouteResponse'_modelSelectionExpression
- The model selection expression for the route. Supported only for
WebSocket APIs.
GetRouteResponse'
, getRouteResponse'_operationName
- The operation name for the route.
GetRouteResponse'
, getRouteResponse'_requestModels
- The request models for the route. Supported only for WebSocket APIs.
GetRouteResponse'
, getRouteResponse'_requestParameters
- The request parameters for the route. Supported only for WebSocket APIs.
GetRoute
, getRouteResponse'_routeId
- The route ID.
GetRouteResponse'
, getRouteResponse'_routeKey
- The route key for the route.
GetRouteResponse'
, getRouteResponse'_routeResponseSelectionExpression
- The route response selection expression for the route. Supported only
for WebSocket APIs.
GetRouteResponse'
, getRouteResponse'_target
- The target for the route.
$sel:httpStatus:GetRouteResponse''
, getRouteResponse'_httpStatus
- The response's http status code.
GetRouteResponse
data GetRouteResponse Source #
See: newGetRouteResponse
smart constructor.
Instances
Create a value of GetRouteResponse
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:
GetRouteResponse
, getRouteResponse_routeResponseId
- The route response ID.
GetRouteResponse
, getRouteResponse_apiId
- The API identifier.
GetRouteResponse
, getRouteResponse_routeId
- The route ID.
data GetRouteResponseResponse Source #
See: newGetRouteResponseResponse
smart constructor.
GetRouteResponseResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) Int |
Instances
newGetRouteResponseResponse Source #
Create a value of GetRouteResponseResponse
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:
GetRouteResponseResponse
, getRouteResponseResponse_modelSelectionExpression
- Represents the model selection expression of a route response. Supported
only for WebSocket APIs.
GetRouteResponseResponse
, getRouteResponseResponse_responseModels
- Represents the response models of a route response.
GetRouteResponseResponse
, getRouteResponseResponse_responseParameters
- Represents the response parameters of a route response.
GetRouteResponse
, getRouteResponseResponse_routeResponseId
- Represents the identifier of a route response.
GetRouteResponseResponse
, getRouteResponseResponse_routeResponseKey
- Represents the route response key of a route response.
$sel:httpStatus:GetRouteResponseResponse'
, getRouteResponseResponse_httpStatus
- The response's http status code.
GetRouteResponses (Paginated)
data GetRouteResponses Source #
See: newGetRouteResponses
smart constructor.
Instances
Create a value of GetRouteResponses
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:maxResults:GetRouteResponses'
, getRouteResponses_maxResults
- The maximum number of elements to be returned for this resource.
GetRouteResponses
, getRouteResponses_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
GetRouteResponses
, getRouteResponses_routeId
- The route ID.
GetRouteResponses
, getRouteResponses_apiId
- The API identifier.
data GetRouteResponsesResponse Source #
See: newGetRouteResponsesResponse
smart constructor.
Instances
newGetRouteResponsesResponse Source #
Create a value of GetRouteResponsesResponse
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:items:GetRouteResponsesResponse'
, getRouteResponsesResponse_items
- The elements from this collection.
GetRouteResponses
, getRouteResponsesResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetRouteResponsesResponse'
, getRouteResponsesResponse_httpStatus
- The response's http status code.
GetRoutes (Paginated)
See: newGetRoutes
smart constructor.
Instances
Create a value of GetRoutes
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:maxResults:GetRoutes'
, getRoutes_maxResults
- The maximum number of elements to be returned for this resource.
GetRoutes
, getRoutes_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
GetRoutes
, getRoutes_apiId
- The API identifier.
data GetRoutesResponse Source #
See: newGetRoutesResponse
smart constructor.
Instances
Create a value of GetRoutesResponse
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:items:GetRoutesResponse'
, getRoutesResponse_items
- The elements from this collection.
GetRoutes
, getRoutesResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetRoutesResponse'
, getRoutesResponse_httpStatus
- The response's http status code.
GetStage
See: newGetStage
smart constructor.
Instances
Create a value of GetStage
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:
GetStage
, getStage_stageName
- The stage name. Stage names can only contain alphanumeric characters,
hyphens, and underscores. Maximum length is 128 characters.
GetStage
, getStage_apiId
- The API identifier.
data GetStageResponse Source #
See: newGetStageResponse
smart constructor.
GetStageResponse' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe (HashMap Text RouteSettings)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Int |
Instances
Create a value of GetStageResponse
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:
GetStageResponse
, getStageResponse_accessLogSettings
- Settings for logging access in this stage.
GetStageResponse
, getStageResponse_apiGatewayManaged
- Specifies whether a stage is managed by API Gateway. If you created an
API using quick create, the $default stage is managed by API Gateway.
You can't modify the $default stage.
GetStageResponse
, getStageResponse_autoDeploy
- Specifies whether updates to an API automatically trigger a new
deployment. The default value is false.
GetStageResponse
, getStageResponse_clientCertificateId
- The identifier of a client certificate for a Stage. Supported only for
WebSocket APIs.
GetStageResponse
, getStageResponse_createdDate
- The timestamp when the stage was created.
GetStageResponse
, getStageResponse_defaultRouteSettings
- Default route settings for the stage.
GetStageResponse
, getStageResponse_deploymentId
- The identifier of the Deployment that the Stage is associated with.
Can't be updated if autoDeploy is enabled.
GetStageResponse
, getStageResponse_description
- The description of the stage.
GetStageResponse
, getStageResponse_lastDeploymentStatusMessage
- Describes the status of the last deployment of a stage. Supported only
for stages with autoDeploy enabled.
GetStageResponse
, getStageResponse_lastUpdatedDate
- The timestamp when the stage was last updated.
GetStageResponse
, getStageResponse_routeSettings
- Route settings for the stage, by routeKey.
GetStage
, getStageResponse_stageName
- The name of the stage.
GetStageResponse
, getStageResponse_stageVariables
- 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-._~:/?#&=,]+.
GetStageResponse
, getStageResponse_tags
- The collection of tags. Each tag element is associated with a given
resource.
$sel:httpStatus:GetStageResponse'
, getStageResponse_httpStatus
- The response's http status code.
GetStages (Paginated)
See: newGetStages
smart constructor.
Instances
Create a value of GetStages
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:maxResults:GetStages'
, getStages_maxResults
- The maximum number of elements to be returned for this resource.
GetStages
, getStages_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
GetStages
, getStages_apiId
- The API identifier.
data GetStagesResponse Source #
See: newGetStagesResponse
smart constructor.
Instances
Create a value of GetStagesResponse
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:items:GetStagesResponse'
, getStagesResponse_items
- The elements from this collection.
GetStages
, getStagesResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetStagesResponse'
, getStagesResponse_httpStatus
- The response's http status code.
GetTags
See: newGetTags
smart constructor.
Instances
ToHeaders GetTags Source # | |
Defined in Amazonka.ApiGatewayV2.GetTags | |
ToPath GetTags Source # | |
Defined in Amazonka.ApiGatewayV2.GetTags toPath :: GetTags -> ByteString # | |
ToQuery GetTags Source # | |
Defined in Amazonka.ApiGatewayV2.GetTags toQuery :: GetTags -> QueryString # | |
AWSRequest GetTags Source # | |
Defined in Amazonka.ApiGatewayV2.GetTags type AWSResponse GetTags # request :: (Service -> Service) -> GetTags -> Request GetTags # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTags))) # | |
Generic GetTags Source # | |
Read GetTags Source # | |
Show GetTags Source # | |
NFData GetTags Source # | |
Defined in Amazonka.ApiGatewayV2.GetTags | |
Eq GetTags Source # | |
Hashable GetTags Source # | |
Defined in Amazonka.ApiGatewayV2.GetTags | |
type AWSResponse GetTags Source # | |
Defined in Amazonka.ApiGatewayV2.GetTags | |
type Rep GetTags Source # | |
Defined in Amazonka.ApiGatewayV2.GetTags |
Create a value of GetTags
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:resourceArn:GetTags'
, getTags_resourceArn
- The resource ARN for the tag.
data GetTagsResponse Source #
See: newGetTagsResponse
smart constructor.
Instances
Create a value of GetTagsResponse
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:
GetTagsResponse
, getTagsResponse_tags
- Undocumented member.
$sel:httpStatus:GetTagsResponse'
, getTagsResponse_httpStatus
- The response's http status code.
GetVpcLink
data GetVpcLink Source #
See: newGetVpcLink
smart constructor.
Instances
:: Text | |
-> GetVpcLink |
Create a value of GetVpcLink
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:
GetVpcLink
, getVpcLink_vpcLinkId
- The ID of the VPC link.
data GetVpcLinkResponse Source #
See: newGetVpcLinkResponse
smart constructor.
GetVpcLinkResponse' (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe VpcLinkVersion) Int |
Instances
newGetVpcLinkResponse Source #
Create a value of GetVpcLinkResponse
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:
GetVpcLinkResponse
, getVpcLinkResponse_createdDate
- The timestamp when the VPC link was created.
GetVpcLinkResponse
, getVpcLinkResponse_name
- The name of the VPC link.
GetVpcLinkResponse
, getVpcLinkResponse_securityGroupIds
- A list of security group IDs for the VPC link.
GetVpcLinkResponse
, getVpcLinkResponse_subnetIds
- A list of subnet IDs to include in the VPC link.
GetVpcLinkResponse
, getVpcLinkResponse_tags
- Tags for the VPC link.
GetVpcLink
, getVpcLinkResponse_vpcLinkId
- The ID of the VPC link.
GetVpcLinkResponse
, getVpcLinkResponse_vpcLinkStatus
- The status of the VPC link.
GetVpcLinkResponse
, getVpcLinkResponse_vpcLinkStatusMessage
- A message summarizing the cause of the status of the VPC link.
GetVpcLinkResponse
, getVpcLinkResponse_vpcLinkVersion
- The version of the VPC link.
$sel:httpStatus:GetVpcLinkResponse'
, getVpcLinkResponse_httpStatus
- The response's http status code.
GetVpcLinks
data GetVpcLinks Source #
See: newGetVpcLinks
smart constructor.
GetVpcLinks' (Maybe Text) (Maybe Text) |
Instances
newGetVpcLinks :: GetVpcLinks Source #
Create a value of GetVpcLinks
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:maxResults:GetVpcLinks'
, getVpcLinks_maxResults
- The maximum number of elements to be returned for this resource.
GetVpcLinks
, getVpcLinks_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
data GetVpcLinksResponse Source #
See: newGetVpcLinksResponse
smart constructor.
Instances
newGetVpcLinksResponse Source #
Create a value of GetVpcLinksResponse
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:items:GetVpcLinksResponse'
, getVpcLinksResponse_items
- A collection of VPC links.
GetVpcLinks
, getVpcLinksResponse_nextToken
- The next page of elements from this collection. Not valid for the last
element of the collection.
$sel:httpStatus:GetVpcLinksResponse'
, getVpcLinksResponse_httpStatus
- The response's http status code.
ImportApi
See: newImportApi
smart constructor.
Instances
Create a value of ImportApi
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:ImportApi'
, importApi_basepath
- Specifies how to interpret the base path of the API during import. Valid
values are ignore, prepend, and split. The default value is ignore. To
learn more, see
Set the OpenAPI basePath Property.
Supported only for HTTP APIs.
$sel:failOnWarnings:ImportApi'
, importApi_failOnWarnings
- Specifies whether to rollback the API creation when a warning is
encountered. By default, API creation continues if a warning is
encountered.
$sel:body:ImportApi'
, importApi_body
- The OpenAPI definition. Supported only for HTTP APIs.
data ImportApiResponse Source #
See: newImportApiResponse
smart constructor.
ImportApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int |
Instances
Create a value of ImportApiResponse
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:
ImportApiResponse
, importApiResponse_apiEndpoint
- The URI of the API, of the form
{api-id}.execute-api.{region}.amazonaws.com. The stage name is typically
appended to this URI to form a complete path to a deployed API stage.
ImportApiResponse
, importApiResponse_apiGatewayManaged
- Specifies whether an API is managed by API Gateway. You can't update or
delete a managed API by using API Gateway. A managed API can be deleted
only through the tooling or service that created it.
ImportApiResponse
, importApiResponse_apiId
- The API ID.
ImportApiResponse
, importApiResponse_apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
ImportApiResponse
, importApiResponse_corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.
ImportApiResponse
, importApiResponse_createdDate
- The timestamp when the API was created.
ImportApiResponse
, importApiResponse_description
- The description of the API.
ImportApiResponse
, importApiResponse_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.
ImportApiResponse
, importApiResponse_disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
ImportApiResponse
, importApiResponse_importInfo
- The validation information during API import. This may include
particular properties of your OpenAPI definition which are ignored
during import. Supported only for HTTP APIs.
ImportApiResponse
, importApiResponse_name
- The name of the API.
ImportApiResponse
, importApiResponse_protocolType
- The API protocol.
ImportApiResponse
, importApiResponse_routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.
ImportApiResponse
, importApiResponse_tags
- A collection of tags associated with the API.
ImportApiResponse
, importApiResponse_version
- A version identifier for the API.
ImportApiResponse
, importApiResponse_warnings
- The warning messages reported when failonwarnings is turned on during
API import.
$sel:httpStatus:ImportApiResponse'
, importApiResponse_httpStatus
- The response's http status code.
ReimportApi
data ReimportApi Source #
See: newReimportApi
smart constructor.
Instances
Create a value of ReimportApi
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:ReimportApi'
, reimportApi_basepath
- Specifies how to interpret the base path of the API during import. Valid
values are ignore, prepend, and split. The default value is ignore. To
learn more, see
Set the OpenAPI basePath Property.
Supported only for HTTP APIs.
$sel:failOnWarnings:ReimportApi'
, reimportApi_failOnWarnings
- Specifies whether to rollback the API creation when a warning is
encountered. By default, API creation continues if a warning is
encountered.
ReimportApi
, reimportApi_apiId
- The API identifier.
$sel:body:ReimportApi'
, reimportApi_body
- The OpenAPI definition. Supported only for HTTP APIs.
data ReimportApiResponse Source #
See: newReimportApiResponse
smart constructor.
ReimportApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int |
Instances
newReimportApiResponse Source #
Create a value of ReimportApiResponse
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:
ReimportApiResponse
, reimportApiResponse_apiEndpoint
- The URI of the API, of the form
{api-id}.execute-api.{region}.amazonaws.com. The stage name is typically
appended to this URI to form a complete path to a deployed API stage.
ReimportApiResponse
, reimportApiResponse_apiGatewayManaged
- Specifies whether an API is managed by API Gateway. You can't update or
delete a managed API by using API Gateway. A managed API can be deleted
only through the tooling or service that created it.
ReimportApi
, reimportApiResponse_apiId
- The API ID.
ReimportApiResponse
, reimportApiResponse_apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
ReimportApiResponse
, reimportApiResponse_corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.
ReimportApiResponse
, reimportApiResponse_createdDate
- The timestamp when the API was created.
ReimportApiResponse
, reimportApiResponse_description
- The description of the API.
ReimportApiResponse
, reimportApiResponse_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.
ReimportApiResponse
, reimportApiResponse_disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
ReimportApiResponse
, reimportApiResponse_importInfo
- The validation information during API import. This may include
particular properties of your OpenAPI definition which are ignored
during import. Supported only for HTTP APIs.
ReimportApiResponse
, reimportApiResponse_name
- The name of the API.
ReimportApiResponse
, reimportApiResponse_protocolType
- The API protocol.
ReimportApiResponse
, reimportApiResponse_routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.
ReimportApiResponse
, reimportApiResponse_tags
- A collection of tags associated with the API.
ReimportApiResponse
, reimportApiResponse_version
- A version identifier for the API.
ReimportApiResponse
, reimportApiResponse_warnings
- The warning messages reported when failonwarnings is turned on during
API import.
$sel:httpStatus:ReimportApiResponse'
, reimportApiResponse_httpStatus
- The response's http status code.
ResetAuthorizersCache
data ResetAuthorizersCache Source #
See: newResetAuthorizersCache
smart constructor.
Instances
newResetAuthorizersCache Source #
Create a value of ResetAuthorizersCache
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:
ResetAuthorizersCache
, resetAuthorizersCache_stageName
- The stage name. Stage names can contain only alphanumeric characters,
hyphens, and underscores, or be $default. Maximum length is 128
characters.
ResetAuthorizersCache
, resetAuthorizersCache_apiId
- The API identifier.
data ResetAuthorizersCacheResponse Source #
See: newResetAuthorizersCacheResponse
smart constructor.
Instances
newResetAuthorizersCacheResponse :: ResetAuthorizersCacheResponse Source #
Create a value of ResetAuthorizersCacheResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
Creates a new Tag resource to represent a tag.
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
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:
TagResource
, tagResource_tags
- The collection of tags. Each tag element is associated with a given
resource.
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The resource ARN for the tag.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
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:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
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:resourceArn:UntagResource'
, untagResource_resourceArn
- The resource ARN for the tag.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The Tag keys to delete
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Instances
Generic UntagResourceResponse Source # | |
Defined in Amazonka.ApiGatewayV2.UntagResource type Rep UntagResourceResponse :: Type -> Type # | |
Read UntagResourceResponse Source # | |
Show UntagResourceResponse Source # | |
Defined in Amazonka.ApiGatewayV2.UntagResource showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS # | |
NFData UntagResourceResponse Source # | |
Defined in Amazonka.ApiGatewayV2.UntagResource rnf :: UntagResourceResponse -> () # | |
Eq UntagResourceResponse Source # | |
Defined in Amazonka.ApiGatewayV2.UntagResource (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool # | |
type Rep UntagResourceResponse Source # | |
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateApi
Updates an Api.
See: newUpdateApi
smart constructor.
UpdateApi' (Maybe Text) (Maybe Cors) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Create a value of UpdateApi
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:
UpdateApi
, updateApi_apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
UpdateApi
, updateApi_corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.
UpdateApi
, updateApi_credentialsArn
- This property is part of quick create. It specifies the credentials
required for the integration, if any. For a Lambda integration, 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
arn:aws:iam::*:user/*. To use resource-based permissions on supported
AWS services, don't specify this parameter. Currently, this property is
not used for HTTP integrations. If provided, this value replaces the
credentials associated with the quick create integration. Supported only
for HTTP APIs.
UpdateApi
, updateApi_description
- The description of the API.
UpdateApi
, updateApi_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.
UpdateApi
, updateApi_disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
UpdateApi
, updateApi_name
- The name of the API.
UpdateApi
, updateApi_routeKey
- This property is part of quick create. If not specified, the route
created using quick create is kept. Otherwise, this value replaces the
route key of the quick create route. Additional routes may still be
added after the API is updated. Supported only for HTTP APIs.
UpdateApi
, updateApi_routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.
UpdateApi
, updateApi_target
- This property is part of quick create. For HTTP integrations, specify a
fully qualified URL. For Lambda integrations, specify a function ARN.
The type of the integration will be HTTP_PROXY or AWS_PROXY,
respectively. The value provided updates the integration URI and
integration type. You can update a quick-created target, but you can't
remove it from an API. Supported only for HTTP APIs.
UpdateApi
, updateApi_version
- A version identifier for the API.
UpdateApi
, updateApi_apiId
- The API identifier.
data UpdateApiResponse Source #
See: newUpdateApiResponse
smart constructor.
UpdateApiResponse' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe ProtocolType) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Int |
Instances
Create a value of UpdateApiResponse
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:
UpdateApiResponse
, updateApiResponse_apiEndpoint
- The URI of the API, of the form
{api-id}.execute-api.{region}.amazonaws.com. The stage name is typically
appended to this URI to form a complete path to a deployed API stage.
UpdateApiResponse
, updateApiResponse_apiGatewayManaged
- Specifies whether an API is managed by API Gateway. You can't update or
delete a managed API by using API Gateway. A managed API can be deleted
only through the tooling or service that created it.
UpdateApi
, updateApiResponse_apiId
- The API ID.
UpdateApi
, updateApiResponse_apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
UpdateApi
, updateApiResponse_corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.
UpdateApiResponse
, updateApiResponse_createdDate
- The timestamp when the API was created.
UpdateApi
, updateApiResponse_description
- The description of the API.
UpdateApi
, updateApiResponse_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.
UpdateApi
, updateApiResponse_disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
UpdateApiResponse
, updateApiResponse_importInfo
- The validation information during API import. This may include
particular properties of your OpenAPI definition which are ignored
during import. Supported only for HTTP APIs.
UpdateApi
, updateApiResponse_name
- The name of the API.
UpdateApiResponse
, updateApiResponse_protocolType
- The API protocol.
UpdateApi
, updateApiResponse_routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.
UpdateApiResponse
, updateApiResponse_tags
- A collection of tags associated with the API.
UpdateApi
, updateApiResponse_version
- A version identifier for the API.
UpdateApiResponse
, updateApiResponse_warnings
- The warning messages reported when failonwarnings is turned on during
API import.
$sel:httpStatus:UpdateApiResponse'
, updateApiResponse_httpStatus
- The response's http status code.
UpdateApiMapping
data UpdateApiMapping Source #
Updates an ApiMapping.
See: newUpdateApiMapping
smart constructor.
Instances
Create a value of UpdateApiMapping
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:
UpdateApiMapping
, updateApiMapping_apiMappingKey
- The API mapping key.
UpdateApiMapping
, updateApiMapping_stage
- The API stage.
UpdateApiMapping
, updateApiMapping_apiMappingId
- The API mapping identifier.
UpdateApiMapping
, updateApiMapping_apiId
- The API identifier.
UpdateApiMapping
, updateApiMapping_domainName
- The domain name.
data UpdateApiMappingResponse Source #
See: newUpdateApiMappingResponse
smart constructor.
Instances
newUpdateApiMappingResponse Source #
Create a value of UpdateApiMappingResponse
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:
UpdateApiMapping
, updateApiMappingResponse_apiId
- The API identifier.
UpdateApiMapping
, updateApiMappingResponse_apiMappingId
- The API mapping identifier.
UpdateApiMapping
, updateApiMappingResponse_apiMappingKey
- The API mapping key.
UpdateApiMapping
, updateApiMappingResponse_stage
- The API stage.
$sel:httpStatus:UpdateApiMappingResponse'
, updateApiMappingResponse_httpStatus
- The response's http status code.
UpdateAuthorizer
data UpdateAuthorizer Source #
Updates an Authorizer.
See: newUpdateAuthorizer
smart constructor.
UpdateAuthorizer' (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) (Maybe Text) Text Text |
Instances
Create a value of UpdateAuthorizer
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:
UpdateAuthorizer
, updateAuthorizer_authorizerCredentialsArn
- 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, don't specify this parameter.
UpdateAuthorizer
, updateAuthorizer_authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda
authorizer. Required for HTTP API Lambda authorizers. Supported values
are 1.0 and 2.0. To learn more, see
Working with AWS Lambda authorizers for HTTP APIs.
UpdateAuthorizer
, updateAuthorizer_authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. If it
equals 0, authorization caching is disabled. If it is greater than 0,
API Gateway caches authorizer responses. The maximum value is 3600, or 1
hour. Supported only for HTTP API Lambda authorizers.
UpdateAuthorizer
, updateAuthorizer_authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using
incoming request parameters. Specify JWT to use JSON Web Tokens
(supported only for HTTP APIs).
UpdateAuthorizer
, updateAuthorizer_authorizerUri
- The authorizer's Uniform Resource Identifier (URI). For 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.
Supported only for REQUEST authorizers.
UpdateAuthorizer
, updateAuthorizer_enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple
format. By default, a Lambda authorizer must return an IAM policy. If
enabled, the Lambda authorizer can return a boolean value instead of an
IAM policy. Supported only for HTTP APIs. To learn more, see
Working with AWS Lambda authorizers for HTTP APIs
UpdateAuthorizer
, updateAuthorizer_identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
UpdateAuthorizer
, updateAuthorizer_identityValidationExpression
- This parameter is not used.
UpdateAuthorizer
, updateAuthorizer_jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT
authorizer type. Supported only for HTTP APIs.
UpdateAuthorizer
, updateAuthorizer_name
- The name of the authorizer.
UpdateAuthorizer
, updateAuthorizer_authorizerId
- The authorizer identifier.
UpdateAuthorizer
, updateAuthorizer_apiId
- The API identifier.
data UpdateAuthorizerResponse Source #
See: newUpdateAuthorizerResponse
smart constructor.
UpdateAuthorizerResponse' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) (Maybe Text) Int |
Instances
newUpdateAuthorizerResponse Source #
Create a value of UpdateAuthorizerResponse
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:
UpdateAuthorizer
, updateAuthorizerResponse_authorizerCredentialsArn
- 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, don't specify this parameter.
Supported only for REQUEST authorizers.
UpdateAuthorizer
, updateAuthorizerResponse_authorizerId
- The authorizer identifier.
UpdateAuthorizer
, updateAuthorizerResponse_authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda
authorizer. Required for HTTP API Lambda authorizers. Supported values
are 1.0 and 2.0. To learn more, see
Working with AWS Lambda authorizers for HTTP APIs.
UpdateAuthorizer
, updateAuthorizerResponse_authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. If it
equals 0, authorization caching is disabled. If it is greater than 0,
API Gateway caches authorizer responses. The maximum value is 3600, or 1
hour. Supported only for HTTP API Lambda authorizers.
UpdateAuthorizer
, updateAuthorizerResponse_authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using
incoming request parameters. Specify JWT to use JSON Web Tokens
(supported only for HTTP APIs).
UpdateAuthorizer
, updateAuthorizerResponse_authorizerUri
- The authorizer's Uniform Resource Identifier (URI). For 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.
Supported only for REQUEST authorizers.
UpdateAuthorizer
, updateAuthorizerResponse_enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple
format. If enabled, the Lambda authorizer can return a boolean value
instead of an IAM policy. Supported only for HTTP APIs. To learn more,
see
Working with AWS Lambda authorizers for HTTP APIs
UpdateAuthorizer
, updateAuthorizerResponse_identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
UpdateAuthorizer
, updateAuthorizerResponse_identityValidationExpression
- The validation expression does not apply to the REQUEST authorizer.
UpdateAuthorizer
, updateAuthorizerResponse_jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT
authorizer type. Supported only for HTTP APIs.
UpdateAuthorizer
, updateAuthorizerResponse_name
- The name of the authorizer.
$sel:httpStatus:UpdateAuthorizerResponse'
, updateAuthorizerResponse_httpStatus
- The response's http status code.
UpdateDeployment
data UpdateDeployment Source #
Updates a Deployment.
See: newUpdateDeployment
smart constructor.
Instances
Create a value of UpdateDeployment
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:
UpdateDeployment
, updateDeployment_description
- The description for the deployment resource.
UpdateDeployment
, updateDeployment_apiId
- The API identifier.
UpdateDeployment
, updateDeployment_deploymentId
- The deployment ID.
data UpdateDeploymentResponse Source #
See: newUpdateDeploymentResponse
smart constructor.
UpdateDeploymentResponse' (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe DeploymentStatus) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateDeploymentResponse Source #
Create a value of UpdateDeploymentResponse
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:
UpdateDeploymentResponse
, updateDeploymentResponse_autoDeployed
- Specifies whether a deployment was automatically released.
UpdateDeploymentResponse
, updateDeploymentResponse_createdDate
- The date and time when the Deployment resource was created.
UpdateDeployment
, updateDeploymentResponse_deploymentId
- The identifier for the deployment.
UpdateDeploymentResponse
, updateDeploymentResponse_deploymentStatus
- The status of the deployment: PENDING, FAILED, or SUCCEEDED.
UpdateDeploymentResponse
, updateDeploymentResponse_deploymentStatusMessage
- May contain additional feedback on the status of an API deployment.
UpdateDeployment
, updateDeploymentResponse_description
- The description for the deployment.
$sel:httpStatus:UpdateDeploymentResponse'
, updateDeploymentResponse_httpStatus
- The response's http status code.
UpdateDomainName
data UpdateDomainName Source #
Updates a DomainName.
See: newUpdateDomainName
smart constructor.
Instances
Create a value of UpdateDomainName
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:
UpdateDomainName
, updateDomainName_domainNameConfigurations
- The domain name configurations.
UpdateDomainName
, updateDomainName_mutualTlsAuthentication
- The mutual TLS authentication configuration for a custom domain name.
UpdateDomainName
, updateDomainName_domainName
- The domain name.
data UpdateDomainNameResponse Source #
See: newUpdateDomainNameResponse
smart constructor.
UpdateDomainNameResponse' (Maybe Text) (Maybe Text) (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthentication) (Maybe (HashMap Text Text)) Int |
Instances
newUpdateDomainNameResponse Source #
Create a value of UpdateDomainNameResponse
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:
UpdateDomainNameResponse
, updateDomainNameResponse_apiMappingSelectionExpression
- The API mapping selection expression.
UpdateDomainName
, updateDomainNameResponse_domainName
- The name of the DomainName resource.
UpdateDomainName
, updateDomainNameResponse_domainNameConfigurations
- The domain name configurations.
UpdateDomainName
, updateDomainNameResponse_mutualTlsAuthentication
- The mutual TLS authentication configuration for a custom domain name.
UpdateDomainNameResponse
, updateDomainNameResponse_tags
- The collection of tags associated with a domain name.
$sel:httpStatus:UpdateDomainNameResponse'
, updateDomainNameResponse_httpStatus
- The response's http status code.
UpdateIntegration
data UpdateIntegration Source #
Updates an Integration.
See: newUpdateIntegration
smart constructor.
UpdateIntegration' (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfigInput) Text Text |
Instances
Create a value of UpdateIntegration
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:
UpdateIntegration
, updateIntegration_connectionId
- The ID of the VPC link for a private integration. Supported only for
HTTP APIs.
UpdateIntegration
, updateIntegration_connectionType
- The type of the network connection to the integration endpoint. Specify
INTERNET for connections through the public routable internet or
VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.
UpdateIntegration
, updateIntegration_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
UpdateIntegration
, updateIntegration_credentialsArn
- 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.
UpdateIntegration
, updateIntegration_description
- The description of the integration
UpdateIntegration
, updateIntegration_integrationMethod
- Specifies the integration's HTTP method type.
UpdateIntegration
, updateIntegration_integrationSubtype
- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS
service action to invoke. To learn more, see
Integration subtype reference.
UpdateIntegration
, updateIntegration_integrationType
- The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration. For HTTP API private integrations, use an HTTP_PROXY integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
UpdateIntegration
, updateIntegration_integrationUri
- For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
UpdateIntegration
, updateIntegration_passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the
Content-Type header in the request, and the available mapping templates
specified as the requestTemplates property on the Integration resource.
There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
UpdateIntegration
, updateIntegration_payloadFormatVersion
- Specifies the format of the payload sent to an integration. Required for
HTTP APIs.
UpdateIntegration
, updateIntegration_requestParameters
- For WebSocket APIs, a key-value map specifying request parameters that
are passed from the method request to the backend. 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 backend. 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.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API integrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to the backend. The key should follow the pattern <action>:<header|querystring|path>.<location> where action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
UpdateIntegration
, updateIntegration_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. Supported only for WebSocket APIs.
UpdateIntegration
, updateIntegration_responseParameters
- Supported only for HTTP APIs. You use response parameters to transform
the HTTP response from a backend integration before returning the
response to clients. Specify a key-value map from a selection key to
response parameters. The selection key must be a valid HTTP status code
within the range of 200-599. Response parameters are a key-value map.
The key must match pattern <action>:<header>.<location> or
overwrite.statuscode. The action can be append, overwrite or remove. The
value can be a static value, or map to response data, stage variables,
or context variables that are evaluated at runtime. To learn more, see
Transforming API requests and responses.
UpdateIntegration
, updateIntegration_templateSelectionExpression
- The template selection expression for the integration.
UpdateIntegration
, updateIntegration_timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and
between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is
29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
UpdateIntegration
, updateIntegration_tlsConfig
- The TLS configuration for a private integration. If you specify a TLS
configuration, private integration traffic uses the HTTPS protocol.
Supported only for HTTP APIs.
UpdateIntegration
, updateIntegration_apiId
- The API identifier.
UpdateIntegration
, updateIntegration_integrationId
- The integration ID.
data UpdateIntegrationResponse' Source #
See: newUpdateIntegrationResponse'
smart constructor.
UpdateIntegrationResponse'' (Maybe Bool) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfig) Int |
Instances
newUpdateIntegrationResponse' Source #
Create a value of UpdateIntegrationResponse'
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:
UpdateIntegrationResponse'
, updateIntegrationResponse'_apiGatewayManaged
- Specifies whether an integration is managed by API Gateway. If you
created an API using using quick create, the resulting integration is
managed by API Gateway. You can update a managed integration, but you
can't delete it.
UpdateIntegration
, updateIntegrationResponse'_connectionId
- The ID of the VPC link for a private integration. Supported only for
HTTP APIs.
UpdateIntegration
, updateIntegrationResponse'_connectionType
- The type of the network connection to the integration endpoint. Specify
INTERNET for connections through the public routable internet or
VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.
UpdateIntegration
, updateIntegrationResponse'_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
UpdateIntegration
, updateIntegrationResponse'_credentialsArn
- 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.
UpdateIntegration
, updateIntegrationResponse'_description
- Represents the description of an integration.
UpdateIntegration
, updateIntegrationResponse'_integrationId
- Represents the identifier of an integration.
UpdateIntegration
, updateIntegrationResponse'_integrationMethod
- Specifies the integration's HTTP method type.
UpdateIntegrationResponse'
, updateIntegrationResponse'_integrationResponseSelectionExpression
- The integration response selection expression for the integration.
Supported only for WebSocket APIs. See
Integration Response Selection Expressions.
UpdateIntegration
, updateIntegrationResponse'_integrationSubtype
- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS
service action to invoke. To learn more, see
Integration subtype reference.
UpdateIntegration
, updateIntegrationResponse'_integrationType
- The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
UpdateIntegration
, updateIntegrationResponse'_integrationUri
- For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
UpdateIntegration
, updateIntegrationResponse'_passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the
Content-Type header in the request, and the available mapping templates
specified as the requestTemplates property on the Integration resource.
There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
UpdateIntegration
, updateIntegrationResponse'_payloadFormatVersion
- Specifies the format of the payload sent to an integration. Required for
HTTP APIs.
UpdateIntegration
, updateIntegrationResponse'_requestParameters
- For WebSocket APIs, a key-value map specifying request parameters that
are passed from the method request to the backend. 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 backend. 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.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
UpdateIntegration
, updateIntegrationResponse'_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. Supported only for WebSocket APIs.
UpdateIntegration
, updateIntegrationResponse'_responseParameters
- Supported only for HTTP APIs. You use response parameters to transform
the HTTP response from a backend integration before returning the
response to clients. Specify a key-value map from a selection key to
response parameters. The selection key must be a valid HTTP status code
within the range of 200-599. Response parameters are a key-value map.
The key must match pattern <action>:<header>.<location> or
overwrite.statuscode. The action can be append, overwrite or remove. The
value can be a static value, or map to response data, stage variables,
or context variables that are evaluated at runtime. To learn more, see
Transforming API requests and responses.
UpdateIntegration
, updateIntegrationResponse'_templateSelectionExpression
- The template selection expression for the integration. Supported only
for WebSocket APIs.
UpdateIntegration
, updateIntegrationResponse'_timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and
between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is
29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
UpdateIntegration
, updateIntegrationResponse'_tlsConfig
- The TLS configuration for a private integration. If you specify a TLS
configuration, private integration traffic uses the HTTPS protocol.
Supported only for HTTP APIs.
$sel:httpStatus:UpdateIntegrationResponse''
, updateIntegrationResponse'_httpStatus
- The response's http status code.
UpdateIntegrationResponse
data UpdateIntegrationResponse Source #
Updates an IntegrationResponses.
See: newUpdateIntegrationResponse
smart constructor.
UpdateIntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text |
Instances
newUpdateIntegrationResponse Source #
:: Text | |
-> Text | |
-> Text | |
-> UpdateIntegrationResponse |
Create a value of UpdateIntegrationResponse
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:
UpdateIntegrationResponse
, updateIntegrationResponse_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
UpdateIntegrationResponse
, updateIntegrationResponse_integrationResponseKey
- The integration response key.
UpdateIntegrationResponse
, updateIntegrationResponse_responseParameters
- A key-value map specifying response parameters that are passed to the
method response from the backend. 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.
UpdateIntegrationResponse
, updateIntegrationResponse_responseTemplates
- The collection of response templates for the integration response as a
string-to-string map of key-value pairs. Response templates are
represented as a key/value map, with a content-type as the key and a
template as the value.
UpdateIntegrationResponse
, updateIntegrationResponse_templateSelectionExpression
- The template selection expression for the integration response.
Supported only for WebSocket APIs.
UpdateIntegrationResponse
, updateIntegrationResponse_apiId
- The API identifier.
UpdateIntegrationResponse
, updateIntegrationResponse_integrationResponseId
- The integration response ID.
UpdateIntegrationResponse
, updateIntegrationResponse_integrationId
- The integration ID.
data UpdateIntegrationResponseResponse Source #
See: newUpdateIntegrationResponseResponse
smart constructor.
UpdateIntegrationResponseResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Int |
Instances
newUpdateIntegrationResponseResponse Source #
Create a value of UpdateIntegrationResponseResponse
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:
UpdateIntegrationResponse
, updateIntegrationResponseResponse_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
UpdateIntegrationResponse
, updateIntegrationResponseResponse_integrationResponseId
- The integration response ID.
UpdateIntegrationResponse
, updateIntegrationResponseResponse_integrationResponseKey
- The integration response key.
UpdateIntegrationResponse
, updateIntegrationResponseResponse_responseParameters
- A key-value map specifying response parameters that are passed to the
method response from the backend. 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.
UpdateIntegrationResponse
, updateIntegrationResponseResponse_responseTemplates
- The collection of response templates for the integration response as a
string-to-string map of key-value pairs. Response templates are
represented as a key/value map, with a content-type as the key and a
template as the value.
UpdateIntegrationResponse
, updateIntegrationResponseResponse_templateSelectionExpression
- The template selection expressions for the integration response.
$sel:httpStatus:UpdateIntegrationResponseResponse'
, updateIntegrationResponseResponse_httpStatus
- The response's http status code.
UpdateModel
data UpdateModel Source #
Updates a Model.
See: newUpdateModel
smart constructor.
Instances
Create a value of UpdateModel
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:
UpdateModel
, updateModel_contentType
- The content-type for the model, for example, "application/json".
UpdateModel
, updateModel_description
- The description of the model.
UpdateModel
, updateModel_name
- The name of the model.
UpdateModel
, updateModel_schema
- The schema for the model. For application/json models, this should be
JSON schema draft 4 model.
UpdateModel
, updateModel_modelId
- The model ID.
UpdateModel
, updateModel_apiId
- The API identifier.
data UpdateModelResponse Source #
See: newUpdateModelResponse
smart constructor.
Instances
newUpdateModelResponse Source #
Create a value of UpdateModelResponse
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:
UpdateModel
, updateModelResponse_contentType
- The content-type for the model, for example, "application/json".
UpdateModel
, updateModelResponse_description
- The description of the model.
UpdateModel
, updateModelResponse_modelId
- The model identifier.
UpdateModel
, updateModelResponse_name
- The name of the model. Must be alphanumeric.
UpdateModel
, updateModelResponse_schema
- The schema for the model. For application/json models, this should be
JSON schema draft 4 model.
$sel:httpStatus:UpdateModelResponse'
, updateModelResponse_httpStatus
- The response's http status code.
UpdateRoute
data UpdateRoute Source #
Updates a Route.
See: newUpdateRoute
smart constructor.
UpdateRoute' (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) Text Text |
Instances
Create a value of UpdateRoute
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:
UpdateRoute
, updateRoute_apiKeyRequired
- Specifies whether an API key is required for the route. Supported only
for WebSocket APIs.
UpdateRoute
, updateRoute_authorizationScopes
- The authorization scopes supported by this route.
UpdateRoute
, updateRoute_authorizationType
- The authorization type for the route. For WebSocket APIs, valid values
are NONE for open access, AWS_IAM for using AWS IAM permissions, and
CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are
NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using
AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
UpdateRoute
, updateRoute_authorizerId
- The identifier of the Authorizer resource to be associated with this
route. The authorizer identifier is generated by API Gateway when you
created the authorizer.
UpdateRoute
, updateRoute_modelSelectionExpression
- The model selection expression for the route. Supported only for
WebSocket APIs.
UpdateRoute
, updateRoute_operationName
- The operation name for the route.
UpdateRoute
, updateRoute_requestModels
- The request models for the route. Supported only for WebSocket APIs.
UpdateRoute
, updateRoute_requestParameters
- The request parameters for the route. Supported only for WebSocket APIs.
UpdateRoute
, updateRoute_routeKey
- The route key for the route.
UpdateRoute
, updateRoute_routeResponseSelectionExpression
- The route response selection expression for the route. Supported only
for WebSocket APIs.
UpdateRoute
, updateRoute_target
- The target for the route.
UpdateRoute
, updateRoute_apiId
- The API identifier.
UpdateRoute
, updateRoute_routeId
- The route ID.
data UpdateRouteResponse' Source #
See: newUpdateRouteResponse'
smart constructor.
UpdateRouteResponse'' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateRouteResponse' Source #
Create a value of UpdateRouteResponse'
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:
UpdateRouteResponse'
, updateRouteResponse'_apiGatewayManaged
- Specifies whether a route is managed by API Gateway. If you created an
API using quick create, the $default route is managed by API Gateway.
You can't modify the $default route key.
UpdateRoute
, updateRouteResponse'_apiKeyRequired
- Specifies whether an API key is required for this route. Supported only
for WebSocket APIs.
UpdateRoute
, updateRouteResponse'_authorizationScopes
- A list of authorization scopes configured on a route. The scopes are
used with a JWT authorizer to authorize the method invocation. The
authorization works by matching the route scopes against the scopes
parsed from the access token in the incoming request. The method
invocation is authorized if any route scope matches a claimed scope in
the access token. Otherwise, the invocation is not authorized. When the
route scope is configured, the client must provide an access token
instead of an identity token for authorization purposes.
UpdateRoute
, updateRouteResponse'_authorizationType
- The authorization type for the route. For WebSocket APIs, valid values
are NONE for open access, AWS_IAM for using AWS IAM permissions, and
CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are
NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using
AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
UpdateRoute
, updateRouteResponse'_authorizerId
- The identifier of the Authorizer resource to be associated with this
route. The authorizer identifier is generated by API Gateway when you
created the authorizer.
UpdateRoute
, updateRouteResponse'_modelSelectionExpression
- The model selection expression for the route. Supported only for
WebSocket APIs.
UpdateRoute
, updateRouteResponse'_operationName
- The operation name for the route.
UpdateRoute
, updateRouteResponse'_requestModels
- The request models for the route. Supported only for WebSocket APIs.
UpdateRoute
, updateRouteResponse'_requestParameters
- The request parameters for the route. Supported only for WebSocket APIs.
UpdateRoute
, updateRouteResponse'_routeId
- The route ID.
UpdateRoute
, updateRouteResponse'_routeKey
- The route key for the route.
UpdateRoute
, updateRouteResponse'_routeResponseSelectionExpression
- The route response selection expression for the route. Supported only
for WebSocket APIs.
UpdateRoute
, updateRouteResponse'_target
- The target for the route.
$sel:httpStatus:UpdateRouteResponse''
, updateRouteResponse'_httpStatus
- The response's http status code.
UpdateRouteResponse
data UpdateRouteResponse Source #
Updates a RouteResponse.
See: newUpdateRouteResponse
smart constructor.
UpdateRouteResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) Text Text Text |
Instances
newUpdateRouteResponse Source #
:: Text | |
-> Text | |
-> Text | |
-> UpdateRouteResponse |
Create a value of UpdateRouteResponse
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:
UpdateRouteResponse
, updateRouteResponse_modelSelectionExpression
- The model selection expression for the route response. Supported only
for WebSocket APIs.
UpdateRouteResponse
, updateRouteResponse_responseModels
- The response models for the route response.
UpdateRouteResponse
, updateRouteResponse_responseParameters
- The route response parameters.
UpdateRouteResponse
, updateRouteResponse_routeResponseKey
- The route response key.
UpdateRouteResponse
, updateRouteResponse_routeResponseId
- The route response ID.
UpdateRouteResponse
, updateRouteResponse_apiId
- The API identifier.
UpdateRouteResponse
, updateRouteResponse_routeId
- The route ID.
data UpdateRouteResponseResponse Source #
See: newUpdateRouteResponseResponse
smart constructor.
UpdateRouteResponseResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) Int |
Instances
newUpdateRouteResponseResponse Source #
Create a value of UpdateRouteResponseResponse
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:
UpdateRouteResponse
, updateRouteResponseResponse_modelSelectionExpression
- Represents the model selection expression of a route response. Supported
only for WebSocket APIs.
UpdateRouteResponse
, updateRouteResponseResponse_responseModels
- Represents the response models of a route response.
UpdateRouteResponse
, updateRouteResponseResponse_responseParameters
- Represents the response parameters of a route response.
UpdateRouteResponse
, updateRouteResponseResponse_routeResponseId
- Represents the identifier of a route response.
UpdateRouteResponse
, updateRouteResponseResponse_routeResponseKey
- Represents the route response key of a route response.
$sel:httpStatus:UpdateRouteResponseResponse'
, updateRouteResponseResponse_httpStatus
- The response's http status code.
UpdateStage
data UpdateStage Source #
Updates a Stage.
See: newUpdateStage
smart constructor.
UpdateStage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Text) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe (HashMap Text RouteSettings)) (Maybe (HashMap Text Text)) Text Text |
Instances
Create a value of UpdateStage
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:
UpdateStage
, updateStage_accessLogSettings
- Settings for logging access in this stage.
UpdateStage
, updateStage_autoDeploy
- Specifies whether updates to an API automatically trigger a new
deployment. The default value is false.
UpdateStage
, updateStage_clientCertificateId
- The identifier of a client certificate for a Stage.
UpdateStage
, updateStage_defaultRouteSettings
- The default route settings for the stage.
UpdateStage
, updateStage_deploymentId
- The deployment identifier for the API stage. Can't be updated if
autoDeploy is enabled.
UpdateStage
, updateStage_description
- The description for the API stage.
UpdateStage
, updateStage_routeSettings
- Route settings for the stage.
UpdateStage
, updateStage_stageVariables
- A map that defines the stage variables for a Stage. Variable names can
have alphanumeric and underscore characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+.
UpdateStage
, updateStage_stageName
- The stage name. Stage names can contain only alphanumeric characters,
hyphens, and underscores, or be $default. Maximum length is 128
characters.
UpdateStage
, updateStage_apiId
- The API identifier.
data UpdateStageResponse Source #
See: newUpdateStageResponse
smart constructor.
UpdateStageResponse' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe (HashMap Text RouteSettings)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Int |
Instances
newUpdateStageResponse Source #
Create a value of UpdateStageResponse
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:
UpdateStage
, updateStageResponse_accessLogSettings
- Settings for logging access in this stage.
UpdateStageResponse
, updateStageResponse_apiGatewayManaged
- Specifies whether a stage is managed by API Gateway. If you created an
API using quick create, the $default stage is managed by API Gateway.
You can't modify the $default stage.
UpdateStage
, updateStageResponse_autoDeploy
- Specifies whether updates to an API automatically trigger a new
deployment. The default value is false.
UpdateStage
, updateStageResponse_clientCertificateId
- The identifier of a client certificate for a Stage. Supported only for
WebSocket APIs.
UpdateStageResponse
, updateStageResponse_createdDate
- The timestamp when the stage was created.
UpdateStage
, updateStageResponse_defaultRouteSettings
- Default route settings for the stage.
UpdateStage
, updateStageResponse_deploymentId
- The identifier of the Deployment that the Stage is associated with.
Can't be updated if autoDeploy is enabled.
UpdateStage
, updateStageResponse_description
- The description of the stage.
UpdateStageResponse
, updateStageResponse_lastDeploymentStatusMessage
- Describes the status of the last deployment of a stage. Supported only
for stages with autoDeploy enabled.
UpdateStageResponse
, updateStageResponse_lastUpdatedDate
- The timestamp when the stage was last updated.
UpdateStage
, updateStageResponse_routeSettings
- Route settings for the stage, by routeKey.
UpdateStage
, updateStageResponse_stageName
- The name of the stage.
UpdateStage
, updateStageResponse_stageVariables
- 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-._~:/?#&=,]+.
UpdateStageResponse
, updateStageResponse_tags
- The collection of tags. Each tag element is associated with a given
resource.
$sel:httpStatus:UpdateStageResponse'
, updateStageResponse_httpStatus
- The response's http status code.
UpdateVpcLink
data UpdateVpcLink Source #
Updates a VPC link.
See: newUpdateVpcLink
smart constructor.
Instances
Create a value of UpdateVpcLink
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:
UpdateVpcLink
, updateVpcLink_name
- The name of the VPC link.
UpdateVpcLink
, updateVpcLink_vpcLinkId
- The ID of the VPC link.
data UpdateVpcLinkResponse Source #
See: newUpdateVpcLinkResponse
smart constructor.
UpdateVpcLinkResponse' (Maybe ISO8601) (Maybe Text) (Maybe [Text]) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe VpcLinkVersion) Int |
Instances
newUpdateVpcLinkResponse Source #
Create a value of UpdateVpcLinkResponse
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:
UpdateVpcLinkResponse
, updateVpcLinkResponse_createdDate
- The timestamp when the VPC link was created.
UpdateVpcLink
, updateVpcLinkResponse_name
- The name of the VPC link.
UpdateVpcLinkResponse
, updateVpcLinkResponse_securityGroupIds
- A list of security group IDs for the VPC link.
UpdateVpcLinkResponse
, updateVpcLinkResponse_subnetIds
- A list of subnet IDs to include in the VPC link.
UpdateVpcLinkResponse
, updateVpcLinkResponse_tags
- Tags for the VPC link.
UpdateVpcLink
, updateVpcLinkResponse_vpcLinkId
- The ID of the VPC link.
UpdateVpcLinkResponse
, updateVpcLinkResponse_vpcLinkStatus
- The status of the VPC link.
UpdateVpcLinkResponse
, updateVpcLinkResponse_vpcLinkStatusMessage
- A message summarizing the cause of the status of the VPC link.
UpdateVpcLinkResponse
, updateVpcLinkResponse_vpcLinkVersion
- The version of the VPC link.
$sel:httpStatus:UpdateVpcLinkResponse'
, updateVpcLinkResponse_httpStatus
- The response's http status code.
Types
AuthorizationType
newtype AuthorizationType Source #
The authorization type. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer. For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
pattern AuthorizationType_AWS_IAM :: AuthorizationType | |
pattern AuthorizationType_CUSTOM :: AuthorizationType | |
pattern AuthorizationType_JWT :: AuthorizationType | |
pattern AuthorizationType_NONE :: AuthorizationType |
Instances
AuthorizerType
newtype AuthorizerType Source #
The authorizer type. Specify REQUEST for a Lambda function using incoming request parameters. Specify JWT to use JSON Web Tokens (supported only for HTTP APIs).
pattern AuthorizerType_JWT :: AuthorizerType | |
pattern AuthorizerType_REQUEST :: AuthorizerType |
Instances
ConnectionType
newtype ConnectionType Source #
Represents a connection type.
pattern ConnectionType_INTERNET :: ConnectionType | |
pattern ConnectionType_VPC_LINK :: ConnectionType |
Instances
ContentHandlingStrategy
newtype ContentHandlingStrategy Source #
Specifies how to handle response payload content type conversions. Supported only for WebSocket APIs.
pattern ContentHandlingStrategy_CONVERT_TO_BINARY :: ContentHandlingStrategy | |
pattern ContentHandlingStrategy_CONVERT_TO_TEXT :: ContentHandlingStrategy |
Instances
DeploymentStatus
newtype DeploymentStatus Source #
Represents a deployment status.
pattern DeploymentStatus_DEPLOYED :: DeploymentStatus | |
pattern DeploymentStatus_FAILED :: DeploymentStatus | |
pattern DeploymentStatus_PENDING :: DeploymentStatus |
Instances
DomainNameStatus
newtype DomainNameStatus Source #
The status of the domain name migration. The valid values are AVAILABLE, UPDATING, PENDING_CERTIFICATE_REIMPORT, and PENDING_OWNERSHIP_VERIFICATION. 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.
Instances
EndpointType
newtype EndpointType Source #
Represents an endpoint type.
pattern EndpointType_EDGE :: EndpointType | |
pattern EndpointType_REGIONAL :: EndpointType |
Instances
IntegrationType
newtype IntegrationType Source #
Represents an API method integration type.
pattern IntegrationType_AWS :: IntegrationType | |
pattern IntegrationType_AWS_PROXY :: IntegrationType | |
pattern IntegrationType_HTTP :: IntegrationType | |
pattern IntegrationType_HTTP_PROXY :: IntegrationType | |
pattern IntegrationType_MOCK :: IntegrationType |
Instances
LoggingLevel
newtype LoggingLevel Source #
The logging level.
pattern LoggingLevel_ERROR :: LoggingLevel | |
pattern LoggingLevel_INFO :: LoggingLevel | |
pattern LoggingLevel_OFF :: LoggingLevel |
Instances
PassthroughBehavior
newtype PassthroughBehavior Source #
Represents passthrough behavior for an integration response. Supported only for WebSocket APIs.
pattern PassthroughBehavior_NEVER :: PassthroughBehavior | |
pattern PassthroughBehavior_WHEN_NO_MATCH :: PassthroughBehavior | |
pattern PassthroughBehavior_WHEN_NO_TEMPLATES :: PassthroughBehavior |
Instances
ProtocolType
newtype ProtocolType Source #
Represents a protocol type.
pattern ProtocolType_HTTP :: ProtocolType | |
pattern ProtocolType_WEBSOCKET :: ProtocolType |
Instances
SecurityPolicy
newtype SecurityPolicy Source #
The Transport Layer Security (TLS) version of the security policy for this domain name. The valid values are TLS_1_0 and TLS_1_2.
pattern SecurityPolicy_TLS_1_0 :: SecurityPolicy | |
pattern SecurityPolicy_TLS_1_2 :: SecurityPolicy |
Instances
VpcLinkStatus
newtype VpcLinkStatus Source #
The status of the VPC link.
pattern VpcLinkStatus_AVAILABLE :: VpcLinkStatus | |
pattern VpcLinkStatus_DELETING :: VpcLinkStatus | |
pattern VpcLinkStatus_FAILED :: VpcLinkStatus | |
pattern VpcLinkStatus_INACTIVE :: VpcLinkStatus | |
pattern VpcLinkStatus_PENDING :: VpcLinkStatus |
Instances
VpcLinkVersion
newtype VpcLinkVersion Source #
The version of the VPC link.
pattern VpcLinkVersion_V2 :: VpcLinkVersion |
Instances
AccessLogSettings
data AccessLogSettings Source #
Settings for logging access in a stage.
See: newAccessLogSettings
smart constructor.
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 ARN of the CloudWatch Logs log group to receive access logs.
$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.
Api
Represents an API.
See: newApi
smart constructor.
Api' (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Cors) (Maybe ISO8601) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text]) Text Text ProtocolType |
Instances
:: Text | |
-> Text | |
-> ProtocolType | |
-> Api |
Create a value of Api
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:apiEndpoint:Api'
, api_apiEndpoint
- The URI of the API, of the form
{api-id}.execute-api.{region}.amazonaws.com. The stage name is typically
appended to this URI to form a complete path to a deployed API stage.
$sel:apiGatewayManaged:Api'
, api_apiGatewayManaged
- Specifies whether an API is managed by API Gateway. You can't update or
delete a managed API by using API Gateway. A managed API can be deleted
only through the tooling or service that created it.
$sel:apiId:Api'
, api_apiId
- The API ID.
$sel:apiKeySelectionExpression:Api'
, api_apiKeySelectionExpression
- An API key selection expression. Supported only for WebSocket APIs. See
API Key Selection Expressions.
$sel:corsConfiguration:Api'
, api_corsConfiguration
- A CORS configuration. Supported only for HTTP APIs.
$sel:createdDate:Api'
, api_createdDate
- The timestamp when the API was created.
$sel:description:Api'
, api_description
- The description of the API.
$sel:disableExecuteApiEndpoint:Api'
, api_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:disableSchemaValidation:Api'
, api_disableSchemaValidation
- Avoid validating models when creating a deployment. Supported only for
WebSocket APIs.
$sel:importInfo:Api'
, api_importInfo
- The validation information during API import. This may include
particular properties of your OpenAPI definition which are ignored
during import. Supported only for HTTP APIs.
$sel:tags:Api'
, api_tags
- A collection of tags associated with the API.
$sel:version:Api'
, api_version
- A version identifier for the API.
$sel:warnings:Api'
, api_warnings
- The warning messages reported when failonwarnings is turned on during
API import.
$sel:routeSelectionExpression:Api'
, api_routeSelectionExpression
- The route selection expression for the API. For HTTP APIs, the
routeSelectionExpression must be ${request.method} ${request.path}. If
not provided, this will be the default for HTTP APIs. This property is
required for WebSocket APIs.
$sel:name:Api'
, api_name
- The name of the API.
$sel:protocolType:Api'
, api_protocolType
- The API protocol.
ApiMapping
data ApiMapping Source #
Represents an API mapping.
See: newApiMapping
smart constructor.
Instances
Create a value of ApiMapping
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:apiMappingId:ApiMapping'
, apiMapping_apiMappingId
- The API mapping identifier.
$sel:apiMappingKey:ApiMapping'
, apiMapping_apiMappingKey
- The API mapping key.
$sel:stage:ApiMapping'
, apiMapping_stage
- The API stage.
$sel:apiId:ApiMapping'
, apiMapping_apiId
- The API identifier.
Authorizer
data Authorizer Source #
Represents an authorizer.
See: newAuthorizer
smart constructor.
Authorizer' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Natural) (Maybe AuthorizerType) (Maybe Text) (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe JWTConfiguration) Text |
Instances
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:authorizerCredentialsArn:Authorizer'
, authorizer_authorizerCredentialsArn
- 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, don't specify this parameter.
Supported only for REQUEST authorizers.
$sel:authorizerId:Authorizer'
, authorizer_authorizerId
- The authorizer identifier.
$sel:authorizerPayloadFormatVersion:Authorizer'
, authorizer_authorizerPayloadFormatVersion
- Specifies the format of the payload sent to an HTTP API Lambda
authorizer. Required for HTTP API Lambda authorizers. Supported values
are 1.0 and 2.0. To learn more, see
Working with AWS Lambda authorizers for HTTP APIs.
$sel:authorizerResultTtlInSeconds:Authorizer'
, authorizer_authorizerResultTtlInSeconds
- The time to live (TTL) for cached authorizer results, in seconds. If it
equals 0, authorization caching is disabled. If it is greater than 0,
API Gateway caches authorizer responses. The maximum value is 3600, or 1
hour. Supported only for HTTP API Lambda authorizers.
$sel:authorizerType:Authorizer'
, authorizer_authorizerType
- The authorizer type. Specify REQUEST for a Lambda function using
incoming request parameters. Specify JWT to use JSON Web Tokens
(supported only for HTTP APIs).
$sel:authorizerUri:Authorizer'
, authorizer_authorizerUri
- The authorizer's Uniform Resource Identifier (URI). For 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.
Supported only for REQUEST authorizers.
$sel:enableSimpleResponses:Authorizer'
, authorizer_enableSimpleResponses
- Specifies whether a Lambda authorizer returns a response in a simple
format. If enabled, the Lambda authorizer can return a boolean value
instead of an IAM policy. Supported only for HTTP APIs. To learn more,
see
Working with AWS Lambda authorizers for HTTP APIs
$sel:identitySource:Authorizer'
, authorizer_identitySource
- The identity source for which authorization is requested.
For a REQUEST authorizer, this is optional. The value is a set of one or more mapping expressions of the specified request parameters. The identity source can be headers, query string parameters, stage variables, and context parameters. For example, if an Auth header and a Name query string parameter are defined as identity sources, this value is route.request.header.Auth, route.request.querystring.Name for WebSocket APIs. For HTTP APIs, use selection expressions prefixed with $, for example, $request.header.Auth, $request.querystring.Name. These parameters are used to perform runtime validation for Lambda-based authorizers by verifying all of the identity-related request parameters are present in the request, 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. For HTTP APIs, identity sources are also used as the cache key when caching is enabled. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.
For JWT, a single entry that specifies where to extract the JSON Web Token (JWT) from inbound requests. Currently only header-based and query parameter-based selections are supported, for example $request.header.Authorization.
$sel:identityValidationExpression:Authorizer'
, authorizer_identityValidationExpression
- The validation expression does not apply to the REQUEST authorizer.
$sel:jwtConfiguration:Authorizer'
, authorizer_jwtConfiguration
- Represents the configuration of a JWT authorizer. Required for the JWT
authorizer type. Supported only for HTTP APIs.
$sel:name:Authorizer'
, authorizer_name
- The name of the authorizer.
Cors
Represents a CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
See: newCors
smart constructor.
Instances
Create a value of Cors
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:allowCredentials:Cors'
, cors_allowCredentials
- Specifies whether credentials are included in the CORS request.
Supported only for HTTP APIs.
$sel:allowHeaders:Cors'
, cors_allowHeaders
- Represents a collection of allowed headers. Supported only for HTTP
APIs.
$sel:allowMethods:Cors'
, cors_allowMethods
- Represents a collection of allowed HTTP methods. Supported only for HTTP
APIs.
$sel:allowOrigins:Cors'
, cors_allowOrigins
- Represents a collection of allowed origins. Supported only for HTTP
APIs.
$sel:exposeHeaders:Cors'
, cors_exposeHeaders
- Represents a collection of exposed headers. Supported only for HTTP
APIs.
$sel:maxAge:Cors'
, cors_maxAge
- The number of seconds that the browser should cache preflight request
results. Supported only for HTTP APIs.
Deployment
data Deployment Source #
An immutable representation of an API that can be called by users. A Deployment must be associated with a Stage for it to be callable over the internet.
See: newDeployment
smart constructor.
Deployment' (Maybe Bool) (Maybe ISO8601) (Maybe Text) (Maybe DeploymentStatus) (Maybe Text) (Maybe Text) |
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:autoDeployed:Deployment'
, deployment_autoDeployed
- Specifies whether a deployment was automatically released.
$sel:createdDate:Deployment'
, deployment_createdDate
- The date and time when the Deployment resource was created.
$sel:deploymentId:Deployment'
, deployment_deploymentId
- The identifier for the deployment.
$sel:deploymentStatus:Deployment'
, deployment_deploymentStatus
- The status of the deployment: PENDING, FAILED, or SUCCEEDED.
$sel:deploymentStatusMessage:Deployment'
, deployment_deploymentStatusMessage
- May contain additional feedback on the status of an API deployment.
$sel:description:Deployment'
, deployment_description
- The description for the deployment.
DomainName
data DomainName Source #
Represents a domain name.
See: newDomainName
smart constructor.
DomainName' (Maybe Text) (Maybe [DomainNameConfiguration]) (Maybe MutualTlsAuthentication) (Maybe (HashMap Text Text)) Text |
Instances
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:apiMappingSelectionExpression:DomainName'
, domainName_apiMappingSelectionExpression
- The API mapping selection expression.
$sel:domainNameConfigurations:DomainName'
, domainName_domainNameConfigurations
- The domain name configurations.
$sel:mutualTlsAuthentication:DomainName'
, domainName_mutualTlsAuthentication
- The mutual TLS authentication configuration for a custom domain name.
$sel:tags:DomainName'
, domainName_tags
- The collection of tags associated with a domain name.
$sel:domainName:DomainName'
, domainName_domainName
- The name of the DomainName resource.
DomainNameConfiguration
data DomainNameConfiguration Source #
The domain name configuration.
See: newDomainNameConfiguration
smart constructor.
DomainNameConfiguration' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointType) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) |
Instances
newDomainNameConfiguration :: DomainNameConfiguration Source #
Create a value of DomainNameConfiguration
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:apiGatewayDomainName:DomainNameConfiguration'
, domainNameConfiguration_apiGatewayDomainName
- A domain name for the API.
$sel:certificateArn:DomainNameConfiguration'
, domainNameConfiguration_certificateArn
- An AWS-managed certificate that will be used by the edge-optimized
endpoint for this domain name. AWS Certificate Manager is the only
supported source.
$sel:certificateName:DomainNameConfiguration'
, domainNameConfiguration_certificateName
- The user-friendly name of the certificate that will be used by the
edge-optimized endpoint for this domain name.
$sel:certificateUploadDate:DomainNameConfiguration'
, domainNameConfiguration_certificateUploadDate
- The timestamp when the certificate that was used by edge-optimized
endpoint for this domain name was uploaded.
$sel:domainNameStatus:DomainNameConfiguration'
, domainNameConfiguration_domainNameStatus
- The status of the domain name migration. The valid values are AVAILABLE,
UPDATING, PENDING_CERTIFICATE_REIMPORT, and
PENDING_OWNERSHIP_VERIFICATION. 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:DomainNameConfiguration'
, domainNameConfiguration_domainNameStatusMessage
- An optional text message containing detailed information about status of
the domain name migration.
$sel:endpointType:DomainNameConfiguration'
, domainNameConfiguration_endpointType
- The endpoint type.
$sel:hostedZoneId:DomainNameConfiguration'
, domainNameConfiguration_hostedZoneId
- The Amazon Route 53 Hosted Zone ID of the endpoint.
$sel:ownershipVerificationCertificateArn:DomainNameConfiguration'
, domainNameConfiguration_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:securityPolicy:DomainNameConfiguration'
, domainNameConfiguration_securityPolicy
- The Transport Layer Security (TLS) version of the security policy for
this domain name. The valid values are TLS_1_0 and TLS_1_2.
Integration
data Integration Source #
Represents an integration.
See: newIntegration
smart constructor.
Integration' (Maybe Bool) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe IntegrationType) (Maybe Text) (Maybe PassthroughBehavior) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text (HashMap Text Text))) (Maybe Text) (Maybe Natural) (Maybe TlsConfig) |
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:apiGatewayManaged:Integration'
, integration_apiGatewayManaged
- Specifies whether an integration is managed by API Gateway. If you
created an API using using quick create, the resulting integration is
managed by API Gateway. You can update a managed integration, but you
can't delete it.
$sel:connectionId:Integration'
, integration_connectionId
- The ID of the VPC link for a private integration. Supported only for
HTTP APIs.
$sel:connectionType:Integration'
, integration_connectionType
- The type of the network connection to the integration endpoint. Specify
INTERNET for connections through the public routable internet or
VPC_LINK for private connections between API Gateway and resources in a
VPC. The default value is INTERNET.
$sel:contentHandlingStrategy:Integration'
, integration_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
$sel:credentialsArn:Integration'
, integration_credentialsArn
- 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:description:Integration'
, integration_description
- Represents the description of an integration.
$sel:integrationId:Integration'
, integration_integrationId
- Represents the identifier of an integration.
$sel:integrationMethod:Integration'
, integration_integrationMethod
- Specifies the integration's HTTP method type.
$sel:integrationResponseSelectionExpression:Integration'
, integration_integrationResponseSelectionExpression
- The integration response selection expression for the integration.
Supported only for WebSocket APIs. See
Integration Response Selection Expressions.
$sel:integrationSubtype:Integration'
, integration_integrationSubtype
- Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS
service action to invoke. To learn more, see
Integration subtype reference.
$sel:integrationType:Integration'
, integration_integrationType
- The integration type of an integration. One of the following:
AWS: for integrating the route or method request with an AWS service action, including the Lambda function-invoking action. With the Lambda function-invoking action, this is referred to as the Lambda custom integration. With any other AWS service action, this is known as AWS integration. Supported only for WebSocket APIs.
AWS_PROXY: for integrating the route or method request with a Lambda function or other AWS service action. This integration is also referred to as a Lambda proxy integration.
HTTP: for integrating the route or method request with an HTTP endpoint. This integration is also referred to as the HTTP custom integration. Supported only for WebSocket APIs.
HTTP_PROXY: for integrating the route or method request with an HTTP endpoint, with the client request passed through as-is. This is also referred to as HTTP proxy integration.
MOCK: for integrating the route or method request with API Gateway as a "loopback" endpoint without invoking any backend. Supported only for WebSocket APIs.
$sel:integrationUri:Integration'
, integration_integrationUri
- For a Lambda integration, specify the URI of a Lambda function.
For an HTTP integration, specify a fully-qualified URL.
For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.
$sel:passthroughBehavior:Integration'
, integration_passthroughBehavior
- Specifies the pass-through behavior for incoming requests based on the
Content-Type header in the request, and the available mapping templates
specified as the requestTemplates property on the Integration resource.
There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and
NEVER. Supported only for WebSocket APIs.
WHEN_NO_MATCH passes the request body for unmapped content types through to the integration backend without transformation.
NEVER rejects unmapped content types with an HTTP 415 Unsupported Media Type response.
WHEN_NO_TEMPLATES allows pass-through when the integration has no content types mapped to templates. However, if there is at least one content type defined, unmapped content types will be rejected with the same HTTP 415 Unsupported Media Type response.
$sel:payloadFormatVersion:Integration'
, integration_payloadFormatVersion
- Specifies the format of the payload sent to an integration. Required for
HTTP APIs.
$sel:requestParameters:Integration'
, integration_requestParameters
- For WebSocket APIs, a key-value map specifying request parameters that
are passed from the method request to the backend. 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 backend. 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.
For HTTP API integrations with a specified integrationSubtype, request parameters are a key-value map specifying parameters that are passed to AWS_PROXY integrations. You can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Working with AWS service integrations for HTTP APIs.
For HTTP API itegrations, without a specified integrationSubtype request parameters are a key-value map specifying how to transform HTTP requests before sending them to backend integrations. The key should follow the pattern <action>:<header|querystring|path>.<location>. The action can be append, overwrite or remove. For values, you can provide static values, or map request data, stage variables, or context variables that are evaluated at runtime. To learn more, see Transforming API requests and responses.
$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. Supported only for WebSocket APIs.
$sel:responseParameters:Integration'
, integration_responseParameters
- Supported only for HTTP APIs. You use response parameters to transform
the HTTP response from a backend integration before returning the
response to clients. Specify a key-value map from a selection key to
response parameters. The selection key must be a valid HTTP status code
within the range of 200-599. Response parameters are a key-value map.
The key must match pattern <action>:<header>.<location> or
overwrite.statuscode. The action can be append, overwrite or remove. The
value can be a static value, or map to response data, stage variables,
or context variables that are evaluated at runtime. To learn more, see
Transforming API requests and responses.
$sel:templateSelectionExpression:Integration'
, integration_templateSelectionExpression
- The template selection expression for the integration. Supported only
for WebSocket APIs.
$sel:timeoutInMillis:Integration'
, integration_timeoutInMillis
- Custom timeout between 50 and 29,000 milliseconds for WebSocket APIs and
between 50 and 30,000 milliseconds for HTTP APIs. The default timeout is
29 seconds for WebSocket APIs and 30 seconds for HTTP APIs.
$sel:tlsConfig:Integration'
, integration_tlsConfig
- The TLS configuration for a private integration. If you specify a TLS
configuration, private integration traffic uses the HTTPS protocol.
Supported only for HTTP APIs.
IntegrationResponse
data IntegrationResponse Source #
Represents an integration response.
See: newIntegrationResponse
smart constructor.
IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text |
Instances
newIntegrationResponse 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:contentHandlingStrategy:IntegrationResponse'
, integrationResponse_contentHandlingStrategy
- Supported only for WebSocket APIs. Specifies how to handle response
payload content type conversions. Supported values are CONVERT_TO_BINARY
and CONVERT_TO_TEXT, with the following behaviors:
CONVERT_TO_BINARY: Converts a response payload from a Base64-encoded string to the corresponding binary blob.
CONVERT_TO_TEXT: Converts a response payload from a binary blob to a Base64-encoded string.
If this property is not defined, the response payload will be passed through from the integration response to the route response or method response without modification.
$sel:integrationResponseId:IntegrationResponse'
, integrationResponse_integrationResponseId
- The integration response ID.
$sel:responseParameters:IntegrationResponse'
, integrationResponse_responseParameters
- A key-value map specifying response parameters that are passed to the
method response from the backend. 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
- The collection of response templates for the integration response as a
string-to-string map of key-value pairs. Response templates are
represented as a key/value map, with a content-type as the key and a
template as the value.
$sel:templateSelectionExpression:IntegrationResponse'
, integrationResponse_templateSelectionExpression
- The template selection expressions for the integration response.
$sel:integrationResponseKey:IntegrationResponse'
, integrationResponse_integrationResponseKey
- The integration response key.
JWTConfiguration
data JWTConfiguration Source #
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
See: newJWTConfiguration
smart constructor.
JWTConfiguration' (Maybe [Text]) (Maybe Text) |
Instances
newJWTConfiguration :: JWTConfiguration Source #
Create a value of JWTConfiguration
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:audience:JWTConfiguration'
, jWTConfiguration_audience
- A list of the intended recipients of the JWT. A valid JWT must provide
an aud that matches at least one entry in this list. See
RFC 7519. Supported
only for HTTP APIs.
$sel:issuer:JWTConfiguration'
, jWTConfiguration_issuer
- The base domain of the identity provider that issues JSON Web Tokens.
For example, an Amazon Cognito user pool has the following format:
https://cognito-idp.{region}.amazonaws.com/{userPoolId} . Required
for the JWT authorizer type. Supported only for HTTP APIs.
Model
Represents a data model for an API. Supported only for WebSocket APIs. See Create Models and Mapping Templates for Request and Response Mappings.
See: newModel
smart constructor.
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, for example, "application/json".
$sel:description:Model'
, model_description
- The description of the model.
$sel:modelId:Model'
, model_modelId
- The model identifier.
$sel:schema:Model'
, model_schema
- The schema for the model. For application/json models, this should be
JSON schema draft 4 model.
$sel:name:Model'
, model_name
- The name of the model. Must be alphanumeric.
MutualTlsAuthentication
data MutualTlsAuthentication Source #
See: newMutualTlsAuthentication
smart constructor.
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.
MutualTlsAuthenticationInput
data MutualTlsAuthenticationInput Source #
See: newMutualTlsAuthenticationInput
smart constructor.
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.
ParameterConstraints
data ParameterConstraints Source #
Validation constraints imposed on parameters of a request (path, query string, headers).
See: newParameterConstraints
smart constructor.
Instances
newParameterConstraints :: ParameterConstraints Source #
Create a value of ParameterConstraints
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:required:ParameterConstraints'
, parameterConstraints_required
- Whether or not the parameter is required.
Route
Represents a route.
See: newRoute
smart constructor.
Route' (Maybe Bool) (Maybe Bool) (Maybe [Text]) (Maybe AuthorizationType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Create a value of Route
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:apiGatewayManaged:Route'
, route_apiGatewayManaged
- Specifies whether a route is managed by API Gateway. If you created an
API using quick create, the $default route is managed by API Gateway.
You can't modify the $default route key.
$sel:apiKeyRequired:Route'
, route_apiKeyRequired
- Specifies whether an API key is required for this route. Supported only
for WebSocket APIs.
$sel:authorizationScopes:Route'
, route_authorizationScopes
- A list of authorization scopes configured on a route. The scopes are
used with a JWT authorizer to authorize the method invocation. The
authorization works by matching the route scopes against the scopes
parsed from the access token in the incoming request. The method
invocation is authorized if any route scope matches a claimed scope in
the access token. Otherwise, the invocation is not authorized. When the
route scope is configured, the client must provide an access token
instead of an identity token for authorization purposes.
$sel:authorizationType:Route'
, route_authorizationType
- The authorization type for the route. For WebSocket APIs, valid values
are NONE for open access, AWS_IAM for using AWS IAM permissions, and
CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are
NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using
AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
$sel:authorizerId:Route'
, route_authorizerId
- The identifier of the Authorizer resource to be associated with this
route. The authorizer identifier is generated by API Gateway when you
created the authorizer.
$sel:modelSelectionExpression:Route'
, route_modelSelectionExpression
- The model selection expression for the route. Supported only for
WebSocket APIs.
$sel:operationName:Route'
, route_operationName
- The operation name for the route.
$sel:requestModels:Route'
, route_requestModels
- The request models for the route. Supported only for WebSocket APIs.
$sel:requestParameters:Route'
, route_requestParameters
- The request parameters for the route. Supported only for WebSocket APIs.
$sel:routeId:Route'
, route_routeId
- The route ID.
$sel:routeResponseSelectionExpression:Route'
, route_routeResponseSelectionExpression
- The route response selection expression for the route. Supported only
for WebSocket APIs.
$sel:target:Route'
, route_target
- The target for the route.
$sel:routeKey:Route'
, route_routeKey
- The route key for the route.
RouteResponse
data RouteResponse Source #
Represents a route response.
See: newRouteResponse
smart constructor.
RouteResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text ParameterConstraints)) (Maybe Text) Text |
Instances
Create a value of RouteResponse
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:modelSelectionExpression:RouteResponse'
, routeResponse_modelSelectionExpression
- Represents the model selection expression of a route response. Supported
only for WebSocket APIs.
$sel:responseModels:RouteResponse'
, routeResponse_responseModels
- Represents the response models of a route response.
$sel:responseParameters:RouteResponse'
, routeResponse_responseParameters
- Represents the response parameters of a route response.
$sel:routeResponseId:RouteResponse'
, routeResponse_routeResponseId
- Represents the identifier of a route response.
$sel:routeResponseKey:RouteResponse'
, routeResponse_routeResponseKey
- Represents the route response key of a route response.
RouteSettings
data RouteSettings Source #
Represents a collection of route settings.
See: newRouteSettings
smart constructor.
Instances
newRouteSettings :: RouteSettings Source #
Create a value of RouteSettings
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:dataTraceEnabled:RouteSettings'
, routeSettings_dataTraceEnabled
- Specifies whether (true) or not (false) data trace logging is enabled
for this route. This property affects the log entries pushed to Amazon
CloudWatch Logs. Supported only for WebSocket APIs.
$sel:detailedMetricsEnabled:RouteSettings'
, routeSettings_detailedMetricsEnabled
- Specifies whether detailed metrics are enabled.
$sel:loggingLevel:RouteSettings'
, routeSettings_loggingLevel
- Specifies the logging level for this route: INFO, ERROR, or OFF. This
property affects the log entries pushed to Amazon CloudWatch Logs.
Supported only for WebSocket APIs.
$sel:throttlingBurstLimit:RouteSettings'
, routeSettings_throttlingBurstLimit
- Specifies the throttling burst limit.
$sel:throttlingRateLimit:RouteSettings'
, routeSettings_throttlingRateLimit
- Specifies the throttling rate limit.
Stage
Represents an API stage.
See: newStage
smart constructor.
Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ISO8601) (Maybe RouteSettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ISO8601) (Maybe (HashMap Text RouteSettings)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) Text |
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:apiGatewayManaged:Stage'
, stage_apiGatewayManaged
- Specifies whether a stage is managed by API Gateway. If you created an
API using quick create, the $default stage is managed by API Gateway.
You can't modify the $default stage.
$sel:autoDeploy:Stage'
, stage_autoDeploy
- Specifies whether updates to an API automatically trigger a new
deployment. The default value is false.
$sel:clientCertificateId:Stage'
, stage_clientCertificateId
- The identifier of a client certificate for a Stage. Supported only for
WebSocket APIs.
$sel:createdDate:Stage'
, stage_createdDate
- The timestamp when the stage was created.
$sel:defaultRouteSettings:Stage'
, stage_defaultRouteSettings
- Default route settings for the stage.
$sel:deploymentId:Stage'
, stage_deploymentId
- The identifier of the Deployment that the Stage is associated with.
Can't be updated if autoDeploy is enabled.
$sel:description:Stage'
, stage_description
- The description of the stage.
$sel:lastDeploymentStatusMessage:Stage'
, stage_lastDeploymentStatusMessage
- Describes the status of the last deployment of a stage. Supported only
for stages with autoDeploy enabled.
$sel:lastUpdatedDate:Stage'
, stage_lastUpdatedDate
- The timestamp when the stage was last updated.
$sel:routeSettings:Stage'
, stage_routeSettings
- Route settings for the stage, by routeKey.
$sel:stageVariables:Stage'
, stage_stageVariables
- 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:tags:Stage'
, stage_tags
- The collection of tags. Each tag element is associated with a given
resource.
$sel:stageName:Stage'
, stage_stageName
- The name of the stage.
TlsConfig
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
See: newTlsConfig
smart constructor.
Instances
FromJSON TlsConfig Source # | |
Generic TlsConfig Source # | |
Read TlsConfig Source # | |
Show TlsConfig Source # | |
NFData TlsConfig Source # | |
Defined in Amazonka.ApiGatewayV2.Types.TlsConfig | |
Eq TlsConfig Source # | |
Hashable TlsConfig Source # | |
Defined in Amazonka.ApiGatewayV2.Types.TlsConfig | |
type Rep TlsConfig Source # | |
Defined in Amazonka.ApiGatewayV2.Types.TlsConfig type Rep TlsConfig = D1 ('MetaData "TlsConfig" "Amazonka.ApiGatewayV2.Types.TlsConfig" "amazonka-apigatewayv2-2.0-4MZ8oueToeLOWomgegceF" 'False) (C1 ('MetaCons "TlsConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "serverNameToVerify") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) |
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:serverNameToVerify:TlsConfig'
, tlsConfig_serverNameToVerify
- If you specify a server name, API Gateway uses it to verify the hostname
on the integration's certificate. The server name is also included in
the TLS handshake to support Server Name Indication (SNI) or virtual
hosting.
TlsConfigInput
data TlsConfigInput Source #
The TLS configuration for a private integration. If you specify a TLS configuration, private integration traffic uses the HTTPS protocol. Supported only for HTTP APIs.
See: newTlsConfigInput
smart constructor.
Instances
newTlsConfigInput :: TlsConfigInput Source #
Create a value of TlsConfigInput
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:serverNameToVerify:TlsConfigInput'
, tlsConfigInput_serverNameToVerify
- If you specify a server name, API Gateway uses it to verify the hostname
on the integration's certificate. The server name is also included in
the TLS handshake to support Server Name Indication (SNI) or virtual
hosting.
VpcLink
Represents a VPC link.
See: newVpcLink
smart constructor.
VpcLink' (Maybe ISO8601) (Maybe (HashMap Text Text)) (Maybe VpcLinkStatus) (Maybe Text) (Maybe VpcLinkVersion) Text [Text] [Text] Text |
Instances
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:createdDate:VpcLink'
, vpcLink_createdDate
- The timestamp when the VPC link was created.
$sel:tags:VpcLink'
, vpcLink_tags
- Tags for the VPC link.
$sel:vpcLinkStatus:VpcLink'
, vpcLink_vpcLinkStatus
- The status of the VPC link.
$sel:vpcLinkStatusMessage:VpcLink'
, vpcLink_vpcLinkStatusMessage
- A message summarizing the cause of the status of the VPC link.
$sel:vpcLinkVersion:VpcLink'
, vpcLink_vpcLinkVersion
- The version of the VPC link.
$sel:vpcLinkId:VpcLink'
, vpcLink_vpcLinkId
- The ID of the VPC link.
$sel:securityGroupIds:VpcLink'
, vpcLink_securityGroupIds
- A list of security group IDs for the VPC link.
$sel:subnetIds:VpcLink'
, vpcLink_subnetIds
- A list of subnet IDs to include in the VPC link.
$sel:name:VpcLink'
, vpcLink_name
- The name of the VPC link.