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 |
- 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
- GetAuthorizer
- GetAuthorizers
- GetDeployment
- GetDeployments
- GetDomainName
- GetDomainNames
- GetIntegration
- GetIntegrationResponse
- GetIntegrationResponses
- GetIntegrations
- GetModel
- GetModelTemplate
- GetModels
- GetRoute
- GetRouteResponse
- GetRouteResponses
- GetRoutes
- GetStage
- GetStages
- GetTags
- GetVpcLink
- GetVpcLinks
- ImportApi
- ReimportApi
- ResetAuthorizersCache
- TagResource
- UntagResource
- UpdateApi
- UpdateApiMapping
- UpdateAuthorizer
- UpdateDeployment
- UpdateDomainName
- UpdateIntegration
- UpdateIntegrationResponse
- UpdateModel
- UpdateRoute
- UpdateRouteResponse
- UpdateStage
- UpdateVpcLink
- Types
Synopsis
- createApi_apiKeySelectionExpression :: Lens' CreateApi (Maybe Text)
- createApi_corsConfiguration :: Lens' CreateApi (Maybe Cors)
- createApi_credentialsArn :: Lens' CreateApi (Maybe Text)
- createApi_description :: Lens' CreateApi (Maybe Text)
- createApi_disableExecuteApiEndpoint :: Lens' CreateApi (Maybe Bool)
- createApi_disableSchemaValidation :: Lens' CreateApi (Maybe Bool)
- createApi_routeKey :: Lens' CreateApi (Maybe Text)
- createApi_routeSelectionExpression :: Lens' CreateApi (Maybe Text)
- createApi_tags :: Lens' CreateApi (Maybe (HashMap Text Text))
- createApi_target :: Lens' CreateApi (Maybe Text)
- createApi_version :: Lens' CreateApi (Maybe Text)
- createApi_protocolType :: Lens' CreateApi ProtocolType
- createApi_name :: Lens' CreateApi Text
- createApiResponse_apiEndpoint :: Lens' CreateApiResponse (Maybe Text)
- createApiResponse_apiGatewayManaged :: Lens' CreateApiResponse (Maybe Bool)
- createApiResponse_apiId :: Lens' CreateApiResponse (Maybe Text)
- createApiResponse_apiKeySelectionExpression :: Lens' CreateApiResponse (Maybe Text)
- createApiResponse_corsConfiguration :: Lens' CreateApiResponse (Maybe Cors)
- createApiResponse_createdDate :: Lens' CreateApiResponse (Maybe UTCTime)
- createApiResponse_description :: Lens' CreateApiResponse (Maybe Text)
- createApiResponse_disableExecuteApiEndpoint :: Lens' CreateApiResponse (Maybe Bool)
- createApiResponse_disableSchemaValidation :: Lens' CreateApiResponse (Maybe Bool)
- createApiResponse_importInfo :: Lens' CreateApiResponse (Maybe [Text])
- createApiResponse_name :: Lens' CreateApiResponse (Maybe Text)
- createApiResponse_protocolType :: Lens' CreateApiResponse (Maybe ProtocolType)
- createApiResponse_routeSelectionExpression :: Lens' CreateApiResponse (Maybe Text)
- createApiResponse_tags :: Lens' CreateApiResponse (Maybe (HashMap Text Text))
- createApiResponse_version :: Lens' CreateApiResponse (Maybe Text)
- createApiResponse_warnings :: Lens' CreateApiResponse (Maybe [Text])
- createApiResponse_httpStatus :: Lens' CreateApiResponse Int
- createApiMapping_apiMappingKey :: Lens' CreateApiMapping (Maybe Text)
- createApiMapping_domainName :: Lens' CreateApiMapping Text
- createApiMapping_stage :: Lens' CreateApiMapping Text
- createApiMapping_apiId :: Lens' CreateApiMapping Text
- createApiMappingResponse_apiId :: Lens' CreateApiMappingResponse (Maybe Text)
- createApiMappingResponse_apiMappingId :: Lens' CreateApiMappingResponse (Maybe Text)
- createApiMappingResponse_apiMappingKey :: Lens' CreateApiMappingResponse (Maybe Text)
- createApiMappingResponse_stage :: Lens' CreateApiMappingResponse (Maybe Text)
- createApiMappingResponse_httpStatus :: Lens' CreateApiMappingResponse Int
- createAuthorizer_authorizerCredentialsArn :: Lens' CreateAuthorizer (Maybe Text)
- createAuthorizer_authorizerPayloadFormatVersion :: Lens' CreateAuthorizer (Maybe Text)
- createAuthorizer_authorizerResultTtlInSeconds :: Lens' CreateAuthorizer (Maybe Natural)
- createAuthorizer_authorizerUri :: Lens' CreateAuthorizer (Maybe Text)
- createAuthorizer_enableSimpleResponses :: Lens' CreateAuthorizer (Maybe Bool)
- createAuthorizer_identityValidationExpression :: Lens' CreateAuthorizer (Maybe Text)
- createAuthorizer_jwtConfiguration :: Lens' CreateAuthorizer (Maybe JWTConfiguration)
- createAuthorizer_apiId :: Lens' CreateAuthorizer Text
- createAuthorizer_authorizerType :: Lens' CreateAuthorizer AuthorizerType
- createAuthorizer_identitySource :: Lens' CreateAuthorizer [Text]
- createAuthorizer_name :: Lens' CreateAuthorizer Text
- createAuthorizerResponse_authorizerCredentialsArn :: Lens' CreateAuthorizerResponse (Maybe Text)
- createAuthorizerResponse_authorizerId :: Lens' CreateAuthorizerResponse (Maybe Text)
- createAuthorizerResponse_authorizerPayloadFormatVersion :: Lens' CreateAuthorizerResponse (Maybe Text)
- createAuthorizerResponse_authorizerResultTtlInSeconds :: Lens' CreateAuthorizerResponse (Maybe Natural)
- createAuthorizerResponse_authorizerType :: Lens' CreateAuthorizerResponse (Maybe AuthorizerType)
- createAuthorizerResponse_authorizerUri :: Lens' CreateAuthorizerResponse (Maybe Text)
- createAuthorizerResponse_enableSimpleResponses :: Lens' CreateAuthorizerResponse (Maybe Bool)
- createAuthorizerResponse_identitySource :: Lens' CreateAuthorizerResponse (Maybe [Text])
- createAuthorizerResponse_identityValidationExpression :: Lens' CreateAuthorizerResponse (Maybe Text)
- createAuthorizerResponse_jwtConfiguration :: Lens' CreateAuthorizerResponse (Maybe JWTConfiguration)
- createAuthorizerResponse_name :: Lens' CreateAuthorizerResponse (Maybe Text)
- createAuthorizerResponse_httpStatus :: Lens' CreateAuthorizerResponse Int
- createDeployment_description :: Lens' CreateDeployment (Maybe Text)
- createDeployment_stageName :: Lens' CreateDeployment (Maybe Text)
- createDeployment_apiId :: Lens' CreateDeployment Text
- createDeploymentResponse_autoDeployed :: Lens' CreateDeploymentResponse (Maybe Bool)
- createDeploymentResponse_createdDate :: Lens' CreateDeploymentResponse (Maybe UTCTime)
- createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_deploymentStatus :: Lens' CreateDeploymentResponse (Maybe DeploymentStatus)
- createDeploymentResponse_deploymentStatusMessage :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_description :: Lens' CreateDeploymentResponse (Maybe Text)
- createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int
- createDomainName_domainNameConfigurations :: Lens' CreateDomainName (Maybe [DomainNameConfiguration])
- createDomainName_mutualTlsAuthentication :: Lens' CreateDomainName (Maybe MutualTlsAuthenticationInput)
- createDomainName_tags :: Lens' CreateDomainName (Maybe (HashMap Text Text))
- createDomainName_domainName :: Lens' CreateDomainName Text
- createDomainNameResponse_apiMappingSelectionExpression :: Lens' CreateDomainNameResponse (Maybe Text)
- createDomainNameResponse_domainName :: Lens' CreateDomainNameResponse (Maybe Text)
- createDomainNameResponse_domainNameConfigurations :: Lens' CreateDomainNameResponse (Maybe [DomainNameConfiguration])
- createDomainNameResponse_mutualTlsAuthentication :: Lens' CreateDomainNameResponse (Maybe MutualTlsAuthentication)
- createDomainNameResponse_tags :: Lens' CreateDomainNameResponse (Maybe (HashMap Text Text))
- createDomainNameResponse_httpStatus :: Lens' CreateDomainNameResponse Int
- createIntegration_connectionId :: Lens' CreateIntegration (Maybe Text)
- createIntegration_connectionType :: Lens' CreateIntegration (Maybe ConnectionType)
- createIntegration_contentHandlingStrategy :: Lens' CreateIntegration (Maybe ContentHandlingStrategy)
- createIntegration_credentialsArn :: Lens' CreateIntegration (Maybe Text)
- createIntegration_description :: Lens' CreateIntegration (Maybe Text)
- createIntegration_integrationMethod :: Lens' CreateIntegration (Maybe Text)
- createIntegration_integrationSubtype :: Lens' CreateIntegration (Maybe Text)
- createIntegration_integrationUri :: Lens' CreateIntegration (Maybe Text)
- createIntegration_passthroughBehavior :: Lens' CreateIntegration (Maybe PassthroughBehavior)
- createIntegration_payloadFormatVersion :: Lens' CreateIntegration (Maybe Text)
- createIntegration_requestParameters :: Lens' CreateIntegration (Maybe (HashMap Text Text))
- createIntegration_requestTemplates :: Lens' CreateIntegration (Maybe (HashMap Text Text))
- createIntegration_responseParameters :: Lens' CreateIntegration (Maybe (HashMap Text (HashMap Text Text)))
- createIntegration_templateSelectionExpression :: Lens' CreateIntegration (Maybe Text)
- createIntegration_timeoutInMillis :: Lens' CreateIntegration (Maybe Natural)
- createIntegration_tlsConfig :: Lens' CreateIntegration (Maybe TlsConfigInput)
- createIntegration_apiId :: Lens' CreateIntegration Text
- createIntegration_integrationType :: Lens' CreateIntegration IntegrationType
- createIntegrationResponse'_apiGatewayManaged :: Lens' CreateIntegrationResponse' (Maybe Bool)
- createIntegrationResponse'_connectionId :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_connectionType :: Lens' CreateIntegrationResponse' (Maybe ConnectionType)
- createIntegrationResponse'_contentHandlingStrategy :: Lens' CreateIntegrationResponse' (Maybe ContentHandlingStrategy)
- createIntegrationResponse'_credentialsArn :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_description :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_integrationId :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_integrationMethod :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_integrationResponseSelectionExpression :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_integrationSubtype :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_integrationType :: Lens' CreateIntegrationResponse' (Maybe IntegrationType)
- createIntegrationResponse'_integrationUri :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_passthroughBehavior :: Lens' CreateIntegrationResponse' (Maybe PassthroughBehavior)
- createIntegrationResponse'_payloadFormatVersion :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_requestParameters :: Lens' CreateIntegrationResponse' (Maybe (HashMap Text Text))
- createIntegrationResponse'_requestTemplates :: Lens' CreateIntegrationResponse' (Maybe (HashMap Text Text))
- createIntegrationResponse'_responseParameters :: Lens' CreateIntegrationResponse' (Maybe (HashMap Text (HashMap Text Text)))
- createIntegrationResponse'_templateSelectionExpression :: Lens' CreateIntegrationResponse' (Maybe Text)
- createIntegrationResponse'_timeoutInMillis :: Lens' CreateIntegrationResponse' (Maybe Natural)
- createIntegrationResponse'_tlsConfig :: Lens' CreateIntegrationResponse' (Maybe TlsConfig)
- createIntegrationResponse'_httpStatus :: Lens' CreateIntegrationResponse' Int
- createIntegrationResponse_contentHandlingStrategy :: Lens' CreateIntegrationResponse (Maybe ContentHandlingStrategy)
- createIntegrationResponse_responseParameters :: Lens' CreateIntegrationResponse (Maybe (HashMap Text Text))
- createIntegrationResponse_responseTemplates :: Lens' CreateIntegrationResponse (Maybe (HashMap Text Text))
- createIntegrationResponse_templateSelectionExpression :: Lens' CreateIntegrationResponse (Maybe Text)
- createIntegrationResponse_apiId :: Lens' CreateIntegrationResponse Text
- createIntegrationResponse_integrationId :: Lens' CreateIntegrationResponse Text
- createIntegrationResponse_integrationResponseKey :: Lens' CreateIntegrationResponse Text
- createIntegrationResponseResponse_contentHandlingStrategy :: Lens' CreateIntegrationResponseResponse (Maybe ContentHandlingStrategy)
- createIntegrationResponseResponse_integrationResponseId :: Lens' CreateIntegrationResponseResponse (Maybe Text)
- createIntegrationResponseResponse_integrationResponseKey :: Lens' CreateIntegrationResponseResponse (Maybe Text)
- createIntegrationResponseResponse_responseParameters :: Lens' CreateIntegrationResponseResponse (Maybe (HashMap Text Text))
- createIntegrationResponseResponse_responseTemplates :: Lens' CreateIntegrationResponseResponse (Maybe (HashMap Text Text))
- createIntegrationResponseResponse_templateSelectionExpression :: Lens' CreateIntegrationResponseResponse (Maybe Text)
- createIntegrationResponseResponse_httpStatus :: Lens' CreateIntegrationResponseResponse Int
- createModel_contentType :: Lens' CreateModel (Maybe Text)
- createModel_description :: Lens' CreateModel (Maybe Text)
- createModel_apiId :: Lens' CreateModel Text
- createModel_schema :: Lens' CreateModel Text
- createModel_name :: Lens' CreateModel Text
- createModelResponse_contentType :: Lens' CreateModelResponse (Maybe Text)
- createModelResponse_description :: Lens' CreateModelResponse (Maybe Text)
- createModelResponse_modelId :: Lens' CreateModelResponse (Maybe Text)
- createModelResponse_name :: Lens' CreateModelResponse (Maybe Text)
- createModelResponse_schema :: Lens' CreateModelResponse (Maybe Text)
- createModelResponse_httpStatus :: Lens' CreateModelResponse Int
- createRoute_apiKeyRequired :: Lens' CreateRoute (Maybe Bool)
- createRoute_authorizationScopes :: Lens' CreateRoute (Maybe [Text])
- createRoute_authorizationType :: Lens' CreateRoute (Maybe AuthorizationType)
- createRoute_authorizerId :: Lens' CreateRoute (Maybe Text)
- createRoute_modelSelectionExpression :: Lens' CreateRoute (Maybe Text)
- createRoute_operationName :: Lens' CreateRoute (Maybe Text)
- createRoute_requestModels :: Lens' CreateRoute (Maybe (HashMap Text Text))
- createRoute_requestParameters :: Lens' CreateRoute (Maybe (HashMap Text ParameterConstraints))
- createRoute_routeResponseSelectionExpression :: Lens' CreateRoute (Maybe Text)
- createRoute_target :: Lens' CreateRoute (Maybe Text)
- createRoute_apiId :: Lens' CreateRoute Text
- createRoute_routeKey :: Lens' CreateRoute Text
- createRouteResponse'_apiGatewayManaged :: Lens' CreateRouteResponse' (Maybe Bool)
- createRouteResponse'_apiKeyRequired :: Lens' CreateRouteResponse' (Maybe Bool)
- createRouteResponse'_authorizationScopes :: Lens' CreateRouteResponse' (Maybe [Text])
- createRouteResponse'_authorizationType :: Lens' CreateRouteResponse' (Maybe AuthorizationType)
- createRouteResponse'_authorizerId :: Lens' CreateRouteResponse' (Maybe Text)
- createRouteResponse'_modelSelectionExpression :: Lens' CreateRouteResponse' (Maybe Text)
- createRouteResponse'_operationName :: Lens' CreateRouteResponse' (Maybe Text)
- createRouteResponse'_requestModels :: Lens' CreateRouteResponse' (Maybe (HashMap Text Text))
- createRouteResponse'_requestParameters :: Lens' CreateRouteResponse' (Maybe (HashMap Text ParameterConstraints))
- createRouteResponse'_routeId :: Lens' CreateRouteResponse' (Maybe Text)
- createRouteResponse'_routeKey :: Lens' CreateRouteResponse' (Maybe Text)
- createRouteResponse'_routeResponseSelectionExpression :: Lens' CreateRouteResponse' (Maybe Text)
- createRouteResponse'_target :: Lens' CreateRouteResponse' (Maybe Text)
- createRouteResponse'_httpStatus :: Lens' CreateRouteResponse' Int
- createRouteResponse_modelSelectionExpression :: Lens' CreateRouteResponse (Maybe Text)
- createRouteResponse_responseModels :: Lens' CreateRouteResponse (Maybe (HashMap Text Text))
- createRouteResponse_responseParameters :: Lens' CreateRouteResponse (Maybe (HashMap Text ParameterConstraints))
- createRouteResponse_apiId :: Lens' CreateRouteResponse Text
- createRouteResponse_routeId :: Lens' CreateRouteResponse Text
- createRouteResponse_routeResponseKey :: Lens' CreateRouteResponse Text
- createRouteResponseResponse_modelSelectionExpression :: Lens' CreateRouteResponseResponse (Maybe Text)
- createRouteResponseResponse_responseModels :: Lens' CreateRouteResponseResponse (Maybe (HashMap Text Text))
- createRouteResponseResponse_responseParameters :: Lens' CreateRouteResponseResponse (Maybe (HashMap Text ParameterConstraints))
- createRouteResponseResponse_routeResponseId :: Lens' CreateRouteResponseResponse (Maybe Text)
- createRouteResponseResponse_routeResponseKey :: Lens' CreateRouteResponseResponse (Maybe Text)
- createRouteResponseResponse_httpStatus :: Lens' CreateRouteResponseResponse Int
- createStage_accessLogSettings :: Lens' CreateStage (Maybe AccessLogSettings)
- createStage_autoDeploy :: Lens' CreateStage (Maybe Bool)
- createStage_clientCertificateId :: Lens' CreateStage (Maybe Text)
- createStage_defaultRouteSettings :: Lens' CreateStage (Maybe RouteSettings)
- createStage_deploymentId :: Lens' CreateStage (Maybe Text)
- createStage_description :: Lens' CreateStage (Maybe Text)
- createStage_routeSettings :: Lens' CreateStage (Maybe (HashMap Text RouteSettings))
- createStage_stageVariables :: Lens' CreateStage (Maybe (HashMap Text Text))
- createStage_tags :: Lens' CreateStage (Maybe (HashMap Text Text))
- createStage_apiId :: Lens' CreateStage Text
- createStage_stageName :: Lens' CreateStage Text
- createStageResponse_accessLogSettings :: Lens' CreateStageResponse (Maybe AccessLogSettings)
- createStageResponse_apiGatewayManaged :: Lens' CreateStageResponse (Maybe Bool)
- createStageResponse_autoDeploy :: Lens' CreateStageResponse (Maybe Bool)
- createStageResponse_clientCertificateId :: Lens' CreateStageResponse (Maybe Text)
- createStageResponse_createdDate :: Lens' CreateStageResponse (Maybe UTCTime)
- createStageResponse_defaultRouteSettings :: Lens' CreateStageResponse (Maybe RouteSettings)
- createStageResponse_deploymentId :: Lens' CreateStageResponse (Maybe Text)
- createStageResponse_description :: Lens' CreateStageResponse (Maybe Text)
- createStageResponse_lastDeploymentStatusMessage :: Lens' CreateStageResponse (Maybe Text)
- createStageResponse_lastUpdatedDate :: Lens' CreateStageResponse (Maybe UTCTime)
- createStageResponse_routeSettings :: Lens' CreateStageResponse (Maybe (HashMap Text RouteSettings))
- createStageResponse_stageName :: Lens' CreateStageResponse (Maybe Text)
- createStageResponse_stageVariables :: Lens' CreateStageResponse (Maybe (HashMap Text Text))
- createStageResponse_tags :: Lens' CreateStageResponse (Maybe (HashMap Text Text))
- createStageResponse_httpStatus :: Lens' CreateStageResponse Int
- createVpcLink_securityGroupIds :: Lens' CreateVpcLink (Maybe [Text])
- createVpcLink_tags :: Lens' CreateVpcLink (Maybe (HashMap Text Text))
- createVpcLink_subnetIds :: Lens' CreateVpcLink [Text]
- createVpcLink_name :: Lens' CreateVpcLink Text
- createVpcLinkResponse_createdDate :: Lens' CreateVpcLinkResponse (Maybe UTCTime)
- createVpcLinkResponse_name :: Lens' CreateVpcLinkResponse (Maybe Text)
- createVpcLinkResponse_securityGroupIds :: Lens' CreateVpcLinkResponse (Maybe [Text])
- createVpcLinkResponse_subnetIds :: Lens' CreateVpcLinkResponse (Maybe [Text])
- createVpcLinkResponse_tags :: Lens' CreateVpcLinkResponse (Maybe (HashMap Text Text))
- createVpcLinkResponse_vpcLinkId :: Lens' CreateVpcLinkResponse (Maybe Text)
- createVpcLinkResponse_vpcLinkStatus :: Lens' CreateVpcLinkResponse (Maybe VpcLinkStatus)
- createVpcLinkResponse_vpcLinkStatusMessage :: Lens' CreateVpcLinkResponse (Maybe Text)
- createVpcLinkResponse_vpcLinkVersion :: Lens' CreateVpcLinkResponse (Maybe VpcLinkVersion)
- createVpcLinkResponse_httpStatus :: Lens' CreateVpcLinkResponse Int
- deleteAccessLogSettings_stageName :: Lens' DeleteAccessLogSettings Text
- deleteAccessLogSettings_apiId :: Lens' DeleteAccessLogSettings Text
- deleteApi_apiId :: Lens' DeleteApi Text
- deleteApiMapping_apiMappingId :: Lens' DeleteApiMapping Text
- deleteApiMapping_domainName :: Lens' DeleteApiMapping Text
- deleteAuthorizer_authorizerId :: Lens' DeleteAuthorizer Text
- deleteAuthorizer_apiId :: Lens' DeleteAuthorizer Text
- deleteCorsConfiguration_apiId :: Lens' DeleteCorsConfiguration Text
- deleteDeployment_apiId :: Lens' DeleteDeployment Text
- deleteDeployment_deploymentId :: Lens' DeleteDeployment Text
- deleteDomainName_domainName :: Lens' DeleteDomainName Text
- deleteIntegration_apiId :: Lens' DeleteIntegration Text
- deleteIntegration_integrationId :: Lens' DeleteIntegration Text
- deleteIntegrationResponse_apiId :: Lens' DeleteIntegrationResponse Text
- deleteIntegrationResponse_integrationResponseId :: Lens' DeleteIntegrationResponse Text
- deleteIntegrationResponse_integrationId :: Lens' DeleteIntegrationResponse Text
- deleteModel_modelId :: Lens' DeleteModel Text
- deleteModel_apiId :: Lens' DeleteModel Text
- deleteRoute_apiId :: Lens' DeleteRoute Text
- deleteRoute_routeId :: Lens' DeleteRoute Text
- deleteRouteRequestParameter_requestParameterKey :: Lens' DeleteRouteRequestParameter Text
- deleteRouteRequestParameter_apiId :: Lens' DeleteRouteRequestParameter Text
- deleteRouteRequestParameter_routeId :: Lens' DeleteRouteRequestParameter Text
- deleteRouteResponse_routeResponseId :: Lens' DeleteRouteResponse Text
- deleteRouteResponse_apiId :: Lens' DeleteRouteResponse Text
- deleteRouteResponse_routeId :: Lens' DeleteRouteResponse Text
- deleteRouteSettings_stageName :: Lens' DeleteRouteSettings Text
- deleteRouteSettings_routeKey :: Lens' DeleteRouteSettings Text
- deleteRouteSettings_apiId :: Lens' DeleteRouteSettings Text
- deleteStage_stageName :: Lens' DeleteStage Text
- deleteStage_apiId :: Lens' DeleteStage Text
- deleteVpcLink_vpcLinkId :: Lens' DeleteVpcLink Text
- deleteVpcLinkResponse_httpStatus :: Lens' DeleteVpcLinkResponse Int
- exportApi_exportVersion :: Lens' ExportApi (Maybe Text)
- exportApi_includeExtensions :: Lens' ExportApi (Maybe Bool)
- exportApi_stageName :: Lens' ExportApi (Maybe Text)
- exportApi_specification :: Lens' ExportApi Text
- exportApi_outputType :: Lens' ExportApi Text
- exportApi_apiId :: Lens' ExportApi Text
- exportApiResponse_body :: Lens' ExportApiResponse (Maybe ByteString)
- exportApiResponse_httpStatus :: Lens' ExportApiResponse Int
- getApi_apiId :: Lens' GetApi Text
- getApiResponse_apiEndpoint :: Lens' GetApiResponse (Maybe Text)
- getApiResponse_apiGatewayManaged :: Lens' GetApiResponse (Maybe Bool)
- getApiResponse_apiId :: Lens' GetApiResponse (Maybe Text)
- getApiResponse_apiKeySelectionExpression :: Lens' GetApiResponse (Maybe Text)
- getApiResponse_corsConfiguration :: Lens' GetApiResponse (Maybe Cors)
- getApiResponse_createdDate :: Lens' GetApiResponse (Maybe UTCTime)
- getApiResponse_description :: Lens' GetApiResponse (Maybe Text)
- getApiResponse_disableExecuteApiEndpoint :: Lens' GetApiResponse (Maybe Bool)
- getApiResponse_disableSchemaValidation :: Lens' GetApiResponse (Maybe Bool)
- getApiResponse_importInfo :: Lens' GetApiResponse (Maybe [Text])
- getApiResponse_name :: Lens' GetApiResponse (Maybe Text)
- getApiResponse_protocolType :: Lens' GetApiResponse (Maybe ProtocolType)
- getApiResponse_routeSelectionExpression :: Lens' GetApiResponse (Maybe Text)
- getApiResponse_tags :: Lens' GetApiResponse (Maybe (HashMap Text Text))
- getApiResponse_version :: Lens' GetApiResponse (Maybe Text)
- getApiResponse_warnings :: Lens' GetApiResponse (Maybe [Text])
- getApiResponse_httpStatus :: Lens' GetApiResponse Int
- getApiMapping_apiMappingId :: Lens' GetApiMapping Text
- getApiMapping_domainName :: Lens' GetApiMapping Text
- getApiMappingResponse_apiId :: Lens' GetApiMappingResponse (Maybe Text)
- getApiMappingResponse_apiMappingId :: Lens' GetApiMappingResponse (Maybe Text)
- getApiMappingResponse_apiMappingKey :: Lens' GetApiMappingResponse (Maybe Text)
- getApiMappingResponse_stage :: Lens' GetApiMappingResponse (Maybe Text)
- getApiMappingResponse_httpStatus :: Lens' GetApiMappingResponse Int
- getApiMappings_maxResults :: Lens' GetApiMappings (Maybe Text)
- getApiMappings_nextToken :: Lens' GetApiMappings (Maybe Text)
- getApiMappings_domainName :: Lens' GetApiMappings Text
- getApiMappingsResponse_items :: Lens' GetApiMappingsResponse (Maybe [ApiMapping])
- getApiMappingsResponse_nextToken :: Lens' GetApiMappingsResponse (Maybe Text)
- getApiMappingsResponse_httpStatus :: Lens' GetApiMappingsResponse Int
- getApis_maxResults :: Lens' GetApis (Maybe Text)
- getApis_nextToken :: Lens' GetApis (Maybe Text)
- getApisResponse_items :: Lens' GetApisResponse (Maybe [Api])
- getApisResponse_nextToken :: Lens' GetApisResponse (Maybe Text)
- getApisResponse_httpStatus :: Lens' GetApisResponse Int
- getAuthorizer_authorizerId :: Lens' GetAuthorizer Text
- getAuthorizer_apiId :: Lens' GetAuthorizer Text
- getAuthorizerResponse_authorizerCredentialsArn :: Lens' GetAuthorizerResponse (Maybe Text)
- getAuthorizerResponse_authorizerId :: Lens' GetAuthorizerResponse (Maybe Text)
- getAuthorizerResponse_authorizerPayloadFormatVersion :: Lens' GetAuthorizerResponse (Maybe Text)
- getAuthorizerResponse_authorizerResultTtlInSeconds :: Lens' GetAuthorizerResponse (Maybe Natural)
- getAuthorizerResponse_authorizerType :: Lens' GetAuthorizerResponse (Maybe AuthorizerType)
- getAuthorizerResponse_authorizerUri :: Lens' GetAuthorizerResponse (Maybe Text)
- getAuthorizerResponse_enableSimpleResponses :: Lens' GetAuthorizerResponse (Maybe Bool)
- getAuthorizerResponse_identitySource :: Lens' GetAuthorizerResponse (Maybe [Text])
- getAuthorizerResponse_identityValidationExpression :: Lens' GetAuthorizerResponse (Maybe Text)
- getAuthorizerResponse_jwtConfiguration :: Lens' GetAuthorizerResponse (Maybe JWTConfiguration)
- getAuthorizerResponse_name :: Lens' GetAuthorizerResponse (Maybe Text)
- getAuthorizerResponse_httpStatus :: Lens' GetAuthorizerResponse Int
- getAuthorizers_maxResults :: Lens' GetAuthorizers (Maybe Text)
- getAuthorizers_nextToken :: Lens' GetAuthorizers (Maybe Text)
- getAuthorizers_apiId :: Lens' GetAuthorizers Text
- getAuthorizersResponse_items :: Lens' GetAuthorizersResponse (Maybe [Authorizer])
- getAuthorizersResponse_nextToken :: Lens' GetAuthorizersResponse (Maybe Text)
- getAuthorizersResponse_httpStatus :: Lens' GetAuthorizersResponse Int
- getDeployment_apiId :: Lens' GetDeployment Text
- getDeployment_deploymentId :: Lens' GetDeployment Text
- getDeploymentResponse_autoDeployed :: Lens' GetDeploymentResponse (Maybe Bool)
- getDeploymentResponse_createdDate :: Lens' GetDeploymentResponse (Maybe UTCTime)
- getDeploymentResponse_deploymentId :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_deploymentStatus :: Lens' GetDeploymentResponse (Maybe DeploymentStatus)
- getDeploymentResponse_deploymentStatusMessage :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_description :: Lens' GetDeploymentResponse (Maybe Text)
- getDeploymentResponse_httpStatus :: Lens' GetDeploymentResponse Int
- getDeployments_maxResults :: Lens' GetDeployments (Maybe Text)
- getDeployments_nextToken :: Lens' GetDeployments (Maybe Text)
- getDeployments_apiId :: Lens' GetDeployments Text
- getDeploymentsResponse_items :: Lens' GetDeploymentsResponse (Maybe [Deployment])
- getDeploymentsResponse_nextToken :: Lens' GetDeploymentsResponse (Maybe Text)
- getDeploymentsResponse_httpStatus :: Lens' GetDeploymentsResponse Int
- getDomainName_domainName :: Lens' GetDomainName Text
- getDomainNameResponse_apiMappingSelectionExpression :: Lens' GetDomainNameResponse (Maybe Text)
- getDomainNameResponse_domainName :: Lens' GetDomainNameResponse (Maybe Text)
- getDomainNameResponse_domainNameConfigurations :: Lens' GetDomainNameResponse (Maybe [DomainNameConfiguration])
- getDomainNameResponse_mutualTlsAuthentication :: Lens' GetDomainNameResponse (Maybe MutualTlsAuthentication)
- getDomainNameResponse_tags :: Lens' GetDomainNameResponse (Maybe (HashMap Text Text))
- getDomainNameResponse_httpStatus :: Lens' GetDomainNameResponse Int
- getDomainNames_maxResults :: Lens' GetDomainNames (Maybe Text)
- getDomainNames_nextToken :: Lens' GetDomainNames (Maybe Text)
- getDomainNamesResponse_items :: Lens' GetDomainNamesResponse (Maybe [DomainName])
- getDomainNamesResponse_nextToken :: Lens' GetDomainNamesResponse (Maybe Text)
- getDomainNamesResponse_httpStatus :: Lens' GetDomainNamesResponse Int
- getIntegration_apiId :: Lens' GetIntegration Text
- getIntegration_integrationId :: Lens' GetIntegration Text
- getIntegrationResponse'_apiGatewayManaged :: Lens' GetIntegrationResponse' (Maybe Bool)
- getIntegrationResponse'_connectionId :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_connectionType :: Lens' GetIntegrationResponse' (Maybe ConnectionType)
- getIntegrationResponse'_contentHandlingStrategy :: Lens' GetIntegrationResponse' (Maybe ContentHandlingStrategy)
- getIntegrationResponse'_credentialsArn :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_description :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_integrationId :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_integrationMethod :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_integrationResponseSelectionExpression :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_integrationSubtype :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_integrationType :: Lens' GetIntegrationResponse' (Maybe IntegrationType)
- getIntegrationResponse'_integrationUri :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_passthroughBehavior :: Lens' GetIntegrationResponse' (Maybe PassthroughBehavior)
- getIntegrationResponse'_payloadFormatVersion :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_requestParameters :: Lens' GetIntegrationResponse' (Maybe (HashMap Text Text))
- getIntegrationResponse'_requestTemplates :: Lens' GetIntegrationResponse' (Maybe (HashMap Text Text))
- getIntegrationResponse'_responseParameters :: Lens' GetIntegrationResponse' (Maybe (HashMap Text (HashMap Text Text)))
- getIntegrationResponse'_templateSelectionExpression :: Lens' GetIntegrationResponse' (Maybe Text)
- getIntegrationResponse'_timeoutInMillis :: Lens' GetIntegrationResponse' (Maybe Natural)
- getIntegrationResponse'_tlsConfig :: Lens' GetIntegrationResponse' (Maybe TlsConfig)
- getIntegrationResponse'_httpStatus :: Lens' GetIntegrationResponse' Int
- getIntegrationResponse_apiId :: Lens' GetIntegrationResponse Text
- getIntegrationResponse_integrationResponseId :: Lens' GetIntegrationResponse Text
- getIntegrationResponse_integrationId :: Lens' GetIntegrationResponse Text
- getIntegrationResponseResponse_contentHandlingStrategy :: Lens' GetIntegrationResponseResponse (Maybe ContentHandlingStrategy)
- getIntegrationResponseResponse_integrationResponseId :: Lens' GetIntegrationResponseResponse (Maybe Text)
- getIntegrationResponseResponse_integrationResponseKey :: Lens' GetIntegrationResponseResponse (Maybe Text)
- getIntegrationResponseResponse_responseParameters :: Lens' GetIntegrationResponseResponse (Maybe (HashMap Text Text))
- getIntegrationResponseResponse_responseTemplates :: Lens' GetIntegrationResponseResponse (Maybe (HashMap Text Text))
- getIntegrationResponseResponse_templateSelectionExpression :: Lens' GetIntegrationResponseResponse (Maybe Text)
- getIntegrationResponseResponse_httpStatus :: Lens' GetIntegrationResponseResponse Int
- getIntegrationResponses_maxResults :: Lens' GetIntegrationResponses (Maybe Text)
- getIntegrationResponses_nextToken :: Lens' GetIntegrationResponses (Maybe Text)
- getIntegrationResponses_integrationId :: Lens' GetIntegrationResponses Text
- getIntegrationResponses_apiId :: Lens' GetIntegrationResponses Text
- getIntegrationResponsesResponse_items :: Lens' GetIntegrationResponsesResponse (Maybe [IntegrationResponse])
- getIntegrationResponsesResponse_nextToken :: Lens' GetIntegrationResponsesResponse (Maybe Text)
- getIntegrationResponsesResponse_httpStatus :: Lens' GetIntegrationResponsesResponse Int
- getIntegrations_maxResults :: Lens' GetIntegrations (Maybe Text)
- getIntegrations_nextToken :: Lens' GetIntegrations (Maybe Text)
- getIntegrations_apiId :: Lens' GetIntegrations Text
- getIntegrationsResponse_items :: Lens' GetIntegrationsResponse (Maybe [Integration])
- getIntegrationsResponse_nextToken :: Lens' GetIntegrationsResponse (Maybe Text)
- getIntegrationsResponse_httpStatus :: Lens' GetIntegrationsResponse Int
- getModel_modelId :: Lens' GetModel Text
- getModel_apiId :: Lens' GetModel Text
- getModelResponse_contentType :: Lens' GetModelResponse (Maybe Text)
- getModelResponse_description :: Lens' GetModelResponse (Maybe Text)
- getModelResponse_modelId :: Lens' GetModelResponse (Maybe Text)
- getModelResponse_name :: Lens' GetModelResponse (Maybe Text)
- getModelResponse_schema :: Lens' GetModelResponse (Maybe Text)
- getModelResponse_httpStatus :: Lens' GetModelResponse Int
- getModelTemplate_modelId :: Lens' GetModelTemplate Text
- getModelTemplate_apiId :: Lens' GetModelTemplate Text
- getModelTemplateResponse_value :: Lens' GetModelTemplateResponse (Maybe Text)
- getModelTemplateResponse_httpStatus :: Lens' GetModelTemplateResponse Int
- getModels_maxResults :: Lens' GetModels (Maybe Text)
- getModels_nextToken :: Lens' GetModels (Maybe Text)
- getModels_apiId :: Lens' GetModels Text
- getModelsResponse_items :: Lens' GetModelsResponse (Maybe [Model])
- getModelsResponse_nextToken :: Lens' GetModelsResponse (Maybe Text)
- getModelsResponse_httpStatus :: Lens' GetModelsResponse Int
- getRoute_apiId :: Lens' GetRoute Text
- getRoute_routeId :: Lens' GetRoute Text
- getRouteResponse'_apiGatewayManaged :: Lens' GetRouteResponse' (Maybe Bool)
- getRouteResponse'_apiKeyRequired :: Lens' GetRouteResponse' (Maybe Bool)
- getRouteResponse'_authorizationScopes :: Lens' GetRouteResponse' (Maybe [Text])
- getRouteResponse'_authorizationType :: Lens' GetRouteResponse' (Maybe AuthorizationType)
- getRouteResponse'_authorizerId :: Lens' GetRouteResponse' (Maybe Text)
- getRouteResponse'_modelSelectionExpression :: Lens' GetRouteResponse' (Maybe Text)
- getRouteResponse'_operationName :: Lens' GetRouteResponse' (Maybe Text)
- getRouteResponse'_requestModels :: Lens' GetRouteResponse' (Maybe (HashMap Text Text))
- getRouteResponse'_requestParameters :: Lens' GetRouteResponse' (Maybe (HashMap Text ParameterConstraints))
- getRouteResponse'_routeId :: Lens' GetRouteResponse' (Maybe Text)
- getRouteResponse'_routeKey :: Lens' GetRouteResponse' (Maybe Text)
- getRouteResponse'_routeResponseSelectionExpression :: Lens' GetRouteResponse' (Maybe Text)
- getRouteResponse'_target :: Lens' GetRouteResponse' (Maybe Text)
- getRouteResponse'_httpStatus :: Lens' GetRouteResponse' Int
- getRouteResponse_routeResponseId :: Lens' GetRouteResponse Text
- getRouteResponse_apiId :: Lens' GetRouteResponse Text
- getRouteResponse_routeId :: Lens' GetRouteResponse Text
- getRouteResponseResponse_modelSelectionExpression :: Lens' GetRouteResponseResponse (Maybe Text)
- getRouteResponseResponse_responseModels :: Lens' GetRouteResponseResponse (Maybe (HashMap Text Text))
- getRouteResponseResponse_responseParameters :: Lens' GetRouteResponseResponse (Maybe (HashMap Text ParameterConstraints))
- getRouteResponseResponse_routeResponseId :: Lens' GetRouteResponseResponse (Maybe Text)
- getRouteResponseResponse_routeResponseKey :: Lens' GetRouteResponseResponse (Maybe Text)
- getRouteResponseResponse_httpStatus :: Lens' GetRouteResponseResponse Int
- getRouteResponses_maxResults :: Lens' GetRouteResponses (Maybe Text)
- getRouteResponses_nextToken :: Lens' GetRouteResponses (Maybe Text)
- getRouteResponses_routeId :: Lens' GetRouteResponses Text
- getRouteResponses_apiId :: Lens' GetRouteResponses Text
- getRouteResponsesResponse_items :: Lens' GetRouteResponsesResponse (Maybe [RouteResponse])
- getRouteResponsesResponse_nextToken :: Lens' GetRouteResponsesResponse (Maybe Text)
- getRouteResponsesResponse_httpStatus :: Lens' GetRouteResponsesResponse Int
- getRoutes_maxResults :: Lens' GetRoutes (Maybe Text)
- getRoutes_nextToken :: Lens' GetRoutes (Maybe Text)
- getRoutes_apiId :: Lens' GetRoutes Text
- getRoutesResponse_items :: Lens' GetRoutesResponse (Maybe [Route])
- getRoutesResponse_nextToken :: Lens' GetRoutesResponse (Maybe Text)
- getRoutesResponse_httpStatus :: Lens' GetRoutesResponse Int
- getStage_stageName :: Lens' GetStage Text
- getStage_apiId :: Lens' GetStage Text
- getStageResponse_accessLogSettings :: Lens' GetStageResponse (Maybe AccessLogSettings)
- getStageResponse_apiGatewayManaged :: Lens' GetStageResponse (Maybe Bool)
- getStageResponse_autoDeploy :: Lens' GetStageResponse (Maybe Bool)
- getStageResponse_clientCertificateId :: Lens' GetStageResponse (Maybe Text)
- getStageResponse_createdDate :: Lens' GetStageResponse (Maybe UTCTime)
- getStageResponse_defaultRouteSettings :: Lens' GetStageResponse (Maybe RouteSettings)
- getStageResponse_deploymentId :: Lens' GetStageResponse (Maybe Text)
- getStageResponse_description :: Lens' GetStageResponse (Maybe Text)
- getStageResponse_lastDeploymentStatusMessage :: Lens' GetStageResponse (Maybe Text)
- getStageResponse_lastUpdatedDate :: Lens' GetStageResponse (Maybe UTCTime)
- getStageResponse_routeSettings :: Lens' GetStageResponse (Maybe (HashMap Text RouteSettings))
- getStageResponse_stageName :: Lens' GetStageResponse (Maybe Text)
- getStageResponse_stageVariables :: Lens' GetStageResponse (Maybe (HashMap Text Text))
- getStageResponse_tags :: Lens' GetStageResponse (Maybe (HashMap Text Text))
- getStageResponse_httpStatus :: Lens' GetStageResponse Int
- getStages_maxResults :: Lens' GetStages (Maybe Text)
- getStages_nextToken :: Lens' GetStages (Maybe Text)
- getStages_apiId :: Lens' GetStages Text
- getStagesResponse_items :: Lens' GetStagesResponse (Maybe [Stage])
- getStagesResponse_nextToken :: Lens' GetStagesResponse (Maybe Text)
- getStagesResponse_httpStatus :: Lens' GetStagesResponse Int
- getTags_resourceArn :: Lens' GetTags Text
- getTagsResponse_tags :: Lens' GetTagsResponse (Maybe (HashMap Text Text))
- getTagsResponse_httpStatus :: Lens' GetTagsResponse Int
- getVpcLink_vpcLinkId :: Lens' GetVpcLink Text
- getVpcLinkResponse_createdDate :: Lens' GetVpcLinkResponse (Maybe UTCTime)
- getVpcLinkResponse_name :: Lens' GetVpcLinkResponse (Maybe Text)
- getVpcLinkResponse_securityGroupIds :: Lens' GetVpcLinkResponse (Maybe [Text])
- getVpcLinkResponse_subnetIds :: Lens' GetVpcLinkResponse (Maybe [Text])
- getVpcLinkResponse_tags :: Lens' GetVpcLinkResponse (Maybe (HashMap Text Text))
- getVpcLinkResponse_vpcLinkId :: Lens' GetVpcLinkResponse (Maybe Text)
- getVpcLinkResponse_vpcLinkStatus :: Lens' GetVpcLinkResponse (Maybe VpcLinkStatus)
- getVpcLinkResponse_vpcLinkStatusMessage :: Lens' GetVpcLinkResponse (Maybe Text)
- getVpcLinkResponse_vpcLinkVersion :: Lens' GetVpcLinkResponse (Maybe VpcLinkVersion)
- getVpcLinkResponse_httpStatus :: Lens' GetVpcLinkResponse Int
- getVpcLinks_maxResults :: Lens' GetVpcLinks (Maybe Text)
- getVpcLinks_nextToken :: Lens' GetVpcLinks (Maybe Text)
- getVpcLinksResponse_items :: Lens' GetVpcLinksResponse (Maybe [VpcLink])
- getVpcLinksResponse_nextToken :: Lens' GetVpcLinksResponse (Maybe Text)
- getVpcLinksResponse_httpStatus :: Lens' GetVpcLinksResponse Int
- importApi_basepath :: Lens' ImportApi (Maybe Text)
- importApi_failOnWarnings :: Lens' ImportApi (Maybe Bool)
- importApi_body :: Lens' ImportApi Text
- importApiResponse_apiEndpoint :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_apiGatewayManaged :: Lens' ImportApiResponse (Maybe Bool)
- importApiResponse_apiId :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_apiKeySelectionExpression :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_corsConfiguration :: Lens' ImportApiResponse (Maybe Cors)
- importApiResponse_createdDate :: Lens' ImportApiResponse (Maybe UTCTime)
- importApiResponse_description :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_disableExecuteApiEndpoint :: Lens' ImportApiResponse (Maybe Bool)
- importApiResponse_disableSchemaValidation :: Lens' ImportApiResponse (Maybe Bool)
- importApiResponse_importInfo :: Lens' ImportApiResponse (Maybe [Text])
- importApiResponse_name :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_protocolType :: Lens' ImportApiResponse (Maybe ProtocolType)
- importApiResponse_routeSelectionExpression :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_tags :: Lens' ImportApiResponse (Maybe (HashMap Text Text))
- importApiResponse_version :: Lens' ImportApiResponse (Maybe Text)
- importApiResponse_warnings :: Lens' ImportApiResponse (Maybe [Text])
- importApiResponse_httpStatus :: Lens' ImportApiResponse Int
- reimportApi_basepath :: Lens' ReimportApi (Maybe Text)
- reimportApi_failOnWarnings :: Lens' ReimportApi (Maybe Bool)
- reimportApi_apiId :: Lens' ReimportApi Text
- reimportApi_body :: Lens' ReimportApi Text
- reimportApiResponse_apiEndpoint :: Lens' ReimportApiResponse (Maybe Text)
- reimportApiResponse_apiGatewayManaged :: Lens' ReimportApiResponse (Maybe Bool)
- reimportApiResponse_apiId :: Lens' ReimportApiResponse (Maybe Text)
- reimportApiResponse_apiKeySelectionExpression :: Lens' ReimportApiResponse (Maybe Text)
- reimportApiResponse_corsConfiguration :: Lens' ReimportApiResponse (Maybe Cors)
- reimportApiResponse_createdDate :: Lens' ReimportApiResponse (Maybe UTCTime)
- reimportApiResponse_description :: Lens' ReimportApiResponse (Maybe Text)
- reimportApiResponse_disableExecuteApiEndpoint :: Lens' ReimportApiResponse (Maybe Bool)
- reimportApiResponse_disableSchemaValidation :: Lens' ReimportApiResponse (Maybe Bool)
- reimportApiResponse_importInfo :: Lens' ReimportApiResponse (Maybe [Text])
- reimportApiResponse_name :: Lens' ReimportApiResponse (Maybe Text)
- reimportApiResponse_protocolType :: Lens' ReimportApiResponse (Maybe ProtocolType)
- reimportApiResponse_routeSelectionExpression :: Lens' ReimportApiResponse (Maybe Text)
- reimportApiResponse_tags :: Lens' ReimportApiResponse (Maybe (HashMap Text Text))
- reimportApiResponse_version :: Lens' ReimportApiResponse (Maybe Text)
- reimportApiResponse_warnings :: Lens' ReimportApiResponse (Maybe [Text])
- reimportApiResponse_httpStatus :: Lens' ReimportApiResponse Int
- resetAuthorizersCache_stageName :: Lens' ResetAuthorizersCache Text
- resetAuthorizersCache_apiId :: Lens' ResetAuthorizersCache Text
- tagResource_tags :: Lens' TagResource (Maybe (HashMap Text Text))
- tagResource_resourceArn :: Lens' TagResource Text
- tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int
- untagResource_resourceArn :: Lens' UntagResource Text
- untagResource_tagKeys :: Lens' UntagResource [Text]
- updateApi_apiKeySelectionExpression :: Lens' UpdateApi (Maybe Text)
- updateApi_corsConfiguration :: Lens' UpdateApi (Maybe Cors)
- updateApi_credentialsArn :: Lens' UpdateApi (Maybe Text)
- updateApi_description :: Lens' UpdateApi (Maybe Text)
- updateApi_disableExecuteApiEndpoint :: Lens' UpdateApi (Maybe Bool)
- updateApi_disableSchemaValidation :: Lens' UpdateApi (Maybe Bool)
- updateApi_name :: Lens' UpdateApi (Maybe Text)
- updateApi_routeKey :: Lens' UpdateApi (Maybe Text)
- updateApi_routeSelectionExpression :: Lens' UpdateApi (Maybe Text)
- updateApi_target :: Lens' UpdateApi (Maybe Text)
- updateApi_version :: Lens' UpdateApi (Maybe Text)
- updateApi_apiId :: Lens' UpdateApi Text
- updateApiResponse_apiEndpoint :: Lens' UpdateApiResponse (Maybe Text)
- updateApiResponse_apiGatewayManaged :: Lens' UpdateApiResponse (Maybe Bool)
- updateApiResponse_apiId :: Lens' UpdateApiResponse (Maybe Text)
- updateApiResponse_apiKeySelectionExpression :: Lens' UpdateApiResponse (Maybe Text)
- updateApiResponse_corsConfiguration :: Lens' UpdateApiResponse (Maybe Cors)
- updateApiResponse_createdDate :: Lens' UpdateApiResponse (Maybe UTCTime)
- updateApiResponse_description :: Lens' UpdateApiResponse (Maybe Text)
- updateApiResponse_disableExecuteApiEndpoint :: Lens' UpdateApiResponse (Maybe Bool)
- updateApiResponse_disableSchemaValidation :: Lens' UpdateApiResponse (Maybe Bool)
- updateApiResponse_importInfo :: Lens' UpdateApiResponse (Maybe [Text])
- updateApiResponse_name :: Lens' UpdateApiResponse (Maybe Text)
- updateApiResponse_protocolType :: Lens' UpdateApiResponse (Maybe ProtocolType)
- updateApiResponse_routeSelectionExpression :: Lens' UpdateApiResponse (Maybe Text)
- updateApiResponse_tags :: Lens' UpdateApiResponse (Maybe (HashMap Text Text))
- updateApiResponse_version :: Lens' UpdateApiResponse (Maybe Text)
- updateApiResponse_warnings :: Lens' UpdateApiResponse (Maybe [Text])
- updateApiResponse_httpStatus :: Lens' UpdateApiResponse Int
- updateApiMapping_apiMappingKey :: Lens' UpdateApiMapping (Maybe Text)
- updateApiMapping_stage :: Lens' UpdateApiMapping (Maybe Text)
- updateApiMapping_apiMappingId :: Lens' UpdateApiMapping Text
- updateApiMapping_apiId :: Lens' UpdateApiMapping Text
- updateApiMapping_domainName :: Lens' UpdateApiMapping Text
- updateApiMappingResponse_apiId :: Lens' UpdateApiMappingResponse (Maybe Text)
- updateApiMappingResponse_apiMappingId :: Lens' UpdateApiMappingResponse (Maybe Text)
- updateApiMappingResponse_apiMappingKey :: Lens' UpdateApiMappingResponse (Maybe Text)
- updateApiMappingResponse_stage :: Lens' UpdateApiMappingResponse (Maybe Text)
- updateApiMappingResponse_httpStatus :: Lens' UpdateApiMappingResponse Int
- updateAuthorizer_authorizerCredentialsArn :: Lens' UpdateAuthorizer (Maybe Text)
- updateAuthorizer_authorizerPayloadFormatVersion :: Lens' UpdateAuthorizer (Maybe Text)
- updateAuthorizer_authorizerResultTtlInSeconds :: Lens' UpdateAuthorizer (Maybe Natural)
- updateAuthorizer_authorizerType :: Lens' UpdateAuthorizer (Maybe AuthorizerType)
- updateAuthorizer_authorizerUri :: Lens' UpdateAuthorizer (Maybe Text)
- updateAuthorizer_enableSimpleResponses :: Lens' UpdateAuthorizer (Maybe Bool)
- updateAuthorizer_identitySource :: Lens' UpdateAuthorizer (Maybe [Text])
- updateAuthorizer_identityValidationExpression :: Lens' UpdateAuthorizer (Maybe Text)
- updateAuthorizer_jwtConfiguration :: Lens' UpdateAuthorizer (Maybe JWTConfiguration)
- updateAuthorizer_name :: Lens' UpdateAuthorizer (Maybe Text)
- updateAuthorizer_authorizerId :: Lens' UpdateAuthorizer Text
- updateAuthorizer_apiId :: Lens' UpdateAuthorizer Text
- updateAuthorizerResponse_authorizerCredentialsArn :: Lens' UpdateAuthorizerResponse (Maybe Text)
- updateAuthorizerResponse_authorizerId :: Lens' UpdateAuthorizerResponse (Maybe Text)
- updateAuthorizerResponse_authorizerPayloadFormatVersion :: Lens' UpdateAuthorizerResponse (Maybe Text)
- updateAuthorizerResponse_authorizerResultTtlInSeconds :: Lens' UpdateAuthorizerResponse (Maybe Natural)
- updateAuthorizerResponse_authorizerType :: Lens' UpdateAuthorizerResponse (Maybe AuthorizerType)
- updateAuthorizerResponse_authorizerUri :: Lens' UpdateAuthorizerResponse (Maybe Text)
- updateAuthorizerResponse_enableSimpleResponses :: Lens' UpdateAuthorizerResponse (Maybe Bool)
- updateAuthorizerResponse_identitySource :: Lens' UpdateAuthorizerResponse (Maybe [Text])
- updateAuthorizerResponse_identityValidationExpression :: Lens' UpdateAuthorizerResponse (Maybe Text)
- updateAuthorizerResponse_jwtConfiguration :: Lens' UpdateAuthorizerResponse (Maybe JWTConfiguration)
- updateAuthorizerResponse_name :: Lens' UpdateAuthorizerResponse (Maybe Text)
- updateAuthorizerResponse_httpStatus :: Lens' UpdateAuthorizerResponse Int
- updateDeployment_description :: Lens' UpdateDeployment (Maybe Text)
- updateDeployment_apiId :: Lens' UpdateDeployment Text
- updateDeployment_deploymentId :: Lens' UpdateDeployment Text
- updateDeploymentResponse_autoDeployed :: Lens' UpdateDeploymentResponse (Maybe Bool)
- updateDeploymentResponse_createdDate :: Lens' UpdateDeploymentResponse (Maybe UTCTime)
- updateDeploymentResponse_deploymentId :: Lens' UpdateDeploymentResponse (Maybe Text)
- updateDeploymentResponse_deploymentStatus :: Lens' UpdateDeploymentResponse (Maybe DeploymentStatus)
- updateDeploymentResponse_deploymentStatusMessage :: Lens' UpdateDeploymentResponse (Maybe Text)
- updateDeploymentResponse_description :: Lens' UpdateDeploymentResponse (Maybe Text)
- updateDeploymentResponse_httpStatus :: Lens' UpdateDeploymentResponse Int
- updateDomainName_domainNameConfigurations :: Lens' UpdateDomainName (Maybe [DomainNameConfiguration])
- updateDomainName_mutualTlsAuthentication :: Lens' UpdateDomainName (Maybe MutualTlsAuthenticationInput)
- updateDomainName_domainName :: Lens' UpdateDomainName Text
- updateDomainNameResponse_apiMappingSelectionExpression :: Lens' UpdateDomainNameResponse (Maybe Text)
- updateDomainNameResponse_domainName :: Lens' UpdateDomainNameResponse (Maybe Text)
- updateDomainNameResponse_domainNameConfigurations :: Lens' UpdateDomainNameResponse (Maybe [DomainNameConfiguration])
- updateDomainNameResponse_mutualTlsAuthentication :: Lens' UpdateDomainNameResponse (Maybe MutualTlsAuthentication)
- updateDomainNameResponse_tags :: Lens' UpdateDomainNameResponse (Maybe (HashMap Text Text))
- updateDomainNameResponse_httpStatus :: Lens' UpdateDomainNameResponse Int
- updateIntegration_connectionId :: Lens' UpdateIntegration (Maybe Text)
- updateIntegration_connectionType :: Lens' UpdateIntegration (Maybe ConnectionType)
- updateIntegration_contentHandlingStrategy :: Lens' UpdateIntegration (Maybe ContentHandlingStrategy)
- updateIntegration_credentialsArn :: Lens' UpdateIntegration (Maybe Text)
- updateIntegration_description :: Lens' UpdateIntegration (Maybe Text)
- updateIntegration_integrationMethod :: Lens' UpdateIntegration (Maybe Text)
- updateIntegration_integrationSubtype :: Lens' UpdateIntegration (Maybe Text)
- updateIntegration_integrationType :: Lens' UpdateIntegration (Maybe IntegrationType)
- updateIntegration_integrationUri :: Lens' UpdateIntegration (Maybe Text)
- updateIntegration_passthroughBehavior :: Lens' UpdateIntegration (Maybe PassthroughBehavior)
- updateIntegration_payloadFormatVersion :: Lens' UpdateIntegration (Maybe Text)
- updateIntegration_requestParameters :: Lens' UpdateIntegration (Maybe (HashMap Text Text))
- updateIntegration_requestTemplates :: Lens' UpdateIntegration (Maybe (HashMap Text Text))
- updateIntegration_responseParameters :: Lens' UpdateIntegration (Maybe (HashMap Text (HashMap Text Text)))
- updateIntegration_templateSelectionExpression :: Lens' UpdateIntegration (Maybe Text)
- updateIntegration_timeoutInMillis :: Lens' UpdateIntegration (Maybe Natural)
- updateIntegration_tlsConfig :: Lens' UpdateIntegration (Maybe TlsConfigInput)
- updateIntegration_apiId :: Lens' UpdateIntegration Text
- updateIntegration_integrationId :: Lens' UpdateIntegration Text
- updateIntegrationResponse'_apiGatewayManaged :: Lens' UpdateIntegrationResponse' (Maybe Bool)
- updateIntegrationResponse'_connectionId :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_connectionType :: Lens' UpdateIntegrationResponse' (Maybe ConnectionType)
- updateIntegrationResponse'_contentHandlingStrategy :: Lens' UpdateIntegrationResponse' (Maybe ContentHandlingStrategy)
- updateIntegrationResponse'_credentialsArn :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_description :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_integrationId :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_integrationMethod :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_integrationResponseSelectionExpression :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_integrationSubtype :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_integrationType :: Lens' UpdateIntegrationResponse' (Maybe IntegrationType)
- updateIntegrationResponse'_integrationUri :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_passthroughBehavior :: Lens' UpdateIntegrationResponse' (Maybe PassthroughBehavior)
- updateIntegrationResponse'_payloadFormatVersion :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_requestParameters :: Lens' UpdateIntegrationResponse' (Maybe (HashMap Text Text))
- updateIntegrationResponse'_requestTemplates :: Lens' UpdateIntegrationResponse' (Maybe (HashMap Text Text))
- updateIntegrationResponse'_responseParameters :: Lens' UpdateIntegrationResponse' (Maybe (HashMap Text (HashMap Text Text)))
- updateIntegrationResponse'_templateSelectionExpression :: Lens' UpdateIntegrationResponse' (Maybe Text)
- updateIntegrationResponse'_timeoutInMillis :: Lens' UpdateIntegrationResponse' (Maybe Natural)
- updateIntegrationResponse'_tlsConfig :: Lens' UpdateIntegrationResponse' (Maybe TlsConfig)
- updateIntegrationResponse'_httpStatus :: Lens' UpdateIntegrationResponse' Int
- updateIntegrationResponse_contentHandlingStrategy :: Lens' UpdateIntegrationResponse (Maybe ContentHandlingStrategy)
- updateIntegrationResponse_integrationResponseKey :: Lens' UpdateIntegrationResponse (Maybe Text)
- updateIntegrationResponse_responseParameters :: Lens' UpdateIntegrationResponse (Maybe (HashMap Text Text))
- updateIntegrationResponse_responseTemplates :: Lens' UpdateIntegrationResponse (Maybe (HashMap Text Text))
- updateIntegrationResponse_templateSelectionExpression :: Lens' UpdateIntegrationResponse (Maybe Text)
- updateIntegrationResponse_apiId :: Lens' UpdateIntegrationResponse Text
- updateIntegrationResponse_integrationResponseId :: Lens' UpdateIntegrationResponse Text
- updateIntegrationResponse_integrationId :: Lens' UpdateIntegrationResponse Text
- updateIntegrationResponseResponse_contentHandlingStrategy :: Lens' UpdateIntegrationResponseResponse (Maybe ContentHandlingStrategy)
- updateIntegrationResponseResponse_integrationResponseId :: Lens' UpdateIntegrationResponseResponse (Maybe Text)
- updateIntegrationResponseResponse_integrationResponseKey :: Lens' UpdateIntegrationResponseResponse (Maybe Text)
- updateIntegrationResponseResponse_responseParameters :: Lens' UpdateIntegrationResponseResponse (Maybe (HashMap Text Text))
- updateIntegrationResponseResponse_responseTemplates :: Lens' UpdateIntegrationResponseResponse (Maybe (HashMap Text Text))
- updateIntegrationResponseResponse_templateSelectionExpression :: Lens' UpdateIntegrationResponseResponse (Maybe Text)
- updateIntegrationResponseResponse_httpStatus :: Lens' UpdateIntegrationResponseResponse Int
- updateModel_contentType :: Lens' UpdateModel (Maybe Text)
- updateModel_description :: Lens' UpdateModel (Maybe Text)
- updateModel_name :: Lens' UpdateModel (Maybe Text)
- updateModel_schema :: Lens' UpdateModel (Maybe Text)
- updateModel_modelId :: Lens' UpdateModel Text
- updateModel_apiId :: Lens' UpdateModel Text
- updateModelResponse_contentType :: Lens' UpdateModelResponse (Maybe Text)
- updateModelResponse_description :: Lens' UpdateModelResponse (Maybe Text)
- updateModelResponse_modelId :: Lens' UpdateModelResponse (Maybe Text)
- updateModelResponse_name :: Lens' UpdateModelResponse (Maybe Text)
- updateModelResponse_schema :: Lens' UpdateModelResponse (Maybe Text)
- updateModelResponse_httpStatus :: Lens' UpdateModelResponse Int
- updateRoute_apiKeyRequired :: Lens' UpdateRoute (Maybe Bool)
- updateRoute_authorizationScopes :: Lens' UpdateRoute (Maybe [Text])
- updateRoute_authorizationType :: Lens' UpdateRoute (Maybe AuthorizationType)
- updateRoute_authorizerId :: Lens' UpdateRoute (Maybe Text)
- updateRoute_modelSelectionExpression :: Lens' UpdateRoute (Maybe Text)
- updateRoute_operationName :: Lens' UpdateRoute (Maybe Text)
- updateRoute_requestModels :: Lens' UpdateRoute (Maybe (HashMap Text Text))
- updateRoute_requestParameters :: Lens' UpdateRoute (Maybe (HashMap Text ParameterConstraints))
- updateRoute_routeKey :: Lens' UpdateRoute (Maybe Text)
- updateRoute_routeResponseSelectionExpression :: Lens' UpdateRoute (Maybe Text)
- updateRoute_target :: Lens' UpdateRoute (Maybe Text)
- updateRoute_apiId :: Lens' UpdateRoute Text
- updateRoute_routeId :: Lens' UpdateRoute Text
- updateRouteResponse'_apiGatewayManaged :: Lens' UpdateRouteResponse' (Maybe Bool)
- updateRouteResponse'_apiKeyRequired :: Lens' UpdateRouteResponse' (Maybe Bool)
- updateRouteResponse'_authorizationScopes :: Lens' UpdateRouteResponse' (Maybe [Text])
- updateRouteResponse'_authorizationType :: Lens' UpdateRouteResponse' (Maybe AuthorizationType)
- updateRouteResponse'_authorizerId :: Lens' UpdateRouteResponse' (Maybe Text)
- updateRouteResponse'_modelSelectionExpression :: Lens' UpdateRouteResponse' (Maybe Text)
- updateRouteResponse'_operationName :: Lens' UpdateRouteResponse' (Maybe Text)
- updateRouteResponse'_requestModels :: Lens' UpdateRouteResponse' (Maybe (HashMap Text Text))
- updateRouteResponse'_requestParameters :: Lens' UpdateRouteResponse' (Maybe (HashMap Text ParameterConstraints))
- updateRouteResponse'_routeId :: Lens' UpdateRouteResponse' (Maybe Text)
- updateRouteResponse'_routeKey :: Lens' UpdateRouteResponse' (Maybe Text)
- updateRouteResponse'_routeResponseSelectionExpression :: Lens' UpdateRouteResponse' (Maybe Text)
- updateRouteResponse'_target :: Lens' UpdateRouteResponse' (Maybe Text)
- updateRouteResponse'_httpStatus :: Lens' UpdateRouteResponse' Int
- updateRouteResponse_modelSelectionExpression :: Lens' UpdateRouteResponse (Maybe Text)
- updateRouteResponse_responseModels :: Lens' UpdateRouteResponse (Maybe (HashMap Text Text))
- updateRouteResponse_responseParameters :: Lens' UpdateRouteResponse (Maybe (HashMap Text ParameterConstraints))
- updateRouteResponse_routeResponseKey :: Lens' UpdateRouteResponse (Maybe Text)
- updateRouteResponse_routeResponseId :: Lens' UpdateRouteResponse Text
- updateRouteResponse_apiId :: Lens' UpdateRouteResponse Text
- updateRouteResponse_routeId :: Lens' UpdateRouteResponse Text
- updateRouteResponseResponse_modelSelectionExpression :: Lens' UpdateRouteResponseResponse (Maybe Text)
- updateRouteResponseResponse_responseModels :: Lens' UpdateRouteResponseResponse (Maybe (HashMap Text Text))
- updateRouteResponseResponse_responseParameters :: Lens' UpdateRouteResponseResponse (Maybe (HashMap Text ParameterConstraints))
- updateRouteResponseResponse_routeResponseId :: Lens' UpdateRouteResponseResponse (Maybe Text)
- updateRouteResponseResponse_routeResponseKey :: Lens' UpdateRouteResponseResponse (Maybe Text)
- updateRouteResponseResponse_httpStatus :: Lens' UpdateRouteResponseResponse Int
- updateStage_accessLogSettings :: Lens' UpdateStage (Maybe AccessLogSettings)
- updateStage_autoDeploy :: Lens' UpdateStage (Maybe Bool)
- updateStage_clientCertificateId :: Lens' UpdateStage (Maybe Text)
- updateStage_defaultRouteSettings :: Lens' UpdateStage (Maybe RouteSettings)
- updateStage_deploymentId :: Lens' UpdateStage (Maybe Text)
- updateStage_description :: Lens' UpdateStage (Maybe Text)
- updateStage_routeSettings :: Lens' UpdateStage (Maybe (HashMap Text RouteSettings))
- updateStage_stageVariables :: Lens' UpdateStage (Maybe (HashMap Text Text))
- updateStage_stageName :: Lens' UpdateStage Text
- updateStage_apiId :: Lens' UpdateStage Text
- updateStageResponse_accessLogSettings :: Lens' UpdateStageResponse (Maybe AccessLogSettings)
- updateStageResponse_apiGatewayManaged :: Lens' UpdateStageResponse (Maybe Bool)
- updateStageResponse_autoDeploy :: Lens' UpdateStageResponse (Maybe Bool)
- updateStageResponse_clientCertificateId :: Lens' UpdateStageResponse (Maybe Text)
- updateStageResponse_createdDate :: Lens' UpdateStageResponse (Maybe UTCTime)
- updateStageResponse_defaultRouteSettings :: Lens' UpdateStageResponse (Maybe RouteSettings)
- updateStageResponse_deploymentId :: Lens' UpdateStageResponse (Maybe Text)
- updateStageResponse_description :: Lens' UpdateStageResponse (Maybe Text)
- updateStageResponse_lastDeploymentStatusMessage :: Lens' UpdateStageResponse (Maybe Text)
- updateStageResponse_lastUpdatedDate :: Lens' UpdateStageResponse (Maybe UTCTime)
- updateStageResponse_routeSettings :: Lens' UpdateStageResponse (Maybe (HashMap Text RouteSettings))
- updateStageResponse_stageName :: Lens' UpdateStageResponse (Maybe Text)
- updateStageResponse_stageVariables :: Lens' UpdateStageResponse (Maybe (HashMap Text Text))
- updateStageResponse_tags :: Lens' UpdateStageResponse (Maybe (HashMap Text Text))
- updateStageResponse_httpStatus :: Lens' UpdateStageResponse Int
- updateVpcLink_name :: Lens' UpdateVpcLink (Maybe Text)
- updateVpcLink_vpcLinkId :: Lens' UpdateVpcLink Text
- updateVpcLinkResponse_createdDate :: Lens' UpdateVpcLinkResponse (Maybe UTCTime)
- updateVpcLinkResponse_name :: Lens' UpdateVpcLinkResponse (Maybe Text)
- updateVpcLinkResponse_securityGroupIds :: Lens' UpdateVpcLinkResponse (Maybe [Text])
- updateVpcLinkResponse_subnetIds :: Lens' UpdateVpcLinkResponse (Maybe [Text])
- updateVpcLinkResponse_tags :: Lens' UpdateVpcLinkResponse (Maybe (HashMap Text Text))
- updateVpcLinkResponse_vpcLinkId :: Lens' UpdateVpcLinkResponse (Maybe Text)
- updateVpcLinkResponse_vpcLinkStatus :: Lens' UpdateVpcLinkResponse (Maybe VpcLinkStatus)
- updateVpcLinkResponse_vpcLinkStatusMessage :: Lens' UpdateVpcLinkResponse (Maybe Text)
- updateVpcLinkResponse_vpcLinkVersion :: Lens' UpdateVpcLinkResponse (Maybe VpcLinkVersion)
- updateVpcLinkResponse_httpStatus :: Lens' UpdateVpcLinkResponse Int
- accessLogSettings_destinationArn :: Lens' AccessLogSettings (Maybe Text)
- accessLogSettings_format :: Lens' AccessLogSettings (Maybe Text)
- api_apiEndpoint :: Lens' Api (Maybe Text)
- api_apiGatewayManaged :: Lens' Api (Maybe Bool)
- api_apiId :: Lens' Api (Maybe Text)
- api_apiKeySelectionExpression :: Lens' Api (Maybe Text)
- api_corsConfiguration :: Lens' Api (Maybe Cors)
- api_createdDate :: Lens' Api (Maybe UTCTime)
- api_description :: Lens' Api (Maybe Text)
- api_disableExecuteApiEndpoint :: Lens' Api (Maybe Bool)
- api_disableSchemaValidation :: Lens' Api (Maybe Bool)
- api_importInfo :: Lens' Api (Maybe [Text])
- api_tags :: Lens' Api (Maybe (HashMap Text Text))
- api_version :: Lens' Api (Maybe Text)
- api_warnings :: Lens' Api (Maybe [Text])
- api_routeSelectionExpression :: Lens' Api Text
- api_name :: Lens' Api Text
- api_protocolType :: Lens' Api ProtocolType
- apiMapping_apiMappingId :: Lens' ApiMapping (Maybe Text)
- apiMapping_apiMappingKey :: Lens' ApiMapping (Maybe Text)
- apiMapping_stage :: Lens' ApiMapping Text
- apiMapping_apiId :: Lens' ApiMapping Text
- authorizer_authorizerCredentialsArn :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerId :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerPayloadFormatVersion :: Lens' Authorizer (Maybe Text)
- authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Natural)
- authorizer_authorizerType :: Lens' Authorizer (Maybe AuthorizerType)
- authorizer_authorizerUri :: Lens' Authorizer (Maybe Text)
- authorizer_enableSimpleResponses :: Lens' Authorizer (Maybe Bool)
- authorizer_identitySource :: Lens' Authorizer (Maybe [Text])
- authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text)
- authorizer_jwtConfiguration :: Lens' Authorizer (Maybe JWTConfiguration)
- authorizer_name :: Lens' Authorizer Text
- cors_allowCredentials :: Lens' Cors (Maybe Bool)
- cors_allowHeaders :: Lens' Cors (Maybe [Text])
- cors_allowMethods :: Lens' Cors (Maybe [Text])
- cors_allowOrigins :: Lens' Cors (Maybe [Text])
- cors_exposeHeaders :: Lens' Cors (Maybe [Text])
- cors_maxAge :: Lens' Cors (Maybe Int)
- deployment_autoDeployed :: Lens' Deployment (Maybe Bool)
- deployment_createdDate :: Lens' Deployment (Maybe UTCTime)
- deployment_deploymentId :: Lens' Deployment (Maybe Text)
- deployment_deploymentStatus :: Lens' Deployment (Maybe DeploymentStatus)
- deployment_deploymentStatusMessage :: Lens' Deployment (Maybe Text)
- deployment_description :: Lens' Deployment (Maybe Text)
- domainName_apiMappingSelectionExpression :: Lens' DomainName (Maybe Text)
- domainName_domainNameConfigurations :: Lens' DomainName (Maybe [DomainNameConfiguration])
- domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication)
- domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text))
- domainName_domainName :: Lens' DomainName Text
- domainNameConfiguration_apiGatewayDomainName :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_certificateArn :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_certificateName :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_certificateUploadDate :: Lens' DomainNameConfiguration (Maybe UTCTime)
- domainNameConfiguration_domainNameStatus :: Lens' DomainNameConfiguration (Maybe DomainNameStatus)
- domainNameConfiguration_domainNameStatusMessage :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_endpointType :: Lens' DomainNameConfiguration (Maybe EndpointType)
- domainNameConfiguration_hostedZoneId :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_ownershipVerificationCertificateArn :: Lens' DomainNameConfiguration (Maybe Text)
- domainNameConfiguration_securityPolicy :: Lens' DomainNameConfiguration (Maybe SecurityPolicy)
- integration_apiGatewayManaged :: Lens' Integration (Maybe Bool)
- integration_connectionId :: Lens' Integration (Maybe Text)
- integration_connectionType :: Lens' Integration (Maybe ConnectionType)
- integration_contentHandlingStrategy :: Lens' Integration (Maybe ContentHandlingStrategy)
- integration_credentialsArn :: Lens' Integration (Maybe Text)
- integration_description :: Lens' Integration (Maybe Text)
- integration_integrationId :: Lens' Integration (Maybe Text)
- integration_integrationMethod :: Lens' Integration (Maybe Text)
- integration_integrationResponseSelectionExpression :: Lens' Integration (Maybe Text)
- integration_integrationSubtype :: Lens' Integration (Maybe Text)
- integration_integrationType :: Lens' Integration (Maybe IntegrationType)
- integration_integrationUri :: Lens' Integration (Maybe Text)
- integration_passthroughBehavior :: Lens' Integration (Maybe PassthroughBehavior)
- integration_payloadFormatVersion :: Lens' Integration (Maybe Text)
- integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text))
- integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text))
- integration_responseParameters :: Lens' Integration (Maybe (HashMap Text (HashMap Text Text)))
- integration_templateSelectionExpression :: Lens' Integration (Maybe Text)
- integration_timeoutInMillis :: Lens' Integration (Maybe Natural)
- integration_tlsConfig :: Lens' Integration (Maybe TlsConfig)
- integrationResponse_contentHandlingStrategy :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy)
- integrationResponse_integrationResponseId :: Lens' IntegrationResponse (Maybe Text)
- integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text))
- integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text))
- integrationResponse_templateSelectionExpression :: Lens' IntegrationResponse (Maybe Text)
- integrationResponse_integrationResponseKey :: Lens' IntegrationResponse Text
- jWTConfiguration_audience :: Lens' JWTConfiguration (Maybe [Text])
- jWTConfiguration_issuer :: Lens' JWTConfiguration (Maybe Text)
- model_contentType :: Lens' Model (Maybe Text)
- model_description :: Lens' Model (Maybe Text)
- model_modelId :: Lens' Model (Maybe Text)
- model_schema :: Lens' Model (Maybe Text)
- model_name :: Lens' Model Text
- mutualTlsAuthentication_truststoreUri :: Lens' MutualTlsAuthentication (Maybe Text)
- mutualTlsAuthentication_truststoreVersion :: Lens' MutualTlsAuthentication (Maybe Text)
- mutualTlsAuthentication_truststoreWarnings :: Lens' MutualTlsAuthentication (Maybe [Text])
- mutualTlsAuthenticationInput_truststoreUri :: Lens' MutualTlsAuthenticationInput (Maybe Text)
- mutualTlsAuthenticationInput_truststoreVersion :: Lens' MutualTlsAuthenticationInput (Maybe Text)
- parameterConstraints_required :: Lens' ParameterConstraints (Maybe Bool)
- route_apiGatewayManaged :: Lens' Route (Maybe Bool)
- route_apiKeyRequired :: Lens' Route (Maybe Bool)
- route_authorizationScopes :: Lens' Route (Maybe [Text])
- route_authorizationType :: Lens' Route (Maybe AuthorizationType)
- route_authorizerId :: Lens' Route (Maybe Text)
- route_modelSelectionExpression :: Lens' Route (Maybe Text)
- route_operationName :: Lens' Route (Maybe Text)
- route_requestModels :: Lens' Route (Maybe (HashMap Text Text))
- route_requestParameters :: Lens' Route (Maybe (HashMap Text ParameterConstraints))
- route_routeId :: Lens' Route (Maybe Text)
- route_routeResponseSelectionExpression :: Lens' Route (Maybe Text)
- route_target :: Lens' Route (Maybe Text)
- route_routeKey :: Lens' Route Text
- routeResponse_modelSelectionExpression :: Lens' RouteResponse (Maybe Text)
- routeResponse_responseModels :: Lens' RouteResponse (Maybe (HashMap Text Text))
- routeResponse_responseParameters :: Lens' RouteResponse (Maybe (HashMap Text ParameterConstraints))
- routeResponse_routeResponseId :: Lens' RouteResponse (Maybe Text)
- routeResponse_routeResponseKey :: Lens' RouteResponse Text
- routeSettings_dataTraceEnabled :: Lens' RouteSettings (Maybe Bool)
- routeSettings_detailedMetricsEnabled :: Lens' RouteSettings (Maybe Bool)
- routeSettings_loggingLevel :: Lens' RouteSettings (Maybe LoggingLevel)
- routeSettings_throttlingBurstLimit :: Lens' RouteSettings (Maybe Int)
- routeSettings_throttlingRateLimit :: Lens' RouteSettings (Maybe Double)
- stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings)
- stage_apiGatewayManaged :: Lens' Stage (Maybe Bool)
- stage_autoDeploy :: Lens' Stage (Maybe Bool)
- stage_clientCertificateId :: Lens' Stage (Maybe Text)
- stage_createdDate :: Lens' Stage (Maybe UTCTime)
- stage_defaultRouteSettings :: Lens' Stage (Maybe RouteSettings)
- stage_deploymentId :: Lens' Stage (Maybe Text)
- stage_description :: Lens' Stage (Maybe Text)
- stage_lastDeploymentStatusMessage :: Lens' Stage (Maybe Text)
- stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime)
- stage_routeSettings :: Lens' Stage (Maybe (HashMap Text RouteSettings))
- stage_stageVariables :: Lens' Stage (Maybe (HashMap Text Text))
- stage_tags :: Lens' Stage (Maybe (HashMap Text Text))
- stage_stageName :: Lens' Stage Text
- tlsConfig_serverNameToVerify :: Lens' TlsConfig (Maybe Text)
- tlsConfigInput_serverNameToVerify :: Lens' TlsConfigInput (Maybe Text)
- vpcLink_createdDate :: Lens' VpcLink (Maybe UTCTime)
- vpcLink_tags :: Lens' VpcLink (Maybe (HashMap Text Text))
- vpcLink_vpcLinkStatus :: Lens' VpcLink (Maybe VpcLinkStatus)
- vpcLink_vpcLinkStatusMessage :: Lens' VpcLink (Maybe Text)
- vpcLink_vpcLinkVersion :: Lens' VpcLink (Maybe VpcLinkVersion)
- vpcLink_vpcLinkId :: Lens' VpcLink Text
- vpcLink_securityGroupIds :: Lens' VpcLink [Text]
- vpcLink_subnetIds :: Lens' VpcLink [Text]
- vpcLink_name :: Lens' VpcLink Text
Operations
CreateApi
createApi_apiKeySelectionExpression :: Lens' CreateApi (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
createApi_corsConfiguration :: Lens' CreateApi (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs. See Configuring CORS for more information.
createApi_credentialsArn :: Lens' CreateApi (Maybe Text) Source #
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_disableExecuteApiEndpoint :: Lens' CreateApi (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
createApi_disableSchemaValidation :: Lens' CreateApi (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
createApi_routeKey :: Lens' CreateApi (Maybe Text) Source #
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_routeSelectionExpression :: Lens' CreateApi (Maybe Text) Source #
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_tags :: Lens' CreateApi (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
createApi_target :: Lens' CreateApi (Maybe Text) Source #
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_protocolType :: Lens' CreateApi ProtocolType Source #
The API protocol.
createApiResponse_apiEndpoint :: Lens' CreateApiResponse (Maybe Text) Source #
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_apiGatewayManaged :: Lens' CreateApiResponse (Maybe Bool) Source #
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_apiId :: Lens' CreateApiResponse (Maybe Text) Source #
The API ID.
createApiResponse_apiKeySelectionExpression :: Lens' CreateApiResponse (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
createApiResponse_corsConfiguration :: Lens' CreateApiResponse (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs.
createApiResponse_createdDate :: Lens' CreateApiResponse (Maybe UTCTime) Source #
The timestamp when the API was created.
createApiResponse_description :: Lens' CreateApiResponse (Maybe Text) Source #
The description of the API.
createApiResponse_disableExecuteApiEndpoint :: Lens' CreateApiResponse (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
createApiResponse_disableSchemaValidation :: Lens' CreateApiResponse (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
createApiResponse_importInfo :: Lens' CreateApiResponse (Maybe [Text]) Source #
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.
createApiResponse_name :: Lens' CreateApiResponse (Maybe Text) Source #
The name of the API.
createApiResponse_protocolType :: Lens' CreateApiResponse (Maybe ProtocolType) Source #
The API protocol.
createApiResponse_routeSelectionExpression :: Lens' CreateApiResponse (Maybe Text) Source #
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.
createApiResponse_tags :: Lens' CreateApiResponse (Maybe (HashMap Text Text)) Source #
A collection of tags associated with the API.
createApiResponse_version :: Lens' CreateApiResponse (Maybe Text) Source #
A version identifier for the API.
createApiResponse_warnings :: Lens' CreateApiResponse (Maybe [Text]) Source #
The warning messages reported when failonwarnings is turned on during API import.
createApiResponse_httpStatus :: Lens' CreateApiResponse Int Source #
The response's http status code.
CreateApiMapping
createApiMapping_apiMappingKey :: Lens' CreateApiMapping (Maybe Text) Source #
The API mapping key.
createApiMapping_domainName :: Lens' CreateApiMapping Text Source #
The domain name.
createApiMapping_stage :: Lens' CreateApiMapping Text Source #
The API stage.
createApiMapping_apiId :: Lens' CreateApiMapping Text Source #
The API identifier.
createApiMappingResponse_apiId :: Lens' CreateApiMappingResponse (Maybe Text) Source #
The API identifier.
createApiMappingResponse_apiMappingId :: Lens' CreateApiMappingResponse (Maybe Text) Source #
The API mapping identifier.
createApiMappingResponse_apiMappingKey :: Lens' CreateApiMappingResponse (Maybe Text) Source #
The API mapping key.
createApiMappingResponse_stage :: Lens' CreateApiMappingResponse (Maybe Text) Source #
The API stage.
createApiMappingResponse_httpStatus :: Lens' CreateApiMappingResponse Int Source #
The response's http status code.
CreateAuthorizer
createAuthorizer_authorizerCredentialsArn :: Lens' CreateAuthorizer (Maybe Text) Source #
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
createAuthorizer_authorizerPayloadFormatVersion :: Lens' CreateAuthorizer (Maybe Text) Source #
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_authorizerResultTtlInSeconds :: Lens' CreateAuthorizer (Maybe Natural) Source #
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_authorizerUri :: Lens' CreateAuthorizer (Maybe Text) Source #
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_enableSimpleResponses :: Lens' CreateAuthorizer (Maybe Bool) Source #
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_identityValidationExpression :: Lens' CreateAuthorizer (Maybe Text) Source #
This parameter is not used.
createAuthorizer_jwtConfiguration :: Lens' CreateAuthorizer (Maybe JWTConfiguration) Source #
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
createAuthorizer_apiId :: Lens' CreateAuthorizer Text Source #
The API identifier.
createAuthorizer_authorizerType :: Lens' CreateAuthorizer 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).
createAuthorizer_identitySource :: Lens' CreateAuthorizer [Text] Source #
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_name :: Lens' CreateAuthorizer Text Source #
The name of the authorizer.
createAuthorizerResponse_authorizerCredentialsArn :: Lens' CreateAuthorizerResponse (Maybe Text) Source #
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
createAuthorizerResponse_authorizerId :: Lens' CreateAuthorizerResponse (Maybe Text) Source #
The authorizer identifier.
createAuthorizerResponse_authorizerPayloadFormatVersion :: Lens' CreateAuthorizerResponse (Maybe Text) Source #
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.
createAuthorizerResponse_authorizerResultTtlInSeconds :: Lens' CreateAuthorizerResponse (Maybe Natural) Source #
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.
createAuthorizerResponse_authorizerType :: Lens' CreateAuthorizerResponse (Maybe 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).
createAuthorizerResponse_authorizerUri :: Lens' CreateAuthorizerResponse (Maybe Text) Source #
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.
createAuthorizerResponse_enableSimpleResponses :: Lens' CreateAuthorizerResponse (Maybe Bool) Source #
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
createAuthorizerResponse_identitySource :: Lens' CreateAuthorizerResponse (Maybe [Text]) Source #
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.
createAuthorizerResponse_identityValidationExpression :: Lens' CreateAuthorizerResponse (Maybe Text) Source #
The validation expression does not apply to the REQUEST authorizer.
createAuthorizerResponse_jwtConfiguration :: Lens' CreateAuthorizerResponse (Maybe JWTConfiguration) Source #
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
createAuthorizerResponse_name :: Lens' CreateAuthorizerResponse (Maybe Text) Source #
The name of the authorizer.
createAuthorizerResponse_httpStatus :: Lens' CreateAuthorizerResponse Int Source #
The response's http status code.
CreateDeployment
createDeployment_description :: Lens' CreateDeployment (Maybe Text) Source #
The description for the deployment resource.
createDeployment_stageName :: Lens' CreateDeployment (Maybe Text) Source #
The name of the Stage resource for the Deployment resource to create.
createDeployment_apiId :: Lens' CreateDeployment Text Source #
The API identifier.
createDeploymentResponse_autoDeployed :: Lens' CreateDeploymentResponse (Maybe Bool) Source #
Specifies whether a deployment was automatically released.
createDeploymentResponse_createdDate :: Lens' CreateDeploymentResponse (Maybe UTCTime) Source #
The date and time when the Deployment resource was created.
createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text) Source #
The identifier for the deployment.
createDeploymentResponse_deploymentStatus :: Lens' CreateDeploymentResponse (Maybe DeploymentStatus) Source #
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
createDeploymentResponse_deploymentStatusMessage :: Lens' CreateDeploymentResponse (Maybe Text) Source #
May contain additional feedback on the status of an API deployment.
createDeploymentResponse_description :: Lens' CreateDeploymentResponse (Maybe Text) Source #
The description for the deployment.
createDeploymentResponse_httpStatus :: Lens' CreateDeploymentResponse Int Source #
The response's http status code.
CreateDomainName
createDomainName_domainNameConfigurations :: Lens' CreateDomainName (Maybe [DomainNameConfiguration]) Source #
The domain name configurations.
createDomainName_mutualTlsAuthentication :: Lens' CreateDomainName (Maybe MutualTlsAuthenticationInput) Source #
The mutual TLS authentication configuration for a custom domain name.
createDomainName_tags :: Lens' CreateDomainName (Maybe (HashMap Text Text)) Source #
The collection of tags associated with a domain name.
createDomainName_domainName :: Lens' CreateDomainName Text Source #
The domain name.
createDomainNameResponse_apiMappingSelectionExpression :: Lens' CreateDomainNameResponse (Maybe Text) Source #
The API mapping selection expression.
createDomainNameResponse_domainName :: Lens' CreateDomainNameResponse (Maybe Text) Source #
The name of the DomainName resource.
createDomainNameResponse_domainNameConfigurations :: Lens' CreateDomainNameResponse (Maybe [DomainNameConfiguration]) Source #
The domain name configurations.
createDomainNameResponse_mutualTlsAuthentication :: Lens' CreateDomainNameResponse (Maybe MutualTlsAuthentication) Source #
The mutual TLS authentication configuration for a custom domain name.
createDomainNameResponse_tags :: Lens' CreateDomainNameResponse (Maybe (HashMap Text Text)) Source #
The collection of tags associated with a domain name.
createDomainNameResponse_httpStatus :: Lens' CreateDomainNameResponse Int Source #
The response's http status code.
CreateIntegration
createIntegration_connectionId :: Lens' CreateIntegration (Maybe Text) Source #
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
createIntegration_connectionType :: Lens' CreateIntegration (Maybe ConnectionType) Source #
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_contentHandlingStrategy :: Lens' CreateIntegration (Maybe ContentHandlingStrategy) Source #
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_credentialsArn :: Lens' CreateIntegration (Maybe Text) Source #
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
createIntegration_description :: Lens' CreateIntegration (Maybe Text) Source #
The description of the integration.
createIntegration_integrationMethod :: Lens' CreateIntegration (Maybe Text) Source #
Specifies the integration's HTTP method type.
createIntegration_integrationSubtype :: Lens' CreateIntegration (Maybe Text) Source #
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
createIntegration_integrationUri :: Lens' CreateIntegration (Maybe Text) Source #
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_passthroughBehavior :: Lens' CreateIntegration (Maybe PassthroughBehavior) Source #
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_payloadFormatVersion :: Lens' CreateIntegration (Maybe Text) Source #
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
createIntegration_requestParameters :: Lens' CreateIntegration (Maybe (HashMap Text Text)) Source #
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_requestTemplates :: Lens' CreateIntegration (Maybe (HashMap Text Text)) Source #
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
createIntegration_responseParameters :: Lens' CreateIntegration (Maybe (HashMap Text (HashMap Text Text))) Source #
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_templateSelectionExpression :: Lens' CreateIntegration (Maybe Text) Source #
The template selection expression for the integration.
createIntegration_timeoutInMillis :: Lens' CreateIntegration (Maybe Natural) Source #
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_tlsConfig :: Lens' CreateIntegration (Maybe 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.
createIntegration_apiId :: Lens' CreateIntegration Text Source #
The API identifier.
createIntegration_integrationType :: Lens' CreateIntegration IntegrationType Source #
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.
createIntegrationResponse'_apiGatewayManaged :: Lens' CreateIntegrationResponse' (Maybe Bool) Source #
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.
createIntegrationResponse'_connectionId :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
createIntegrationResponse'_connectionType :: Lens' CreateIntegrationResponse' (Maybe ConnectionType) Source #
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.
createIntegrationResponse'_contentHandlingStrategy :: Lens' CreateIntegrationResponse' (Maybe ContentHandlingStrategy) Source #
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.
createIntegrationResponse'_credentialsArn :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
createIntegrationResponse'_description :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
Represents the description of an integration.
createIntegrationResponse'_integrationId :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
Represents the identifier of an integration.
createIntegrationResponse'_integrationMethod :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
Specifies the integration's HTTP method type.
createIntegrationResponse'_integrationResponseSelectionExpression :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
createIntegrationResponse'_integrationSubtype :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
createIntegrationResponse'_integrationType :: Lens' CreateIntegrationResponse' (Maybe IntegrationType) Source #
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.
createIntegrationResponse'_integrationUri :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
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.
createIntegrationResponse'_passthroughBehavior :: Lens' CreateIntegrationResponse' (Maybe PassthroughBehavior) Source #
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.
createIntegrationResponse'_payloadFormatVersion :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
createIntegrationResponse'_requestParameters :: Lens' CreateIntegrationResponse' (Maybe (HashMap Text Text)) Source #
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.
createIntegrationResponse'_requestTemplates :: Lens' CreateIntegrationResponse' (Maybe (HashMap Text Text)) Source #
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
createIntegrationResponse'_responseParameters :: Lens' CreateIntegrationResponse' (Maybe (HashMap Text (HashMap Text Text))) Source #
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.
createIntegrationResponse'_templateSelectionExpression :: Lens' CreateIntegrationResponse' (Maybe Text) Source #
The template selection expression for the integration. Supported only for WebSocket APIs.
createIntegrationResponse'_timeoutInMillis :: Lens' CreateIntegrationResponse' (Maybe Natural) Source #
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.
createIntegrationResponse'_tlsConfig :: Lens' CreateIntegrationResponse' (Maybe TlsConfig) 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.
createIntegrationResponse'_httpStatus :: Lens' CreateIntegrationResponse' Int Source #
The response's http status code.
CreateIntegrationResponse
createIntegrationResponse_contentHandlingStrategy :: Lens' CreateIntegrationResponse (Maybe ContentHandlingStrategy) Source #
Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:
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_responseParameters :: Lens' CreateIntegrationResponse (Maybe (HashMap Text Text)) Source #
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_responseTemplates :: Lens' CreateIntegrationResponse (Maybe (HashMap Text Text)) Source #
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_templateSelectionExpression :: Lens' CreateIntegrationResponse (Maybe Text) Source #
The template selection expression for the integration response. Supported only for WebSocket APIs.
createIntegrationResponse_apiId :: Lens' CreateIntegrationResponse Text Source #
The API identifier.
createIntegrationResponse_integrationId :: Lens' CreateIntegrationResponse Text Source #
The integration ID.
createIntegrationResponse_integrationResponseKey :: Lens' CreateIntegrationResponse Text Source #
The integration response key.
createIntegrationResponseResponse_contentHandlingStrategy :: Lens' CreateIntegrationResponseResponse (Maybe ContentHandlingStrategy) Source #
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_integrationResponseId :: Lens' CreateIntegrationResponseResponse (Maybe Text) Source #
The integration response ID.
createIntegrationResponseResponse_integrationResponseKey :: Lens' CreateIntegrationResponseResponse (Maybe Text) Source #
The integration response key.
createIntegrationResponseResponse_responseParameters :: Lens' CreateIntegrationResponseResponse (Maybe (HashMap Text Text)) Source #
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.
createIntegrationResponseResponse_responseTemplates :: Lens' CreateIntegrationResponseResponse (Maybe (HashMap Text Text)) Source #
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.
createIntegrationResponseResponse_templateSelectionExpression :: Lens' CreateIntegrationResponseResponse (Maybe Text) Source #
The template selection expressions for the integration response.
createIntegrationResponseResponse_httpStatus :: Lens' CreateIntegrationResponseResponse Int Source #
The response's http status code.
CreateModel
createModel_contentType :: Lens' CreateModel (Maybe Text) Source #
The content-type for the model, for example, "application/json".
createModel_description :: Lens' CreateModel (Maybe Text) Source #
The description of the model.
createModel_apiId :: Lens' CreateModel Text Source #
The API identifier.
createModel_schema :: Lens' CreateModel Text Source #
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
createModel_name :: Lens' CreateModel Text Source #
The name of the model. Must be alphanumeric.
createModelResponse_contentType :: Lens' CreateModelResponse (Maybe Text) Source #
The content-type for the model, for example, "application/json".
createModelResponse_description :: Lens' CreateModelResponse (Maybe Text) Source #
The description of the model.
createModelResponse_modelId :: Lens' CreateModelResponse (Maybe Text) Source #
The model identifier.
createModelResponse_name :: Lens' CreateModelResponse (Maybe Text) Source #
The name of the model. Must be alphanumeric.
createModelResponse_schema :: Lens' CreateModelResponse (Maybe Text) Source #
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
createModelResponse_httpStatus :: Lens' CreateModelResponse Int Source #
The response's http status code.
CreateRoute
createRoute_apiKeyRequired :: Lens' CreateRoute (Maybe Bool) Source #
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
createRoute_authorizationScopes :: Lens' CreateRoute (Maybe [Text]) Source #
The authorization scopes supported by this route.
createRoute_authorizationType :: Lens' CreateRoute (Maybe AuthorizationType) Source #
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_authorizerId :: Lens' CreateRoute (Maybe Text) Source #
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_modelSelectionExpression :: Lens' CreateRoute (Maybe Text) Source #
The model selection expression for the route. Supported only for WebSocket APIs.
createRoute_operationName :: Lens' CreateRoute (Maybe Text) Source #
The operation name for the route.
createRoute_requestModels :: Lens' CreateRoute (Maybe (HashMap Text Text)) Source #
The request models for the route. Supported only for WebSocket APIs.
createRoute_requestParameters :: Lens' CreateRoute (Maybe (HashMap Text ParameterConstraints)) Source #
The request parameters for the route. Supported only for WebSocket APIs.
createRoute_routeResponseSelectionExpression :: Lens' CreateRoute (Maybe Text) Source #
The route response selection expression for the route. Supported only for WebSocket APIs.
createRoute_target :: Lens' CreateRoute (Maybe Text) Source #
The target for the route.
createRoute_apiId :: Lens' CreateRoute Text Source #
The API identifier.
createRoute_routeKey :: Lens' CreateRoute Text Source #
The route key for the route.
createRouteResponse'_apiGatewayManaged :: Lens' CreateRouteResponse' (Maybe Bool) Source #
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.
createRouteResponse'_apiKeyRequired :: Lens' CreateRouteResponse' (Maybe Bool) Source #
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
createRouteResponse'_authorizationScopes :: Lens' CreateRouteResponse' (Maybe [Text]) Source #
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.
createRouteResponse'_authorizationType :: Lens' CreateRouteResponse' (Maybe AuthorizationType) Source #
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.
createRouteResponse'_authorizerId :: Lens' CreateRouteResponse' (Maybe Text) Source #
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.
createRouteResponse'_modelSelectionExpression :: Lens' CreateRouteResponse' (Maybe Text) Source #
The model selection expression for the route. Supported only for WebSocket APIs.
createRouteResponse'_operationName :: Lens' CreateRouteResponse' (Maybe Text) Source #
The operation name for the route.
createRouteResponse'_requestModels :: Lens' CreateRouteResponse' (Maybe (HashMap Text Text)) Source #
The request models for the route. Supported only for WebSocket APIs.
createRouteResponse'_requestParameters :: Lens' CreateRouteResponse' (Maybe (HashMap Text ParameterConstraints)) Source #
The request parameters for the route. Supported only for WebSocket APIs.
createRouteResponse'_routeId :: Lens' CreateRouteResponse' (Maybe Text) Source #
The route ID.
createRouteResponse'_routeKey :: Lens' CreateRouteResponse' (Maybe Text) Source #
The route key for the route.
createRouteResponse'_routeResponseSelectionExpression :: Lens' CreateRouteResponse' (Maybe Text) Source #
The route response selection expression for the route. Supported only for WebSocket APIs.
createRouteResponse'_target :: Lens' CreateRouteResponse' (Maybe Text) Source #
The target for the route.
createRouteResponse'_httpStatus :: Lens' CreateRouteResponse' Int Source #
The response's http status code.
CreateRouteResponse
createRouteResponse_modelSelectionExpression :: Lens' CreateRouteResponse (Maybe Text) Source #
The model selection expression for the route response. Supported only for WebSocket APIs.
createRouteResponse_responseModels :: Lens' CreateRouteResponse (Maybe (HashMap Text Text)) Source #
The response models for the route response.
createRouteResponse_responseParameters :: Lens' CreateRouteResponse (Maybe (HashMap Text ParameterConstraints)) Source #
The route response parameters.
createRouteResponse_apiId :: Lens' CreateRouteResponse Text Source #
The API identifier.
createRouteResponse_routeId :: Lens' CreateRouteResponse Text Source #
The route ID.
createRouteResponse_routeResponseKey :: Lens' CreateRouteResponse Text Source #
The route response key.
createRouteResponseResponse_modelSelectionExpression :: Lens' CreateRouteResponseResponse (Maybe Text) Source #
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
createRouteResponseResponse_responseModels :: Lens' CreateRouteResponseResponse (Maybe (HashMap Text Text)) Source #
Represents the response models of a route response.
createRouteResponseResponse_responseParameters :: Lens' CreateRouteResponseResponse (Maybe (HashMap Text ParameterConstraints)) Source #
Represents the response parameters of a route response.
createRouteResponseResponse_routeResponseId :: Lens' CreateRouteResponseResponse (Maybe Text) Source #
Represents the identifier of a route response.
createRouteResponseResponse_routeResponseKey :: Lens' CreateRouteResponseResponse (Maybe Text) Source #
Represents the route response key of a route response.
createRouteResponseResponse_httpStatus :: Lens' CreateRouteResponseResponse Int Source #
The response's http status code.
CreateStage
createStage_accessLogSettings :: Lens' CreateStage (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
createStage_autoDeploy :: Lens' CreateStage (Maybe Bool) Source #
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
createStage_clientCertificateId :: Lens' CreateStage (Maybe Text) Source #
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
createStage_defaultRouteSettings :: Lens' CreateStage (Maybe RouteSettings) Source #
The default route settings for the stage.
createStage_deploymentId :: Lens' CreateStage (Maybe Text) Source #
The deployment identifier of the API stage.
createStage_description :: Lens' CreateStage (Maybe Text) Source #
The description for the API stage.
createStage_routeSettings :: Lens' CreateStage (Maybe (HashMap Text RouteSettings)) Source #
Route settings for the stage, by routeKey.
createStage_stageVariables :: Lens' CreateStage (Maybe (HashMap Text Text)) Source #
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_tags :: Lens' CreateStage (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
createStage_apiId :: Lens' CreateStage Text Source #
The API identifier.
createStage_stageName :: Lens' CreateStage Text Source #
The name of the stage.
createStageResponse_accessLogSettings :: Lens' CreateStageResponse (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
createStageResponse_apiGatewayManaged :: Lens' CreateStageResponse (Maybe Bool) Source #
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.
createStageResponse_autoDeploy :: Lens' CreateStageResponse (Maybe Bool) Source #
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
createStageResponse_clientCertificateId :: Lens' CreateStageResponse (Maybe Text) Source #
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
createStageResponse_createdDate :: Lens' CreateStageResponse (Maybe UTCTime) Source #
The timestamp when the stage was created.
createStageResponse_defaultRouteSettings :: Lens' CreateStageResponse (Maybe RouteSettings) Source #
Default route settings for the stage.
createStageResponse_deploymentId :: Lens' CreateStageResponse (Maybe Text) Source #
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
createStageResponse_description :: Lens' CreateStageResponse (Maybe Text) Source #
The description of the stage.
createStageResponse_lastDeploymentStatusMessage :: Lens' CreateStageResponse (Maybe Text) Source #
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
createStageResponse_lastUpdatedDate :: Lens' CreateStageResponse (Maybe UTCTime) Source #
The timestamp when the stage was last updated.
createStageResponse_routeSettings :: Lens' CreateStageResponse (Maybe (HashMap Text RouteSettings)) Source #
Route settings for the stage, by routeKey.
createStageResponse_stageName :: Lens' CreateStageResponse (Maybe Text) Source #
The name of the stage.
createStageResponse_stageVariables :: Lens' CreateStageResponse (Maybe (HashMap Text Text)) Source #
A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
createStageResponse_tags :: Lens' CreateStageResponse (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
createStageResponse_httpStatus :: Lens' CreateStageResponse Int Source #
The response's http status code.
CreateVpcLink
createVpcLink_securityGroupIds :: Lens' CreateVpcLink (Maybe [Text]) Source #
A list of security group IDs for the VPC link.
createVpcLink_tags :: Lens' CreateVpcLink (Maybe (HashMap Text Text)) Source #
A list of tags.
createVpcLink_subnetIds :: Lens' CreateVpcLink [Text] Source #
A list of subnet IDs to include in the VPC link.
createVpcLink_name :: Lens' CreateVpcLink Text Source #
The name of the VPC link.
createVpcLinkResponse_createdDate :: Lens' CreateVpcLinkResponse (Maybe UTCTime) Source #
The timestamp when the VPC link was created.
createVpcLinkResponse_name :: Lens' CreateVpcLinkResponse (Maybe Text) Source #
The name of the VPC link.
createVpcLinkResponse_securityGroupIds :: Lens' CreateVpcLinkResponse (Maybe [Text]) Source #
A list of security group IDs for the VPC link.
createVpcLinkResponse_subnetIds :: Lens' CreateVpcLinkResponse (Maybe [Text]) Source #
A list of subnet IDs to include in the VPC link.
createVpcLinkResponse_tags :: Lens' CreateVpcLinkResponse (Maybe (HashMap Text Text)) Source #
Tags for the VPC link.
createVpcLinkResponse_vpcLinkId :: Lens' CreateVpcLinkResponse (Maybe Text) Source #
The ID of the VPC link.
createVpcLinkResponse_vpcLinkStatus :: Lens' CreateVpcLinkResponse (Maybe VpcLinkStatus) Source #
The status of the VPC link.
createVpcLinkResponse_vpcLinkStatusMessage :: Lens' CreateVpcLinkResponse (Maybe Text) Source #
A message summarizing the cause of the status of the VPC link.
createVpcLinkResponse_vpcLinkVersion :: Lens' CreateVpcLinkResponse (Maybe VpcLinkVersion) Source #
The version of the VPC link.
createVpcLinkResponse_httpStatus :: Lens' CreateVpcLinkResponse Int Source #
The response's http status code.
DeleteAccessLogSettings
deleteAccessLogSettings_stageName :: Lens' DeleteAccessLogSettings Text Source #
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
deleteAccessLogSettings_apiId :: Lens' DeleteAccessLogSettings Text Source #
The API identifier.
DeleteApi
DeleteApiMapping
deleteApiMapping_apiMappingId :: Lens' DeleteApiMapping Text Source #
The API mapping identifier.
deleteApiMapping_domainName :: Lens' DeleteApiMapping Text Source #
The domain name.
DeleteAuthorizer
deleteAuthorizer_authorizerId :: Lens' DeleteAuthorizer Text Source #
The authorizer identifier.
deleteAuthorizer_apiId :: Lens' DeleteAuthorizer Text Source #
The API identifier.
DeleteCorsConfiguration
deleteCorsConfiguration_apiId :: Lens' DeleteCorsConfiguration Text Source #
The API identifier.
DeleteDeployment
deleteDeployment_apiId :: Lens' DeleteDeployment Text Source #
The API identifier.
deleteDeployment_deploymentId :: Lens' DeleteDeployment Text Source #
The deployment ID.
DeleteDomainName
deleteDomainName_domainName :: Lens' DeleteDomainName Text Source #
The domain name.
DeleteIntegration
deleteIntegration_apiId :: Lens' DeleteIntegration Text Source #
The API identifier.
deleteIntegration_integrationId :: Lens' DeleteIntegration Text Source #
The integration ID.
DeleteIntegrationResponse
deleteIntegrationResponse_apiId :: Lens' DeleteIntegrationResponse Text Source #
The API identifier.
deleteIntegrationResponse_integrationResponseId :: Lens' DeleteIntegrationResponse Text Source #
The integration response ID.
deleteIntegrationResponse_integrationId :: Lens' DeleteIntegrationResponse Text Source #
The integration ID.
DeleteModel
deleteModel_modelId :: Lens' DeleteModel Text Source #
The model ID.
deleteModel_apiId :: Lens' DeleteModel Text Source #
The API identifier.
DeleteRoute
deleteRoute_apiId :: Lens' DeleteRoute Text Source #
The API identifier.
deleteRoute_routeId :: Lens' DeleteRoute Text Source #
The route ID.
DeleteRouteRequestParameter
deleteRouteRequestParameter_requestParameterKey :: Lens' DeleteRouteRequestParameter Text Source #
The route request parameter key.
deleteRouteRequestParameter_apiId :: Lens' DeleteRouteRequestParameter Text Source #
The API identifier.
deleteRouteRequestParameter_routeId :: Lens' DeleteRouteRequestParameter Text Source #
The route ID.
DeleteRouteResponse
deleteRouteResponse_routeResponseId :: Lens' DeleteRouteResponse Text Source #
The route response ID.
deleteRouteResponse_apiId :: Lens' DeleteRouteResponse Text Source #
The API identifier.
deleteRouteResponse_routeId :: Lens' DeleteRouteResponse Text Source #
The route ID.
DeleteRouteSettings
deleteRouteSettings_stageName :: Lens' DeleteRouteSettings Text Source #
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
deleteRouteSettings_routeKey :: Lens' DeleteRouteSettings Text Source #
The route key.
deleteRouteSettings_apiId :: Lens' DeleteRouteSettings Text Source #
The API identifier.
DeleteStage
deleteStage_stageName :: Lens' DeleteStage Text Source #
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
deleteStage_apiId :: Lens' DeleteStage Text Source #
The API identifier.
DeleteVpcLink
deleteVpcLink_vpcLinkId :: Lens' DeleteVpcLink Text Source #
The ID of the VPC link.
deleteVpcLinkResponse_httpStatus :: Lens' DeleteVpcLinkResponse Int Source #
The response's http status code.
ExportApi
exportApi_exportVersion :: Lens' ExportApi (Maybe Text) Source #
The version of the API Gateway export algorithm. API Gateway uses the latest version by default. Currently, the only supported version is 1.0.
exportApi_includeExtensions :: Lens' ExportApi (Maybe Bool) Source #
Specifies whether to include API Gateway extensions in the exported API definition. API Gateway extensions are included by default.
exportApi_stageName :: Lens' ExportApi (Maybe Text) Source #
The name of the API stage to export. If you don't specify this property, a representation of the latest API configuration is exported.
exportApi_specification :: Lens' ExportApi Text Source #
The version of the API specification to use. OAS30, for OpenAPI 3.0, is the only supported value.
exportApi_outputType :: Lens' ExportApi Text Source #
The output type of the exported definition file. Valid values are JSON and YAML.
exportApiResponse_body :: Lens' ExportApiResponse (Maybe ByteString) Source #
Undocumented member.
exportApiResponse_httpStatus :: Lens' ExportApiResponse Int Source #
The response's http status code.
GetApi
getApiResponse_apiEndpoint :: Lens' GetApiResponse (Maybe Text) Source #
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_apiGatewayManaged :: Lens' GetApiResponse (Maybe Bool) Source #
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.
getApiResponse_apiId :: Lens' GetApiResponse (Maybe Text) Source #
The API ID.
getApiResponse_apiKeySelectionExpression :: Lens' GetApiResponse (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
getApiResponse_corsConfiguration :: Lens' GetApiResponse (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs.
getApiResponse_createdDate :: Lens' GetApiResponse (Maybe UTCTime) Source #
The timestamp when the API was created.
getApiResponse_description :: Lens' GetApiResponse (Maybe Text) Source #
The description of the API.
getApiResponse_disableExecuteApiEndpoint :: Lens' GetApiResponse (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
getApiResponse_disableSchemaValidation :: Lens' GetApiResponse (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
getApiResponse_importInfo :: Lens' GetApiResponse (Maybe [Text]) Source #
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_name :: Lens' GetApiResponse (Maybe Text) Source #
The name of the API.
getApiResponse_protocolType :: Lens' GetApiResponse (Maybe ProtocolType) Source #
The API protocol.
getApiResponse_routeSelectionExpression :: Lens' GetApiResponse (Maybe Text) Source #
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_tags :: Lens' GetApiResponse (Maybe (HashMap Text Text)) Source #
A collection of tags associated with the API.
getApiResponse_version :: Lens' GetApiResponse (Maybe Text) Source #
A version identifier for the API.
getApiResponse_warnings :: Lens' GetApiResponse (Maybe [Text]) Source #
The warning messages reported when failonwarnings is turned on during API import.
getApiResponse_httpStatus :: Lens' GetApiResponse Int Source #
The response's http status code.
GetApiMapping
getApiMapping_apiMappingId :: Lens' GetApiMapping Text Source #
The API mapping identifier.
getApiMapping_domainName :: Lens' GetApiMapping Text Source #
The domain name.
getApiMappingResponse_apiId :: Lens' GetApiMappingResponse (Maybe Text) Source #
The API identifier.
getApiMappingResponse_apiMappingId :: Lens' GetApiMappingResponse (Maybe Text) Source #
The API mapping identifier.
getApiMappingResponse_apiMappingKey :: Lens' GetApiMappingResponse (Maybe Text) Source #
The API mapping key.
getApiMappingResponse_stage :: Lens' GetApiMappingResponse (Maybe Text) Source #
The API stage.
getApiMappingResponse_httpStatus :: Lens' GetApiMappingResponse Int Source #
The response's http status code.
GetApiMappings
getApiMappings_maxResults :: Lens' GetApiMappings (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getApiMappings_nextToken :: Lens' GetApiMappings (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getApiMappings_domainName :: Lens' GetApiMappings Text Source #
The domain name.
getApiMappingsResponse_items :: Lens' GetApiMappingsResponse (Maybe [ApiMapping]) Source #
The elements from this collection.
getApiMappingsResponse_nextToken :: Lens' GetApiMappingsResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getApiMappingsResponse_httpStatus :: Lens' GetApiMappingsResponse Int Source #
The response's http status code.
GetApis
getApis_maxResults :: Lens' GetApis (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getApis_nextToken :: Lens' GetApis (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getApisResponse_items :: Lens' GetApisResponse (Maybe [Api]) Source #
The elements from this collection.
getApisResponse_nextToken :: Lens' GetApisResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getApisResponse_httpStatus :: Lens' GetApisResponse Int Source #
The response's http status code.
GetAuthorizer
getAuthorizer_authorizerId :: Lens' GetAuthorizer Text Source #
The authorizer identifier.
getAuthorizer_apiId :: Lens' GetAuthorizer Text Source #
The API identifier.
getAuthorizerResponse_authorizerCredentialsArn :: Lens' GetAuthorizerResponse (Maybe Text) Source #
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
getAuthorizerResponse_authorizerId :: Lens' GetAuthorizerResponse (Maybe Text) Source #
The authorizer identifier.
getAuthorizerResponse_authorizerPayloadFormatVersion :: Lens' GetAuthorizerResponse (Maybe Text) Source #
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_authorizerResultTtlInSeconds :: Lens' GetAuthorizerResponse (Maybe Natural) Source #
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_authorizerType :: Lens' GetAuthorizerResponse (Maybe 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).
getAuthorizerResponse_authorizerUri :: Lens' GetAuthorizerResponse (Maybe Text) Source #
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_enableSimpleResponses :: Lens' GetAuthorizerResponse (Maybe Bool) Source #
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_identitySource :: Lens' GetAuthorizerResponse (Maybe [Text]) Source #
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_identityValidationExpression :: Lens' GetAuthorizerResponse (Maybe Text) Source #
The validation expression does not apply to the REQUEST authorizer.
getAuthorizerResponse_jwtConfiguration :: Lens' GetAuthorizerResponse (Maybe JWTConfiguration) Source #
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
getAuthorizerResponse_name :: Lens' GetAuthorizerResponse (Maybe Text) Source #
The name of the authorizer.
getAuthorizerResponse_httpStatus :: Lens' GetAuthorizerResponse Int Source #
The response's http status code.
GetAuthorizers
getAuthorizers_maxResults :: Lens' GetAuthorizers (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getAuthorizers_nextToken :: Lens' GetAuthorizers (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getAuthorizers_apiId :: Lens' GetAuthorizers Text Source #
The API identifier.
getAuthorizersResponse_items :: Lens' GetAuthorizersResponse (Maybe [Authorizer]) Source #
The elements from this collection.
getAuthorizersResponse_nextToken :: Lens' GetAuthorizersResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getAuthorizersResponse_httpStatus :: Lens' GetAuthorizersResponse Int Source #
The response's http status code.
GetDeployment
getDeployment_apiId :: Lens' GetDeployment Text Source #
The API identifier.
getDeployment_deploymentId :: Lens' GetDeployment Text Source #
The deployment ID.
getDeploymentResponse_autoDeployed :: Lens' GetDeploymentResponse (Maybe Bool) Source #
Specifies whether a deployment was automatically released.
getDeploymentResponse_createdDate :: Lens' GetDeploymentResponse (Maybe UTCTime) Source #
The date and time when the Deployment resource was created.
getDeploymentResponse_deploymentId :: Lens' GetDeploymentResponse (Maybe Text) Source #
The identifier for the deployment.
getDeploymentResponse_deploymentStatus :: Lens' GetDeploymentResponse (Maybe DeploymentStatus) Source #
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
getDeploymentResponse_deploymentStatusMessage :: Lens' GetDeploymentResponse (Maybe Text) Source #
May contain additional feedback on the status of an API deployment.
getDeploymentResponse_description :: Lens' GetDeploymentResponse (Maybe Text) Source #
The description for the deployment.
getDeploymentResponse_httpStatus :: Lens' GetDeploymentResponse Int Source #
The response's http status code.
GetDeployments
getDeployments_maxResults :: Lens' GetDeployments (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getDeployments_nextToken :: Lens' GetDeployments (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getDeployments_apiId :: Lens' GetDeployments Text Source #
The API identifier.
getDeploymentsResponse_items :: Lens' GetDeploymentsResponse (Maybe [Deployment]) Source #
The elements from this collection.
getDeploymentsResponse_nextToken :: Lens' GetDeploymentsResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getDeploymentsResponse_httpStatus :: Lens' GetDeploymentsResponse Int Source #
The response's http status code.
GetDomainName
getDomainName_domainName :: Lens' GetDomainName Text Source #
The domain name.
getDomainNameResponse_apiMappingSelectionExpression :: Lens' GetDomainNameResponse (Maybe Text) Source #
The API mapping selection expression.
getDomainNameResponse_domainName :: Lens' GetDomainNameResponse (Maybe Text) Source #
The name of the DomainName resource.
getDomainNameResponse_domainNameConfigurations :: Lens' GetDomainNameResponse (Maybe [DomainNameConfiguration]) Source #
The domain name configurations.
getDomainNameResponse_mutualTlsAuthentication :: Lens' GetDomainNameResponse (Maybe MutualTlsAuthentication) Source #
The mutual TLS authentication configuration for a custom domain name.
getDomainNameResponse_tags :: Lens' GetDomainNameResponse (Maybe (HashMap Text Text)) Source #
The collection of tags associated with a domain name.
getDomainNameResponse_httpStatus :: Lens' GetDomainNameResponse Int Source #
The response's http status code.
GetDomainNames
getDomainNames_maxResults :: Lens' GetDomainNames (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getDomainNames_nextToken :: Lens' GetDomainNames (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getDomainNamesResponse_items :: Lens' GetDomainNamesResponse (Maybe [DomainName]) Source #
The elements from this collection.
getDomainNamesResponse_nextToken :: Lens' GetDomainNamesResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getDomainNamesResponse_httpStatus :: Lens' GetDomainNamesResponse Int Source #
The response's http status code.
GetIntegration
getIntegration_apiId :: Lens' GetIntegration Text Source #
The API identifier.
getIntegration_integrationId :: Lens' GetIntegration Text Source #
The integration ID.
getIntegrationResponse'_apiGatewayManaged :: Lens' GetIntegrationResponse' (Maybe Bool) Source #
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'_connectionId :: Lens' GetIntegrationResponse' (Maybe Text) Source #
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
getIntegrationResponse'_connectionType :: Lens' GetIntegrationResponse' (Maybe ConnectionType) Source #
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'_contentHandlingStrategy :: Lens' GetIntegrationResponse' (Maybe ContentHandlingStrategy) Source #
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'_credentialsArn :: Lens' GetIntegrationResponse' (Maybe Text) Source #
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
getIntegrationResponse'_description :: Lens' GetIntegrationResponse' (Maybe Text) Source #
Represents the description of an integration.
getIntegrationResponse'_integrationId :: Lens' GetIntegrationResponse' (Maybe Text) Source #
Represents the identifier of an integration.
getIntegrationResponse'_integrationMethod :: Lens' GetIntegrationResponse' (Maybe Text) Source #
Specifies the integration's HTTP method type.
getIntegrationResponse'_integrationResponseSelectionExpression :: Lens' GetIntegrationResponse' (Maybe Text) Source #
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
getIntegrationResponse'_integrationSubtype :: Lens' GetIntegrationResponse' (Maybe Text) Source #
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
getIntegrationResponse'_integrationType :: Lens' GetIntegrationResponse' (Maybe IntegrationType) Source #
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'_integrationUri :: Lens' GetIntegrationResponse' (Maybe Text) Source #
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'_passthroughBehavior :: Lens' GetIntegrationResponse' (Maybe PassthroughBehavior) Source #
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'_payloadFormatVersion :: Lens' GetIntegrationResponse' (Maybe Text) Source #
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
getIntegrationResponse'_requestParameters :: Lens' GetIntegrationResponse' (Maybe (HashMap Text Text)) Source #
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'_requestTemplates :: Lens' GetIntegrationResponse' (Maybe (HashMap Text Text)) Source #
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
getIntegrationResponse'_responseParameters :: Lens' GetIntegrationResponse' (Maybe (HashMap Text (HashMap Text Text))) Source #
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'_templateSelectionExpression :: Lens' GetIntegrationResponse' (Maybe Text) Source #
The template selection expression for the integration. Supported only for WebSocket APIs.
getIntegrationResponse'_timeoutInMillis :: Lens' GetIntegrationResponse' (Maybe Natural) Source #
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'_tlsConfig :: Lens' GetIntegrationResponse' (Maybe TlsConfig) 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.
getIntegrationResponse'_httpStatus :: Lens' GetIntegrationResponse' Int Source #
The response's http status code.
GetIntegrationResponse
getIntegrationResponse_apiId :: Lens' GetIntegrationResponse Text Source #
The API identifier.
getIntegrationResponse_integrationResponseId :: Lens' GetIntegrationResponse Text Source #
The integration response ID.
getIntegrationResponse_integrationId :: Lens' GetIntegrationResponse Text Source #
The integration ID.
getIntegrationResponseResponse_contentHandlingStrategy :: Lens' GetIntegrationResponseResponse (Maybe ContentHandlingStrategy) Source #
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.
getIntegrationResponseResponse_integrationResponseId :: Lens' GetIntegrationResponseResponse (Maybe Text) Source #
The integration response ID.
getIntegrationResponseResponse_integrationResponseKey :: Lens' GetIntegrationResponseResponse (Maybe Text) Source #
The integration response key.
getIntegrationResponseResponse_responseParameters :: Lens' GetIntegrationResponseResponse (Maybe (HashMap Text Text)) Source #
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_responseTemplates :: Lens' GetIntegrationResponseResponse (Maybe (HashMap Text Text)) Source #
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_templateSelectionExpression :: Lens' GetIntegrationResponseResponse (Maybe Text) Source #
The template selection expressions for the integration response.
getIntegrationResponseResponse_httpStatus :: Lens' GetIntegrationResponseResponse Int Source #
The response's http status code.
GetIntegrationResponses
getIntegrationResponses_maxResults :: Lens' GetIntegrationResponses (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getIntegrationResponses_nextToken :: Lens' GetIntegrationResponses (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getIntegrationResponses_integrationId :: Lens' GetIntegrationResponses Text Source #
The integration ID.
getIntegrationResponses_apiId :: Lens' GetIntegrationResponses Text Source #
The API identifier.
getIntegrationResponsesResponse_items :: Lens' GetIntegrationResponsesResponse (Maybe [IntegrationResponse]) Source #
The elements from this collection.
getIntegrationResponsesResponse_nextToken :: Lens' GetIntegrationResponsesResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getIntegrationResponsesResponse_httpStatus :: Lens' GetIntegrationResponsesResponse Int Source #
The response's http status code.
GetIntegrations
getIntegrations_maxResults :: Lens' GetIntegrations (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getIntegrations_nextToken :: Lens' GetIntegrations (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getIntegrations_apiId :: Lens' GetIntegrations Text Source #
The API identifier.
getIntegrationsResponse_items :: Lens' GetIntegrationsResponse (Maybe [Integration]) Source #
The elements from this collection.
getIntegrationsResponse_nextToken :: Lens' GetIntegrationsResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getIntegrationsResponse_httpStatus :: Lens' GetIntegrationsResponse Int Source #
The response's http status code.
GetModel
getModelResponse_contentType :: Lens' GetModelResponse (Maybe Text) Source #
The content-type for the model, for example, "application/json".
getModelResponse_description :: Lens' GetModelResponse (Maybe Text) Source #
The description of the model.
getModelResponse_modelId :: Lens' GetModelResponse (Maybe Text) Source #
The model identifier.
getModelResponse_name :: Lens' GetModelResponse (Maybe Text) Source #
The name of the model. Must be alphanumeric.
getModelResponse_schema :: Lens' GetModelResponse (Maybe Text) Source #
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
getModelResponse_httpStatus :: Lens' GetModelResponse Int Source #
The response's http status code.
GetModelTemplate
getModelTemplate_modelId :: Lens' GetModelTemplate Text Source #
The model ID.
getModelTemplate_apiId :: Lens' GetModelTemplate Text Source #
The API identifier.
getModelTemplateResponse_value :: Lens' GetModelTemplateResponse (Maybe Text) Source #
The template value.
getModelTemplateResponse_httpStatus :: Lens' GetModelTemplateResponse Int Source #
The response's http status code.
GetModels
getModels_maxResults :: Lens' GetModels (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getModels_nextToken :: Lens' GetModels (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getModelsResponse_items :: Lens' GetModelsResponse (Maybe [Model]) Source #
The elements from this collection.
getModelsResponse_nextToken :: Lens' GetModelsResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getModelsResponse_httpStatus :: Lens' GetModelsResponse Int Source #
The response's http status code.
GetRoute
getRouteResponse'_apiGatewayManaged :: Lens' GetRouteResponse' (Maybe Bool) Source #
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'_apiKeyRequired :: Lens' GetRouteResponse' (Maybe Bool) Source #
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
getRouteResponse'_authorizationScopes :: Lens' GetRouteResponse' (Maybe [Text]) Source #
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'_authorizationType :: Lens' GetRouteResponse' (Maybe AuthorizationType) Source #
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'_authorizerId :: Lens' GetRouteResponse' (Maybe Text) Source #
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'_modelSelectionExpression :: Lens' GetRouteResponse' (Maybe Text) Source #
The model selection expression for the route. Supported only for WebSocket APIs.
getRouteResponse'_operationName :: Lens' GetRouteResponse' (Maybe Text) Source #
The operation name for the route.
getRouteResponse'_requestModels :: Lens' GetRouteResponse' (Maybe (HashMap Text Text)) Source #
The request models for the route. Supported only for WebSocket APIs.
getRouteResponse'_requestParameters :: Lens' GetRouteResponse' (Maybe (HashMap Text ParameterConstraints)) Source #
The request parameters for the route. Supported only for WebSocket APIs.
getRouteResponse'_routeId :: Lens' GetRouteResponse' (Maybe Text) Source #
The route ID.
getRouteResponse'_routeKey :: Lens' GetRouteResponse' (Maybe Text) Source #
The route key for the route.
getRouteResponse'_routeResponseSelectionExpression :: Lens' GetRouteResponse' (Maybe Text) Source #
The route response selection expression for the route. Supported only for WebSocket APIs.
getRouteResponse'_target :: Lens' GetRouteResponse' (Maybe Text) Source #
The target for the route.
getRouteResponse'_httpStatus :: Lens' GetRouteResponse' Int Source #
The response's http status code.
GetRouteResponse
getRouteResponse_routeResponseId :: Lens' GetRouteResponse Text Source #
The route response ID.
getRouteResponse_apiId :: Lens' GetRouteResponse Text Source #
The API identifier.
getRouteResponse_routeId :: Lens' GetRouteResponse Text Source #
The route ID.
getRouteResponseResponse_modelSelectionExpression :: Lens' GetRouteResponseResponse (Maybe Text) Source #
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
getRouteResponseResponse_responseModels :: Lens' GetRouteResponseResponse (Maybe (HashMap Text Text)) Source #
Represents the response models of a route response.
getRouteResponseResponse_responseParameters :: Lens' GetRouteResponseResponse (Maybe (HashMap Text ParameterConstraints)) Source #
Represents the response parameters of a route response.
getRouteResponseResponse_routeResponseId :: Lens' GetRouteResponseResponse (Maybe Text) Source #
Represents the identifier of a route response.
getRouteResponseResponse_routeResponseKey :: Lens' GetRouteResponseResponse (Maybe Text) Source #
Represents the route response key of a route response.
getRouteResponseResponse_httpStatus :: Lens' GetRouteResponseResponse Int Source #
The response's http status code.
GetRouteResponses
getRouteResponses_maxResults :: Lens' GetRouteResponses (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getRouteResponses_nextToken :: Lens' GetRouteResponses (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getRouteResponses_routeId :: Lens' GetRouteResponses Text Source #
The route ID.
getRouteResponses_apiId :: Lens' GetRouteResponses Text Source #
The API identifier.
getRouteResponsesResponse_items :: Lens' GetRouteResponsesResponse (Maybe [RouteResponse]) Source #
The elements from this collection.
getRouteResponsesResponse_nextToken :: Lens' GetRouteResponsesResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getRouteResponsesResponse_httpStatus :: Lens' GetRouteResponsesResponse Int Source #
The response's http status code.
GetRoutes
getRoutes_maxResults :: Lens' GetRoutes (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getRoutes_nextToken :: Lens' GetRoutes (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getRoutesResponse_items :: Lens' GetRoutesResponse (Maybe [Route]) Source #
The elements from this collection.
getRoutesResponse_nextToken :: Lens' GetRoutesResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getRoutesResponse_httpStatus :: Lens' GetRoutesResponse Int Source #
The response's http status code.
GetStage
getStage_stageName :: Lens' GetStage Text Source #
The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
getStageResponse_accessLogSettings :: Lens' GetStageResponse (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
getStageResponse_apiGatewayManaged :: Lens' GetStageResponse (Maybe Bool) Source #
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_autoDeploy :: Lens' GetStageResponse (Maybe Bool) Source #
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
getStageResponse_clientCertificateId :: Lens' GetStageResponse (Maybe Text) Source #
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
getStageResponse_createdDate :: Lens' GetStageResponse (Maybe UTCTime) Source #
The timestamp when the stage was created.
getStageResponse_defaultRouteSettings :: Lens' GetStageResponse (Maybe RouteSettings) Source #
Default route settings for the stage.
getStageResponse_deploymentId :: Lens' GetStageResponse (Maybe Text) Source #
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
getStageResponse_description :: Lens' GetStageResponse (Maybe Text) Source #
The description of the stage.
getStageResponse_lastDeploymentStatusMessage :: Lens' GetStageResponse (Maybe Text) Source #
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
getStageResponse_lastUpdatedDate :: Lens' GetStageResponse (Maybe UTCTime) Source #
The timestamp when the stage was last updated.
getStageResponse_routeSettings :: Lens' GetStageResponse (Maybe (HashMap Text RouteSettings)) Source #
Route settings for the stage, by routeKey.
getStageResponse_stageName :: Lens' GetStageResponse (Maybe Text) Source #
The name of the stage.
getStageResponse_stageVariables :: Lens' GetStageResponse (Maybe (HashMap Text Text)) Source #
A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
getStageResponse_tags :: Lens' GetStageResponse (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
getStageResponse_httpStatus :: Lens' GetStageResponse Int Source #
The response's http status code.
GetStages
getStages_maxResults :: Lens' GetStages (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getStages_nextToken :: Lens' GetStages (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getStagesResponse_items :: Lens' GetStagesResponse (Maybe [Stage]) Source #
The elements from this collection.
getStagesResponse_nextToken :: Lens' GetStagesResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getStagesResponse_httpStatus :: Lens' GetStagesResponse Int Source #
The response's http status code.
GetTags
getTagsResponse_tags :: Lens' GetTagsResponse (Maybe (HashMap Text Text)) Source #
Undocumented member.
getTagsResponse_httpStatus :: Lens' GetTagsResponse Int Source #
The response's http status code.
GetVpcLink
getVpcLink_vpcLinkId :: Lens' GetVpcLink Text Source #
The ID of the VPC link.
getVpcLinkResponse_createdDate :: Lens' GetVpcLinkResponse (Maybe UTCTime) Source #
The timestamp when the VPC link was created.
getVpcLinkResponse_name :: Lens' GetVpcLinkResponse (Maybe Text) Source #
The name of the VPC link.
getVpcLinkResponse_securityGroupIds :: Lens' GetVpcLinkResponse (Maybe [Text]) Source #
A list of security group IDs for the VPC link.
getVpcLinkResponse_subnetIds :: Lens' GetVpcLinkResponse (Maybe [Text]) Source #
A list of subnet IDs to include in the VPC link.
getVpcLinkResponse_tags :: Lens' GetVpcLinkResponse (Maybe (HashMap Text Text)) Source #
Tags for the VPC link.
getVpcLinkResponse_vpcLinkId :: Lens' GetVpcLinkResponse (Maybe Text) Source #
The ID of the VPC link.
getVpcLinkResponse_vpcLinkStatus :: Lens' GetVpcLinkResponse (Maybe VpcLinkStatus) Source #
The status of the VPC link.
getVpcLinkResponse_vpcLinkStatusMessage :: Lens' GetVpcLinkResponse (Maybe Text) Source #
A message summarizing the cause of the status of the VPC link.
getVpcLinkResponse_vpcLinkVersion :: Lens' GetVpcLinkResponse (Maybe VpcLinkVersion) Source #
The version of the VPC link.
getVpcLinkResponse_httpStatus :: Lens' GetVpcLinkResponse Int Source #
The response's http status code.
GetVpcLinks
getVpcLinks_maxResults :: Lens' GetVpcLinks (Maybe Text) Source #
The maximum number of elements to be returned for this resource.
getVpcLinks_nextToken :: Lens' GetVpcLinks (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getVpcLinksResponse_items :: Lens' GetVpcLinksResponse (Maybe [VpcLink]) Source #
A collection of VPC links.
getVpcLinksResponse_nextToken :: Lens' GetVpcLinksResponse (Maybe Text) Source #
The next page of elements from this collection. Not valid for the last element of the collection.
getVpcLinksResponse_httpStatus :: Lens' GetVpcLinksResponse Int Source #
The response's http status code.
ImportApi
importApi_basepath :: Lens' ImportApi (Maybe Text) Source #
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.
importApi_failOnWarnings :: Lens' ImportApi (Maybe Bool) Source #
Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
importApi_body :: Lens' ImportApi Text Source #
The OpenAPI definition. Supported only for HTTP APIs.
importApiResponse_apiEndpoint :: Lens' ImportApiResponse (Maybe Text) Source #
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_apiGatewayManaged :: Lens' ImportApiResponse (Maybe Bool) Source #
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_apiId :: Lens' ImportApiResponse (Maybe Text) Source #
The API ID.
importApiResponse_apiKeySelectionExpression :: Lens' ImportApiResponse (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
importApiResponse_corsConfiguration :: Lens' ImportApiResponse (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs.
importApiResponse_createdDate :: Lens' ImportApiResponse (Maybe UTCTime) Source #
The timestamp when the API was created.
importApiResponse_description :: Lens' ImportApiResponse (Maybe Text) Source #
The description of the API.
importApiResponse_disableExecuteApiEndpoint :: Lens' ImportApiResponse (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
importApiResponse_disableSchemaValidation :: Lens' ImportApiResponse (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
importApiResponse_importInfo :: Lens' ImportApiResponse (Maybe [Text]) Source #
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_name :: Lens' ImportApiResponse (Maybe Text) Source #
The name of the API.
importApiResponse_protocolType :: Lens' ImportApiResponse (Maybe ProtocolType) Source #
The API protocol.
importApiResponse_routeSelectionExpression :: Lens' ImportApiResponse (Maybe Text) Source #
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_tags :: Lens' ImportApiResponse (Maybe (HashMap Text Text)) Source #
A collection of tags associated with the API.
importApiResponse_version :: Lens' ImportApiResponse (Maybe Text) Source #
A version identifier for the API.
importApiResponse_warnings :: Lens' ImportApiResponse (Maybe [Text]) Source #
The warning messages reported when failonwarnings is turned on during API import.
importApiResponse_httpStatus :: Lens' ImportApiResponse Int Source #
The response's http status code.
ReimportApi
reimportApi_basepath :: Lens' ReimportApi (Maybe Text) Source #
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.
reimportApi_failOnWarnings :: Lens' ReimportApi (Maybe Bool) Source #
Specifies whether to rollback the API creation when a warning is encountered. By default, API creation continues if a warning is encountered.
reimportApi_apiId :: Lens' ReimportApi Text Source #
The API identifier.
reimportApi_body :: Lens' ReimportApi Text Source #
The OpenAPI definition. Supported only for HTTP APIs.
reimportApiResponse_apiEndpoint :: Lens' ReimportApiResponse (Maybe Text) Source #
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_apiGatewayManaged :: Lens' ReimportApiResponse (Maybe Bool) Source #
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.
reimportApiResponse_apiId :: Lens' ReimportApiResponse (Maybe Text) Source #
The API ID.
reimportApiResponse_apiKeySelectionExpression :: Lens' ReimportApiResponse (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
reimportApiResponse_corsConfiguration :: Lens' ReimportApiResponse (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs.
reimportApiResponse_createdDate :: Lens' ReimportApiResponse (Maybe UTCTime) Source #
The timestamp when the API was created.
reimportApiResponse_description :: Lens' ReimportApiResponse (Maybe Text) Source #
The description of the API.
reimportApiResponse_disableExecuteApiEndpoint :: Lens' ReimportApiResponse (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
reimportApiResponse_disableSchemaValidation :: Lens' ReimportApiResponse (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
reimportApiResponse_importInfo :: Lens' ReimportApiResponse (Maybe [Text]) Source #
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_name :: Lens' ReimportApiResponse (Maybe Text) Source #
The name of the API.
reimportApiResponse_protocolType :: Lens' ReimportApiResponse (Maybe ProtocolType) Source #
The API protocol.
reimportApiResponse_routeSelectionExpression :: Lens' ReimportApiResponse (Maybe Text) Source #
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_tags :: Lens' ReimportApiResponse (Maybe (HashMap Text Text)) Source #
A collection of tags associated with the API.
reimportApiResponse_version :: Lens' ReimportApiResponse (Maybe Text) Source #
A version identifier for the API.
reimportApiResponse_warnings :: Lens' ReimportApiResponse (Maybe [Text]) Source #
The warning messages reported when failonwarnings is turned on during API import.
reimportApiResponse_httpStatus :: Lens' ReimportApiResponse Int Source #
The response's http status code.
ResetAuthorizersCache
resetAuthorizersCache_stageName :: Lens' ResetAuthorizersCache Text Source #
The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
resetAuthorizersCache_apiId :: Lens' ResetAuthorizersCache Text Source #
The API identifier.
TagResource
tagResource_tags :: Lens' TagResource (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
tagResource_resourceArn :: Lens' TagResource Text Source #
The resource ARN for the tag.
tagResourceResponse_httpStatus :: Lens' TagResourceResponse Int Source #
The response's http status code.
UntagResource
untagResource_resourceArn :: Lens' UntagResource Text Source #
The resource ARN for the tag.
untagResource_tagKeys :: Lens' UntagResource [Text] Source #
The Tag keys to delete
UpdateApi
updateApi_apiKeySelectionExpression :: Lens' UpdateApi (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
updateApi_corsConfiguration :: Lens' UpdateApi (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs.
updateApi_credentialsArn :: Lens' UpdateApi (Maybe Text) Source #
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_disableExecuteApiEndpoint :: Lens' UpdateApi (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
updateApi_disableSchemaValidation :: Lens' UpdateApi (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
updateApi_routeKey :: Lens' UpdateApi (Maybe Text) Source #
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_routeSelectionExpression :: Lens' UpdateApi (Maybe Text) Source #
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_target :: Lens' UpdateApi (Maybe Text) Source #
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.
updateApiResponse_apiEndpoint :: Lens' UpdateApiResponse (Maybe Text) Source #
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_apiGatewayManaged :: Lens' UpdateApiResponse (Maybe Bool) Source #
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.
updateApiResponse_apiId :: Lens' UpdateApiResponse (Maybe Text) Source #
The API ID.
updateApiResponse_apiKeySelectionExpression :: Lens' UpdateApiResponse (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
updateApiResponse_corsConfiguration :: Lens' UpdateApiResponse (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs.
updateApiResponse_createdDate :: Lens' UpdateApiResponse (Maybe UTCTime) Source #
The timestamp when the API was created.
updateApiResponse_description :: Lens' UpdateApiResponse (Maybe Text) Source #
The description of the API.
updateApiResponse_disableExecuteApiEndpoint :: Lens' UpdateApiResponse (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
updateApiResponse_disableSchemaValidation :: Lens' UpdateApiResponse (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
updateApiResponse_importInfo :: Lens' UpdateApiResponse (Maybe [Text]) Source #
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.
updateApiResponse_name :: Lens' UpdateApiResponse (Maybe Text) Source #
The name of the API.
updateApiResponse_protocolType :: Lens' UpdateApiResponse (Maybe ProtocolType) Source #
The API protocol.
updateApiResponse_routeSelectionExpression :: Lens' UpdateApiResponse (Maybe Text) Source #
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_tags :: Lens' UpdateApiResponse (Maybe (HashMap Text Text)) Source #
A collection of tags associated with the API.
updateApiResponse_version :: Lens' UpdateApiResponse (Maybe Text) Source #
A version identifier for the API.
updateApiResponse_warnings :: Lens' UpdateApiResponse (Maybe [Text]) Source #
The warning messages reported when failonwarnings is turned on during API import.
updateApiResponse_httpStatus :: Lens' UpdateApiResponse Int Source #
The response's http status code.
UpdateApiMapping
updateApiMapping_apiMappingKey :: Lens' UpdateApiMapping (Maybe Text) Source #
The API mapping key.
updateApiMapping_stage :: Lens' UpdateApiMapping (Maybe Text) Source #
The API stage.
updateApiMapping_apiMappingId :: Lens' UpdateApiMapping Text Source #
The API mapping identifier.
updateApiMapping_apiId :: Lens' UpdateApiMapping Text Source #
The API identifier.
updateApiMapping_domainName :: Lens' UpdateApiMapping Text Source #
The domain name.
updateApiMappingResponse_apiId :: Lens' UpdateApiMappingResponse (Maybe Text) Source #
The API identifier.
updateApiMappingResponse_apiMappingId :: Lens' UpdateApiMappingResponse (Maybe Text) Source #
The API mapping identifier.
updateApiMappingResponse_apiMappingKey :: Lens' UpdateApiMappingResponse (Maybe Text) Source #
The API mapping key.
updateApiMappingResponse_stage :: Lens' UpdateApiMappingResponse (Maybe Text) Source #
The API stage.
updateApiMappingResponse_httpStatus :: Lens' UpdateApiMappingResponse Int Source #
The response's http status code.
UpdateAuthorizer
updateAuthorizer_authorizerCredentialsArn :: Lens' UpdateAuthorizer (Maybe Text) Source #
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter.
updateAuthorizer_authorizerPayloadFormatVersion :: Lens' UpdateAuthorizer (Maybe Text) Source #
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_authorizerResultTtlInSeconds :: Lens' UpdateAuthorizer (Maybe Natural) Source #
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_authorizerType :: Lens' UpdateAuthorizer (Maybe 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).
updateAuthorizer_authorizerUri :: Lens' UpdateAuthorizer (Maybe Text) Source #
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_enableSimpleResponses :: Lens' UpdateAuthorizer (Maybe Bool) Source #
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_identitySource :: Lens' UpdateAuthorizer (Maybe [Text]) Source #
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_identityValidationExpression :: Lens' UpdateAuthorizer (Maybe Text) Source #
This parameter is not used.
updateAuthorizer_jwtConfiguration :: Lens' UpdateAuthorizer (Maybe JWTConfiguration) Source #
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
updateAuthorizer_name :: Lens' UpdateAuthorizer (Maybe Text) Source #
The name of the authorizer.
updateAuthorizer_authorizerId :: Lens' UpdateAuthorizer Text Source #
The authorizer identifier.
updateAuthorizer_apiId :: Lens' UpdateAuthorizer Text Source #
The API identifier.
updateAuthorizerResponse_authorizerCredentialsArn :: Lens' UpdateAuthorizerResponse (Maybe Text) Source #
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
updateAuthorizerResponse_authorizerId :: Lens' UpdateAuthorizerResponse (Maybe Text) Source #
The authorizer identifier.
updateAuthorizerResponse_authorizerPayloadFormatVersion :: Lens' UpdateAuthorizerResponse (Maybe Text) Source #
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.
updateAuthorizerResponse_authorizerResultTtlInSeconds :: Lens' UpdateAuthorizerResponse (Maybe Natural) Source #
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.
updateAuthorizerResponse_authorizerType :: Lens' UpdateAuthorizerResponse (Maybe 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).
updateAuthorizerResponse_authorizerUri :: Lens' UpdateAuthorizerResponse (Maybe Text) Source #
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.
updateAuthorizerResponse_enableSimpleResponses :: Lens' UpdateAuthorizerResponse (Maybe Bool) Source #
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
updateAuthorizerResponse_identitySource :: Lens' UpdateAuthorizerResponse (Maybe [Text]) Source #
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.
updateAuthorizerResponse_identityValidationExpression :: Lens' UpdateAuthorizerResponse (Maybe Text) Source #
The validation expression does not apply to the REQUEST authorizer.
updateAuthorizerResponse_jwtConfiguration :: Lens' UpdateAuthorizerResponse (Maybe JWTConfiguration) Source #
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
updateAuthorizerResponse_name :: Lens' UpdateAuthorizerResponse (Maybe Text) Source #
The name of the authorizer.
updateAuthorizerResponse_httpStatus :: Lens' UpdateAuthorizerResponse Int Source #
The response's http status code.
UpdateDeployment
updateDeployment_description :: Lens' UpdateDeployment (Maybe Text) Source #
The description for the deployment resource.
updateDeployment_apiId :: Lens' UpdateDeployment Text Source #
The API identifier.
updateDeployment_deploymentId :: Lens' UpdateDeployment Text Source #
The deployment ID.
updateDeploymentResponse_autoDeployed :: Lens' UpdateDeploymentResponse (Maybe Bool) Source #
Specifies whether a deployment was automatically released.
updateDeploymentResponse_createdDate :: Lens' UpdateDeploymentResponse (Maybe UTCTime) Source #
The date and time when the Deployment resource was created.
updateDeploymentResponse_deploymentId :: Lens' UpdateDeploymentResponse (Maybe Text) Source #
The identifier for the deployment.
updateDeploymentResponse_deploymentStatus :: Lens' UpdateDeploymentResponse (Maybe DeploymentStatus) Source #
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
updateDeploymentResponse_deploymentStatusMessage :: Lens' UpdateDeploymentResponse (Maybe Text) Source #
May contain additional feedback on the status of an API deployment.
updateDeploymentResponse_description :: Lens' UpdateDeploymentResponse (Maybe Text) Source #
The description for the deployment.
updateDeploymentResponse_httpStatus :: Lens' UpdateDeploymentResponse Int Source #
The response's http status code.
UpdateDomainName
updateDomainName_domainNameConfigurations :: Lens' UpdateDomainName (Maybe [DomainNameConfiguration]) Source #
The domain name configurations.
updateDomainName_mutualTlsAuthentication :: Lens' UpdateDomainName (Maybe MutualTlsAuthenticationInput) Source #
The mutual TLS authentication configuration for a custom domain name.
updateDomainName_domainName :: Lens' UpdateDomainName Text Source #
The domain name.
updateDomainNameResponse_apiMappingSelectionExpression :: Lens' UpdateDomainNameResponse (Maybe Text) Source #
The API mapping selection expression.
updateDomainNameResponse_domainName :: Lens' UpdateDomainNameResponse (Maybe Text) Source #
The name of the DomainName resource.
updateDomainNameResponse_domainNameConfigurations :: Lens' UpdateDomainNameResponse (Maybe [DomainNameConfiguration]) Source #
The domain name configurations.
updateDomainNameResponse_mutualTlsAuthentication :: Lens' UpdateDomainNameResponse (Maybe MutualTlsAuthentication) Source #
The mutual TLS authentication configuration for a custom domain name.
updateDomainNameResponse_tags :: Lens' UpdateDomainNameResponse (Maybe (HashMap Text Text)) Source #
The collection of tags associated with a domain name.
updateDomainNameResponse_httpStatus :: Lens' UpdateDomainNameResponse Int Source #
The response's http status code.
UpdateIntegration
updateIntegration_connectionId :: Lens' UpdateIntegration (Maybe Text) Source #
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
updateIntegration_connectionType :: Lens' UpdateIntegration (Maybe ConnectionType) Source #
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_contentHandlingStrategy :: Lens' UpdateIntegration (Maybe ContentHandlingStrategy) Source #
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_credentialsArn :: Lens' UpdateIntegration (Maybe Text) Source #
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
updateIntegration_description :: Lens' UpdateIntegration (Maybe Text) Source #
The description of the integration
updateIntegration_integrationMethod :: Lens' UpdateIntegration (Maybe Text) Source #
Specifies the integration's HTTP method type.
updateIntegration_integrationSubtype :: Lens' UpdateIntegration (Maybe Text) Source #
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
updateIntegration_integrationType :: Lens' UpdateIntegration (Maybe IntegrationType) Source #
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_integrationUri :: Lens' UpdateIntegration (Maybe Text) Source #
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_passthroughBehavior :: Lens' UpdateIntegration (Maybe PassthroughBehavior) Source #
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_payloadFormatVersion :: Lens' UpdateIntegration (Maybe Text) Source #
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
updateIntegration_requestParameters :: Lens' UpdateIntegration (Maybe (HashMap Text Text)) Source #
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_requestTemplates :: Lens' UpdateIntegration (Maybe (HashMap Text Text)) Source #
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
updateIntegration_responseParameters :: Lens' UpdateIntegration (Maybe (HashMap Text (HashMap Text Text))) Source #
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_templateSelectionExpression :: Lens' UpdateIntegration (Maybe Text) Source #
The template selection expression for the integration.
updateIntegration_timeoutInMillis :: Lens' UpdateIntegration (Maybe Natural) Source #
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_tlsConfig :: Lens' UpdateIntegration (Maybe 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.
updateIntegration_apiId :: Lens' UpdateIntegration Text Source #
The API identifier.
updateIntegration_integrationId :: Lens' UpdateIntegration Text Source #
The integration ID.
updateIntegrationResponse'_apiGatewayManaged :: Lens' UpdateIntegrationResponse' (Maybe Bool) Source #
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.
updateIntegrationResponse'_connectionId :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
updateIntegrationResponse'_connectionType :: Lens' UpdateIntegrationResponse' (Maybe ConnectionType) Source #
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.
updateIntegrationResponse'_contentHandlingStrategy :: Lens' UpdateIntegrationResponse' (Maybe ContentHandlingStrategy) Source #
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'_credentialsArn :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
updateIntegrationResponse'_description :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
Represents the description of an integration.
updateIntegrationResponse'_integrationId :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
Represents the identifier of an integration.
updateIntegrationResponse'_integrationMethod :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
Specifies the integration's HTTP method type.
updateIntegrationResponse'_integrationResponseSelectionExpression :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
updateIntegrationResponse'_integrationSubtype :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
updateIntegrationResponse'_integrationType :: Lens' UpdateIntegrationResponse' (Maybe IntegrationType) Source #
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.
updateIntegrationResponse'_integrationUri :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
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.
updateIntegrationResponse'_passthroughBehavior :: Lens' UpdateIntegrationResponse' (Maybe PassthroughBehavior) Source #
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.
updateIntegrationResponse'_payloadFormatVersion :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
updateIntegrationResponse'_requestParameters :: Lens' UpdateIntegrationResponse' (Maybe (HashMap Text Text)) Source #
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.
updateIntegrationResponse'_requestTemplates :: Lens' UpdateIntegrationResponse' (Maybe (HashMap Text Text)) Source #
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
updateIntegrationResponse'_responseParameters :: Lens' UpdateIntegrationResponse' (Maybe (HashMap Text (HashMap Text Text))) Source #
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.
updateIntegrationResponse'_templateSelectionExpression :: Lens' UpdateIntegrationResponse' (Maybe Text) Source #
The template selection expression for the integration. Supported only for WebSocket APIs.
updateIntegrationResponse'_timeoutInMillis :: Lens' UpdateIntegrationResponse' (Maybe Natural) Source #
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.
updateIntegrationResponse'_tlsConfig :: Lens' UpdateIntegrationResponse' (Maybe TlsConfig) 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.
updateIntegrationResponse'_httpStatus :: Lens' UpdateIntegrationResponse' Int Source #
The response's http status code.
UpdateIntegrationResponse
updateIntegrationResponse_contentHandlingStrategy :: Lens' UpdateIntegrationResponse (Maybe ContentHandlingStrategy) Source #
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_integrationResponseKey :: Lens' UpdateIntegrationResponse (Maybe Text) Source #
The integration response key.
updateIntegrationResponse_responseParameters :: Lens' UpdateIntegrationResponse (Maybe (HashMap Text Text)) Source #
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_responseTemplates :: Lens' UpdateIntegrationResponse (Maybe (HashMap Text Text)) Source #
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_templateSelectionExpression :: Lens' UpdateIntegrationResponse (Maybe Text) Source #
The template selection expression for the integration response. Supported only for WebSocket APIs.
updateIntegrationResponse_apiId :: Lens' UpdateIntegrationResponse Text Source #
The API identifier.
updateIntegrationResponse_integrationResponseId :: Lens' UpdateIntegrationResponse Text Source #
The integration response ID.
updateIntegrationResponse_integrationId :: Lens' UpdateIntegrationResponse Text Source #
The integration ID.
updateIntegrationResponseResponse_contentHandlingStrategy :: Lens' UpdateIntegrationResponseResponse (Maybe ContentHandlingStrategy) Source #
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.
updateIntegrationResponseResponse_integrationResponseId :: Lens' UpdateIntegrationResponseResponse (Maybe Text) Source #
The integration response ID.
updateIntegrationResponseResponse_integrationResponseKey :: Lens' UpdateIntegrationResponseResponse (Maybe Text) Source #
The integration response key.
updateIntegrationResponseResponse_responseParameters :: Lens' UpdateIntegrationResponseResponse (Maybe (HashMap Text Text)) Source #
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.
updateIntegrationResponseResponse_responseTemplates :: Lens' UpdateIntegrationResponseResponse (Maybe (HashMap Text Text)) Source #
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.
updateIntegrationResponseResponse_templateSelectionExpression :: Lens' UpdateIntegrationResponseResponse (Maybe Text) Source #
The template selection expressions for the integration response.
updateIntegrationResponseResponse_httpStatus :: Lens' UpdateIntegrationResponseResponse Int Source #
The response's http status code.
UpdateModel
updateModel_contentType :: Lens' UpdateModel (Maybe Text) Source #
The content-type for the model, for example, "application/json".
updateModel_description :: Lens' UpdateModel (Maybe Text) Source #
The description of the model.
updateModel_name :: Lens' UpdateModel (Maybe Text) Source #
The name of the model.
updateModel_schema :: Lens' UpdateModel (Maybe Text) Source #
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
updateModel_modelId :: Lens' UpdateModel Text Source #
The model ID.
updateModel_apiId :: Lens' UpdateModel Text Source #
The API identifier.
updateModelResponse_contentType :: Lens' UpdateModelResponse (Maybe Text) Source #
The content-type for the model, for example, "application/json".
updateModelResponse_description :: Lens' UpdateModelResponse (Maybe Text) Source #
The description of the model.
updateModelResponse_modelId :: Lens' UpdateModelResponse (Maybe Text) Source #
The model identifier.
updateModelResponse_name :: Lens' UpdateModelResponse (Maybe Text) Source #
The name of the model. Must be alphanumeric.
updateModelResponse_schema :: Lens' UpdateModelResponse (Maybe Text) Source #
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
updateModelResponse_httpStatus :: Lens' UpdateModelResponse Int Source #
The response's http status code.
UpdateRoute
updateRoute_apiKeyRequired :: Lens' UpdateRoute (Maybe Bool) Source #
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
updateRoute_authorizationScopes :: Lens' UpdateRoute (Maybe [Text]) Source #
The authorization scopes supported by this route.
updateRoute_authorizationType :: Lens' UpdateRoute (Maybe AuthorizationType) Source #
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_authorizerId :: Lens' UpdateRoute (Maybe Text) Source #
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_modelSelectionExpression :: Lens' UpdateRoute (Maybe Text) Source #
The model selection expression for the route. Supported only for WebSocket APIs.
updateRoute_operationName :: Lens' UpdateRoute (Maybe Text) Source #
The operation name for the route.
updateRoute_requestModels :: Lens' UpdateRoute (Maybe (HashMap Text Text)) Source #
The request models for the route. Supported only for WebSocket APIs.
updateRoute_requestParameters :: Lens' UpdateRoute (Maybe (HashMap Text ParameterConstraints)) Source #
The request parameters for the route. Supported only for WebSocket APIs.
updateRoute_routeKey :: Lens' UpdateRoute (Maybe Text) Source #
The route key for the route.
updateRoute_routeResponseSelectionExpression :: Lens' UpdateRoute (Maybe Text) Source #
The route response selection expression for the route. Supported only for WebSocket APIs.
updateRoute_target :: Lens' UpdateRoute (Maybe Text) Source #
The target for the route.
updateRoute_apiId :: Lens' UpdateRoute Text Source #
The API identifier.
updateRoute_routeId :: Lens' UpdateRoute Text Source #
The route ID.
updateRouteResponse'_apiGatewayManaged :: Lens' UpdateRouteResponse' (Maybe Bool) Source #
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.
updateRouteResponse'_apiKeyRequired :: Lens' UpdateRouteResponse' (Maybe Bool) Source #
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
updateRouteResponse'_authorizationScopes :: Lens' UpdateRouteResponse' (Maybe [Text]) Source #
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.
updateRouteResponse'_authorizationType :: Lens' UpdateRouteResponse' (Maybe AuthorizationType) Source #
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.
updateRouteResponse'_authorizerId :: Lens' UpdateRouteResponse' (Maybe Text) Source #
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.
updateRouteResponse'_modelSelectionExpression :: Lens' UpdateRouteResponse' (Maybe Text) Source #
The model selection expression for the route. Supported only for WebSocket APIs.
updateRouteResponse'_operationName :: Lens' UpdateRouteResponse' (Maybe Text) Source #
The operation name for the route.
updateRouteResponse'_requestModels :: Lens' UpdateRouteResponse' (Maybe (HashMap Text Text)) Source #
The request models for the route. Supported only for WebSocket APIs.
updateRouteResponse'_requestParameters :: Lens' UpdateRouteResponse' (Maybe (HashMap Text ParameterConstraints)) Source #
The request parameters for the route. Supported only for WebSocket APIs.
updateRouteResponse'_routeId :: Lens' UpdateRouteResponse' (Maybe Text) Source #
The route ID.
updateRouteResponse'_routeKey :: Lens' UpdateRouteResponse' (Maybe Text) Source #
The route key for the route.
updateRouteResponse'_routeResponseSelectionExpression :: Lens' UpdateRouteResponse' (Maybe Text) Source #
The route response selection expression for the route. Supported only for WebSocket APIs.
updateRouteResponse'_target :: Lens' UpdateRouteResponse' (Maybe Text) Source #
The target for the route.
updateRouteResponse'_httpStatus :: Lens' UpdateRouteResponse' Int Source #
The response's http status code.
UpdateRouteResponse
updateRouteResponse_modelSelectionExpression :: Lens' UpdateRouteResponse (Maybe Text) Source #
The model selection expression for the route response. Supported only for WebSocket APIs.
updateRouteResponse_responseModels :: Lens' UpdateRouteResponse (Maybe (HashMap Text Text)) Source #
The response models for the route response.
updateRouteResponse_responseParameters :: Lens' UpdateRouteResponse (Maybe (HashMap Text ParameterConstraints)) Source #
The route response parameters.
updateRouteResponse_routeResponseKey :: Lens' UpdateRouteResponse (Maybe Text) Source #
The route response key.
updateRouteResponse_routeResponseId :: Lens' UpdateRouteResponse Text Source #
The route response ID.
updateRouteResponse_apiId :: Lens' UpdateRouteResponse Text Source #
The API identifier.
updateRouteResponse_routeId :: Lens' UpdateRouteResponse Text Source #
The route ID.
updateRouteResponseResponse_modelSelectionExpression :: Lens' UpdateRouteResponseResponse (Maybe Text) Source #
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
updateRouteResponseResponse_responseModels :: Lens' UpdateRouteResponseResponse (Maybe (HashMap Text Text)) Source #
Represents the response models of a route response.
updateRouteResponseResponse_responseParameters :: Lens' UpdateRouteResponseResponse (Maybe (HashMap Text ParameterConstraints)) Source #
Represents the response parameters of a route response.
updateRouteResponseResponse_routeResponseId :: Lens' UpdateRouteResponseResponse (Maybe Text) Source #
Represents the identifier of a route response.
updateRouteResponseResponse_routeResponseKey :: Lens' UpdateRouteResponseResponse (Maybe Text) Source #
Represents the route response key of a route response.
updateRouteResponseResponse_httpStatus :: Lens' UpdateRouteResponseResponse Int Source #
The response's http status code.
UpdateStage
updateStage_accessLogSettings :: Lens' UpdateStage (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
updateStage_autoDeploy :: Lens' UpdateStage (Maybe Bool) Source #
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
updateStage_clientCertificateId :: Lens' UpdateStage (Maybe Text) Source #
The identifier of a client certificate for a Stage.
updateStage_defaultRouteSettings :: Lens' UpdateStage (Maybe RouteSettings) Source #
The default route settings for the stage.
updateStage_deploymentId :: Lens' UpdateStage (Maybe Text) Source #
The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
updateStage_description :: Lens' UpdateStage (Maybe Text) Source #
The description for the API stage.
updateStage_routeSettings :: Lens' UpdateStage (Maybe (HashMap Text RouteSettings)) Source #
Route settings for the stage.
updateStage_stageVariables :: Lens' UpdateStage (Maybe (HashMap Text Text)) Source #
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_stageName :: Lens' UpdateStage Text Source #
The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
updateStage_apiId :: Lens' UpdateStage Text Source #
The API identifier.
updateStageResponse_accessLogSettings :: Lens' UpdateStageResponse (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
updateStageResponse_apiGatewayManaged :: Lens' UpdateStageResponse (Maybe Bool) Source #
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.
updateStageResponse_autoDeploy :: Lens' UpdateStageResponse (Maybe Bool) Source #
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
updateStageResponse_clientCertificateId :: Lens' UpdateStageResponse (Maybe Text) Source #
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
updateStageResponse_createdDate :: Lens' UpdateStageResponse (Maybe UTCTime) Source #
The timestamp when the stage was created.
updateStageResponse_defaultRouteSettings :: Lens' UpdateStageResponse (Maybe RouteSettings) Source #
Default route settings for the stage.
updateStageResponse_deploymentId :: Lens' UpdateStageResponse (Maybe Text) Source #
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
updateStageResponse_description :: Lens' UpdateStageResponse (Maybe Text) Source #
The description of the stage.
updateStageResponse_lastDeploymentStatusMessage :: Lens' UpdateStageResponse (Maybe Text) Source #
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
updateStageResponse_lastUpdatedDate :: Lens' UpdateStageResponse (Maybe UTCTime) Source #
The timestamp when the stage was last updated.
updateStageResponse_routeSettings :: Lens' UpdateStageResponse (Maybe (HashMap Text RouteSettings)) Source #
Route settings for the stage, by routeKey.
updateStageResponse_stageName :: Lens' UpdateStageResponse (Maybe Text) Source #
The name of the stage.
updateStageResponse_stageVariables :: Lens' UpdateStageResponse (Maybe (HashMap Text Text)) Source #
A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
updateStageResponse_tags :: Lens' UpdateStageResponse (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
updateStageResponse_httpStatus :: Lens' UpdateStageResponse Int Source #
The response's http status code.
UpdateVpcLink
updateVpcLink_name :: Lens' UpdateVpcLink (Maybe Text) Source #
The name of the VPC link.
updateVpcLink_vpcLinkId :: Lens' UpdateVpcLink Text Source #
The ID of the VPC link.
updateVpcLinkResponse_createdDate :: Lens' UpdateVpcLinkResponse (Maybe UTCTime) Source #
The timestamp when the VPC link was created.
updateVpcLinkResponse_name :: Lens' UpdateVpcLinkResponse (Maybe Text) Source #
The name of the VPC link.
updateVpcLinkResponse_securityGroupIds :: Lens' UpdateVpcLinkResponse (Maybe [Text]) Source #
A list of security group IDs for the VPC link.
updateVpcLinkResponse_subnetIds :: Lens' UpdateVpcLinkResponse (Maybe [Text]) Source #
A list of subnet IDs to include in the VPC link.
updateVpcLinkResponse_tags :: Lens' UpdateVpcLinkResponse (Maybe (HashMap Text Text)) Source #
Tags for the VPC link.
updateVpcLinkResponse_vpcLinkId :: Lens' UpdateVpcLinkResponse (Maybe Text) Source #
The ID of the VPC link.
updateVpcLinkResponse_vpcLinkStatus :: Lens' UpdateVpcLinkResponse (Maybe VpcLinkStatus) Source #
The status of the VPC link.
updateVpcLinkResponse_vpcLinkStatusMessage :: Lens' UpdateVpcLinkResponse (Maybe Text) Source #
A message summarizing the cause of the status of the VPC link.
updateVpcLinkResponse_vpcLinkVersion :: Lens' UpdateVpcLinkResponse (Maybe VpcLinkVersion) Source #
The version of the VPC link.
updateVpcLinkResponse_httpStatus :: Lens' UpdateVpcLinkResponse Int Source #
The response's http status code.
Types
AccessLogSettings
accessLogSettings_destinationArn :: Lens' AccessLogSettings (Maybe Text) Source #
The ARN of the CloudWatch Logs log group to receive access logs.
accessLogSettings_format :: Lens' AccessLogSettings (Maybe Text) Source #
A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.
Api
api_apiEndpoint :: Lens' Api (Maybe Text) Source #
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.
api_apiGatewayManaged :: Lens' Api (Maybe Bool) Source #
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.
api_apiKeySelectionExpression :: Lens' Api (Maybe Text) Source #
An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.
api_corsConfiguration :: Lens' Api (Maybe Cors) Source #
A CORS configuration. Supported only for HTTP APIs.
api_disableExecuteApiEndpoint :: Lens' Api (Maybe Bool) Source #
Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.
api_disableSchemaValidation :: Lens' Api (Maybe Bool) Source #
Avoid validating models when creating a deployment. Supported only for WebSocket APIs.
api_importInfo :: Lens' Api (Maybe [Text]) Source #
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.
api_tags :: Lens' Api (Maybe (HashMap Text Text)) Source #
A collection of tags associated with the API.
api_warnings :: Lens' Api (Maybe [Text]) Source #
The warning messages reported when failonwarnings is turned on during API import.
api_routeSelectionExpression :: Lens' Api Text Source #
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.
api_protocolType :: Lens' Api ProtocolType Source #
The API protocol.
ApiMapping
apiMapping_apiMappingId :: Lens' ApiMapping (Maybe Text) Source #
The API mapping identifier.
apiMapping_apiMappingKey :: Lens' ApiMapping (Maybe Text) Source #
The API mapping key.
apiMapping_stage :: Lens' ApiMapping Text Source #
The API stage.
apiMapping_apiId :: Lens' ApiMapping Text Source #
The API identifier.
Authorizer
authorizer_authorizerCredentialsArn :: Lens' Authorizer (Maybe Text) Source #
Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, don't specify this parameter. Supported only for REQUEST authorizers.
authorizer_authorizerId :: Lens' Authorizer (Maybe Text) Source #
The authorizer identifier.
authorizer_authorizerPayloadFormatVersion :: Lens' Authorizer (Maybe Text) Source #
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.
authorizer_authorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Natural) Source #
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.
authorizer_authorizerType :: Lens' Authorizer (Maybe 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).
authorizer_authorizerUri :: Lens' Authorizer (Maybe Text) Source #
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.
authorizer_enableSimpleResponses :: Lens' Authorizer (Maybe Bool) Source #
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
authorizer_identitySource :: Lens' Authorizer (Maybe [Text]) Source #
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.
authorizer_identityValidationExpression :: Lens' Authorizer (Maybe Text) Source #
The validation expression does not apply to the REQUEST authorizer.
authorizer_jwtConfiguration :: Lens' Authorizer (Maybe JWTConfiguration) Source #
Represents the configuration of a JWT authorizer. Required for the JWT authorizer type. Supported only for HTTP APIs.
authorizer_name :: Lens' Authorizer Text Source #
The name of the authorizer.
Cors
cors_allowCredentials :: Lens' Cors (Maybe Bool) Source #
Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.
cors_allowHeaders :: Lens' Cors (Maybe [Text]) Source #
Represents a collection of allowed headers. Supported only for HTTP APIs.
cors_allowMethods :: Lens' Cors (Maybe [Text]) Source #
Represents a collection of allowed HTTP methods. Supported only for HTTP APIs.
cors_allowOrigins :: Lens' Cors (Maybe [Text]) Source #
Represents a collection of allowed origins. Supported only for HTTP APIs.
cors_exposeHeaders :: Lens' Cors (Maybe [Text]) Source #
Represents a collection of exposed headers. Supported only for HTTP APIs.
cors_maxAge :: Lens' Cors (Maybe Int) Source #
The number of seconds that the browser should cache preflight request results. Supported only for HTTP APIs.
Deployment
deployment_autoDeployed :: Lens' Deployment (Maybe Bool) Source #
Specifies whether a deployment was automatically released.
deployment_createdDate :: Lens' Deployment (Maybe UTCTime) Source #
The date and time when the Deployment resource was created.
deployment_deploymentId :: Lens' Deployment (Maybe Text) Source #
The identifier for the deployment.
deployment_deploymentStatus :: Lens' Deployment (Maybe DeploymentStatus) Source #
The status of the deployment: PENDING, FAILED, or SUCCEEDED.
deployment_deploymentStatusMessage :: Lens' Deployment (Maybe Text) Source #
May contain additional feedback on the status of an API deployment.
deployment_description :: Lens' Deployment (Maybe Text) Source #
The description for the deployment.
DomainName
domainName_apiMappingSelectionExpression :: Lens' DomainName (Maybe Text) Source #
The API mapping selection expression.
domainName_domainNameConfigurations :: Lens' DomainName (Maybe [DomainNameConfiguration]) Source #
The domain name configurations.
domainName_mutualTlsAuthentication :: Lens' DomainName (Maybe MutualTlsAuthentication) Source #
The mutual TLS authentication configuration for a custom domain name.
domainName_tags :: Lens' DomainName (Maybe (HashMap Text Text)) Source #
The collection of tags associated with a domain name.
domainName_domainName :: Lens' DomainName Text Source #
The name of the DomainName resource.
DomainNameConfiguration
domainNameConfiguration_apiGatewayDomainName :: Lens' DomainNameConfiguration (Maybe Text) Source #
A domain name for the API.
domainNameConfiguration_certificateArn :: Lens' DomainNameConfiguration (Maybe Text) Source #
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.
domainNameConfiguration_certificateName :: Lens' DomainNameConfiguration (Maybe Text) Source #
The user-friendly name of the certificate that will be used by the edge-optimized endpoint for this domain name.
domainNameConfiguration_certificateUploadDate :: Lens' DomainNameConfiguration (Maybe UTCTime) Source #
The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
domainNameConfiguration_domainNameStatus :: Lens' DomainNameConfiguration (Maybe 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.
domainNameConfiguration_domainNameStatusMessage :: Lens' DomainNameConfiguration (Maybe Text) Source #
An optional text message containing detailed information about status of the domain name migration.
domainNameConfiguration_endpointType :: Lens' DomainNameConfiguration (Maybe EndpointType) Source #
The endpoint type.
domainNameConfiguration_hostedZoneId :: Lens' DomainNameConfiguration (Maybe Text) Source #
The Amazon Route 53 Hosted Zone ID of the endpoint.
domainNameConfiguration_ownershipVerificationCertificateArn :: Lens' DomainNameConfiguration (Maybe Text) Source #
The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn
domainNameConfiguration_securityPolicy :: Lens' DomainNameConfiguration (Maybe 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.
Integration
integration_apiGatewayManaged :: Lens' Integration (Maybe Bool) Source #
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.
integration_connectionId :: Lens' Integration (Maybe Text) Source #
The ID of the VPC link for a private integration. Supported only for HTTP APIs.
integration_connectionType :: Lens' Integration (Maybe ConnectionType) Source #
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.
integration_contentHandlingStrategy :: Lens' Integration (Maybe ContentHandlingStrategy) Source #
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.
integration_credentialsArn :: Lens' Integration (Maybe Text) Source #
Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::*:user/*. To use resource-based permissions on supported AWS services, specify null.
integration_description :: Lens' Integration (Maybe Text) Source #
Represents the description of an integration.
integration_integrationId :: Lens' Integration (Maybe Text) Source #
Represents the identifier of an integration.
integration_integrationMethod :: Lens' Integration (Maybe Text) Source #
Specifies the integration's HTTP method type.
integration_integrationResponseSelectionExpression :: Lens' Integration (Maybe Text) Source #
The integration response selection expression for the integration. Supported only for WebSocket APIs. See Integration Response Selection Expressions.
integration_integrationSubtype :: Lens' Integration (Maybe Text) Source #
Supported only for HTTP API AWS_PROXY integrations. Specifies the AWS service action to invoke. To learn more, see Integration subtype reference.
integration_integrationType :: Lens' Integration (Maybe IntegrationType) Source #
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.
integration_integrationUri :: Lens' Integration (Maybe Text) Source #
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.
integration_passthroughBehavior :: Lens' Integration (Maybe PassthroughBehavior) Source #
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.
integration_payloadFormatVersion :: Lens' Integration (Maybe Text) Source #
Specifies the format of the payload sent to an integration. Required for HTTP APIs.
integration_requestParameters :: Lens' Integration (Maybe (HashMap Text Text)) Source #
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.
integration_requestTemplates :: Lens' Integration (Maybe (HashMap Text Text)) Source #
Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value. Supported only for WebSocket APIs.
integration_responseParameters :: Lens' Integration (Maybe (HashMap Text (HashMap Text Text))) Source #
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.
integration_templateSelectionExpression :: Lens' Integration (Maybe Text) Source #
The template selection expression for the integration. Supported only for WebSocket APIs.
integration_timeoutInMillis :: Lens' Integration (Maybe Natural) Source #
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.
integration_tlsConfig :: Lens' Integration (Maybe TlsConfig) 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.
IntegrationResponse
integrationResponse_contentHandlingStrategy :: Lens' IntegrationResponse (Maybe ContentHandlingStrategy) Source #
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.
integrationResponse_integrationResponseId :: Lens' IntegrationResponse (Maybe Text) Source #
The integration response ID.
integrationResponse_responseParameters :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #
A key-value map specifying response parameters that are passed to the method response from the 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.
integrationResponse_responseTemplates :: Lens' IntegrationResponse (Maybe (HashMap Text Text)) Source #
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.
integrationResponse_templateSelectionExpression :: Lens' IntegrationResponse (Maybe Text) Source #
The template selection expressions for the integration response.
integrationResponse_integrationResponseKey :: Lens' IntegrationResponse Text Source #
The integration response key.
JWTConfiguration
jWTConfiguration_audience :: Lens' JWTConfiguration (Maybe [Text]) Source #
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.
jWTConfiguration_issuer :: Lens' JWTConfiguration (Maybe Text) Source #
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
model_contentType :: Lens' Model (Maybe Text) Source #
The content-type for the model, for example, "application/json".
model_schema :: Lens' Model (Maybe Text) Source #
The schema for the model. For application/json models, this should be JSON schema draft 4 model.
MutualTlsAuthentication
mutualTlsAuthentication_truststoreUri :: Lens' MutualTlsAuthentication (Maybe Text) Source #
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
mutualTlsAuthentication_truststoreVersion :: Lens' MutualTlsAuthentication (Maybe Text) Source #
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
mutualTlsAuthentication_truststoreWarnings :: Lens' MutualTlsAuthentication (Maybe [Text]) Source #
A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.
MutualTlsAuthenticationInput
mutualTlsAuthenticationInput_truststoreUri :: Lens' MutualTlsAuthenticationInput (Maybe Text) Source #
An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.
mutualTlsAuthenticationInput_truststoreVersion :: Lens' MutualTlsAuthenticationInput (Maybe Text) Source #
The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.
ParameterConstraints
parameterConstraints_required :: Lens' ParameterConstraints (Maybe Bool) Source #
Whether or not the parameter is required.
Route
route_apiGatewayManaged :: Lens' Route (Maybe Bool) Source #
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.
route_apiKeyRequired :: Lens' Route (Maybe Bool) Source #
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
route_authorizationScopes :: Lens' Route (Maybe [Text]) Source #
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.
route_authorizationType :: Lens' Route (Maybe AuthorizationType) Source #
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.
route_authorizerId :: Lens' Route (Maybe Text) Source #
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.
route_modelSelectionExpression :: Lens' Route (Maybe Text) Source #
The model selection expression for the route. Supported only for WebSocket APIs.
route_requestModels :: Lens' Route (Maybe (HashMap Text Text)) Source #
The request models for the route. Supported only for WebSocket APIs.
route_requestParameters :: Lens' Route (Maybe (HashMap Text ParameterConstraints)) Source #
The request parameters for the route. Supported only for WebSocket APIs.
route_routeResponseSelectionExpression :: Lens' Route (Maybe Text) Source #
The route response selection expression for the route. Supported only for WebSocket APIs.
RouteResponse
routeResponse_modelSelectionExpression :: Lens' RouteResponse (Maybe Text) Source #
Represents the model selection expression of a route response. Supported only for WebSocket APIs.
routeResponse_responseModels :: Lens' RouteResponse (Maybe (HashMap Text Text)) Source #
Represents the response models of a route response.
routeResponse_responseParameters :: Lens' RouteResponse (Maybe (HashMap Text ParameterConstraints)) Source #
Represents the response parameters of a route response.
routeResponse_routeResponseId :: Lens' RouteResponse (Maybe Text) Source #
Represents the identifier of a route response.
routeResponse_routeResponseKey :: Lens' RouteResponse Text Source #
Represents the route response key of a route response.
RouteSettings
routeSettings_dataTraceEnabled :: Lens' RouteSettings (Maybe Bool) Source #
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.
routeSettings_detailedMetricsEnabled :: Lens' RouteSettings (Maybe Bool) Source #
Specifies whether detailed metrics are enabled.
routeSettings_loggingLevel :: Lens' RouteSettings (Maybe LoggingLevel) Source #
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.
routeSettings_throttlingBurstLimit :: Lens' RouteSettings (Maybe Int) Source #
Specifies the throttling burst limit.
routeSettings_throttlingRateLimit :: Lens' RouteSettings (Maybe Double) Source #
Specifies the throttling rate limit.
Stage
stage_accessLogSettings :: Lens' Stage (Maybe AccessLogSettings) Source #
Settings for logging access in this stage.
stage_apiGatewayManaged :: Lens' Stage (Maybe Bool) Source #
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.
stage_autoDeploy :: Lens' Stage (Maybe Bool) Source #
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
stage_clientCertificateId :: Lens' Stage (Maybe Text) Source #
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
stage_defaultRouteSettings :: Lens' Stage (Maybe RouteSettings) Source #
Default route settings for the stage.
stage_deploymentId :: Lens' Stage (Maybe Text) Source #
The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.
stage_lastDeploymentStatusMessage :: Lens' Stage (Maybe Text) Source #
Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.
stage_lastUpdatedDate :: Lens' Stage (Maybe UTCTime) Source #
The timestamp when the stage was last updated.
stage_routeSettings :: Lens' Stage (Maybe (HashMap Text RouteSettings)) Source #
Route settings for the stage, by routeKey.
stage_stageVariables :: Lens' Stage (Maybe (HashMap Text Text)) Source #
A map that defines the stage variables for a stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
stage_tags :: Lens' Stage (Maybe (HashMap Text Text)) Source #
The collection of tags. Each tag element is associated with a given resource.
TlsConfig
tlsConfig_serverNameToVerify :: Lens' TlsConfig (Maybe Text) Source #
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
tlsConfigInput_serverNameToVerify :: Lens' TlsConfigInput (Maybe Text) Source #
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
vpcLink_createdDate :: Lens' VpcLink (Maybe UTCTime) Source #
The timestamp when the VPC link was created.
vpcLink_vpcLinkStatus :: Lens' VpcLink (Maybe VpcLinkStatus) Source #
The status of the VPC link.
vpcLink_vpcLinkStatusMessage :: Lens' VpcLink (Maybe Text) Source #
A message summarizing the cause of the status of the VPC link.
vpcLink_vpcLinkVersion :: Lens' VpcLink (Maybe VpcLinkVersion) Source #
The version of the VPC link.