Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.APIGateway

Contents

Service Configuration
Errors
Waiters
Operations
Types

Description

Derived from API version 2015-07-09 of the AWS service descriptions, licensed under Apache 2.0.

Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. API Gateway allows developers to securely connect mobile and web applications to APIs that run on AWS Lambda, Amazon EC2, or other publicly addressable web services that are hosted outside of AWS.

Synopsis

defaultService :: Service
_BadRequestException :: AsError a => Fold a ServiceError
_ConflictException :: AsError a => Fold a ServiceError
_LimitExceededException :: AsError a => Fold a ServiceError
_NotFoundException :: AsError a => Fold a ServiceError
_ServiceUnavailableException :: AsError a => Fold a ServiceError
_TooManyRequestsException :: AsError a => Fold a ServiceError
_UnauthorizedException :: AsError a => Fold a ServiceError
data CreateApiKey = CreateApiKey' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [StageKey]) (Maybe (HashMap Text Text)) (Maybe Text)
newCreateApiKey :: CreateApiKey
data ApiKey = ApiKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text)
newApiKey :: ApiKey
data CreateAuthorizer = CreateAuthorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Text Text AuthorizerType
newCreateAuthorizer :: Text -> Text -> AuthorizerType -> CreateAuthorizer
data Authorizer = Authorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe AuthorizerType)
newAuthorizer :: Authorizer
data CreateBasePathMapping = CreateBasePathMapping' (Maybe Text) (Maybe Text) Text Text
newCreateBasePathMapping :: Text -> Text -> CreateBasePathMapping
data BasePathMapping = BasePathMapping' (Maybe Text) (Maybe Text) (Maybe Text)
newBasePathMapping :: BasePathMapping
data CreateDeployment = CreateDeployment' (Maybe Bool) (Maybe CacheClusterSize) (Maybe DeploymentCanarySettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe (HashMap Text Text)) Text
newCreateDeployment :: Text -> CreateDeployment
data Deployment = Deployment' (Maybe (HashMap Text (HashMap Text MethodSnapshot))) (Maybe POSIX) (Maybe Text) (Maybe Text)
newDeployment :: Deployment
data CreateDocumentationPart = CreateDocumentationPart' Text DocumentationPartLocation Text
newCreateDocumentationPart :: Text -> DocumentationPartLocation -> Text -> CreateDocumentationPart
data DocumentationPart = DocumentationPart' (Maybe Text) (Maybe DocumentationPartLocation) (Maybe Text)
newDocumentationPart :: DocumentationPart
data CreateDocumentationVersion = CreateDocumentationVersion' (Maybe Text) (Maybe Text) Text Text
newCreateDocumentationVersion :: Text -> Text -> CreateDocumentationVersion
data DocumentationVersion = DocumentationVersion' (Maybe POSIX) (Maybe Text) (Maybe Text)
newDocumentationVersion :: DocumentationVersion
data CreateDomainName = CreateDomainName' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthenticationInput) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text)) Text
newCreateDomainName :: Text -> CreateDomainName
data DomainName = DomainName' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text))
newDomainName :: DomainName
data CreateModel = CreateModel' (Maybe Text) (Maybe Text) Text Text Text
newCreateModel :: Text -> Text -> Text -> CreateModel
data Model = Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newModel :: Model
data CreateRequestValidator = CreateRequestValidator' (Maybe Text) (Maybe Bool) (Maybe Bool) Text
newCreateRequestValidator :: Text -> CreateRequestValidator
data RequestValidator = RequestValidator' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool)
newRequestValidator :: RequestValidator
data CreateResource = CreateResource' Text Text Text
newCreateResource :: Text -> Text -> Text -> CreateResource
data Resource = Resource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Method))
newResource :: Resource
data CreateRestApi = CreateRestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text
newCreateRestApi :: Text -> CreateRestApi
data RestApi = RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])
newRestApi :: RestApi
data CreateStage = CreateStage' (Maybe Bool) (Maybe CacheClusterSize) (Maybe CanarySettings) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) Text Text Text
newCreateStage :: Text -> Text -> Text -> CreateStage
data Stage = Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe CacheClusterSize) (Maybe CacheClusterStatus) (Maybe CanarySettings) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text MethodSetting)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text)
newStage :: Stage
data CreateUsagePlan = CreateUsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings) Text
newCreateUsagePlan :: Text -> CreateUsagePlan
data UsagePlan = UsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings)
newUsagePlan :: UsagePlan
data CreateUsagePlanKey = CreateUsagePlanKey' Text Text Text
newCreateUsagePlanKey :: Text -> Text -> Text -> CreateUsagePlanKey
data UsagePlanKey = UsagePlanKey' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newUsagePlanKey :: UsagePlanKey
data CreateVpcLink = CreateVpcLink' (Maybe Text) (Maybe (HashMap Text Text)) Text [Text]
newCreateVpcLink :: Text -> CreateVpcLink
data VpcLink = VpcLink' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text])
newVpcLink :: VpcLink
data DeleteApiKey = DeleteApiKey' Text
newDeleteApiKey :: Text -> DeleteApiKey
data DeleteApiKeyResponse = DeleteApiKeyResponse' {
}
newDeleteApiKeyResponse :: DeleteApiKeyResponse
data DeleteAuthorizer = DeleteAuthorizer' Text Text
newDeleteAuthorizer :: Text -> Text -> DeleteAuthorizer
data DeleteAuthorizerResponse = DeleteAuthorizerResponse' {
}
newDeleteAuthorizerResponse :: DeleteAuthorizerResponse
data DeleteBasePathMapping = DeleteBasePathMapping' Text Text
newDeleteBasePathMapping :: Text -> Text -> DeleteBasePathMapping
data DeleteBasePathMappingResponse = DeleteBasePathMappingResponse' {
}
newDeleteBasePathMappingResponse :: DeleteBasePathMappingResponse
data DeleteClientCertificate = DeleteClientCertificate' Text
newDeleteClientCertificate :: Text -> DeleteClientCertificate
data DeleteClientCertificateResponse = DeleteClientCertificateResponse' {
}
newDeleteClientCertificateResponse :: DeleteClientCertificateResponse
data DeleteDeployment = DeleteDeployment' Text Text
newDeleteDeployment :: Text -> Text -> DeleteDeployment
data DeleteDeploymentResponse = DeleteDeploymentResponse' {
}
newDeleteDeploymentResponse :: DeleteDeploymentResponse
data DeleteDocumentationPart = DeleteDocumentationPart' Text Text
newDeleteDocumentationPart :: Text -> Text -> DeleteDocumentationPart
data DeleteDocumentationPartResponse = DeleteDocumentationPartResponse' {
}
newDeleteDocumentationPartResponse :: DeleteDocumentationPartResponse
data DeleteDocumentationVersion = DeleteDocumentationVersion' Text Text
newDeleteDocumentationVersion :: Text -> Text -> DeleteDocumentationVersion
data DeleteDocumentationVersionResponse = DeleteDocumentationVersionResponse' {
}
newDeleteDocumentationVersionResponse :: DeleteDocumentationVersionResponse
data DeleteDomainName = DeleteDomainName' Text
newDeleteDomainName :: Text -> DeleteDomainName
data DeleteDomainNameResponse = DeleteDomainNameResponse' {
}
newDeleteDomainNameResponse :: DeleteDomainNameResponse
data DeleteGatewayResponse = DeleteGatewayResponse' Text GatewayResponseType
newDeleteGatewayResponse :: Text -> GatewayResponseType -> DeleteGatewayResponse
data DeleteGatewayResponseResponse = DeleteGatewayResponseResponse' {
}
newDeleteGatewayResponseResponse :: DeleteGatewayResponseResponse
data DeleteIntegration = DeleteIntegration' Text Text Text
newDeleteIntegration :: Text -> Text -> Text -> DeleteIntegration
data DeleteIntegrationResponse' = DeleteIntegrationResponse'' {
}
newDeleteIntegrationResponse' :: DeleteIntegrationResponse'
data DeleteIntegrationResponse = DeleteIntegrationResponse' Text Text Text Text
newDeleteIntegrationResponse :: Text -> Text -> Text -> Text -> DeleteIntegrationResponse
data DeleteIntegrationResponseResponse = DeleteIntegrationResponseResponse' {
}
newDeleteIntegrationResponseResponse :: DeleteIntegrationResponseResponse
data DeleteMethod = DeleteMethod' Text Text Text
newDeleteMethod :: Text -> Text -> Text -> DeleteMethod
data DeleteMethodResponse' = DeleteMethodResponse'' {
}
newDeleteMethodResponse' :: DeleteMethodResponse'
data DeleteMethodResponse = DeleteMethodResponse' Text Text Text Text
newDeleteMethodResponse :: Text -> Text -> Text -> Text -> DeleteMethodResponse
data DeleteMethodResponseResponse = DeleteMethodResponseResponse' {
}
newDeleteMethodResponseResponse :: DeleteMethodResponseResponse
data DeleteModel = DeleteModel' Text Text
newDeleteModel :: Text -> Text -> DeleteModel
data DeleteModelResponse = DeleteModelResponse' {
}
newDeleteModelResponse :: DeleteModelResponse
data DeleteRequestValidator = DeleteRequestValidator' Text Text
newDeleteRequestValidator :: Text -> Text -> DeleteRequestValidator
data DeleteRequestValidatorResponse = DeleteRequestValidatorResponse' {
}
newDeleteRequestValidatorResponse :: DeleteRequestValidatorResponse
data DeleteResource = DeleteResource' Text Text
newDeleteResource :: Text -> Text -> DeleteResource
data DeleteResourceResponse = DeleteResourceResponse' {
}
newDeleteResourceResponse :: DeleteResourceResponse
data DeleteRestApi = DeleteRestApi' Text
newDeleteRestApi :: Text -> DeleteRestApi
data DeleteRestApiResponse = DeleteRestApiResponse' {
}
newDeleteRestApiResponse :: DeleteRestApiResponse
data DeleteStage = DeleteStage' Text Text
newDeleteStage :: Text -> Text -> DeleteStage
data DeleteStageResponse = DeleteStageResponse' {
}
newDeleteStageResponse :: DeleteStageResponse
data DeleteUsagePlan = DeleteUsagePlan' Text
newDeleteUsagePlan :: Text -> DeleteUsagePlan
data DeleteUsagePlanResponse = DeleteUsagePlanResponse' {
}
newDeleteUsagePlanResponse :: DeleteUsagePlanResponse
data DeleteUsagePlanKey = DeleteUsagePlanKey' Text Text
newDeleteUsagePlanKey :: Text -> Text -> DeleteUsagePlanKey
data DeleteUsagePlanKeyResponse = DeleteUsagePlanKeyResponse' {
}
newDeleteUsagePlanKeyResponse :: DeleteUsagePlanKeyResponse
data DeleteVpcLink = DeleteVpcLink' Text
newDeleteVpcLink :: Text -> DeleteVpcLink
data DeleteVpcLinkResponse = DeleteVpcLinkResponse' {
}
newDeleteVpcLinkResponse :: DeleteVpcLinkResponse
data FlushStageAuthorizersCache = FlushStageAuthorizersCache' Text Text
newFlushStageAuthorizersCache :: Text -> Text -> FlushStageAuthorizersCache
data FlushStageAuthorizersCacheResponse = FlushStageAuthorizersCacheResponse' {
}
newFlushStageAuthorizersCacheResponse :: FlushStageAuthorizersCacheResponse
data FlushStageCache = FlushStageCache' Text Text
newFlushStageCache :: Text -> Text -> FlushStageCache
data FlushStageCacheResponse = FlushStageCacheResponse' {
}
newFlushStageCacheResponse :: FlushStageCacheResponse
data GenerateClientCertificate = GenerateClientCertificate' (Maybe Text) (Maybe (HashMap Text Text))
newGenerateClientCertificate :: GenerateClientCertificate
data ClientCertificate = ClientCertificate' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text))
newClientCertificate :: ClientCertificate
data GetAccount = GetAccount' {
}
newGetAccount :: GetAccount
data Account = Account' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ThrottleSettings)
newAccount :: Account
data GetApiKey = GetApiKey' (Maybe Bool) Text
newGetApiKey :: Text -> GetApiKey
data ApiKey = ApiKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text)
newApiKey :: ApiKey
data GetApiKeys = GetApiKeys' (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text)
newGetApiKeys :: GetApiKeys
data GetApiKeysResponse = GetApiKeysResponse' (Maybe [ApiKey]) (Maybe Text) (Maybe [Text]) Int
newGetApiKeysResponse :: Int -> GetApiKeysResponse
data GetAuthorizer = GetAuthorizer' Text Text
newGetAuthorizer :: Text -> Text -> GetAuthorizer
data Authorizer = Authorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe AuthorizerType)
newAuthorizer :: Authorizer
data GetAuthorizers = GetAuthorizers' (Maybe Int) (Maybe Text) Text
newGetAuthorizers :: Text -> GetAuthorizers
data GetAuthorizersResponse = GetAuthorizersResponse' (Maybe [Authorizer]) (Maybe Text) Int
newGetAuthorizersResponse :: Int -> GetAuthorizersResponse
data GetBasePathMapping = GetBasePathMapping' Text Text
newGetBasePathMapping :: Text -> Text -> GetBasePathMapping
data BasePathMapping = BasePathMapping' (Maybe Text) (Maybe Text) (Maybe Text)
newBasePathMapping :: BasePathMapping
data GetBasePathMappings = GetBasePathMappings' (Maybe Int) (Maybe Text) Text
newGetBasePathMappings :: Text -> GetBasePathMappings
data GetBasePathMappingsResponse = GetBasePathMappingsResponse' (Maybe [BasePathMapping]) (Maybe Text) Int
newGetBasePathMappingsResponse :: Int -> GetBasePathMappingsResponse
data GetClientCertificate = GetClientCertificate' Text
newGetClientCertificate :: Text -> GetClientCertificate
data ClientCertificate = ClientCertificate' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text))
newClientCertificate :: ClientCertificate
data GetClientCertificates = GetClientCertificates' (Maybe Int) (Maybe Text)
newGetClientCertificates :: GetClientCertificates
data GetClientCertificatesResponse = GetClientCertificatesResponse' (Maybe [ClientCertificate]) (Maybe Text) Int
newGetClientCertificatesResponse :: Int -> GetClientCertificatesResponse
data GetDeployment = GetDeployment' (Maybe [Text]) Text Text
newGetDeployment :: Text -> Text -> GetDeployment
data Deployment = Deployment' (Maybe (HashMap Text (HashMap Text MethodSnapshot))) (Maybe POSIX) (Maybe Text) (Maybe Text)
newDeployment :: Deployment
data GetDeployments = GetDeployments' (Maybe Int) (Maybe Text) Text
newGetDeployments :: Text -> GetDeployments
data GetDeploymentsResponse = GetDeploymentsResponse' (Maybe [Deployment]) (Maybe Text) Int
newGetDeploymentsResponse :: Int -> GetDeploymentsResponse
data GetDocumentationPart = GetDocumentationPart' Text Text
newGetDocumentationPart :: Text -> Text -> GetDocumentationPart
data DocumentationPart = DocumentationPart' (Maybe Text) (Maybe DocumentationPartLocation) (Maybe Text)
newDocumentationPart :: DocumentationPart
data GetDocumentationParts = GetDocumentationParts' (Maybe Int) (Maybe LocationStatusType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DocumentationPartType) Text
newGetDocumentationParts :: Text -> GetDocumentationParts
data GetDocumentationPartsResponse = GetDocumentationPartsResponse' (Maybe [DocumentationPart]) (Maybe Text) Int
newGetDocumentationPartsResponse :: Int -> GetDocumentationPartsResponse
data GetDocumentationVersion = GetDocumentationVersion' Text Text
newGetDocumentationVersion :: Text -> Text -> GetDocumentationVersion
data DocumentationVersion = DocumentationVersion' (Maybe POSIX) (Maybe Text) (Maybe Text)
newDocumentationVersion :: DocumentationVersion
data GetDocumentationVersions = GetDocumentationVersions' (Maybe Int) (Maybe Text) Text
newGetDocumentationVersions :: Text -> GetDocumentationVersions
data GetDocumentationVersionsResponse = GetDocumentationVersionsResponse' (Maybe [DocumentationVersion]) (Maybe Text) Int
newGetDocumentationVersionsResponse :: Int -> GetDocumentationVersionsResponse
data GetDomainName = GetDomainName' Text
newGetDomainName :: Text -> GetDomainName
data DomainName = DomainName' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text))
newDomainName :: DomainName
data GetDomainNames = GetDomainNames' (Maybe Int) (Maybe Text)
newGetDomainNames :: GetDomainNames
data GetDomainNamesResponse = GetDomainNamesResponse' (Maybe [DomainName]) (Maybe Text) Int
newGetDomainNamesResponse :: Int -> GetDomainNamesResponse
data GetExport = GetExport' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text
newGetExport :: Text -> Text -> Text -> GetExport
data GetExportResponse = GetExportResponse' (Maybe ByteString) (Maybe Text) (Maybe Text) Int
newGetExportResponse :: Int -> GetExportResponse
data GetGatewayResponse = GetGatewayResponse' Text GatewayResponseType
newGetGatewayResponse :: Text -> GatewayResponseType -> GetGatewayResponse
data GatewayResponse = GatewayResponse' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe GatewayResponseType) (Maybe Text)
newGatewayResponse :: GatewayResponse
data GetGatewayResponses = GetGatewayResponses' (Maybe Int) (Maybe Text) Text
newGetGatewayResponses :: Text -> GetGatewayResponses
data GetGatewayResponsesResponse = GetGatewayResponsesResponse' (Maybe [GatewayResponse]) (Maybe Text) Int
newGetGatewayResponsesResponse :: Int -> GetGatewayResponsesResponse
data GetIntegration = GetIntegration' Text Text Text
newGetIntegration :: Text -> Text -> Text -> GetIntegration
data Integration = Integration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text IntegrationResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe IntegrationType) (Maybe Text)
newIntegration :: Integration
data GetIntegrationResponse = GetIntegrationResponse' Text Text Text Text
newGetIntegrationResponse :: Text -> Text -> Text -> Text -> GetIntegrationResponse
data IntegrationResponse = IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text)
newIntegrationResponse :: IntegrationResponse
data GetMethod = GetMethod' Text Text Text
newGetMethod :: Text -> Text -> Text -> GetMethod
data Method = Method' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integration) (Maybe (HashMap Text MethodResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)
newMethod :: Method
data GetMethodResponse = GetMethodResponse' Text Text Text Text
newGetMethodResponse :: Text -> Text -> Text -> Text -> GetMethodResponse
data MethodResponse = MethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)
newMethodResponse :: MethodResponse
data GetModel = GetModel' (Maybe Bool) Text Text
newGetModel :: Text -> Text -> GetModel
data Model = Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newModel :: Model
data GetModelTemplate = GetModelTemplate' Text Text
newGetModelTemplate :: Text -> Text -> GetModelTemplate
data GetModelTemplateResponse = GetModelTemplateResponse' (Maybe Text) Int
newGetModelTemplateResponse :: Int -> GetModelTemplateResponse
data GetModels = GetModels' (Maybe Int) (Maybe Text) Text
newGetModels :: Text -> GetModels
data GetModelsResponse = GetModelsResponse' (Maybe [Model]) (Maybe Text) Int
newGetModelsResponse :: Int -> GetModelsResponse
data GetRequestValidator = GetRequestValidator' Text Text
newGetRequestValidator :: Text -> Text -> GetRequestValidator
data RequestValidator = RequestValidator' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool)
newRequestValidator :: RequestValidator
data GetRequestValidators = GetRequestValidators' (Maybe Int) (Maybe Text) Text
newGetRequestValidators :: Text -> GetRequestValidators
data GetRequestValidatorsResponse = GetRequestValidatorsResponse' (Maybe [RequestValidator]) (Maybe Text) Int
newGetRequestValidatorsResponse :: Int -> GetRequestValidatorsResponse
data GetResource = GetResource' (Maybe [Text]) Text Text
newGetResource :: Text -> Text -> GetResource
data Resource = Resource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Method))
newResource :: Resource
data GetResources = GetResources' (Maybe [Text]) (Maybe Int) (Maybe Text) Text
newGetResources :: Text -> GetResources
data GetResourcesResponse = GetResourcesResponse' (Maybe [Resource]) (Maybe Text) Int
newGetResourcesResponse :: Int -> GetResourcesResponse
data GetRestApi = GetRestApi' Text
newGetRestApi :: Text -> GetRestApi
data RestApi = RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])
newRestApi :: RestApi
data GetRestApis = GetRestApis' (Maybe Int) (Maybe Text)
newGetRestApis :: GetRestApis
data GetRestApisResponse = GetRestApisResponse' (Maybe [RestApi]) (Maybe Text) Int
newGetRestApisResponse :: Int -> GetRestApisResponse
data GetSdk = GetSdk' (Maybe (HashMap Text Text)) Text Text Text
newGetSdk :: Text -> Text -> Text -> GetSdk
data GetSdkResponse = GetSdkResponse' (Maybe ByteString) (Maybe Text) (Maybe Text) Int
newGetSdkResponse :: Int -> GetSdkResponse
data GetSdkType = GetSdkType' Text
newGetSdkType :: Text -> GetSdkType
data SdkType = SdkType' (Maybe [SdkConfigurationProperty]) (Maybe Text) (Maybe Text) (Maybe Text)
newSdkType :: SdkType
data GetSdkTypes = GetSdkTypes' (Maybe Int) (Maybe Text)
newGetSdkTypes :: GetSdkTypes
data GetSdkTypesResponse = GetSdkTypesResponse' (Maybe [SdkType]) (Maybe Text) Int
newGetSdkTypesResponse :: Int -> GetSdkTypesResponse
data GetStage = GetStage' Text Text
newGetStage :: Text -> Text -> GetStage
data Stage = Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe CacheClusterSize) (Maybe CacheClusterStatus) (Maybe CanarySettings) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text MethodSetting)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text)
newStage :: Stage
data GetStages = GetStages' (Maybe Text) Text
newGetStages :: Text -> GetStages
data GetStagesResponse = GetStagesResponse' (Maybe [Stage]) Int
newGetStagesResponse :: Int -> GetStagesResponse
data GetTags = GetTags' (Maybe Int) (Maybe Text) Text
newGetTags :: Text -> GetTags
data GetTagsResponse = GetTagsResponse' (Maybe (HashMap Text Text)) Int
newGetTagsResponse :: Int -> GetTagsResponse
data GetUsage = GetUsage' (Maybe Text) (Maybe Int) (Maybe Text) Text Text Text
newGetUsage :: Text -> Text -> Text -> GetUsage
data Usage = Usage' (Maybe Text) (Maybe (HashMap Text [[Integer]])) (Maybe Text) (Maybe Text) (Maybe Text)
newUsage :: Usage
data GetUsagePlan = GetUsagePlan' Text
newGetUsagePlan :: Text -> GetUsagePlan
data UsagePlan = UsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings)
newUsagePlan :: UsagePlan
data GetUsagePlanKey = GetUsagePlanKey' Text Text
newGetUsagePlanKey :: Text -> Text -> GetUsagePlanKey
data UsagePlanKey = UsagePlanKey' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newUsagePlanKey :: UsagePlanKey
data GetUsagePlanKeys = GetUsagePlanKeys' (Maybe Int) (Maybe Text) (Maybe Text) Text
newGetUsagePlanKeys :: Text -> GetUsagePlanKeys
data GetUsagePlanKeysResponse = GetUsagePlanKeysResponse' (Maybe [UsagePlanKey]) (Maybe Text) Int
newGetUsagePlanKeysResponse :: Int -> GetUsagePlanKeysResponse
data GetUsagePlans = GetUsagePlans' (Maybe Text) (Maybe Int) (Maybe Text)
newGetUsagePlans :: GetUsagePlans
data GetUsagePlansResponse = GetUsagePlansResponse' (Maybe [UsagePlan]) (Maybe Text) Int
newGetUsagePlansResponse :: Int -> GetUsagePlansResponse
data GetVpcLink = GetVpcLink' Text
newGetVpcLink :: Text -> GetVpcLink
data VpcLink = VpcLink' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text])
newVpcLink :: VpcLink
data GetVpcLinks = GetVpcLinks' (Maybe Int) (Maybe Text)
newGetVpcLinks :: GetVpcLinks
data GetVpcLinksResponse = GetVpcLinksResponse' (Maybe [VpcLink]) (Maybe Text) Int
newGetVpcLinksResponse :: Int -> GetVpcLinksResponse
data ImportApiKeys = ImportApiKeys' (Maybe Bool) ByteString ApiKeysFormat
newImportApiKeys :: ByteString -> ApiKeysFormat -> ImportApiKeys
data ImportApiKeysResponse = ImportApiKeysResponse' (Maybe [Text]) (Maybe [Text]) Int
newImportApiKeysResponse :: Int -> ImportApiKeysResponse
data ImportDocumentationParts = ImportDocumentationParts' (Maybe Bool) (Maybe PutMode) Text ByteString
newImportDocumentationParts :: Text -> ByteString -> ImportDocumentationParts
data ImportDocumentationPartsResponse = ImportDocumentationPartsResponse' (Maybe [Text]) (Maybe [Text]) Int
newImportDocumentationPartsResponse :: Int -> ImportDocumentationPartsResponse
data ImportRestApi = ImportRestApi' (Maybe Bool) (Maybe (HashMap Text Text)) ByteString
newImportRestApi :: ByteString -> ImportRestApi
data RestApi = RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])
newRestApi :: RestApi
data PutGatewayResponse = PutGatewayResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text GatewayResponseType
newPutGatewayResponse :: Text -> GatewayResponseType -> PutGatewayResponse
data GatewayResponse = GatewayResponse' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe GatewayResponseType) (Maybe Text)
newGatewayResponse :: GatewayResponse
data PutIntegration = PutIntegration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe Text) Text Text Text IntegrationType
newPutIntegration :: Text -> Text -> Text -> IntegrationType -> PutIntegration
data Integration = Integration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text IntegrationResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe IntegrationType) (Maybe Text)
newIntegration :: Integration
data PutIntegrationResponse = PutIntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text Text
newPutIntegrationResponse :: Text -> Text -> Text -> Text -> PutIntegrationResponse
data IntegrationResponse = IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text)
newIntegrationResponse :: IntegrationResponse
data PutMethod = PutMethod' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text) Text Text Text Text
newPutMethod :: Text -> Text -> Text -> Text -> PutMethod
data Method = Method' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integration) (Maybe (HashMap Text MethodResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)
newMethod :: Method
data PutMethodResponse = PutMethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) Text Text Text Text
newPutMethodResponse :: Text -> Text -> Text -> Text -> PutMethodResponse
data MethodResponse = MethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)
newMethodResponse :: MethodResponse
data PutRestApi = PutRestApi' (Maybe Bool) (Maybe PutMode) (Maybe (HashMap Text Text)) Text ByteString
newPutRestApi :: Text -> ByteString -> PutRestApi
data RestApi = RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])
newRestApi :: RestApi
data TagResource = TagResource' Text (HashMap Text Text)
newTagResource :: Text -> TagResource
data TagResourceResponse = TagResourceResponse' {
}
newTagResourceResponse :: TagResourceResponse
data TestInvokeAuthorizer = TestInvokeAuthorizer' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text [Text])) (Maybe Text) (Maybe (HashMap Text Text)) Text Text
newTestInvokeAuthorizer :: Text -> Text -> TestInvokeAuthorizer
data TestInvokeAuthorizerResponse = TestInvokeAuthorizerResponse' (Maybe (HashMap Text [Text])) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) Int
newTestInvokeAuthorizerResponse :: Int -> TestInvokeAuthorizerResponse
data TestInvokeMethod = TestInvokeMethod' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text [Text])) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text
newTestInvokeMethod :: Text -> Text -> Text -> TestInvokeMethod
data TestInvokeMethodResponse = TestInvokeMethodResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Integer) (Maybe Text) (Maybe (HashMap Text [Text])) (Maybe Int) Int
newTestInvokeMethodResponse :: Int -> TestInvokeMethodResponse
data UntagResource = UntagResource' Text [Text]
newUntagResource :: Text -> UntagResource
data UntagResourceResponse = UntagResourceResponse' {
}
newUntagResourceResponse :: UntagResourceResponse
data UpdateAccount = UpdateAccount' (Maybe [PatchOperation])
newUpdateAccount :: UpdateAccount
data Account = Account' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ThrottleSettings)
newAccount :: Account
data UpdateApiKey = UpdateApiKey' (Maybe [PatchOperation]) Text
newUpdateApiKey :: Text -> UpdateApiKey
data ApiKey = ApiKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text)
newApiKey :: ApiKey
data UpdateAuthorizer = UpdateAuthorizer' (Maybe [PatchOperation]) Text Text
newUpdateAuthorizer :: Text -> Text -> UpdateAuthorizer
data Authorizer = Authorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe AuthorizerType)
newAuthorizer :: Authorizer
data UpdateBasePathMapping = UpdateBasePathMapping' (Maybe [PatchOperation]) Text Text
newUpdateBasePathMapping :: Text -> Text -> UpdateBasePathMapping
data BasePathMapping = BasePathMapping' (Maybe Text) (Maybe Text) (Maybe Text)
newBasePathMapping :: BasePathMapping
data UpdateClientCertificate = UpdateClientCertificate' (Maybe [PatchOperation]) Text
newUpdateClientCertificate :: Text -> UpdateClientCertificate
data ClientCertificate = ClientCertificate' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text))
newClientCertificate :: ClientCertificate
data UpdateDeployment = UpdateDeployment' (Maybe [PatchOperation]) Text Text
newUpdateDeployment :: Text -> Text -> UpdateDeployment
data Deployment = Deployment' (Maybe (HashMap Text (HashMap Text MethodSnapshot))) (Maybe POSIX) (Maybe Text) (Maybe Text)
newDeployment :: Deployment
data UpdateDocumentationPart = UpdateDocumentationPart' (Maybe [PatchOperation]) Text Text
newUpdateDocumentationPart :: Text -> Text -> UpdateDocumentationPart
data DocumentationPart = DocumentationPart' (Maybe Text) (Maybe DocumentationPartLocation) (Maybe Text)
newDocumentationPart :: DocumentationPart
data UpdateDocumentationVersion = UpdateDocumentationVersion' (Maybe [PatchOperation]) Text Text
newUpdateDocumentationVersion :: Text -> Text -> UpdateDocumentationVersion
data DocumentationVersion = DocumentationVersion' (Maybe POSIX) (Maybe Text) (Maybe Text)
newDocumentationVersion :: DocumentationVersion
data UpdateDomainName = UpdateDomainName' (Maybe [PatchOperation]) Text
newUpdateDomainName :: Text -> UpdateDomainName
data DomainName = DomainName' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text))
newDomainName :: DomainName
data UpdateGatewayResponse = UpdateGatewayResponse' (Maybe [PatchOperation]) Text GatewayResponseType
newUpdateGatewayResponse :: Text -> GatewayResponseType -> UpdateGatewayResponse
data GatewayResponse = GatewayResponse' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe GatewayResponseType) (Maybe Text)
newGatewayResponse :: GatewayResponse
data UpdateIntegration = UpdateIntegration' (Maybe [PatchOperation]) Text Text Text
newUpdateIntegration :: Text -> Text -> Text -> UpdateIntegration
data Integration = Integration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text IntegrationResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe IntegrationType) (Maybe Text)
newIntegration :: Integration
data UpdateIntegrationResponse = UpdateIntegrationResponse' (Maybe [PatchOperation]) Text Text Text Text
newUpdateIntegrationResponse :: Text -> Text -> Text -> Text -> UpdateIntegrationResponse
data IntegrationResponse = IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text)
newIntegrationResponse :: IntegrationResponse
data UpdateMethod = UpdateMethod' (Maybe [PatchOperation]) Text Text Text
newUpdateMethod :: Text -> Text -> Text -> UpdateMethod
data Method = Method' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integration) (Maybe (HashMap Text MethodResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)
newMethod :: Method
data UpdateMethodResponse = UpdateMethodResponse' (Maybe [PatchOperation]) Text Text Text Text
newUpdateMethodResponse :: Text -> Text -> Text -> Text -> UpdateMethodResponse
data MethodResponse = MethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)
newMethodResponse :: MethodResponse
data UpdateModel = UpdateModel' (Maybe [PatchOperation]) Text Text
newUpdateModel :: Text -> Text -> UpdateModel
data Model = Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newModel :: Model
data UpdateRequestValidator = UpdateRequestValidator' (Maybe [PatchOperation]) Text Text
newUpdateRequestValidator :: Text -> Text -> UpdateRequestValidator
data RequestValidator = RequestValidator' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool)
newRequestValidator :: RequestValidator
data UpdateResource = UpdateResource' (Maybe [PatchOperation]) Text Text
newUpdateResource :: Text -> Text -> UpdateResource
data Resource = Resource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Method))
newResource :: Resource
data UpdateRestApi = UpdateRestApi' (Maybe [PatchOperation]) Text
newUpdateRestApi :: Text -> UpdateRestApi
data RestApi = RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])
newRestApi :: RestApi
data UpdateStage = UpdateStage' (Maybe [PatchOperation]) Text Text
newUpdateStage :: Text -> Text -> UpdateStage
data Stage = Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe CacheClusterSize) (Maybe CacheClusterStatus) (Maybe CanarySettings) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text MethodSetting)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text)
newStage :: Stage
data UpdateUsage = UpdateUsage' (Maybe [PatchOperation]) Text Text
newUpdateUsage :: Text -> Text -> UpdateUsage
data Usage = Usage' (Maybe Text) (Maybe (HashMap Text [[Integer]])) (Maybe Text) (Maybe Text) (Maybe Text)
newUsage :: Usage
data UpdateUsagePlan = UpdateUsagePlan' (Maybe [PatchOperation]) Text
newUpdateUsagePlan :: Text -> UpdateUsagePlan
data UsagePlan = UsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings)
newUsagePlan :: UsagePlan
data UpdateVpcLink = UpdateVpcLink' (Maybe [PatchOperation]) Text
newUpdateVpcLink :: Text -> UpdateVpcLink
data VpcLink = VpcLink' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text])
newVpcLink :: VpcLink
newtype ApiKeySourceType where
- ApiKeySourceType' {
  - fromApiKeySourceType :: Text
  }
- pattern ApiKeySourceType_AUTHORIZER :: ApiKeySourceType
- pattern ApiKeySourceType_HEADER :: ApiKeySourceType
newtype ApiKeysFormat where
- ApiKeysFormat' {
  - fromApiKeysFormat :: Text
  }
- pattern ApiKeysFormat_Csv :: ApiKeysFormat
newtype AuthorizerType where
- AuthorizerType' {
  - fromAuthorizerType :: Text
  }
- pattern AuthorizerType_COGNITO_USER_POOLS :: AuthorizerType
- pattern AuthorizerType_REQUEST :: AuthorizerType
- pattern AuthorizerType_TOKEN :: AuthorizerType
newtype CacheClusterSize where
- CacheClusterSize' {
  - fromCacheClusterSize :: Text
  }
- pattern CacheClusterSize_ :: CacheClusterSize
newtype CacheClusterStatus where
- CacheClusterStatus' {
  - fromCacheClusterStatus :: Text
  }
- pattern CacheClusterStatus_AVAILABLE :: CacheClusterStatus
- pattern CacheClusterStatus_CREATE_IN_PROGRESS :: CacheClusterStatus
- pattern CacheClusterStatus_DELETE_IN_PROGRESS :: CacheClusterStatus
- pattern CacheClusterStatus_FLUSH_IN_PROGRESS :: CacheClusterStatus
- pattern CacheClusterStatus_NOT_AVAILABLE :: CacheClusterStatus
newtype ConnectionType where
- ConnectionType' {
  - fromConnectionType :: Text
  }
- pattern ConnectionType_INTERNET :: ConnectionType
- pattern ConnectionType_VPC_LINK :: ConnectionType
newtype ContentHandlingStrategy where
- ContentHandlingStrategy' {
  - fromContentHandlingStrategy :: Text
  }
- pattern ContentHandlingStrategy_CONVERT_TO_BINARY :: ContentHandlingStrategy
- pattern ContentHandlingStrategy_CONVERT_TO_TEXT :: ContentHandlingStrategy
newtype DocumentationPartType where
- DocumentationPartType' {
  - fromDocumentationPartType :: Text
  }
- pattern DocumentationPartType_API :: DocumentationPartType
- pattern DocumentationPartType_AUTHORIZER :: DocumentationPartType
- pattern DocumentationPartType_METHOD :: DocumentationPartType
- pattern DocumentationPartType_MODEL :: DocumentationPartType
- pattern DocumentationPartType_PATH_PARAMETER :: DocumentationPartType
- pattern DocumentationPartType_QUERY_PARAMETER :: DocumentationPartType
- pattern DocumentationPartType_REQUEST_BODY :: DocumentationPartType
- pattern DocumentationPartType_REQUEST_HEADER :: DocumentationPartType
- pattern DocumentationPartType_RESOURCE :: DocumentationPartType
- pattern DocumentationPartType_RESPONSE :: DocumentationPartType
- pattern DocumentationPartType_RESPONSE_BODY :: DocumentationPartType
- pattern DocumentationPartType_RESPONSE_HEADER :: DocumentationPartType
newtype DomainNameStatus where
- DomainNameStatus' {
  - fromDomainNameStatus :: Text
  }
- pattern DomainNameStatus_AVAILABLE :: DomainNameStatus
- pattern DomainNameStatus_PENDING :: DomainNameStatus
- pattern DomainNameStatus_PENDING_CERTIFICATE_REIMPORT :: DomainNameStatus
- pattern DomainNameStatus_PENDING_OWNERSHIP_VERIFICATION :: DomainNameStatus
- pattern DomainNameStatus_UPDATING :: DomainNameStatus
newtype EndpointType where
- EndpointType' {
  - fromEndpointType :: Text
  }
- pattern EndpointType_EDGE :: EndpointType
- pattern EndpointType_PRIVATE :: EndpointType
- pattern EndpointType_REGIONAL :: EndpointType
newtype GatewayResponseType where
- GatewayResponseType' {
  - fromGatewayResponseType :: Text
  }
- pattern GatewayResponseType_ACCESS_DENIED :: GatewayResponseType
- pattern GatewayResponseType_API_CONFIGURATION_ERROR :: GatewayResponseType
- pattern GatewayResponseType_AUTHORIZER_CONFIGURATION_ERROR :: GatewayResponseType
- pattern GatewayResponseType_AUTHORIZER_FAILURE :: GatewayResponseType
- pattern GatewayResponseType_BAD_REQUEST_BODY :: GatewayResponseType
- pattern GatewayResponseType_BAD_REQUEST_PARAMETERS :: GatewayResponseType
- pattern GatewayResponseType_DEFAULT_4XX :: GatewayResponseType
- pattern GatewayResponseType_DEFAULT_5XX :: GatewayResponseType
- pattern GatewayResponseType_EXPIRED_TOKEN :: GatewayResponseType
- pattern GatewayResponseType_INTEGRATION_FAILURE :: GatewayResponseType
- pattern GatewayResponseType_INTEGRATION_TIMEOUT :: GatewayResponseType
- pattern GatewayResponseType_INVALID_API_KEY :: GatewayResponseType
- pattern GatewayResponseType_INVALID_SIGNATURE :: GatewayResponseType
- pattern GatewayResponseType_MISSING_AUTHENTICATION_TOKEN :: GatewayResponseType
- pattern GatewayResponseType_QUOTA_EXCEEDED :: GatewayResponseType
- pattern GatewayResponseType_REQUEST_TOO_LARGE :: GatewayResponseType
- pattern GatewayResponseType_RESOURCE_NOT_FOUND :: GatewayResponseType
- pattern GatewayResponseType_THROTTLED :: GatewayResponseType
- pattern GatewayResponseType_UNAUTHORIZED :: GatewayResponseType
- pattern GatewayResponseType_UNSUPPORTED_MEDIA_TYPE :: GatewayResponseType
- pattern GatewayResponseType_WAF_FILTERED :: GatewayResponseType
newtype IntegrationType where
- IntegrationType' {
  - fromIntegrationType :: Text
  }
- pattern IntegrationType_AWS :: IntegrationType
- pattern IntegrationType_AWS_PROXY :: IntegrationType
- pattern IntegrationType_HTTP :: IntegrationType
- pattern IntegrationType_HTTP_PROXY :: IntegrationType
- pattern IntegrationType_MOCK :: IntegrationType
newtype LocationStatusType where
- LocationStatusType' {
  - fromLocationStatusType :: Text
  }
- pattern LocationStatusType_DOCUMENTED :: LocationStatusType
- pattern LocationStatusType_UNDOCUMENTED :: LocationStatusType
newtype Op where
- Op' {
  - fromOp :: Text
  }
- pattern Op_Add :: Op
- pattern Op_Copy :: Op
- pattern Op_Move :: Op
- pattern Op_Remove :: Op
- pattern Op_Replace :: Op
- pattern Op_Test :: Op
newtype PutMode where
- PutMode' {
  - fromPutMode :: Text
  }
- pattern PutMode_Merge :: PutMode
- pattern PutMode_Overwrite :: PutMode
newtype QuotaPeriodType where
- QuotaPeriodType' {
  - fromQuotaPeriodType :: Text
  }
- pattern QuotaPeriodType_DAY :: QuotaPeriodType
- pattern QuotaPeriodType_MONTH :: QuotaPeriodType
- pattern QuotaPeriodType_WEEK :: QuotaPeriodType
newtype SecurityPolicy where
- SecurityPolicy' {
  - fromSecurityPolicy :: Text
  }
- pattern SecurityPolicy_TLS_1_0 :: SecurityPolicy
- pattern SecurityPolicy_TLS_1_2 :: SecurityPolicy
newtype UnauthorizedCacheControlHeaderStrategy where
- UnauthorizedCacheControlHeaderStrategy' {
  - fromUnauthorizedCacheControlHeaderStrategy :: Text
  }
- pattern UnauthorizedCacheControlHeaderStrategy_FAIL_WITH_403 :: UnauthorizedCacheControlHeaderStrategy
- pattern UnauthorizedCacheControlHeaderStrategy_SUCCEED_WITHOUT_RESPONSE_HEADER :: UnauthorizedCacheControlHeaderStrategy
- pattern UnauthorizedCacheControlHeaderStrategy_SUCCEED_WITH_RESPONSE_HEADER :: UnauthorizedCacheControlHeaderStrategy
newtype VpcLinkStatus where
- VpcLinkStatus' {
  - fromVpcLinkStatus :: Text
  }
- pattern VpcLinkStatus_AVAILABLE :: VpcLinkStatus
- pattern VpcLinkStatus_DELETING :: VpcLinkStatus
- pattern VpcLinkStatus_FAILED :: VpcLinkStatus
- pattern VpcLinkStatus_PENDING :: VpcLinkStatus
data AccessLogSettings = AccessLogSettings' (Maybe Text) (Maybe Text)
newAccessLogSettings :: AccessLogSettings
data Account = Account' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ThrottleSettings)
newAccount :: Account
data ApiKey = ApiKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text)
newApiKey :: ApiKey
data ApiStage = ApiStage' (Maybe Text) (Maybe Text) (Maybe (HashMap Text ThrottleSettings))
newApiStage :: ApiStage
data Authorizer = Authorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe AuthorizerType)
newAuthorizer :: Authorizer
data BasePathMapping = BasePathMapping' (Maybe Text) (Maybe Text) (Maybe Text)
newBasePathMapping :: BasePathMapping
data CanarySettings = CanarySettings' (Maybe Text) (Maybe Double) (Maybe (HashMap Text Text)) (Maybe Bool)
newCanarySettings :: CanarySettings
data ClientCertificate = ClientCertificate' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text))
newClientCertificate :: ClientCertificate
data Deployment = Deployment' (Maybe (HashMap Text (HashMap Text MethodSnapshot))) (Maybe POSIX) (Maybe Text) (Maybe Text)
newDeployment :: Deployment
data DeploymentCanarySettings = DeploymentCanarySettings' (Maybe Double) (Maybe (HashMap Text Text)) (Maybe Bool)
newDeploymentCanarySettings :: DeploymentCanarySettings
data DocumentationPart = DocumentationPart' (Maybe Text) (Maybe DocumentationPartLocation) (Maybe Text)
newDocumentationPart :: DocumentationPart
data DocumentationPartLocation = DocumentationPartLocation' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) DocumentationPartType
newDocumentationPartLocation :: DocumentationPartType -> DocumentationPartLocation
data DocumentationVersion = DocumentationVersion' (Maybe POSIX) (Maybe Text) (Maybe Text)
newDocumentationVersion :: DocumentationVersion
data DomainName = DomainName' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text))
newDomainName :: DomainName
data EndpointConfiguration = EndpointConfiguration' (Maybe [EndpointType]) (Maybe [Text])
newEndpointConfiguration :: EndpointConfiguration
data GatewayResponse = GatewayResponse' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe GatewayResponseType) (Maybe Text)
newGatewayResponse :: GatewayResponse
data Integration = Integration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text IntegrationResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe IntegrationType) (Maybe Text)
newIntegration :: Integration
data IntegrationResponse = IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text)
newIntegrationResponse :: IntegrationResponse
data Method = Method' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integration) (Maybe (HashMap Text MethodResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)
newMethod :: Method
data MethodResponse = MethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)
newMethodResponse :: MethodResponse
data MethodSetting = MethodSetting' (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Double) (Maybe UnauthorizedCacheControlHeaderStrategy)
newMethodSetting :: MethodSetting
data MethodSnapshot = MethodSnapshot' (Maybe Bool) (Maybe Text)
newMethodSnapshot :: MethodSnapshot
data Model = Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newModel :: Model
data MutualTlsAuthentication = MutualTlsAuthentication' (Maybe Text) (Maybe Text) (Maybe [Text])
newMutualTlsAuthentication :: MutualTlsAuthentication
data MutualTlsAuthenticationInput = MutualTlsAuthenticationInput' (Maybe Text) (Maybe Text)
newMutualTlsAuthenticationInput :: MutualTlsAuthenticationInput
data PatchOperation = PatchOperation' (Maybe Text) (Maybe Op) (Maybe Text) (Maybe Text)
newPatchOperation :: PatchOperation
data QuotaSettings = QuotaSettings' (Maybe Int) (Maybe Int) (Maybe QuotaPeriodType)
newQuotaSettings :: QuotaSettings
data RequestValidator = RequestValidator' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool)
newRequestValidator :: RequestValidator
data Resource = Resource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Method))
newResource :: Resource
data RestApi = RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])
newRestApi :: RestApi
data SdkConfigurationProperty = SdkConfigurationProperty' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool)
newSdkConfigurationProperty :: SdkConfigurationProperty
data SdkType = SdkType' (Maybe [SdkConfigurationProperty]) (Maybe Text) (Maybe Text) (Maybe Text)
newSdkType :: SdkType
data Stage = Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe CacheClusterSize) (Maybe CacheClusterStatus) (Maybe CanarySettings) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text MethodSetting)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text)
newStage :: Stage
data StageKey = StageKey' (Maybe Text) (Maybe Text)
newStageKey :: StageKey
data ThrottleSettings = ThrottleSettings' (Maybe Int) (Maybe Double)
newThrottleSettings :: ThrottleSettings
data TlsConfig = TlsConfig' (Maybe Bool)
newTlsConfig :: TlsConfig
data Usage = Usage' (Maybe Text) (Maybe (HashMap Text [[Integer]])) (Maybe Text) (Maybe Text) (Maybe Text)
newUsage :: Usage
data UsagePlan = UsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings)
newUsagePlan :: UsagePlan
data UsagePlanKey = UsagePlanKey' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
newUsagePlanKey :: UsagePlanKey
data VpcLink = VpcLink' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text])
newVpcLink :: VpcLink

Service Configuration

defaultService :: Service Source #

API version 2015-07-09 of the Amazon API Gateway SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by APIGateway.

BadRequestException

_BadRequestException :: AsError a => Fold a ServiceError Source #

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

ConflictException

_ConflictException :: AsError a => Fold a ServiceError Source #

The request configuration has conflicts. For details, see the accompanying error message.

LimitExceededException

_LimitExceededException :: AsError a => Fold a ServiceError Source #

The request exceeded the rate limit. Retry after the specified time period.

NotFoundException

_NotFoundException :: AsError a => Fold a ServiceError Source #

The requested resource is not found. Make sure that the request URI is correct.

ServiceUnavailableException

_ServiceUnavailableException :: AsError a => Fold a ServiceError Source #

The requested service is not available. For details see the accompanying error message. Retry after the specified time period.

TooManyRequestsException

_TooManyRequestsException :: AsError a => Fold a ServiceError Source #

The request has reached its throttling limit. Retry after the specified time period.

UnauthorizedException

_UnauthorizedException :: AsError a => Fold a ServiceError Source #

The request is denied because the caller has insufficient permissions.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

CreateApiKey

data CreateApiKey Source #

Request to create an ApiKey resource.

See: newCreateApiKey smart constructor.

Constructors

CreateApiKey' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe [StageKey]) (Maybe (HashMap Text Text)) (Maybe Text)

Instances

Instances details

ToJSON CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods toJSON :: CreateApiKey -> Value # toEncoding :: CreateApiKey -> Encoding # toJSONList :: [CreateApiKey] -> Value # toEncodingList :: [CreateApiKey] -> Encoding #
ToHeaders CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods toHeaders :: CreateApiKey -> [Header] #
ToPath CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods toPath :: CreateApiKey -> ByteString #
ToQuery CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods toQuery :: CreateApiKey -> QueryString #
AWSRequest CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Associated Types type AWSResponse CreateApiKey # Methods request :: (Service -> Service) -> CreateApiKey -> Request CreateApiKey # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateApiKey))) #
Generic CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Associated Types type Rep CreateApiKey :: Type -> Type # Methods from :: CreateApiKey -> Rep CreateApiKey x # to :: Rep CreateApiKey x -> CreateApiKey #
Read CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods readsPrec :: Int -> ReadS CreateApiKey # readList :: ReadS [CreateApiKey] # readPrec :: ReadPrec CreateApiKey # readListPrec :: ReadPrec [CreateApiKey] #
Show CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods showsPrec :: Int -> CreateApiKey -> ShowS # show :: CreateApiKey -> String # showList :: [CreateApiKey] -> ShowS #
NFData CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods rnf :: CreateApiKey -> () #
Eq CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods (==) :: CreateApiKey -> CreateApiKey -> Bool # (/=) :: CreateApiKey -> CreateApiKey -> Bool #
Hashable CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey Methods hashWithSalt :: Int -> CreateApiKey -> Int # hash :: CreateApiKey -> Int #
type AWSResponse CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey type AWSResponse CreateApiKey = ApiKey
type Rep CreateApiKey Source #
Instance details Defined in Amazonka.APIGateway.CreateApiKey type Rep CreateApiKey = D1 ('MetaData "CreateApiKey" "Amazonka.APIGateway.CreateApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "generateDistinctId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StageKey]))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newCreateApiKey :: CreateApiKey Source #

Create a value of CreateApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateApiKey, createApiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

CreateApiKey, createApiKey_description - The description of the ApiKey.

CreateApiKey, createApiKey_enabled - Specifies whether the ApiKey can be used by callers.

$sel:generateDistinctId:CreateApiKey', createApiKey_generateDistinctId - Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

CreateApiKey, createApiKey_name - The name of the ApiKey.

CreateApiKey, createApiKey_stageKeys - DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

CreateApiKey, createApiKey_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

CreateApiKey, createApiKey_value - Specifies a value of the API key.

data ApiKey Source #

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See: newApiKey smart constructor.

Constructors

ApiKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text)

Instances

Instances details

FromJSON ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods parseJSON :: Value -> Parser ApiKey # parseJSONList :: Value -> Parser [ApiKey] #
Generic ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Associated Types type Rep ApiKey :: Type -> Type # Methods from :: ApiKey -> Rep ApiKey x # to :: Rep ApiKey x -> ApiKey #
Read ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods readsPrec :: Int -> ReadS ApiKey # readList :: ReadS [ApiKey] # readPrec :: ReadPrec ApiKey # readListPrec :: ReadPrec [ApiKey] #
Show ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods showsPrec :: Int -> ApiKey -> ShowS # show :: ApiKey -> String # showList :: [ApiKey] -> ShowS #
NFData ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods rnf :: ApiKey -> () #
Eq ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods (==) :: ApiKey -> ApiKey -> Bool # (/=) :: ApiKey -> ApiKey -> Bool #
Hashable ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods hashWithSalt :: Int -> ApiKey -> Int # hash :: ApiKey -> Int #
type Rep ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newApiKey :: ApiKey Source #

Create a value of ApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

$sel:customerId:ApiKey', apiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

$sel:description:ApiKey', apiKey_description - The description of the API Key.

$sel:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

$sel:id:ApiKey', apiKey_id - The identifier of the API Key.

$sel:lastUpdatedDate:ApiKey', apiKey_lastUpdatedDate - The timestamp when the API Key was last updated.

$sel:name:ApiKey', apiKey_name - The name of the API Key.

$sel:stageKeys:ApiKey', apiKey_stageKeys - A list of Stage resources that are associated with the ApiKey resource.

$sel:tags:ApiKey', apiKey_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:value:ApiKey', apiKey_value - The value of the API Key.

CreateAuthorizer

data CreateAuthorizer Source #

Request to add a new Authorizer to an existing RestApi resource.

See: newCreateAuthorizer smart constructor.

Constructors

CreateAuthorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) Text Text AuthorizerType

Instances

Instances details

ToJSON CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Methods toJSON :: CreateAuthorizer -> Value # toEncoding :: CreateAuthorizer -> Encoding # toJSONList :: [CreateAuthorizer] -> Value # toEncodingList :: [CreateAuthorizer] -> Encoding #
ToHeaders CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Methods toHeaders :: CreateAuthorizer -> [Header] #
ToPath CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Methods toPath :: CreateAuthorizer -> ByteString #
ToQuery CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Methods toQuery :: CreateAuthorizer -> QueryString #
AWSRequest CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Associated Types type AWSResponse CreateAuthorizer # Methods request :: (Service -> Service) -> CreateAuthorizer -> Request CreateAuthorizer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateAuthorizer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateAuthorizer))) #
Generic CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Associated Types type Rep CreateAuthorizer :: Type -> Type # Methods from :: CreateAuthorizer -> Rep CreateAuthorizer x # to :: Rep CreateAuthorizer x -> CreateAuthorizer #
Read CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Methods readsPrec :: Int -> ReadS CreateAuthorizer # readList :: ReadS [CreateAuthorizer] # readPrec :: ReadPrec CreateAuthorizer # readListPrec :: ReadPrec [CreateAuthorizer] #
Show CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Methods showsPrec :: Int -> CreateAuthorizer -> ShowS # show :: CreateAuthorizer -> String # showList :: [CreateAuthorizer] -> ShowS #
NFData CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Methods rnf :: CreateAuthorizer -> () #
Eq CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Methods (==) :: CreateAuthorizer -> CreateAuthorizer -> Bool # (/=) :: CreateAuthorizer -> CreateAuthorizer -> Bool #
Hashable CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer Methods hashWithSalt :: Int -> CreateAuthorizer -> Int # hash :: CreateAuthorizer -> Int #
type AWSResponse CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer type AWSResponse CreateAuthorizer = Authorizer
type Rep CreateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.CreateAuthorizer type Rep CreateAuthorizer = D1 ('MetaData "CreateAuthorizer" "Amazonka.APIGateway.CreateAuthorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateAuthorizer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorizerCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "authorizerResultTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "authorizerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identitySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "identityValidationExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "providerARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuthorizerType))))))

newCreateAuthorizer Source #

Arguments

:: Text	`CreateAuthorizer`
-> Text	`CreateAuthorizer`
-> AuthorizerType	`CreateAuthorizer`
-> CreateAuthorizer

Create a value of CreateAuthorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateAuthorizer, createAuthorizer_authType - Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

CreateAuthorizer, createAuthorizer_authorizerCredentials - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

CreateAuthorizer, createAuthorizer_authorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

CreateAuthorizer, createAuthorizer_authorizerUri - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

CreateAuthorizer, createAuthorizer_identitySource - The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

CreateAuthorizer, createAuthorizer_identityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

CreateAuthorizer, createAuthorizer_providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

CreateAuthorizer, createAuthorizer_restApiId - The string identifier of the associated RestApi.

CreateAuthorizer, createAuthorizer_name - The name of the authorizer.

CreateAuthorizer, createAuthorizer_type - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

data Authorizer Source #

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

See: newAuthorizer smart constructor.

Constructors

Authorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe AuthorizerType)

Instances

Instances details

FromJSON Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods parseJSON :: Value -> Parser Authorizer # parseJSONList :: Value -> Parser [Authorizer] #
Generic Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Associated Types type Rep Authorizer :: Type -> Type # Methods from :: Authorizer -> Rep Authorizer x # to :: Rep Authorizer x -> Authorizer #
Read Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods readsPrec :: Int -> ReadS Authorizer # readList :: ReadS [Authorizer] # readPrec :: ReadPrec Authorizer # readListPrec :: ReadPrec [Authorizer] #
Show Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods showsPrec :: Int -> Authorizer -> ShowS # show :: Authorizer -> String # showList :: [Authorizer] -> ShowS #
NFData Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods rnf :: Authorizer -> () #
Eq Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods (==) :: Authorizer -> Authorizer -> Bool # (/=) :: Authorizer -> Authorizer -> Bool #
Hashable Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods hashWithSalt :: Int -> Authorizer -> Int # hash :: Authorizer -> Int #
type Rep Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer type Rep Authorizer = D1 ('MetaData "Authorizer" "Amazonka.APIGateway.Types.Authorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Authorizer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorizerCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "authorizerResultTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "authorizerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "identitySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityValidationExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "providerARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerType)))))))

newAuthorizer :: Authorizer Source #

Create a value of Authorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authType:Authorizer', authorizer_authType - Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

$sel:authorizerCredentials:Authorizer', authorizer_authorizerCredentials - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

$sel:authorizerResultTtlInSeconds:Authorizer', authorizer_authorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

$sel:authorizerUri:Authorizer', authorizer_authorizerUri - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

$sel:id:Authorizer', authorizer_id - The identifier for the authorizer resource.

$sel:identitySource:Authorizer', authorizer_identitySource - The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

$sel:identityValidationExpression:Authorizer', authorizer_identityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

$sel:name:Authorizer', authorizer_name - The name of the authorizer.

$sel:providerARNs:Authorizer', authorizer_providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

$sel:type':Authorizer', authorizer_type - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

CreateBasePathMapping

data CreateBasePathMapping Source #

Requests API Gateway to create a new BasePathMapping resource.

See: newCreateBasePathMapping smart constructor.

Constructors

CreateBasePathMapping' (Maybe Text) (Maybe Text) Text Text

Instances

Instances details

ToJSON CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods toJSON :: CreateBasePathMapping -> Value # toEncoding :: CreateBasePathMapping -> Encoding # toJSONList :: [CreateBasePathMapping] -> Value # toEncodingList :: [CreateBasePathMapping] -> Encoding #
ToHeaders CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods toHeaders :: CreateBasePathMapping -> [Header] #
ToPath CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods toPath :: CreateBasePathMapping -> ByteString #
ToQuery CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods toQuery :: CreateBasePathMapping -> QueryString #
AWSRequest CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Associated Types type AWSResponse CreateBasePathMapping # Methods request :: (Service -> Service) -> CreateBasePathMapping -> Request CreateBasePathMapping # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateBasePathMapping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateBasePathMapping))) #
Generic CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Associated Types type Rep CreateBasePathMapping :: Type -> Type # Methods from :: CreateBasePathMapping -> Rep CreateBasePathMapping x # to :: Rep CreateBasePathMapping x -> CreateBasePathMapping #
Read CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods readsPrec :: Int -> ReadS CreateBasePathMapping # readList :: ReadS [CreateBasePathMapping] # readPrec :: ReadPrec CreateBasePathMapping # readListPrec :: ReadPrec [CreateBasePathMapping] #
Show CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods showsPrec :: Int -> CreateBasePathMapping -> ShowS # show :: CreateBasePathMapping -> String # showList :: [CreateBasePathMapping] -> ShowS #
NFData CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods rnf :: CreateBasePathMapping -> () #
Eq CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods (==) :: CreateBasePathMapping -> CreateBasePathMapping -> Bool # (/=) :: CreateBasePathMapping -> CreateBasePathMapping -> Bool #
Hashable CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping Methods hashWithSalt :: Int -> CreateBasePathMapping -> Int # hash :: CreateBasePathMapping -> Int #
type AWSResponse CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping type AWSResponse CreateBasePathMapping = BasePathMapping
type Rep CreateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.CreateBasePathMapping type Rep CreateBasePathMapping = D1 ('MetaData "CreateBasePathMapping" "Amazonka.APIGateway.CreateBasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateBasePathMapping'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateBasePathMapping Source #

Arguments

:: Text	`CreateBasePathMapping`
-> Text	`CreateBasePathMapping`
-> CreateBasePathMapping

Create a value of CreateBasePathMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateBasePathMapping, createBasePathMapping_basePath - The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify a base path name after the domain name.

CreateBasePathMapping, createBasePathMapping_stage - The name of the API's stage that you want to use for this mapping. Specify '(none)' if you want callers to explicitly specify the stage name after any base path name.

CreateBasePathMapping, createBasePathMapping_domainName - The domain name of the BasePathMapping resource to create.

CreateBasePathMapping, createBasePathMapping_restApiId - The string identifier of the associated RestApi.

data BasePathMapping Source #

Represents the base path that callers of the API must provide as part of the URL after the domain name.

See: newBasePathMapping smart constructor.

Constructors

BasePathMapping' (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods parseJSON :: Value -> Parser BasePathMapping # parseJSONList :: Value -> Parser [BasePathMapping] #
Generic BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Associated Types type Rep BasePathMapping :: Type -> Type # Methods from :: BasePathMapping -> Rep BasePathMapping x # to :: Rep BasePathMapping x -> BasePathMapping #
Read BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods readsPrec :: Int -> ReadS BasePathMapping # readList :: ReadS [BasePathMapping] # readPrec :: ReadPrec BasePathMapping # readListPrec :: ReadPrec [BasePathMapping] #
Show BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods showsPrec :: Int -> BasePathMapping -> ShowS # show :: BasePathMapping -> String # showList :: [BasePathMapping] -> ShowS #
NFData BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods rnf :: BasePathMapping -> () #
Eq BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods (==) :: BasePathMapping -> BasePathMapping -> Bool # (/=) :: BasePathMapping -> BasePathMapping -> Bool #
Hashable BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods hashWithSalt :: Int -> BasePathMapping -> Int # hash :: BasePathMapping -> Int #
type Rep BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping type Rep BasePathMapping = D1 ('MetaData "BasePathMapping" "Amazonka.APIGateway.Types.BasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "BasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBasePathMapping :: BasePathMapping Source #

Create a value of BasePathMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:basePath:BasePathMapping', basePathMapping_basePath - The base path name that callers of the API must provide as part of the URL after the domain name.

$sel:restApiId:BasePathMapping', basePathMapping_restApiId - The string identifier of the associated RestApi.

$sel:stage:BasePathMapping', basePathMapping_stage - The name of the associated stage.

CreateDeployment

data CreateDeployment Source #

Requests API Gateway to create a Deployment resource.

See: newCreateDeployment smart constructor.

Constructors

CreateDeployment' (Maybe Bool) (Maybe CacheClusterSize) (Maybe DeploymentCanarySettings) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe (HashMap Text Text)) Text

Instances

Instances details

ToJSON CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods toJSON :: CreateDeployment -> Value # toEncoding :: CreateDeployment -> Encoding # toJSONList :: [CreateDeployment] -> Value # toEncodingList :: [CreateDeployment] -> Encoding #
ToHeaders CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods toHeaders :: CreateDeployment -> [Header] #
ToPath CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods toPath :: CreateDeployment -> ByteString #
ToQuery CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods toQuery :: CreateDeployment -> QueryString #
AWSRequest CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Associated Types type AWSResponse CreateDeployment # Methods request :: (Service -> Service) -> CreateDeployment -> Request CreateDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDeployment))) #
Generic CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Associated Types type Rep CreateDeployment :: Type -> Type # Methods from :: CreateDeployment -> Rep CreateDeployment x # to :: Rep CreateDeployment x -> CreateDeployment #
Read CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods readsPrec :: Int -> ReadS CreateDeployment # readList :: ReadS [CreateDeployment] # readPrec :: ReadPrec CreateDeployment # readListPrec :: ReadPrec [CreateDeployment] #
Show CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods showsPrec :: Int -> CreateDeployment -> ShowS # show :: CreateDeployment -> String # showList :: [CreateDeployment] -> ShowS #
NFData CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods rnf :: CreateDeployment -> () #
Eq CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods (==) :: CreateDeployment -> CreateDeployment -> Bool # (/=) :: CreateDeployment -> CreateDeployment -> Bool #
Hashable CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment Methods hashWithSalt :: Int -> CreateDeployment -> Int # hash :: CreateDeployment -> Int #
type AWSResponse CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment type AWSResponse CreateDeployment = Deployment
type Rep CreateDeployment Source #
Instance details Defined in Amazonka.APIGateway.CreateDeployment type Rep CreateDeployment = D1 ('MetaData "CreateDeployment" "Amazonka.APIGateway.CreateDeployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateDeployment'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheClusterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "cacheClusterSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterSize))) :: (S1 ('MetaSel ('Just "canarySettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeploymentCanarySettings)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "stageDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tracingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateDeployment Source #

Arguments

:: Text	`CreateDeployment`
-> CreateDeployment

Create a value of CreateDeployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDeployment, createDeployment_cacheClusterEnabled - Enables a cache cluster for the Stage resource specified in the input.

CreateDeployment, createDeployment_cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

CreateDeployment, createDeployment_canarySettings - The input configuration for the canary deployment when the deployment is a canary release deployment.

CreateDeployment, createDeployment_description - The description for the Deployment resource to create.

$sel:stageDescription:CreateDeployment', createDeployment_stageDescription - The description of the Stage resource for the Deployment resource to create.

CreateDeployment, createDeployment_stageName - The name of the Stage resource for the Deployment resource to create.

CreateDeployment, createDeployment_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

CreateDeployment, createDeployment_variables - A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

CreateDeployment, createDeployment_restApiId - The string identifier of the associated RestApi.

data Deployment Source #

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

See: newDeployment smart constructor.

Constructors

Deployment' (Maybe (HashMap Text (HashMap Text MethodSnapshot))) (Maybe POSIX) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods parseJSON :: Value -> Parser Deployment # parseJSONList :: Value -> Parser [Deployment] #
Generic Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Associated Types type Rep Deployment :: Type -> Type # Methods from :: Deployment -> Rep Deployment x # to :: Rep Deployment x -> Deployment #
Read Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods readsPrec :: Int -> ReadS Deployment # readList :: ReadS [Deployment] # readPrec :: ReadPrec Deployment # readListPrec :: ReadPrec [Deployment] #
Show Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods showsPrec :: Int -> Deployment -> ShowS # show :: Deployment -> String # showList :: [Deployment] -> ShowS #
NFData Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods rnf :: Deployment -> () #
Eq Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods (==) :: Deployment -> Deployment -> Bool # (/=) :: Deployment -> Deployment -> Bool #
Hashable Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods hashWithSalt :: Int -> Deployment -> Int # hash :: Deployment -> Int #
type Rep Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.APIGateway.Types.Deployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text MethodSnapshot)))) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDeployment :: Deployment Source #

Create a value of Deployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiSummary:Deployment', deployment_apiSummary - A summary of the RestApi at the date and time that the deployment resource was created.

$sel:createdDate:Deployment', deployment_createdDate - The date and time that the deployment resource was created.

$sel:description:Deployment', deployment_description - The description for the deployment resource.

$sel:id:Deployment', deployment_id - The identifier for the deployment resource.

CreateDocumentationPart

data CreateDocumentationPart Source #

Creates a new documentation part of a given API.

See: newCreateDocumentationPart smart constructor.

Constructors

CreateDocumentationPart' Text DocumentationPartLocation Text

Instances

Instances details

ToJSON CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Methods toJSON :: CreateDocumentationPart -> Value # toEncoding :: CreateDocumentationPart -> Encoding # toJSONList :: [CreateDocumentationPart] -> Value # toEncodingList :: [CreateDocumentationPart] -> Encoding #
ToHeaders CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Methods toHeaders :: CreateDocumentationPart -> [Header] #
ToPath CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Methods toPath :: CreateDocumentationPart -> ByteString #
ToQuery CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Methods toQuery :: CreateDocumentationPart -> QueryString #
AWSRequest CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Associated Types type AWSResponse CreateDocumentationPart # Methods request :: (Service -> Service) -> CreateDocumentationPart -> Request CreateDocumentationPart # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDocumentationPart -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDocumentationPart))) #
Generic CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Associated Types type Rep CreateDocumentationPart :: Type -> Type # Methods from :: CreateDocumentationPart -> Rep CreateDocumentationPart x # to :: Rep CreateDocumentationPart x -> CreateDocumentationPart #
Read CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Methods readsPrec :: Int -> ReadS CreateDocumentationPart # readList :: ReadS [CreateDocumentationPart] # readPrec :: ReadPrec CreateDocumentationPart # readListPrec :: ReadPrec [CreateDocumentationPart] #
Show CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Methods showsPrec :: Int -> CreateDocumentationPart -> ShowS # show :: CreateDocumentationPart -> String # showList :: [CreateDocumentationPart] -> ShowS #
NFData CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Methods rnf :: CreateDocumentationPart -> () #
Eq CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Methods (==) :: CreateDocumentationPart -> CreateDocumentationPart -> Bool # (/=) :: CreateDocumentationPart -> CreateDocumentationPart -> Bool #
Hashable CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart Methods hashWithSalt :: Int -> CreateDocumentationPart -> Int # hash :: CreateDocumentationPart -> Int #
type AWSResponse CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart type AWSResponse CreateDocumentationPart = DocumentationPart
type Rep CreateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationPart type Rep CreateDocumentationPart = D1 ('MetaData "CreateDocumentationPart" "Amazonka.APIGateway.CreateDocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateDocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentationPartLocation) :: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDocumentationPart Source #

Arguments

:: Text	`CreateDocumentationPart`
-> DocumentationPartLocation	`CreateDocumentationPart`
-> Text	`CreateDocumentationPart`
-> CreateDocumentationPart

Create a value of CreateDocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDocumentationPart, createDocumentationPart_restApiId - The string identifier of the associated RestApi.

CreateDocumentationPart, createDocumentationPart_location - The location of the targeted API entity of the to-be-created documentation part.

CreateDocumentationPart, createDocumentationPart_properties - The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only OpenAPI-compliant key-value pairs can be exported and, hence, published.

data DocumentationPart Source #

A documentation part for a targeted API entity.

See: newDocumentationPart smart constructor.

Constructors

DocumentationPart' (Maybe Text) (Maybe DocumentationPartLocation) (Maybe Text)

Instances

Instances details

FromJSON DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods parseJSON :: Value -> Parser DocumentationPart # parseJSONList :: Value -> Parser [DocumentationPart] #
Generic DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Associated Types type Rep DocumentationPart :: Type -> Type # Methods from :: DocumentationPart -> Rep DocumentationPart x # to :: Rep DocumentationPart x -> DocumentationPart #
Read DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods readsPrec :: Int -> ReadS DocumentationPart # readList :: ReadS [DocumentationPart] # readPrec :: ReadPrec DocumentationPart # readListPrec :: ReadPrec [DocumentationPart] #
Show DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods showsPrec :: Int -> DocumentationPart -> ShowS # show :: DocumentationPart -> String # showList :: [DocumentationPart] -> ShowS #
NFData DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods rnf :: DocumentationPart -> () #
Eq DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods (==) :: DocumentationPart -> DocumentationPart -> Bool # (/=) :: DocumentationPart -> DocumentationPart -> Bool #
Hashable DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods hashWithSalt :: Int -> DocumentationPart -> Int # hash :: DocumentationPart -> Int #
type Rep DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart type Rep DocumentationPart = D1 ('MetaData "DocumentationPart" "Amazonka.APIGateway.Types.DocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentationPartLocation)) :: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationPart :: DocumentationPart Source #

Create a value of DocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:DocumentationPart', documentationPart_id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

$sel:location:DocumentationPart', documentationPart_location - The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

$sel:properties:DocumentationPart', documentationPart_properties - A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

CreateDocumentationVersion

data CreateDocumentationVersion Source #

Creates a new documentation version of a given API.

See: newCreateDocumentationVersion smart constructor.

Constructors

CreateDocumentationVersion' (Maybe Text) (Maybe Text) Text Text

Instances

Instances details

ToJSON CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Methods toJSON :: CreateDocumentationVersion -> Value # toEncoding :: CreateDocumentationVersion -> Encoding # toJSONList :: [CreateDocumentationVersion] -> Value # toEncodingList :: [CreateDocumentationVersion] -> Encoding #
ToHeaders CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Methods toHeaders :: CreateDocumentationVersion -> [Header] #
ToPath CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Methods toPath :: CreateDocumentationVersion -> ByteString #
ToQuery CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Methods toQuery :: CreateDocumentationVersion -> QueryString #
AWSRequest CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Associated Types type AWSResponse CreateDocumentationVersion # Methods request :: (Service -> Service) -> CreateDocumentationVersion -> Request CreateDocumentationVersion # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDocumentationVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDocumentationVersion))) #
Generic CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Associated Types type Rep CreateDocumentationVersion :: Type -> Type # Methods from :: CreateDocumentationVersion -> Rep CreateDocumentationVersion x # to :: Rep CreateDocumentationVersion x -> CreateDocumentationVersion #
Read CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Methods readsPrec :: Int -> ReadS CreateDocumentationVersion # readList :: ReadS [CreateDocumentationVersion] # readPrec :: ReadPrec CreateDocumentationVersion # readListPrec :: ReadPrec [CreateDocumentationVersion] #
Show CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Methods showsPrec :: Int -> CreateDocumentationVersion -> ShowS # show :: CreateDocumentationVersion -> String # showList :: [CreateDocumentationVersion] -> ShowS #
NFData CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Methods rnf :: CreateDocumentationVersion -> () #
Eq CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Methods (==) :: CreateDocumentationVersion -> CreateDocumentationVersion -> Bool # (/=) :: CreateDocumentationVersion -> CreateDocumentationVersion -> Bool #
Hashable CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion Methods hashWithSalt :: Int -> CreateDocumentationVersion -> Int # hash :: CreateDocumentationVersion -> Int #
type AWSResponse CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion type AWSResponse CreateDocumentationVersion = DocumentationVersion
type Rep CreateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.CreateDocumentationVersion type Rep CreateDocumentationVersion = D1 ('MetaData "CreateDocumentationVersion" "Amazonka.APIGateway.CreateDocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateDocumentationVersion'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateDocumentationVersion Source #

Arguments

:: Text	`CreateDocumentationVersion`
-> Text	`CreateDocumentationVersion`
-> CreateDocumentationVersion

Create a value of CreateDocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDocumentationVersion, createDocumentationVersion_description - A description about the new documentation snapshot.

CreateDocumentationVersion, createDocumentationVersion_stageName - The stage name to be associated with the new documentation snapshot.

CreateDocumentationVersion, createDocumentationVersion_restApiId - The string identifier of the associated RestApi.

CreateDocumentationVersion, createDocumentationVersion_documentationVersion - The version identifier of the new snapshot.

data DocumentationVersion Source #

A snapshot of the documentation of an API.

See: newDocumentationVersion smart constructor.

Constructors

DocumentationVersion' (Maybe POSIX) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods parseJSON :: Value -> Parser DocumentationVersion # parseJSONList :: Value -> Parser [DocumentationVersion] #
Generic DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Associated Types type Rep DocumentationVersion :: Type -> Type # Methods from :: DocumentationVersion -> Rep DocumentationVersion x # to :: Rep DocumentationVersion x -> DocumentationVersion #
Read DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods readsPrec :: Int -> ReadS DocumentationVersion # readList :: ReadS [DocumentationVersion] # readPrec :: ReadPrec DocumentationVersion # readListPrec :: ReadPrec [DocumentationVersion] #
Show DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods showsPrec :: Int -> DocumentationVersion -> ShowS # show :: DocumentationVersion -> String # showList :: [DocumentationVersion] -> ShowS #
NFData DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods rnf :: DocumentationVersion -> () #
Eq DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods (==) :: DocumentationVersion -> DocumentationVersion -> Bool # (/=) :: DocumentationVersion -> DocumentationVersion -> Bool #
Hashable DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods hashWithSalt :: Int -> DocumentationVersion -> Int # hash :: DocumentationVersion -> Int #
type Rep DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion type Rep DocumentationVersion = D1 ('MetaData "DocumentationVersion" "Amazonka.APIGateway.Types.DocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationVersion :: DocumentationVersion Source #

Create a value of DocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdDate:DocumentationVersion', documentationVersion_createdDate - The date when the API documentation snapshot is created.

$sel:description:DocumentationVersion', documentationVersion_description - The description of the API documentation snapshot.

$sel:version:DocumentationVersion', documentationVersion_version - The version identifier of the API documentation snapshot.

CreateDomainName

data CreateDomainName Source #

A request to create a new domain name.

See: newCreateDomainName smart constructor.

Constructors

CreateDomainName' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthenticationInput) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text)) Text

Instances

Instances details

ToJSON CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Methods toJSON :: CreateDomainName -> Value # toEncoding :: CreateDomainName -> Encoding # toJSONList :: [CreateDomainName] -> Value # toEncodingList :: [CreateDomainName] -> Encoding #
ToHeaders CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Methods toHeaders :: CreateDomainName -> [Header] #
ToPath CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Methods toPath :: CreateDomainName -> ByteString #
ToQuery CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Methods toQuery :: CreateDomainName -> QueryString #
AWSRequest CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Associated Types type AWSResponse CreateDomainName # Methods request :: (Service -> Service) -> CreateDomainName -> Request CreateDomainName # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDomainName -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDomainName))) #
Generic CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Associated Types type Rep CreateDomainName :: Type -> Type # Methods from :: CreateDomainName -> Rep CreateDomainName x # to :: Rep CreateDomainName x -> CreateDomainName #
Read CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Methods readsPrec :: Int -> ReadS CreateDomainName # readList :: ReadS [CreateDomainName] # readPrec :: ReadPrec CreateDomainName # readListPrec :: ReadPrec [CreateDomainName] #
Show CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Methods showsPrec :: Int -> CreateDomainName -> ShowS # show :: CreateDomainName -> String # showList :: [CreateDomainName] -> ShowS #
NFData CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Methods rnf :: CreateDomainName -> () #
Eq CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Methods (==) :: CreateDomainName -> CreateDomainName -> Bool # (/=) :: CreateDomainName -> CreateDomainName -> Bool #
Hashable CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName Methods hashWithSalt :: Int -> CreateDomainName -> Int # hash :: CreateDomainName -> Int #
type AWSResponse CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName type AWSResponse CreateDomainName = DomainName
type Rep CreateDomainName Source #
Instance details Defined in Amazonka.APIGateway.CreateDomainName type Rep CreateDomainName = D1 ('MetaData "CreateDomainName" "Amazonka.APIGateway.CreateDomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateDomainName'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "certificateBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateChain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "certificatePrivateKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration))))) :: ((S1 ('MetaSel ('Just "mutualTlsAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MutualTlsAuthenticationInput)) :: (S1 ('MetaSel ('Just "ownershipVerificationCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "regionalCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityPolicy))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateDomainName Source #

Arguments

:: Text	`CreateDomainName`
-> CreateDomainName

Create a value of CreateDomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateDomainName, createDomainName_certificateArn - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

$sel:certificateBody:CreateDomainName', createDomainName_certificateBody - [Deprecated] The body of the server certificate that will be used by edge-optimized endpoint for this domain name provided by your certificate authority.

$sel:certificateChain:CreateDomainName', createDomainName_certificateChain - [Deprecated] The intermediate certificates and optionally the root certificate, one after the other without any blank lines, used by an edge-optimized endpoint for this domain name. If you include the root certificate, your certificate chain must start with intermediate certificates and end with the root certificate. Use the intermediate certificates that were provided by your certificate authority. Do not include any intermediaries that are not in the chain of trust path.

CreateDomainName, createDomainName_certificateName - The user-friendly name of the certificate that will be used by edge-optimized endpoint for this domain name.

$sel:certificatePrivateKey:CreateDomainName', createDomainName_certificatePrivateKey - [Deprecated] Your edge-optimized endpoint's domain name certificate's private key.

CreateDomainName, createDomainName_endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

CreateDomainName, createDomainName_mutualTlsAuthentication - Undocumented member.

CreateDomainName, createDomainName_ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

CreateDomainName, createDomainName_regionalCertificateArn - The reference to an AWS-managed certificate that will be used by regional endpoint for this domain name. AWS Certificate Manager is the only supported source.

CreateDomainName, createDomainName_regionalCertificateName - The user-friendly name of the certificate that will be used by regional endpoint for this domain name.

CreateDomainName, createDomainName_securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

CreateDomainName, createDomainName_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

CreateDomainName, createDomainName_domainName - The name of the DomainName resource.

data DomainName Source #

Represents a custom domain name as a user-friendly host name of an API (RestApi).

See: newDomainName smart constructor.

Constructors

DomainName' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text))

Instances

Instances details

FromJSON DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods parseJSON :: Value -> Parser DomainName # parseJSONList :: Value -> Parser [DomainName] #
Generic DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Associated Types type Rep DomainName :: Type -> Type # Methods from :: DomainName -> Rep DomainName x # to :: Rep DomainName x -> DomainName #
Read DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods readsPrec :: Int -> ReadS DomainName # readList :: ReadS [DomainName] # readPrec :: ReadPrec DomainName # readListPrec :: ReadPrec [DomainName] #
Show DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods showsPrec :: Int -> DomainName -> ShowS # show :: DomainName -> String # showList :: [DomainName] -> ShowS #
NFData DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods rnf :: DomainName -> () #
Eq DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods (==) :: DomainName -> DomainName -> Bool # (/=) :: DomainName -> DomainName -> Bool #
Hashable DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods hashWithSalt :: Int -> DomainName -> Int # hash :: DomainName -> Int #
type Rep DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName type Rep DomainName = D1 ('MetaData "DomainName" "Amazonka.APIGateway.Types.DomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DomainName'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "certificateUploadDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "distributionDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "distributionHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domainNameStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainNameStatus)) :: S1 ('MetaSel ('Just "domainNameStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration)) :: S1 ('MetaSel ('Just "mutualTlsAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MutualTlsAuthentication))) :: (S1 ('MetaSel ('Just "ownershipVerificationCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "regionalCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "regionalHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityPolicy)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))))

newDomainName :: DomainName Source #

Create a value of DomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:certificateArn:DomainName', domainName_certificateArn - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

$sel:certificateName:DomainName', domainName_certificateName - The name of the certificate that will be used by edge-optimized endpoint for this domain name.

$sel:certificateUploadDate:DomainName', domainName_certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

$sel:distributionDomainName:DomainName', domainName_distributionDomainName - The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

$sel:distributionHostedZoneId:DomainName', domainName_distributionHostedZoneId - The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:domainName:DomainName', domainName_domainName - The custom domain name as an API host name, for example, my-api.example.com.

$sel:domainNameStatus:DomainName', domainName_domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

$sel:domainNameStatusMessage:DomainName', domainName_domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.

$sel:endpointConfiguration:DomainName', domainName_endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

$sel:mutualTlsAuthentication:DomainName', domainName_mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

$sel:ownershipVerificationCertificateArn:DomainName', domainName_ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

$sel:regionalCertificateArn:DomainName', domainName_regionalCertificateArn - The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

$sel:regionalCertificateName:DomainName', domainName_regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.

$sel:regionalDomainName:DomainName', domainName_regionalDomainName - The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

$sel:regionalHostedZoneId:DomainName', domainName_regionalHostedZoneId - The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:securityPolicy:DomainName', domainName_securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

$sel:tags:DomainName', domainName_tags - The collection of tags. Each tag element is associated with a given resource.

CreateModel

data CreateModel Source #

Request to add a new Model to an existing RestApi resource.

See: newCreateModel smart constructor.

Constructors

CreateModel' (Maybe Text) (Maybe Text) Text Text Text

Instances

Instances details

ToJSON CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods toJSON :: CreateModel -> Value # toEncoding :: CreateModel -> Encoding # toJSONList :: [CreateModel] -> Value # toEncodingList :: [CreateModel] -> Encoding #
ToHeaders CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods toHeaders :: CreateModel -> [Header] #
ToPath CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods toPath :: CreateModel -> ByteString #
ToQuery CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods toQuery :: CreateModel -> QueryString #
AWSRequest CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Associated Types type AWSResponse CreateModel # Methods request :: (Service -> Service) -> CreateModel -> Request CreateModel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateModel))) #
Generic CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Associated Types type Rep CreateModel :: Type -> Type # Methods from :: CreateModel -> Rep CreateModel x # to :: Rep CreateModel x -> CreateModel #
Read CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods readsPrec :: Int -> ReadS CreateModel # readList :: ReadS [CreateModel] # readPrec :: ReadPrec CreateModel # readListPrec :: ReadPrec [CreateModel] #
Show CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods showsPrec :: Int -> CreateModel -> ShowS # show :: CreateModel -> String # showList :: [CreateModel] -> ShowS #
NFData CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods rnf :: CreateModel -> () #
Eq CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods (==) :: CreateModel -> CreateModel -> Bool # (/=) :: CreateModel -> CreateModel -> Bool #
Hashable CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel Methods hashWithSalt :: Int -> CreateModel -> Int # hash :: CreateModel -> Int #
type AWSResponse CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel type AWSResponse CreateModel = Model
type Rep CreateModel Source #
Instance details Defined in Amazonka.APIGateway.CreateModel type Rep CreateModel = D1 ('MetaData "CreateModel" "Amazonka.APIGateway.CreateModel" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateModel'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateModel Source #

Arguments

:: Text	`CreateModel`
-> Text	`CreateModel`
-> Text	`CreateModel`
-> CreateModel

Create a value of CreateModel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateModel, createModel_description - The description of the model.

CreateModel, createModel_schema - The schema for the model. For application/json models, this should be JSON schema draft 4 model.

CreateModel, createModel_restApiId - The RestApi identifier under which the Model will be created.

CreateModel, createModel_name - The name of the model. Must be alphanumeric.

CreateModel, createModel_contentType - The content-type for the model.

data Model Source #

Represents the data structure of a method's request or response payload.

See: newModel smart constructor.

Constructors

Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods parseJSON :: Value -> Parser Model # parseJSONList :: Value -> Parser [Model] #
Generic Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Associated Types type Rep Model :: Type -> Type # Methods from :: Model -> Rep Model x # to :: Rep Model x -> Model #
Read Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods readsPrec :: Int -> ReadS Model # readList :: ReadS [Model] # readPrec :: ReadPrec Model # readListPrec :: ReadPrec [Model] #
Show Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods showsPrec :: Int -> Model -> ShowS # show :: Model -> String # showList :: [Model] -> ShowS #
NFData Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods rnf :: Model -> () #
Eq Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #
Hashable Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods hashWithSalt :: Int -> Model -> Int # hash :: Model -> Int #
type Rep Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model type Rep Model = D1 ('MetaData "Model" "Amazonka.APIGateway.Types.Model" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Model'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newModel :: Model Source #

Create a value of Model with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentType:Model', model_contentType - The content-type for the model.

$sel:description:Model', model_description - The description of the model.

$sel:id:Model', model_id - The identifier for the model resource.

$sel:name:Model', model_name - The name of the model. Must be an alphanumeric string.

$sel:schema:Model', model_schema - The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

CreateRequestValidator

data CreateRequestValidator Source #

Creates a RequestValidator of a given RestApi.

See: newCreateRequestValidator smart constructor.

Constructors

CreateRequestValidator' (Maybe Text) (Maybe Bool) (Maybe Bool) Text

Instances

Instances details

ToJSON CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods toJSON :: CreateRequestValidator -> Value # toEncoding :: CreateRequestValidator -> Encoding # toJSONList :: [CreateRequestValidator] -> Value # toEncodingList :: [CreateRequestValidator] -> Encoding #
ToHeaders CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods toHeaders :: CreateRequestValidator -> [Header] #
ToPath CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods toPath :: CreateRequestValidator -> ByteString #
ToQuery CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods toQuery :: CreateRequestValidator -> QueryString #
AWSRequest CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Associated Types type AWSResponse CreateRequestValidator # Methods request :: (Service -> Service) -> CreateRequestValidator -> Request CreateRequestValidator # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateRequestValidator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRequestValidator))) #
Generic CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Associated Types type Rep CreateRequestValidator :: Type -> Type # Methods from :: CreateRequestValidator -> Rep CreateRequestValidator x # to :: Rep CreateRequestValidator x -> CreateRequestValidator #
Read CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods readsPrec :: Int -> ReadS CreateRequestValidator # readList :: ReadS [CreateRequestValidator] # readPrec :: ReadPrec CreateRequestValidator # readListPrec :: ReadPrec [CreateRequestValidator] #
Show CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods showsPrec :: Int -> CreateRequestValidator -> ShowS # show :: CreateRequestValidator -> String # showList :: [CreateRequestValidator] -> ShowS #
NFData CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods rnf :: CreateRequestValidator -> () #
Eq CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods (==) :: CreateRequestValidator -> CreateRequestValidator -> Bool # (/=) :: CreateRequestValidator -> CreateRequestValidator -> Bool #
Hashable CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator Methods hashWithSalt :: Int -> CreateRequestValidator -> Int # hash :: CreateRequestValidator -> Int #
type AWSResponse CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator type AWSResponse CreateRequestValidator = RequestValidator
type Rep CreateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.CreateRequestValidator type Rep CreateRequestValidator = D1 ('MetaData "CreateRequestValidator" "Amazonka.APIGateway.CreateRequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateRequestValidator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "validateRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "validateRequestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateRequestValidator Source #

Arguments

:: Text	`CreateRequestValidator`
-> CreateRequestValidator

Create a value of CreateRequestValidator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateRequestValidator, createRequestValidator_name - The name of the to-be-created RequestValidator.

CreateRequestValidator, createRequestValidator_validateRequestBody - A Boolean flag to indicate whether to validate request body according to the configured model schema for the method (true) or not (false).

CreateRequestValidator, createRequestValidator_validateRequestParameters - A Boolean flag to indicate whether to validate request parameters, true, or not false.

CreateRequestValidator, createRequestValidator_restApiId - The string identifier of the associated RestApi.

data RequestValidator Source #

A set of validation rules for incoming Method requests.

See: newRequestValidator smart constructor.

Constructors

RequestValidator' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool)

Instances

Instances details

FromJSON RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods parseJSON :: Value -> Parser RequestValidator # parseJSONList :: Value -> Parser [RequestValidator] #
Generic RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Associated Types type Rep RequestValidator :: Type -> Type # Methods from :: RequestValidator -> Rep RequestValidator x # to :: Rep RequestValidator x -> RequestValidator #
Read RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods readsPrec :: Int -> ReadS RequestValidator # readList :: ReadS [RequestValidator] # readPrec :: ReadPrec RequestValidator # readListPrec :: ReadPrec [RequestValidator] #
Show RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods showsPrec :: Int -> RequestValidator -> ShowS # show :: RequestValidator -> String # showList :: [RequestValidator] -> ShowS #
NFData RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods rnf :: RequestValidator -> () #
Eq RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods (==) :: RequestValidator -> RequestValidator -> Bool # (/=) :: RequestValidator -> RequestValidator -> Bool #
Hashable RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods hashWithSalt :: Int -> RequestValidator -> Int # hash :: RequestValidator -> Int #
type Rep RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator type Rep RequestValidator = D1 ('MetaData "RequestValidator" "Amazonka.APIGateway.Types.RequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RequestValidator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "validateRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "validateRequestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newRequestValidator :: RequestValidator Source #

Create a value of RequestValidator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:RequestValidator', requestValidator_id - The identifier of this RequestValidator.

$sel:name:RequestValidator', requestValidator_name - The name of this RequestValidator

$sel:validateRequestBody:RequestValidator', requestValidator_validateRequestBody - A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

$sel:validateRequestParameters:RequestValidator', requestValidator_validateRequestParameters - A Boolean flag to indicate whether to validate request parameters (true) or not (false).

CreateResource

data CreateResource Source #

Requests API Gateway to create a Resource resource.

See: newCreateResource smart constructor.

Constructors

CreateResource' Text Text Text

Instances

Instances details

ToJSON CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Methods toJSON :: CreateResource -> Value # toEncoding :: CreateResource -> Encoding # toJSONList :: [CreateResource] -> Value # toEncodingList :: [CreateResource] -> Encoding #
ToHeaders CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Methods toHeaders :: CreateResource -> [Header] #
ToPath CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Methods toPath :: CreateResource -> ByteString #
ToQuery CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Methods toQuery :: CreateResource -> QueryString #
AWSRequest CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Associated Types type AWSResponse CreateResource # Methods request :: (Service -> Service) -> CreateResource -> Request CreateResource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateResource))) #
Generic CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Associated Types type Rep CreateResource :: Type -> Type # Methods from :: CreateResource -> Rep CreateResource x # to :: Rep CreateResource x -> CreateResource #
Read CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Methods readsPrec :: Int -> ReadS CreateResource # readList :: ReadS [CreateResource] # readPrec :: ReadPrec CreateResource # readListPrec :: ReadPrec [CreateResource] #
Show CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Methods showsPrec :: Int -> CreateResource -> ShowS # show :: CreateResource -> String # showList :: [CreateResource] -> ShowS #
NFData CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Methods rnf :: CreateResource -> () #
Eq CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Methods (==) :: CreateResource -> CreateResource -> Bool # (/=) :: CreateResource -> CreateResource -> Bool #
Hashable CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource Methods hashWithSalt :: Int -> CreateResource -> Int # hash :: CreateResource -> Int #
type AWSResponse CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource type AWSResponse CreateResource = Resource
type Rep CreateResource Source #
Instance details Defined in Amazonka.APIGateway.CreateResource type Rep CreateResource = D1 ('MetaData "CreateResource" "Amazonka.APIGateway.CreateResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "pathPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateResource Source #

Arguments

:: Text	`CreateResource`
-> Text	`CreateResource`
-> Text	`CreateResource`
-> CreateResource

Create a value of CreateResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateResource, createResource_restApiId - The string identifier of the associated RestApi.

CreateResource, createResource_parentId - The parent resource's identifier.

CreateResource, createResource_pathPart - The last path segment for this resource.

data Resource Source #

Represents an API resource.

See: newResource smart constructor.

Constructors

Resource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Method))

Instances

Instances details

FromJSON Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods parseJSON :: Value -> Parser Resource # parseJSONList :: Value -> Parser [Resource] #
Generic Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Associated Types type Rep Resource :: Type -> Type # Methods from :: Resource -> Rep Resource x # to :: Rep Resource x -> Resource #
Read Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods readsPrec :: Int -> ReadS Resource # readList :: ReadS [Resource] # readPrec :: ReadPrec Resource # readListPrec :: ReadPrec [Resource] #
Show Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods showsPrec :: Int -> Resource -> ShowS # show :: Resource -> String # showList :: [Resource] -> ShowS #
NFData Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods rnf :: Resource -> () #
Eq Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods (==) :: Resource -> Resource -> Bool # (/=) :: Resource -> Resource -> Bool #
Hashable Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods hashWithSalt :: Int -> Resource -> Int # hash :: Resource -> Int #
type Rep Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource type Rep Resource = D1 ('MetaData "Resource" "Amazonka.APIGateway.Types.Resource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Resource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pathPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceMethods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Method)))))))

newResource :: Resource Source #

Create a value of Resource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:Resource', resource_id - The resource's identifier.

$sel:parentId:Resource', resource_parentId - The parent resource's identifier.

$sel:path:Resource', resource_path - The full path for this resource.

$sel:pathPart:Resource', resource_pathPart - The last path segment for this resource.

$sel:resourceMethods:Resource', resource_resourceMethods - Gets an API resource's method of a given HTTP verb.

CreateRestApi

data CreateRestApi Source #

The POST Request to add a new RestApi resource to your collection.

See: newCreateRestApi smart constructor.

Constructors

CreateRestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Int) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text

Instances

Instances details

ToJSON CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Methods toJSON :: CreateRestApi -> Value # toEncoding :: CreateRestApi -> Encoding # toJSONList :: [CreateRestApi] -> Value # toEncodingList :: [CreateRestApi] -> Encoding #
ToHeaders CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Methods toHeaders :: CreateRestApi -> [Header] #
ToPath CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Methods toPath :: CreateRestApi -> ByteString #
ToQuery CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Methods toQuery :: CreateRestApi -> QueryString #
AWSRequest CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Associated Types type AWSResponse CreateRestApi # Methods request :: (Service -> Service) -> CreateRestApi -> Request CreateRestApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateRestApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateRestApi))) #
Generic CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Associated Types type Rep CreateRestApi :: Type -> Type # Methods from :: CreateRestApi -> Rep CreateRestApi x # to :: Rep CreateRestApi x -> CreateRestApi #
Read CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Methods readsPrec :: Int -> ReadS CreateRestApi # readList :: ReadS [CreateRestApi] # readPrec :: ReadPrec CreateRestApi # readListPrec :: ReadPrec [CreateRestApi] #
Show CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Methods showsPrec :: Int -> CreateRestApi -> ShowS # show :: CreateRestApi -> String # showList :: [CreateRestApi] -> ShowS #
NFData CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Methods rnf :: CreateRestApi -> () #
Eq CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Methods (==) :: CreateRestApi -> CreateRestApi -> Bool # (/=) :: CreateRestApi -> CreateRestApi -> Bool #
Hashable CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi Methods hashWithSalt :: Int -> CreateRestApi -> Int # hash :: CreateRestApi -> Int #
type AWSResponse CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi type AWSResponse CreateRestApi = RestApi
type Rep CreateRestApi Source #
Instance details Defined in Amazonka.APIGateway.CreateRestApi type Rep CreateRestApi = D1 ('MetaData "CreateRestApi" "Amazonka.APIGateway.CreateRestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateRestApi'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiKeySourceType)) :: S1 ('MetaSel ('Just "binaryMediaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "cloneFrom") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration)) :: (S1 ('MetaSel ('Just "minimumCompressionSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateRestApi Source #

Arguments

:: Text	`CreateRestApi`
-> CreateRestApi

Create a value of CreateRestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateRestApi, createRestApi_apiKeySource - The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

CreateRestApi, createRestApi_binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

$sel:cloneFrom:CreateRestApi', createRestApi_cloneFrom - The ID of the RestApi that you want to clone from.

CreateRestApi, createRestApi_description - The description of the RestApi.

CreateRestApi, createRestApi_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint

CreateRestApi, createRestApi_endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

CreateRestApi, createRestApi_minimumCompressionSize - A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

CreateRestApi, createRestApi_policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

CreateRestApi, createRestApi_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

CreateRestApi, createRestApi_version - A version identifier for the API.

CreateRestApi, createRestApi_name - The name of the RestApi.

data RestApi Source #

Represents a REST API.

See: newRestApi smart constructor.

Constructors

RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])

Instances

Instances details

FromJSON RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods parseJSON :: Value -> Parser RestApi # parseJSONList :: Value -> Parser [RestApi] #
Generic RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Associated Types type Rep RestApi :: Type -> Type # Methods from :: RestApi -> Rep RestApi x # to :: Rep RestApi x -> RestApi #
Read RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods readsPrec :: Int -> ReadS RestApi # readList :: ReadS [RestApi] # readPrec :: ReadPrec RestApi # readListPrec :: ReadPrec [RestApi] #
Show RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods showsPrec :: Int -> RestApi -> ShowS # show :: RestApi -> String # showList :: [RestApi] -> ShowS #
NFData RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods rnf :: RestApi -> () #
Eq RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods (==) :: RestApi -> RestApi -> Bool # (/=) :: RestApi -> RestApi -> Bool #
Hashable RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods hashWithSalt :: Int -> RestApi -> Int # hash :: RestApi -> Int #
type Rep RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi type Rep RestApi = D1 ('MetaData "RestApi" "Amazonka.APIGateway.Types.RestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RestApi'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiKeySourceType)) :: (S1 ('MetaSel ('Just "binaryMediaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "minimumCompressionSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newRestApi :: RestApi Source #

Create a value of RestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeySource:RestApi', restApi_apiKeySource - The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

$sel:binaryMediaTypes:RestApi', restApi_binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

$sel:createdDate:RestApi', restApi_createdDate - The timestamp when the API was created.

$sel:description:RestApi', restApi_description - The API's description.

$sel:disableExecuteApiEndpoint:RestApi', restApi_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

$sel:endpointConfiguration:RestApi', restApi_endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

$sel:id:RestApi', restApi_id - The API's identifier. This identifier is unique across all of your APIs in API Gateway.

$sel:minimumCompressionSize:RestApi', restApi_minimumCompressionSize - A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

$sel:name:RestApi', restApi_name - The API's name.

$sel:policy:RestApi', restApi_policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

$sel:tags:RestApi', restApi_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:version:RestApi', restApi_version - A version identifier for the API.

$sel:warnings:RestApi', restApi_warnings - The warning messages reported when failonwarnings is turned on during API import.

CreateStage

data CreateStage Source #

Requests API Gateway to create a Stage resource.

See: newCreateStage smart constructor.

Constructors

CreateStage' (Maybe Bool) (Maybe CacheClusterSize) (Maybe CanarySettings) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) Text Text Text

Instances

Instances details

ToJSON CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Methods toJSON :: CreateStage -> Value # toEncoding :: CreateStage -> Encoding # toJSONList :: [CreateStage] -> Value # toEncodingList :: [CreateStage] -> Encoding #
ToHeaders CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Methods toHeaders :: CreateStage -> [Header] #
ToPath CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Methods toPath :: CreateStage -> ByteString #
ToQuery CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Methods toQuery :: CreateStage -> QueryString #
AWSRequest CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Associated Types type AWSResponse CreateStage # Methods request :: (Service -> Service) -> CreateStage -> Request CreateStage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateStage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStage))) #
Generic CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Associated Types type Rep CreateStage :: Type -> Type # Methods from :: CreateStage -> Rep CreateStage x # to :: Rep CreateStage x -> CreateStage #
Read CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Methods readsPrec :: Int -> ReadS CreateStage # readList :: ReadS [CreateStage] # readPrec :: ReadPrec CreateStage # readListPrec :: ReadPrec [CreateStage] #
Show CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Methods showsPrec :: Int -> CreateStage -> ShowS # show :: CreateStage -> String # showList :: [CreateStage] -> ShowS #
NFData CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Methods rnf :: CreateStage -> () #
Eq CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Methods (==) :: CreateStage -> CreateStage -> Bool # (/=) :: CreateStage -> CreateStage -> Bool #
Hashable CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage Methods hashWithSalt :: Int -> CreateStage -> Int # hash :: CreateStage -> Int #
type AWSResponse CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage type AWSResponse CreateStage = Stage
type Rep CreateStage Source #
Instance details Defined in Amazonka.APIGateway.CreateStage type Rep CreateStage = D1 ('MetaData "CreateStage" "Amazonka.APIGateway.CreateStage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateStage'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheClusterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "cacheClusterSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterSize))) :: (S1 ('MetaSel ('Just "canarySettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanarySettings)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "tracingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newCreateStage Source #

Arguments

:: Text	`CreateStage`
-> Text	`CreateStage`
-> Text	`CreateStage`
-> CreateStage

Create a value of CreateStage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateStage, createStage_cacheClusterEnabled - Whether cache clustering is enabled for the stage.

CreateStage, createStage_cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

CreateStage, createStage_canarySettings - The canary deployment settings of this stage.

CreateStage, createStage_description - The description of the Stage resource.

CreateStage, createStage_documentationVersion - The version of the associated API documentation.

CreateStage, createStage_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

CreateStage, createStage_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

CreateStage, createStage_variables - A map that defines the stage variables for the new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

CreateStage, createStage_restApiId - The string identifier of the associated RestApi.

CreateStage, createStage_stageName - The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

CreateStage, createStage_deploymentId - The identifier of the Deployment resource for the Stage resource.

data Stage Source #

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

See: newStage smart constructor.

Constructors

Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe CacheClusterSize) (Maybe CacheClusterStatus) (Maybe CanarySettings) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text MethodSetting)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text)

Instances

Instances details

FromJSON Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods parseJSON :: Value -> Parser Stage # parseJSONList :: Value -> Parser [Stage] #
Generic Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Associated Types type Rep Stage :: Type -> Type # Methods from :: Stage -> Rep Stage x # to :: Rep Stage x -> Stage #
Read Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods readsPrec :: Int -> ReadS Stage # readList :: ReadS [Stage] # readPrec :: ReadPrec Stage # readListPrec :: ReadPrec [Stage] #
Show Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods showsPrec :: Int -> Stage -> ShowS # show :: Stage -> String # showList :: [Stage] -> ShowS #
NFData Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods rnf :: Stage -> () #
Eq Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods (==) :: Stage -> Stage -> Bool # (/=) :: Stage -> Stage -> Bool #
Hashable Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods hashWithSalt :: Int -> Stage -> Int # hash :: Stage -> Int #
type Rep Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage type Rep Stage = D1 ('MetaData "Stage" "Amazonka.APIGateway.Types.Stage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Stage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :: S1 ('MetaSel ('Just "cacheClusterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "cacheClusterSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterSize)) :: S1 ('MetaSel ('Just "cacheClusterStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterStatus)))) :: ((S1 ('MetaSel ('Just "canarySettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanarySettings)) :: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "methodSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MethodSetting))))) :: ((S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "tracingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "webAclArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newStage :: Stage Source #

Create a value of Stage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessLogSettings:Stage', stage_accessLogSettings - Settings for logging access in this stage.

$sel:cacheClusterEnabled:Stage', stage_cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.

$sel:cacheClusterSize:Stage', stage_cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

$sel:cacheClusterStatus:Stage', stage_cacheClusterStatus - The status of the cache cluster for the stage, if enabled.

$sel:canarySettings:Stage', stage_canarySettings - Settings for the canary deployment in this stage.

$sel:clientCertificateId:Stage', stage_clientCertificateId - The identifier of a client certificate for an API stage.

$sel:createdDate:Stage', stage_createdDate - The timestamp when the stage was created.

Stage, stage_deploymentId - The identifier of the Deployment that the stage points to.

$sel:description:Stage', stage_description - The stage's description.

$sel:documentationVersion:Stage', stage_documentationVersion - The version of the associated API documentation.

$sel:lastUpdatedDate:Stage', stage_lastUpdatedDate - The timestamp when the stage last updated.

$sel:methodSettings:Stage', stage_methodSettings - A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

$sel:stageName:Stage', stage_stageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

$sel:tags:Stage', stage_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:tracingEnabled:Stage', stage_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

$sel:variables:Stage', stage_variables - A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

$sel:webAclArn:Stage', stage_webAclArn - The ARN of the WebAcl associated with the Stage.

CreateUsagePlan

data CreateUsagePlan Source #

The POST request to create a usage plan with the name, description, throttle limits and quota limits, as well as the associated API stages, specified in the payload.

See: newCreateUsagePlan smart constructor.

Constructors

CreateUsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings) Text

Instances

Instances details

ToJSON CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods toJSON :: CreateUsagePlan -> Value # toEncoding :: CreateUsagePlan -> Encoding # toJSONList :: [CreateUsagePlan] -> Value # toEncodingList :: [CreateUsagePlan] -> Encoding #
ToHeaders CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods toHeaders :: CreateUsagePlan -> [Header] #
ToPath CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods toPath :: CreateUsagePlan -> ByteString #
ToQuery CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods toQuery :: CreateUsagePlan -> QueryString #
AWSRequest CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Associated Types type AWSResponse CreateUsagePlan # Methods request :: (Service -> Service) -> CreateUsagePlan -> Request CreateUsagePlan # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUsagePlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUsagePlan))) #
Generic CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Associated Types type Rep CreateUsagePlan :: Type -> Type # Methods from :: CreateUsagePlan -> Rep CreateUsagePlan x # to :: Rep CreateUsagePlan x -> CreateUsagePlan #
Read CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods readsPrec :: Int -> ReadS CreateUsagePlan # readList :: ReadS [CreateUsagePlan] # readPrec :: ReadPrec CreateUsagePlan # readListPrec :: ReadPrec [CreateUsagePlan] #
Show CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods showsPrec :: Int -> CreateUsagePlan -> ShowS # show :: CreateUsagePlan -> String # showList :: [CreateUsagePlan] -> ShowS #
NFData CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods rnf :: CreateUsagePlan -> () #
Eq CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods (==) :: CreateUsagePlan -> CreateUsagePlan -> Bool # (/=) :: CreateUsagePlan -> CreateUsagePlan -> Bool #
Hashable CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan Methods hashWithSalt :: Int -> CreateUsagePlan -> Int # hash :: CreateUsagePlan -> Int #
type AWSResponse CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan type AWSResponse CreateUsagePlan = UsagePlan
type Rep CreateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlan type Rep CreateUsagePlan = D1 ('MetaData "CreateUsagePlan" "Amazonka.APIGateway.CreateUsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateUsagePlan'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiStage])) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "quota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaSettings)))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateUsagePlan Source #

Arguments

:: Text	`CreateUsagePlan`
-> CreateUsagePlan

Create a value of CreateUsagePlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateUsagePlan, createUsagePlan_apiStages - The associated API stages of the usage plan.

CreateUsagePlan, createUsagePlan_description - The description of the usage plan.

CreateUsagePlan, createUsagePlan_quota - The quota of the usage plan.

CreateUsagePlan, createUsagePlan_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

CreateUsagePlan, createUsagePlan_throttle - The throttling limits of the usage plan.

CreateUsagePlan, createUsagePlan_name - The name of the usage plan.

data UsagePlan Source #

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.

See: newUsagePlan smart constructor.

Constructors

UsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings)

Instances

Instances details

FromJSON UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods parseJSON :: Value -> Parser UsagePlan # parseJSONList :: Value -> Parser [UsagePlan] #
Generic UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Associated Types type Rep UsagePlan :: Type -> Type # Methods from :: UsagePlan -> Rep UsagePlan x # to :: Rep UsagePlan x -> UsagePlan #
Read UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods readsPrec :: Int -> ReadS UsagePlan # readList :: ReadS [UsagePlan] # readPrec :: ReadPrec UsagePlan # readListPrec :: ReadPrec [UsagePlan] #
Show UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods showsPrec :: Int -> UsagePlan -> ShowS # show :: UsagePlan -> String # showList :: [UsagePlan] -> ShowS #
NFData UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods rnf :: UsagePlan -> () #
Eq UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods (==) :: UsagePlan -> UsagePlan -> Bool # (/=) :: UsagePlan -> UsagePlan -> Bool #
Hashable UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods hashWithSalt :: Int -> UsagePlan -> Int # hash :: UsagePlan -> Int #
type Rep UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan type Rep UsagePlan = D1 ('MetaData "UsagePlan" "Amazonka.APIGateway.Types.UsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UsagePlan'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiStage])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "quota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaSettings))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings))))))

newUsagePlan :: UsagePlan Source #

Create a value of UsagePlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiStages:UsagePlan', usagePlan_apiStages - The associated API stages of a usage plan.

$sel:description:UsagePlan', usagePlan_description - The description of a usage plan.

$sel:id:UsagePlan', usagePlan_id - The identifier of a UsagePlan resource.

$sel:name:UsagePlan', usagePlan_name - The name of a usage plan.

$sel:productCode:UsagePlan', usagePlan_productCode - The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

$sel:quota:UsagePlan', usagePlan_quota - The target maximum number of permitted requests per a given unit time interval.

$sel:tags:UsagePlan', usagePlan_tags - The collection of tags. Each tag element is associated with a given resource.

UsagePlan, usagePlan_throttle - A map containing method level throttling information for API stage in a usage plan.

CreateUsagePlanKey

data CreateUsagePlanKey Source #

The POST request to create a usage plan key for adding an existing API key to a usage plan.

See: newCreateUsagePlanKey smart constructor.

Constructors

CreateUsagePlanKey' Text Text Text

Instances

Instances details

ToJSON CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Methods toJSON :: CreateUsagePlanKey -> Value # toEncoding :: CreateUsagePlanKey -> Encoding # toJSONList :: [CreateUsagePlanKey] -> Value # toEncodingList :: [CreateUsagePlanKey] -> Encoding #
ToHeaders CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Methods toHeaders :: CreateUsagePlanKey -> [Header] #
ToPath CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Methods toPath :: CreateUsagePlanKey -> ByteString #
ToQuery CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Methods toQuery :: CreateUsagePlanKey -> QueryString #
AWSRequest CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Associated Types type AWSResponse CreateUsagePlanKey # Methods request :: (Service -> Service) -> CreateUsagePlanKey -> Request CreateUsagePlanKey # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUsagePlanKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUsagePlanKey))) #
Generic CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Associated Types type Rep CreateUsagePlanKey :: Type -> Type # Methods from :: CreateUsagePlanKey -> Rep CreateUsagePlanKey x # to :: Rep CreateUsagePlanKey x -> CreateUsagePlanKey #
Read CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Methods readsPrec :: Int -> ReadS CreateUsagePlanKey # readList :: ReadS [CreateUsagePlanKey] # readPrec :: ReadPrec CreateUsagePlanKey # readListPrec :: ReadPrec [CreateUsagePlanKey] #
Show CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Methods showsPrec :: Int -> CreateUsagePlanKey -> ShowS # show :: CreateUsagePlanKey -> String # showList :: [CreateUsagePlanKey] -> ShowS #
NFData CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Methods rnf :: CreateUsagePlanKey -> () #
Eq CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Methods (==) :: CreateUsagePlanKey -> CreateUsagePlanKey -> Bool # (/=) :: CreateUsagePlanKey -> CreateUsagePlanKey -> Bool #
Hashable CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey Methods hashWithSalt :: Int -> CreateUsagePlanKey -> Int # hash :: CreateUsagePlanKey -> Int #
type AWSResponse CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey type AWSResponse CreateUsagePlanKey = UsagePlanKey
type Rep CreateUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.CreateUsagePlanKey type Rep CreateUsagePlanKey = D1 ('MetaData "CreateUsagePlanKey" "Amazonka.APIGateway.CreateUsagePlanKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateUsagePlanKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "keyType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateUsagePlanKey Source #

Arguments

:: Text	`CreateUsagePlanKey`
-> Text	`$sel:keyId:CreateUsagePlanKey'`
-> Text	`$sel:keyType:CreateUsagePlanKey'`
-> CreateUsagePlanKey

Create a value of CreateUsagePlanKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateUsagePlanKey, createUsagePlanKey_usagePlanId - The Id of the UsagePlan resource representing the usage plan containing the to-be-created UsagePlanKey resource representing a plan customer.

$sel:keyId:CreateUsagePlanKey', createUsagePlanKey_keyId - The identifier of a UsagePlanKey resource for a plan customer.

$sel:keyType:CreateUsagePlanKey', createUsagePlanKey_keyType - The type of a UsagePlanKey resource for a plan customer.

data UsagePlanKey Source #

Represents a usage plan key to identify a plan customer.

See: newUsagePlanKey smart constructor.

Constructors

UsagePlanKey' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods parseJSON :: Value -> Parser UsagePlanKey # parseJSONList :: Value -> Parser [UsagePlanKey] #
Generic UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Associated Types type Rep UsagePlanKey :: Type -> Type # Methods from :: UsagePlanKey -> Rep UsagePlanKey x # to :: Rep UsagePlanKey x -> UsagePlanKey #
Read UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods readsPrec :: Int -> ReadS UsagePlanKey # readList :: ReadS [UsagePlanKey] # readPrec :: ReadPrec UsagePlanKey # readListPrec :: ReadPrec [UsagePlanKey] #
Show UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods showsPrec :: Int -> UsagePlanKey -> ShowS # show :: UsagePlanKey -> String # showList :: [UsagePlanKey] -> ShowS #
NFData UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods rnf :: UsagePlanKey -> () #
Eq UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods (==) :: UsagePlanKey -> UsagePlanKey -> Bool # (/=) :: UsagePlanKey -> UsagePlanKey -> Bool #
Hashable UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods hashWithSalt :: Int -> UsagePlanKey -> Int # hash :: UsagePlanKey -> Int #
type Rep UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey type Rep UsagePlanKey = D1 ('MetaData "UsagePlanKey" "Amazonka.APIGateway.Types.UsagePlanKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UsagePlanKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newUsagePlanKey :: UsagePlanKey Source #

Create a value of UsagePlanKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:UsagePlanKey', usagePlanKey_id - The Id of a usage plan key.

$sel:name:UsagePlanKey', usagePlanKey_name - The name of a usage plan key.

$sel:type':UsagePlanKey', usagePlanKey_type - The type of a usage plan key. Currently, the valid key type is API_KEY.

$sel:value:UsagePlanKey', usagePlanKey_value - The value of a usage plan key.

CreateVpcLink

data CreateVpcLink Source #

Creates a VPC link, under the caller's account in a selected region, in an asynchronous operation that typically takes 2-4 minutes to complete and become operational. The caller must have permissions to create and update VPC Endpoint services.

See: newCreateVpcLink smart constructor.

Constructors

CreateVpcLink' (Maybe Text) (Maybe (HashMap Text Text)) Text [Text]

Instances

Instances details

ToJSON CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Methods toJSON :: CreateVpcLink -> Value # toEncoding :: CreateVpcLink -> Encoding # toJSONList :: [CreateVpcLink] -> Value # toEncodingList :: [CreateVpcLink] -> Encoding #
ToHeaders CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Methods toHeaders :: CreateVpcLink -> [Header] #
ToPath CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Methods toPath :: CreateVpcLink -> ByteString #
ToQuery CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Methods toQuery :: CreateVpcLink -> QueryString #
AWSRequest CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Associated Types type AWSResponse CreateVpcLink # Methods request :: (Service -> Service) -> CreateVpcLink -> Request CreateVpcLink # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateVpcLink -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateVpcLink))) #
Generic CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Associated Types type Rep CreateVpcLink :: Type -> Type # Methods from :: CreateVpcLink -> Rep CreateVpcLink x # to :: Rep CreateVpcLink x -> CreateVpcLink #
Read CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Methods readsPrec :: Int -> ReadS CreateVpcLink # readList :: ReadS [CreateVpcLink] # readPrec :: ReadPrec CreateVpcLink # readListPrec :: ReadPrec [CreateVpcLink] #
Show CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Methods showsPrec :: Int -> CreateVpcLink -> ShowS # show :: CreateVpcLink -> String # showList :: [CreateVpcLink] -> ShowS #
NFData CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Methods rnf :: CreateVpcLink -> () #
Eq CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Methods (==) :: CreateVpcLink -> CreateVpcLink -> Bool # (/=) :: CreateVpcLink -> CreateVpcLink -> Bool #
Hashable CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink Methods hashWithSalt :: Int -> CreateVpcLink -> Int # hash :: CreateVpcLink -> Int #
type AWSResponse CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink type AWSResponse CreateVpcLink = VpcLink
type Rep CreateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.CreateVpcLink type Rep CreateVpcLink = D1 ('MetaData "CreateVpcLink" "Amazonka.APIGateway.CreateVpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CreateVpcLink'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "targetArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))))

newCreateVpcLink Source #

Arguments

:: Text	`CreateVpcLink`
-> CreateVpcLink

Create a value of CreateVpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

CreateVpcLink, createVpcLink_description - The description of the VPC link.

CreateVpcLink, createVpcLink_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

CreateVpcLink, createVpcLink_name - The name used to label and identify the VPC link.

CreateVpcLink, createVpcLink_targetArns - The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

data VpcLink Source #

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

See: newVpcLink smart constructor.

Constructors

VpcLink' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text])

Instances

Instances details

FromJSON VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods parseJSON :: Value -> Parser VpcLink # parseJSONList :: Value -> Parser [VpcLink] #
Generic VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Associated Types type Rep VpcLink :: Type -> Type # Methods from :: VpcLink -> Rep VpcLink x # to :: Rep VpcLink x -> VpcLink #
Read VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods readsPrec :: Int -> ReadS VpcLink # readList :: ReadS [VpcLink] # readPrec :: ReadPrec VpcLink # readListPrec :: ReadPrec [VpcLink] #
Show VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods showsPrec :: Int -> VpcLink -> ShowS # show :: VpcLink -> String # showList :: [VpcLink] -> ShowS #
NFData VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods rnf :: VpcLink -> () #
Eq VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods (==) :: VpcLink -> VpcLink -> Bool # (/=) :: VpcLink -> VpcLink -> Bool #
Hashable VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods hashWithSalt :: Int -> VpcLink -> Int # hash :: VpcLink -> Int #
type Rep VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink type Rep VpcLink = D1 ('MetaData "VpcLink" "Amazonka.APIGateway.Types.VpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "VpcLink'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcLinkStatus)) :: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "targetArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newVpcLink :: VpcLink Source #

Create a value of VpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:VpcLink', vpcLink_description - The description of the VPC link.

$sel:id:VpcLink', vpcLink_id - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

$sel:name:VpcLink', vpcLink_name - The name used to label and identify the VPC link.

$sel:status:VpcLink', vpcLink_status - The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

$sel:statusMessage:VpcLink', vpcLink_statusMessage - A description about the VPC link status.

$sel:tags:VpcLink', vpcLink_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:targetArns:VpcLink', vpcLink_targetArns - The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

DeleteApiKey

data DeleteApiKey Source #

A request to delete the ApiKey resource.

See: newDeleteApiKey smart constructor.

Constructors

DeleteApiKey' Text

Instances

Instances details

ToHeaders DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods toHeaders :: DeleteApiKey -> [Header] #
ToPath DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods toPath :: DeleteApiKey -> ByteString #
ToQuery DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods toQuery :: DeleteApiKey -> QueryString #
AWSRequest DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Associated Types type AWSResponse DeleteApiKey # Methods request :: (Service -> Service) -> DeleteApiKey -> Request DeleteApiKey # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteApiKey))) #
Generic DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Associated Types type Rep DeleteApiKey :: Type -> Type # Methods from :: DeleteApiKey -> Rep DeleteApiKey x # to :: Rep DeleteApiKey x -> DeleteApiKey #
Read DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods readsPrec :: Int -> ReadS DeleteApiKey # readList :: ReadS [DeleteApiKey] # readPrec :: ReadPrec DeleteApiKey # readListPrec :: ReadPrec [DeleteApiKey] #
Show DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods showsPrec :: Int -> DeleteApiKey -> ShowS # show :: DeleteApiKey -> String # showList :: [DeleteApiKey] -> ShowS #
NFData DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods rnf :: DeleteApiKey -> () #
Eq DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods (==) :: DeleteApiKey -> DeleteApiKey -> Bool # (/=) :: DeleteApiKey -> DeleteApiKey -> Bool #
Hashable DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods hashWithSalt :: Int -> DeleteApiKey -> Int # hash :: DeleteApiKey -> Int #
type AWSResponse DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey type AWSResponse DeleteApiKey = DeleteApiKeyResponse
type Rep DeleteApiKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey type Rep DeleteApiKey = D1 ('MetaData "DeleteApiKey" "Amazonka.APIGateway.DeleteApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteApiKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteApiKey Source #

Arguments

:: Text	`$sel:apiKey:DeleteApiKey'`
-> DeleteApiKey

Create a value of DeleteApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKey:DeleteApiKey', deleteApiKey_apiKey - The identifier of the ApiKey resource to be deleted.

data DeleteApiKeyResponse Source #

See: newDeleteApiKeyResponse smart constructor.

Constructors

DeleteApiKeyResponse'

Instances

Instances details

Generic DeleteApiKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Associated Types type Rep DeleteApiKeyResponse :: Type -> Type # Methods from :: DeleteApiKeyResponse -> Rep DeleteApiKeyResponse x # to :: Rep DeleteApiKeyResponse x -> DeleteApiKeyResponse #
Read DeleteApiKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods readsPrec :: Int -> ReadS DeleteApiKeyResponse # readList :: ReadS [DeleteApiKeyResponse] # readPrec :: ReadPrec DeleteApiKeyResponse # readListPrec :: ReadPrec [DeleteApiKeyResponse] #
Show DeleteApiKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods showsPrec :: Int -> DeleteApiKeyResponse -> ShowS # show :: DeleteApiKeyResponse -> String # showList :: [DeleteApiKeyResponse] -> ShowS #
NFData DeleteApiKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods rnf :: DeleteApiKeyResponse -> () #
Eq DeleteApiKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey Methods (==) :: DeleteApiKeyResponse -> DeleteApiKeyResponse -> Bool # (/=) :: DeleteApiKeyResponse -> DeleteApiKeyResponse -> Bool #
type Rep DeleteApiKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteApiKey type Rep DeleteApiKeyResponse = D1 ('MetaData "DeleteApiKeyResponse" "Amazonka.APIGateway.DeleteApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteApiKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteApiKeyResponse :: DeleteApiKeyResponse Source #

Create a value of DeleteApiKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteAuthorizer

data DeleteAuthorizer Source #

Request to delete an existing Authorizer resource.

See: newDeleteAuthorizer smart constructor.

Constructors

DeleteAuthorizer' Text Text

Instances

Instances details

ToHeaders DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods toHeaders :: DeleteAuthorizer -> [Header] #
ToPath DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods toPath :: DeleteAuthorizer -> ByteString #
ToQuery DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods toQuery :: DeleteAuthorizer -> QueryString #
AWSRequest DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Associated Types type AWSResponse DeleteAuthorizer # Methods request :: (Service -> Service) -> DeleteAuthorizer -> Request DeleteAuthorizer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteAuthorizer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteAuthorizer))) #
Generic DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Associated Types type Rep DeleteAuthorizer :: Type -> Type # Methods from :: DeleteAuthorizer -> Rep DeleteAuthorizer x # to :: Rep DeleteAuthorizer x -> DeleteAuthorizer #
Read DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods readsPrec :: Int -> ReadS DeleteAuthorizer # readList :: ReadS [DeleteAuthorizer] # readPrec :: ReadPrec DeleteAuthorizer # readListPrec :: ReadPrec [DeleteAuthorizer] #
Show DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods showsPrec :: Int -> DeleteAuthorizer -> ShowS # show :: DeleteAuthorizer -> String # showList :: [DeleteAuthorizer] -> ShowS #
NFData DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods rnf :: DeleteAuthorizer -> () #
Eq DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods (==) :: DeleteAuthorizer -> DeleteAuthorizer -> Bool # (/=) :: DeleteAuthorizer -> DeleteAuthorizer -> Bool #
Hashable DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods hashWithSalt :: Int -> DeleteAuthorizer -> Int # hash :: DeleteAuthorizer -> Int #
type AWSResponse DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer type AWSResponse DeleteAuthorizer = DeleteAuthorizerResponse
type Rep DeleteAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer type Rep DeleteAuthorizer = D1 ('MetaData "DeleteAuthorizer" "Amazonka.APIGateway.DeleteAuthorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteAuthorizer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteAuthorizer Source #

Arguments

:: Text	`DeleteAuthorizer`
-> Text	`DeleteAuthorizer`
-> DeleteAuthorizer

Create a value of DeleteAuthorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteAuthorizer, deleteAuthorizer_restApiId - The string identifier of the associated RestApi.

DeleteAuthorizer, deleteAuthorizer_authorizerId - The identifier of the Authorizer resource.

data DeleteAuthorizerResponse Source #

See: newDeleteAuthorizerResponse smart constructor.

Constructors

DeleteAuthorizerResponse'

Instances

Instances details

Generic DeleteAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Associated Types type Rep DeleteAuthorizerResponse :: Type -> Type # Methods from :: DeleteAuthorizerResponse -> Rep DeleteAuthorizerResponse x # to :: Rep DeleteAuthorizerResponse x -> DeleteAuthorizerResponse #
Read DeleteAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods readsPrec :: Int -> ReadS DeleteAuthorizerResponse # readList :: ReadS [DeleteAuthorizerResponse] # readPrec :: ReadPrec DeleteAuthorizerResponse # readListPrec :: ReadPrec [DeleteAuthorizerResponse] #
Show DeleteAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods showsPrec :: Int -> DeleteAuthorizerResponse -> ShowS # show :: DeleteAuthorizerResponse -> String # showList :: [DeleteAuthorizerResponse] -> ShowS #
NFData DeleteAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods rnf :: DeleteAuthorizerResponse -> () #
Eq DeleteAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer Methods (==) :: DeleteAuthorizerResponse -> DeleteAuthorizerResponse -> Bool # (/=) :: DeleteAuthorizerResponse -> DeleteAuthorizerResponse -> Bool #
type Rep DeleteAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteAuthorizer type Rep DeleteAuthorizerResponse = D1 ('MetaData "DeleteAuthorizerResponse" "Amazonka.APIGateway.DeleteAuthorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteAuthorizerResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteAuthorizerResponse :: DeleteAuthorizerResponse Source #

Create a value of DeleteAuthorizerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteBasePathMapping

data DeleteBasePathMapping Source #

A request to delete the BasePathMapping resource.

See: newDeleteBasePathMapping smart constructor.

Constructors

DeleteBasePathMapping' Text Text

Instances

Instances details

ToHeaders DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods toHeaders :: DeleteBasePathMapping -> [Header] #
ToPath DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods toPath :: DeleteBasePathMapping -> ByteString #
ToQuery DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods toQuery :: DeleteBasePathMapping -> QueryString #
AWSRequest DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Associated Types type AWSResponse DeleteBasePathMapping # Methods request :: (Service -> Service) -> DeleteBasePathMapping -> Request DeleteBasePathMapping # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteBasePathMapping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteBasePathMapping))) #
Generic DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Associated Types type Rep DeleteBasePathMapping :: Type -> Type # Methods from :: DeleteBasePathMapping -> Rep DeleteBasePathMapping x # to :: Rep DeleteBasePathMapping x -> DeleteBasePathMapping #
Read DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods readsPrec :: Int -> ReadS DeleteBasePathMapping # readList :: ReadS [DeleteBasePathMapping] # readPrec :: ReadPrec DeleteBasePathMapping # readListPrec :: ReadPrec [DeleteBasePathMapping] #
Show DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods showsPrec :: Int -> DeleteBasePathMapping -> ShowS # show :: DeleteBasePathMapping -> String # showList :: [DeleteBasePathMapping] -> ShowS #
NFData DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods rnf :: DeleteBasePathMapping -> () #
Eq DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods (==) :: DeleteBasePathMapping -> DeleteBasePathMapping -> Bool # (/=) :: DeleteBasePathMapping -> DeleteBasePathMapping -> Bool #
Hashable DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods hashWithSalt :: Int -> DeleteBasePathMapping -> Int # hash :: DeleteBasePathMapping -> Int #
type AWSResponse DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping type AWSResponse DeleteBasePathMapping = DeleteBasePathMappingResponse
type Rep DeleteBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping type Rep DeleteBasePathMapping = D1 ('MetaData "DeleteBasePathMapping" "Amazonka.APIGateway.DeleteBasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteBasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteBasePathMapping Source #

Arguments

:: Text	`DeleteBasePathMapping`
-> Text	`DeleteBasePathMapping`
-> DeleteBasePathMapping

Create a value of DeleteBasePathMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteBasePathMapping, deleteBasePathMapping_domainName - The domain name of the BasePathMapping resource to delete.

DeleteBasePathMapping, deleteBasePathMapping_basePath - The base path name of the BasePathMapping resource to delete.

To specify an empty base path, set this parameter to '(none)'.

data DeleteBasePathMappingResponse Source #

See: newDeleteBasePathMappingResponse smart constructor.

Constructors

DeleteBasePathMappingResponse'

Instances

Instances details

Generic DeleteBasePathMappingResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Associated Types type Rep DeleteBasePathMappingResponse :: Type -> Type # Methods from :: DeleteBasePathMappingResponse -> Rep DeleteBasePathMappingResponse x # to :: Rep DeleteBasePathMappingResponse x -> DeleteBasePathMappingResponse #
Read DeleteBasePathMappingResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods readsPrec :: Int -> ReadS DeleteBasePathMappingResponse # readList :: ReadS [DeleteBasePathMappingResponse] # readPrec :: ReadPrec DeleteBasePathMappingResponse # readListPrec :: ReadPrec [DeleteBasePathMappingResponse] #
Show DeleteBasePathMappingResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods showsPrec :: Int -> DeleteBasePathMappingResponse -> ShowS # show :: DeleteBasePathMappingResponse -> String # showList :: [DeleteBasePathMappingResponse] -> ShowS #
NFData DeleteBasePathMappingResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods rnf :: DeleteBasePathMappingResponse -> () #
Eq DeleteBasePathMappingResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping Methods (==) :: DeleteBasePathMappingResponse -> DeleteBasePathMappingResponse -> Bool # (/=) :: DeleteBasePathMappingResponse -> DeleteBasePathMappingResponse -> Bool #
type Rep DeleteBasePathMappingResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteBasePathMapping type Rep DeleteBasePathMappingResponse = D1 ('MetaData "DeleteBasePathMappingResponse" "Amazonka.APIGateway.DeleteBasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteBasePathMappingResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteBasePathMappingResponse :: DeleteBasePathMappingResponse Source #

Create a value of DeleteBasePathMappingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteClientCertificate

data DeleteClientCertificate Source #

A request to delete the ClientCertificate resource.

See: newDeleteClientCertificate smart constructor.

Constructors

DeleteClientCertificate' Text

Instances

Instances details

ToHeaders DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods toHeaders :: DeleteClientCertificate -> [Header] #
ToPath DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods toPath :: DeleteClientCertificate -> ByteString #
ToQuery DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods toQuery :: DeleteClientCertificate -> QueryString #
AWSRequest DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Associated Types type AWSResponse DeleteClientCertificate # Methods request :: (Service -> Service) -> DeleteClientCertificate -> Request DeleteClientCertificate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteClientCertificate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteClientCertificate))) #
Generic DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Associated Types type Rep DeleteClientCertificate :: Type -> Type # Methods from :: DeleteClientCertificate -> Rep DeleteClientCertificate x # to :: Rep DeleteClientCertificate x -> DeleteClientCertificate #
Read DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods readsPrec :: Int -> ReadS DeleteClientCertificate # readList :: ReadS [DeleteClientCertificate] # readPrec :: ReadPrec DeleteClientCertificate # readListPrec :: ReadPrec [DeleteClientCertificate] #
Show DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods showsPrec :: Int -> DeleteClientCertificate -> ShowS # show :: DeleteClientCertificate -> String # showList :: [DeleteClientCertificate] -> ShowS #
NFData DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods rnf :: DeleteClientCertificate -> () #
Eq DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods (==) :: DeleteClientCertificate -> DeleteClientCertificate -> Bool # (/=) :: DeleteClientCertificate -> DeleteClientCertificate -> Bool #
Hashable DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods hashWithSalt :: Int -> DeleteClientCertificate -> Int # hash :: DeleteClientCertificate -> Int #
type AWSResponse DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate type AWSResponse DeleteClientCertificate = DeleteClientCertificateResponse
type Rep DeleteClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate type Rep DeleteClientCertificate = D1 ('MetaData "DeleteClientCertificate" "Amazonka.APIGateway.DeleteClientCertificate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteClientCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteClientCertificate Source #

Arguments

:: Text	`DeleteClientCertificate`
-> DeleteClientCertificate

Create a value of DeleteClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteClientCertificate, deleteClientCertificate_clientCertificateId - The identifier of the ClientCertificate resource to be deleted.

data DeleteClientCertificateResponse Source #

See: newDeleteClientCertificateResponse smart constructor.

Constructors

DeleteClientCertificateResponse'

Instances

Instances details

Generic DeleteClientCertificateResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Associated Types type Rep DeleteClientCertificateResponse :: Type -> Type # Methods from :: DeleteClientCertificateResponse -> Rep DeleteClientCertificateResponse x # to :: Rep DeleteClientCertificateResponse x -> DeleteClientCertificateResponse #
Read DeleteClientCertificateResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods readsPrec :: Int -> ReadS DeleteClientCertificateResponse # readList :: ReadS [DeleteClientCertificateResponse] # readPrec :: ReadPrec DeleteClientCertificateResponse # readListPrec :: ReadPrec [DeleteClientCertificateResponse] #
Show DeleteClientCertificateResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods showsPrec :: Int -> DeleteClientCertificateResponse -> ShowS # show :: DeleteClientCertificateResponse -> String # showList :: [DeleteClientCertificateResponse] -> ShowS #
NFData DeleteClientCertificateResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods rnf :: DeleteClientCertificateResponse -> () #
Eq DeleteClientCertificateResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate Methods (==) :: DeleteClientCertificateResponse -> DeleteClientCertificateResponse -> Bool # (/=) :: DeleteClientCertificateResponse -> DeleteClientCertificateResponse -> Bool #
type Rep DeleteClientCertificateResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteClientCertificate type Rep DeleteClientCertificateResponse = D1 ('MetaData "DeleteClientCertificateResponse" "Amazonka.APIGateway.DeleteClientCertificate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteClientCertificateResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteClientCertificateResponse :: DeleteClientCertificateResponse Source #

Create a value of DeleteClientCertificateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteDeployment

data DeleteDeployment Source #

Requests API Gateway to delete a Deployment resource.

See: newDeleteDeployment smart constructor.

Constructors

DeleteDeployment' Text Text

Instances

Instances details

ToHeaders DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods toHeaders :: DeleteDeployment -> [Header] #
ToPath DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods toPath :: DeleteDeployment -> ByteString #
ToQuery DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods toQuery :: DeleteDeployment -> QueryString #
AWSRequest DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Associated Types type AWSResponse DeleteDeployment # Methods request :: (Service -> Service) -> DeleteDeployment -> Request DeleteDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDeployment))) #
Generic DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Associated Types type Rep DeleteDeployment :: Type -> Type # Methods from :: DeleteDeployment -> Rep DeleteDeployment x # to :: Rep DeleteDeployment x -> DeleteDeployment #
Read DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods readsPrec :: Int -> ReadS DeleteDeployment # readList :: ReadS [DeleteDeployment] # readPrec :: ReadPrec DeleteDeployment # readListPrec :: ReadPrec [DeleteDeployment] #
Show DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods showsPrec :: Int -> DeleteDeployment -> ShowS # show :: DeleteDeployment -> String # showList :: [DeleteDeployment] -> ShowS #
NFData DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods rnf :: DeleteDeployment -> () #
Eq DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods (==) :: DeleteDeployment -> DeleteDeployment -> Bool # (/=) :: DeleteDeployment -> DeleteDeployment -> Bool #
Hashable DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods hashWithSalt :: Int -> DeleteDeployment -> Int # hash :: DeleteDeployment -> Int #
type AWSResponse DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment type AWSResponse DeleteDeployment = DeleteDeploymentResponse
type Rep DeleteDeployment Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment type Rep DeleteDeployment = D1 ('MetaData "DeleteDeployment" "Amazonka.APIGateway.DeleteDeployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDeployment Source #

Arguments

:: Text	`DeleteDeployment`
-> Text	`DeleteDeployment`
-> DeleteDeployment

Create a value of DeleteDeployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteDeployment, deleteDeployment_restApiId - The string identifier of the associated RestApi.

DeleteDeployment, deleteDeployment_deploymentId - The identifier of the Deployment resource to delete.

data DeleteDeploymentResponse Source #

See: newDeleteDeploymentResponse smart constructor.

Constructors

DeleteDeploymentResponse'

Instances

Instances details

Generic DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Associated Types type Rep DeleteDeploymentResponse :: Type -> Type # Methods from :: DeleteDeploymentResponse -> Rep DeleteDeploymentResponse x # to :: Rep DeleteDeploymentResponse x -> DeleteDeploymentResponse #
Read DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods readsPrec :: Int -> ReadS DeleteDeploymentResponse # readList :: ReadS [DeleteDeploymentResponse] # readPrec :: ReadPrec DeleteDeploymentResponse # readListPrec :: ReadPrec [DeleteDeploymentResponse] #
Show DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods showsPrec :: Int -> DeleteDeploymentResponse -> ShowS # show :: DeleteDeploymentResponse -> String # showList :: [DeleteDeploymentResponse] -> ShowS #
NFData DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods rnf :: DeleteDeploymentResponse -> () #
Eq DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment Methods (==) :: DeleteDeploymentResponse -> DeleteDeploymentResponse -> Bool # (/=) :: DeleteDeploymentResponse -> DeleteDeploymentResponse -> Bool #
type Rep DeleteDeploymentResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDeployment type Rep DeleteDeploymentResponse = D1 ('MetaData "DeleteDeploymentResponse" "Amazonka.APIGateway.DeleteDeployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteDeploymentResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDeploymentResponse :: DeleteDeploymentResponse Source #

Create a value of DeleteDeploymentResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteDocumentationPart

data DeleteDocumentationPart Source #

Deletes an existing documentation part of an API.

See: newDeleteDocumentationPart smart constructor.

Constructors

DeleteDocumentationPart' Text Text

Instances

Instances details

ToHeaders DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods toHeaders :: DeleteDocumentationPart -> [Header] #
ToPath DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods toPath :: DeleteDocumentationPart -> ByteString #
ToQuery DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods toQuery :: DeleteDocumentationPart -> QueryString #
AWSRequest DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Associated Types type AWSResponse DeleteDocumentationPart # Methods request :: (Service -> Service) -> DeleteDocumentationPart -> Request DeleteDocumentationPart # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteDocumentationPart -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDocumentationPart))) #
Generic DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Associated Types type Rep DeleteDocumentationPart :: Type -> Type # Methods from :: DeleteDocumentationPart -> Rep DeleteDocumentationPart x # to :: Rep DeleteDocumentationPart x -> DeleteDocumentationPart #
Read DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods readsPrec :: Int -> ReadS DeleteDocumentationPart # readList :: ReadS [DeleteDocumentationPart] # readPrec :: ReadPrec DeleteDocumentationPart # readListPrec :: ReadPrec [DeleteDocumentationPart] #
Show DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods showsPrec :: Int -> DeleteDocumentationPart -> ShowS # show :: DeleteDocumentationPart -> String # showList :: [DeleteDocumentationPart] -> ShowS #
NFData DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods rnf :: DeleteDocumentationPart -> () #
Eq DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods (==) :: DeleteDocumentationPart -> DeleteDocumentationPart -> Bool # (/=) :: DeleteDocumentationPart -> DeleteDocumentationPart -> Bool #
Hashable DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods hashWithSalt :: Int -> DeleteDocumentationPart -> Int # hash :: DeleteDocumentationPart -> Int #
type AWSResponse DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart type AWSResponse DeleteDocumentationPart = DeleteDocumentationPartResponse
type Rep DeleteDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart type Rep DeleteDocumentationPart = D1 ('MetaData "DeleteDocumentationPart" "Amazonka.APIGateway.DeleteDocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteDocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentationPartId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDocumentationPart Source #

Arguments

:: Text	`DeleteDocumentationPart`
-> Text	`$sel:documentationPartId:DeleteDocumentationPart'`
-> DeleteDocumentationPart

Create a value of DeleteDocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteDocumentationPart, deleteDocumentationPart_restApiId - The string identifier of the associated RestApi.

$sel:documentationPartId:DeleteDocumentationPart', deleteDocumentationPart_documentationPartId - The identifier of the to-be-deleted documentation part.

data DeleteDocumentationPartResponse Source #

See: newDeleteDocumentationPartResponse smart constructor.

Constructors

DeleteDocumentationPartResponse'

Instances

Instances details

Generic DeleteDocumentationPartResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Associated Types type Rep DeleteDocumentationPartResponse :: Type -> Type # Methods from :: DeleteDocumentationPartResponse -> Rep DeleteDocumentationPartResponse x # to :: Rep DeleteDocumentationPartResponse x -> DeleteDocumentationPartResponse #
Read DeleteDocumentationPartResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods readsPrec :: Int -> ReadS DeleteDocumentationPartResponse # readList :: ReadS [DeleteDocumentationPartResponse] # readPrec :: ReadPrec DeleteDocumentationPartResponse # readListPrec :: ReadPrec [DeleteDocumentationPartResponse] #
Show DeleteDocumentationPartResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods showsPrec :: Int -> DeleteDocumentationPartResponse -> ShowS # show :: DeleteDocumentationPartResponse -> String # showList :: [DeleteDocumentationPartResponse] -> ShowS #
NFData DeleteDocumentationPartResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods rnf :: DeleteDocumentationPartResponse -> () #
Eq DeleteDocumentationPartResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart Methods (==) :: DeleteDocumentationPartResponse -> DeleteDocumentationPartResponse -> Bool # (/=) :: DeleteDocumentationPartResponse -> DeleteDocumentationPartResponse -> Bool #
type Rep DeleteDocumentationPartResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationPart type Rep DeleteDocumentationPartResponse = D1 ('MetaData "DeleteDocumentationPartResponse" "Amazonka.APIGateway.DeleteDocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteDocumentationPartResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDocumentationPartResponse :: DeleteDocumentationPartResponse Source #

Create a value of DeleteDocumentationPartResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteDocumentationVersion

data DeleteDocumentationVersion Source #

Deletes an existing documentation version of an API.

See: newDeleteDocumentationVersion smart constructor.

Constructors

DeleteDocumentationVersion' Text Text

Instances

Instances details

ToHeaders DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods toHeaders :: DeleteDocumentationVersion -> [Header] #
ToPath DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods toPath :: DeleteDocumentationVersion -> ByteString #
ToQuery DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods toQuery :: DeleteDocumentationVersion -> QueryString #
AWSRequest DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Associated Types type AWSResponse DeleteDocumentationVersion # Methods request :: (Service -> Service) -> DeleteDocumentationVersion -> Request DeleteDocumentationVersion # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteDocumentationVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDocumentationVersion))) #
Generic DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Associated Types type Rep DeleteDocumentationVersion :: Type -> Type # Methods from :: DeleteDocumentationVersion -> Rep DeleteDocumentationVersion x # to :: Rep DeleteDocumentationVersion x -> DeleteDocumentationVersion #
Read DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods readsPrec :: Int -> ReadS DeleteDocumentationVersion # readList :: ReadS [DeleteDocumentationVersion] # readPrec :: ReadPrec DeleteDocumentationVersion # readListPrec :: ReadPrec [DeleteDocumentationVersion] #
Show DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods showsPrec :: Int -> DeleteDocumentationVersion -> ShowS # show :: DeleteDocumentationVersion -> String # showList :: [DeleteDocumentationVersion] -> ShowS #
NFData DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods rnf :: DeleteDocumentationVersion -> () #
Eq DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods (==) :: DeleteDocumentationVersion -> DeleteDocumentationVersion -> Bool # (/=) :: DeleteDocumentationVersion -> DeleteDocumentationVersion -> Bool #
Hashable DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods hashWithSalt :: Int -> DeleteDocumentationVersion -> Int # hash :: DeleteDocumentationVersion -> Int #
type AWSResponse DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion type AWSResponse DeleteDocumentationVersion = DeleteDocumentationVersionResponse
type Rep DeleteDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion type Rep DeleteDocumentationVersion = D1 ('MetaData "DeleteDocumentationVersion" "Amazonka.APIGateway.DeleteDocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteDocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDocumentationVersion Source #

Arguments

:: Text	`DeleteDocumentationVersion`
-> Text	`DeleteDocumentationVersion`
-> DeleteDocumentationVersion

Create a value of DeleteDocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteDocumentationVersion, deleteDocumentationVersion_restApiId - The string identifier of the associated RestApi.

DeleteDocumentationVersion, deleteDocumentationVersion_documentationVersion - The version identifier of a to-be-deleted documentation snapshot.

data DeleteDocumentationVersionResponse Source #

See: newDeleteDocumentationVersionResponse smart constructor.

Constructors

DeleteDocumentationVersionResponse'

Instances

Instances details

Generic DeleteDocumentationVersionResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Associated Types type Rep DeleteDocumentationVersionResponse :: Type -> Type # Methods from :: DeleteDocumentationVersionResponse -> Rep DeleteDocumentationVersionResponse x # to :: Rep DeleteDocumentationVersionResponse x -> DeleteDocumentationVersionResponse #
Read DeleteDocumentationVersionResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods readsPrec :: Int -> ReadS DeleteDocumentationVersionResponse # readList :: ReadS [DeleteDocumentationVersionResponse] # readPrec :: ReadPrec DeleteDocumentationVersionResponse # readListPrec :: ReadPrec [DeleteDocumentationVersionResponse] #
Show DeleteDocumentationVersionResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods showsPrec :: Int -> DeleteDocumentationVersionResponse -> ShowS # show :: DeleteDocumentationVersionResponse -> String # showList :: [DeleteDocumentationVersionResponse] -> ShowS #
NFData DeleteDocumentationVersionResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods rnf :: DeleteDocumentationVersionResponse -> () #
Eq DeleteDocumentationVersionResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion Methods (==) :: DeleteDocumentationVersionResponse -> DeleteDocumentationVersionResponse -> Bool # (/=) :: DeleteDocumentationVersionResponse -> DeleteDocumentationVersionResponse -> Bool #
type Rep DeleteDocumentationVersionResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDocumentationVersion type Rep DeleteDocumentationVersionResponse = D1 ('MetaData "DeleteDocumentationVersionResponse" "Amazonka.APIGateway.DeleteDocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteDocumentationVersionResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDocumentationVersionResponse :: DeleteDocumentationVersionResponse Source #

Create a value of DeleteDocumentationVersionResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteDomainName

data DeleteDomainName Source #

A request to delete the DomainName resource.

See: newDeleteDomainName smart constructor.

Constructors

DeleteDomainName' Text

Instances

Instances details

ToHeaders DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods toHeaders :: DeleteDomainName -> [Header] #
ToPath DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods toPath :: DeleteDomainName -> ByteString #
ToQuery DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods toQuery :: DeleteDomainName -> QueryString #
AWSRequest DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Associated Types type AWSResponse DeleteDomainName # Methods request :: (Service -> Service) -> DeleteDomainName -> Request DeleteDomainName # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteDomainName -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteDomainName))) #
Generic DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Associated Types type Rep DeleteDomainName :: Type -> Type # Methods from :: DeleteDomainName -> Rep DeleteDomainName x # to :: Rep DeleteDomainName x -> DeleteDomainName #
Read DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods readsPrec :: Int -> ReadS DeleteDomainName # readList :: ReadS [DeleteDomainName] # readPrec :: ReadPrec DeleteDomainName # readListPrec :: ReadPrec [DeleteDomainName] #
Show DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods showsPrec :: Int -> DeleteDomainName -> ShowS # show :: DeleteDomainName -> String # showList :: [DeleteDomainName] -> ShowS #
NFData DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods rnf :: DeleteDomainName -> () #
Eq DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods (==) :: DeleteDomainName -> DeleteDomainName -> Bool # (/=) :: DeleteDomainName -> DeleteDomainName -> Bool #
Hashable DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods hashWithSalt :: Int -> DeleteDomainName -> Int # hash :: DeleteDomainName -> Int #
type AWSResponse DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName type AWSResponse DeleteDomainName = DeleteDomainNameResponse
type Rep DeleteDomainName Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName type Rep DeleteDomainName = D1 ('MetaData "DeleteDomainName" "Amazonka.APIGateway.DeleteDomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteDomainName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteDomainName Source #

Arguments

:: Text	`DeleteDomainName`
-> DeleteDomainName

Create a value of DeleteDomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteDomainName, deleteDomainName_domainName - The name of the DomainName resource to be deleted.

data DeleteDomainNameResponse Source #

See: newDeleteDomainNameResponse smart constructor.

Constructors

DeleteDomainNameResponse'

Instances

Instances details

Generic DeleteDomainNameResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Associated Types type Rep DeleteDomainNameResponse :: Type -> Type # Methods from :: DeleteDomainNameResponse -> Rep DeleteDomainNameResponse x # to :: Rep DeleteDomainNameResponse x -> DeleteDomainNameResponse #
Read DeleteDomainNameResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods readsPrec :: Int -> ReadS DeleteDomainNameResponse # readList :: ReadS [DeleteDomainNameResponse] # readPrec :: ReadPrec DeleteDomainNameResponse # readListPrec :: ReadPrec [DeleteDomainNameResponse] #
Show DeleteDomainNameResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods showsPrec :: Int -> DeleteDomainNameResponse -> ShowS # show :: DeleteDomainNameResponse -> String # showList :: [DeleteDomainNameResponse] -> ShowS #
NFData DeleteDomainNameResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods rnf :: DeleteDomainNameResponse -> () #
Eq DeleteDomainNameResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName Methods (==) :: DeleteDomainNameResponse -> DeleteDomainNameResponse -> Bool # (/=) :: DeleteDomainNameResponse -> DeleteDomainNameResponse -> Bool #
type Rep DeleteDomainNameResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteDomainName type Rep DeleteDomainNameResponse = D1 ('MetaData "DeleteDomainNameResponse" "Amazonka.APIGateway.DeleteDomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteDomainNameResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteDomainNameResponse :: DeleteDomainNameResponse Source #

Create a value of DeleteDomainNameResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteGatewayResponse

data DeleteGatewayResponse Source #

Clears any customization of a GatewayResponse of a specified response type on the given RestApi and resets it with the default settings.

See: newDeleteGatewayResponse smart constructor.

Constructors

DeleteGatewayResponse' Text GatewayResponseType

Instances

Instances details

ToHeaders DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods toHeaders :: DeleteGatewayResponse -> [Header] #
ToPath DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods toPath :: DeleteGatewayResponse -> ByteString #
ToQuery DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods toQuery :: DeleteGatewayResponse -> QueryString #
AWSRequest DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Associated Types type AWSResponse DeleteGatewayResponse # Methods request :: (Service -> Service) -> DeleteGatewayResponse -> Request DeleteGatewayResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteGatewayResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteGatewayResponse))) #
Generic DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Associated Types type Rep DeleteGatewayResponse :: Type -> Type # Methods from :: DeleteGatewayResponse -> Rep DeleteGatewayResponse x # to :: Rep DeleteGatewayResponse x -> DeleteGatewayResponse #
Read DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods readsPrec :: Int -> ReadS DeleteGatewayResponse # readList :: ReadS [DeleteGatewayResponse] # readPrec :: ReadPrec DeleteGatewayResponse # readListPrec :: ReadPrec [DeleteGatewayResponse] #
Show DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods showsPrec :: Int -> DeleteGatewayResponse -> ShowS # show :: DeleteGatewayResponse -> String # showList :: [DeleteGatewayResponse] -> ShowS #
NFData DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods rnf :: DeleteGatewayResponse -> () #
Eq DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods (==) :: DeleteGatewayResponse -> DeleteGatewayResponse -> Bool # (/=) :: DeleteGatewayResponse -> DeleteGatewayResponse -> Bool #
Hashable DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods hashWithSalt :: Int -> DeleteGatewayResponse -> Int # hash :: DeleteGatewayResponse -> Int #
type AWSResponse DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse type AWSResponse DeleteGatewayResponse = DeleteGatewayResponseResponse
type Rep DeleteGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse type Rep DeleteGatewayResponse = D1 ('MetaData "DeleteGatewayResponse" "Amazonka.APIGateway.DeleteGatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteGatewayResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayResponseType)))

newDeleteGatewayResponse Source #

Arguments

:: Text	`DeleteGatewayResponse`
-> GatewayResponseType	`DeleteGatewayResponse`
-> DeleteGatewayResponse

Create a value of DeleteGatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteGatewayResponse, deleteGatewayResponse_restApiId - The string identifier of the associated RestApi.

DeleteGatewayResponse, deleteGatewayResponse_responseType - The response type of the associated GatewayResponse.

data DeleteGatewayResponseResponse Source #

See: newDeleteGatewayResponseResponse smart constructor.

Constructors

DeleteGatewayResponseResponse'

Instances

Instances details

Generic DeleteGatewayResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Associated Types type Rep DeleteGatewayResponseResponse :: Type -> Type # Methods from :: DeleteGatewayResponseResponse -> Rep DeleteGatewayResponseResponse x # to :: Rep DeleteGatewayResponseResponse x -> DeleteGatewayResponseResponse #
Read DeleteGatewayResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods readsPrec :: Int -> ReadS DeleteGatewayResponseResponse # readList :: ReadS [DeleteGatewayResponseResponse] # readPrec :: ReadPrec DeleteGatewayResponseResponse # readListPrec :: ReadPrec [DeleteGatewayResponseResponse] #
Show DeleteGatewayResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods showsPrec :: Int -> DeleteGatewayResponseResponse -> ShowS # show :: DeleteGatewayResponseResponse -> String # showList :: [DeleteGatewayResponseResponse] -> ShowS #
NFData DeleteGatewayResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods rnf :: DeleteGatewayResponseResponse -> () #
Eq DeleteGatewayResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse Methods (==) :: DeleteGatewayResponseResponse -> DeleteGatewayResponseResponse -> Bool # (/=) :: DeleteGatewayResponseResponse -> DeleteGatewayResponseResponse -> Bool #
type Rep DeleteGatewayResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteGatewayResponse type Rep DeleteGatewayResponseResponse = D1 ('MetaData "DeleteGatewayResponseResponse" "Amazonka.APIGateway.DeleteGatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteGatewayResponseResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteGatewayResponseResponse :: DeleteGatewayResponseResponse Source #

Create a value of DeleteGatewayResponseResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteIntegration

data DeleteIntegration Source #

Represents a delete integration request.

See: newDeleteIntegration smart constructor.

Constructors

DeleteIntegration' Text Text Text

Instances

Instances details

ToHeaders DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods toHeaders :: DeleteIntegration -> [Header] #
ToPath DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods toPath :: DeleteIntegration -> ByteString #
ToQuery DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods toQuery :: DeleteIntegration -> QueryString #
AWSRequest DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Associated Types type AWSResponse DeleteIntegration # Methods request :: (Service -> Service) -> DeleteIntegration -> Request DeleteIntegration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteIntegration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteIntegration))) #
Generic DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Associated Types type Rep DeleteIntegration :: Type -> Type # Methods from :: DeleteIntegration -> Rep DeleteIntegration x # to :: Rep DeleteIntegration x -> DeleteIntegration #
Read DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods readsPrec :: Int -> ReadS DeleteIntegration # readList :: ReadS [DeleteIntegration] # readPrec :: ReadPrec DeleteIntegration # readListPrec :: ReadPrec [DeleteIntegration] #
Show DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods showsPrec :: Int -> DeleteIntegration -> ShowS # show :: DeleteIntegration -> String # showList :: [DeleteIntegration] -> ShowS #
NFData DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods rnf :: DeleteIntegration -> () #
Eq DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods (==) :: DeleteIntegration -> DeleteIntegration -> Bool # (/=) :: DeleteIntegration -> DeleteIntegration -> Bool #
Hashable DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods hashWithSalt :: Int -> DeleteIntegration -> Int # hash :: DeleteIntegration -> Int #
type AWSResponse DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration type AWSResponse DeleteIntegration = DeleteIntegrationResponse'
type Rep DeleteIntegration Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration type Rep DeleteIntegration = D1 ('MetaData "DeleteIntegration" "Amazonka.APIGateway.DeleteIntegration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteIntegration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteIntegration Source #

Arguments

:: Text	`DeleteIntegration`
-> Text	`$sel:resourceId:DeleteIntegration'`
-> Text	`DeleteIntegration`
-> DeleteIntegration

Create a value of DeleteIntegration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteIntegration, deleteIntegration_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:DeleteIntegration', deleteIntegration_resourceId - Specifies a delete integration request's resource identifier.

DeleteIntegration, deleteIntegration_httpMethod - Specifies a delete integration request's HTTP method.

data DeleteIntegrationResponse' Source #

See: newDeleteIntegrationResponse' smart constructor.

Constructors

DeleteIntegrationResponse''

Instances

Instances details

Generic DeleteIntegrationResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Associated Types type Rep DeleteIntegrationResponse' :: Type -> Type # Methods from :: DeleteIntegrationResponse' -> Rep DeleteIntegrationResponse' x # to :: Rep DeleteIntegrationResponse' x -> DeleteIntegrationResponse' #
Read DeleteIntegrationResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods readsPrec :: Int -> ReadS DeleteIntegrationResponse' # readList :: ReadS [DeleteIntegrationResponse'] # readPrec :: ReadPrec DeleteIntegrationResponse' # readListPrec :: ReadPrec [DeleteIntegrationResponse'] #
Show DeleteIntegrationResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods showsPrec :: Int -> DeleteIntegrationResponse' -> ShowS # show :: DeleteIntegrationResponse' -> String # showList :: [DeleteIntegrationResponse'] -> ShowS #
NFData DeleteIntegrationResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods rnf :: DeleteIntegrationResponse' -> () #
Eq DeleteIntegrationResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration Methods (==) :: DeleteIntegrationResponse' -> DeleteIntegrationResponse' -> Bool # (/=) :: DeleteIntegrationResponse' -> DeleteIntegrationResponse' -> Bool #
type Rep DeleteIntegrationResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegration type Rep DeleteIntegrationResponse' = D1 ('MetaData "DeleteIntegrationResponse'" "Amazonka.APIGateway.DeleteIntegration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteIntegrationResponse''" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteIntegrationResponse' :: DeleteIntegrationResponse' Source #

Create a value of DeleteIntegrationResponse' with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteIntegrationResponse

data DeleteIntegrationResponse Source #

Represents a delete integration response request.

See: newDeleteIntegrationResponse smart constructor.

Constructors

DeleteIntegrationResponse' Text Text Text Text

Instances

Instances details

ToHeaders DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods toHeaders :: DeleteIntegrationResponse -> [Header] #
ToPath DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods toPath :: DeleteIntegrationResponse -> ByteString #
ToQuery DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods toQuery :: DeleteIntegrationResponse -> QueryString #
AWSRequest DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Associated Types type AWSResponse DeleteIntegrationResponse # Methods request :: (Service -> Service) -> DeleteIntegrationResponse -> Request DeleteIntegrationResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteIntegrationResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteIntegrationResponse))) #
Generic DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Associated Types type Rep DeleteIntegrationResponse :: Type -> Type # Methods from :: DeleteIntegrationResponse -> Rep DeleteIntegrationResponse x # to :: Rep DeleteIntegrationResponse x -> DeleteIntegrationResponse #
Read DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods readsPrec :: Int -> ReadS DeleteIntegrationResponse # readList :: ReadS [DeleteIntegrationResponse] # readPrec :: ReadPrec DeleteIntegrationResponse # readListPrec :: ReadPrec [DeleteIntegrationResponse] #
Show DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods showsPrec :: Int -> DeleteIntegrationResponse -> ShowS # show :: DeleteIntegrationResponse -> String # showList :: [DeleteIntegrationResponse] -> ShowS #
NFData DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods rnf :: DeleteIntegrationResponse -> () #
Eq DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods (==) :: DeleteIntegrationResponse -> DeleteIntegrationResponse -> Bool # (/=) :: DeleteIntegrationResponse -> DeleteIntegrationResponse -> Bool #
Hashable DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods hashWithSalt :: Int -> DeleteIntegrationResponse -> Int # hash :: DeleteIntegrationResponse -> Int #
type AWSResponse DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse type AWSResponse DeleteIntegrationResponse = DeleteIntegrationResponseResponse
type Rep DeleteIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse type Rep DeleteIntegrationResponse = D1 ('MetaData "DeleteIntegrationResponse" "Amazonka.APIGateway.DeleteIntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteIntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteIntegrationResponse Source #

Arguments

:: Text	`DeleteIntegrationResponse`
-> Text	`$sel:resourceId:DeleteIntegrationResponse'`
-> Text	`DeleteIntegrationResponse`
-> Text	`DeleteIntegrationResponse`
-> DeleteIntegrationResponse

Create a value of DeleteIntegrationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteIntegrationResponse, deleteIntegrationResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:DeleteIntegrationResponse', deleteIntegrationResponse_resourceId - Specifies a delete integration response request's resource identifier.

DeleteIntegrationResponse, deleteIntegrationResponse_httpMethod - Specifies a delete integration response request's HTTP method.

DeleteIntegrationResponse, deleteIntegrationResponse_statusCode - Specifies a delete integration response request's status code.

data DeleteIntegrationResponseResponse Source #

See: newDeleteIntegrationResponseResponse smart constructor.

Constructors

DeleteIntegrationResponseResponse'

Instances

Instances details

Generic DeleteIntegrationResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Associated Types type Rep DeleteIntegrationResponseResponse :: Type -> Type # Methods from :: DeleteIntegrationResponseResponse -> Rep DeleteIntegrationResponseResponse x # to :: Rep DeleteIntegrationResponseResponse x -> DeleteIntegrationResponseResponse #
Read DeleteIntegrationResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods readsPrec :: Int -> ReadS DeleteIntegrationResponseResponse # readList :: ReadS [DeleteIntegrationResponseResponse] # readPrec :: ReadPrec DeleteIntegrationResponseResponse # readListPrec :: ReadPrec [DeleteIntegrationResponseResponse] #
Show DeleteIntegrationResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods showsPrec :: Int -> DeleteIntegrationResponseResponse -> ShowS # show :: DeleteIntegrationResponseResponse -> String # showList :: [DeleteIntegrationResponseResponse] -> ShowS #
NFData DeleteIntegrationResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods rnf :: DeleteIntegrationResponseResponse -> () #
Eq DeleteIntegrationResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse Methods (==) :: DeleteIntegrationResponseResponse -> DeleteIntegrationResponseResponse -> Bool # (/=) :: DeleteIntegrationResponseResponse -> DeleteIntegrationResponseResponse -> Bool #
type Rep DeleteIntegrationResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteIntegrationResponse type Rep DeleteIntegrationResponseResponse = D1 ('MetaData "DeleteIntegrationResponseResponse" "Amazonka.APIGateway.DeleteIntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteIntegrationResponseResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteIntegrationResponseResponse :: DeleteIntegrationResponseResponse Source #

Create a value of DeleteIntegrationResponseResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteMethod

data DeleteMethod Source #

Request to delete an existing Method resource.

See: newDeleteMethod smart constructor.

Constructors

DeleteMethod' Text Text Text

Instances

Instances details

ToHeaders DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods toHeaders :: DeleteMethod -> [Header] #
ToPath DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods toPath :: DeleteMethod -> ByteString #
ToQuery DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods toQuery :: DeleteMethod -> QueryString #
AWSRequest DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Associated Types type AWSResponse DeleteMethod # Methods request :: (Service -> Service) -> DeleteMethod -> Request DeleteMethod # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteMethod -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteMethod))) #
Generic DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Associated Types type Rep DeleteMethod :: Type -> Type # Methods from :: DeleteMethod -> Rep DeleteMethod x # to :: Rep DeleteMethod x -> DeleteMethod #
Read DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods readsPrec :: Int -> ReadS DeleteMethod # readList :: ReadS [DeleteMethod] # readPrec :: ReadPrec DeleteMethod # readListPrec :: ReadPrec [DeleteMethod] #
Show DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods showsPrec :: Int -> DeleteMethod -> ShowS # show :: DeleteMethod -> String # showList :: [DeleteMethod] -> ShowS #
NFData DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods rnf :: DeleteMethod -> () #
Eq DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods (==) :: DeleteMethod -> DeleteMethod -> Bool # (/=) :: DeleteMethod -> DeleteMethod -> Bool #
Hashable DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods hashWithSalt :: Int -> DeleteMethod -> Int # hash :: DeleteMethod -> Int #
type AWSResponse DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod type AWSResponse DeleteMethod = DeleteMethodResponse'
type Rep DeleteMethod Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod type Rep DeleteMethod = D1 ('MetaData "DeleteMethod" "Amazonka.APIGateway.DeleteMethod" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteMethod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteMethod Source #

Arguments

:: Text	`DeleteMethod`
-> Text	`$sel:resourceId:DeleteMethod'`
-> Text	`DeleteMethod`
-> DeleteMethod

Create a value of DeleteMethod with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteMethod, deleteMethod_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:DeleteMethod', deleteMethod_resourceId - The Resource identifier for the Method resource.

DeleteMethod, deleteMethod_httpMethod - The HTTP verb of the Method resource.

data DeleteMethodResponse' Source #

See: newDeleteMethodResponse' smart constructor.

Constructors

DeleteMethodResponse''

Instances

Instances details

Generic DeleteMethodResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Associated Types type Rep DeleteMethodResponse' :: Type -> Type # Methods from :: DeleteMethodResponse' -> Rep DeleteMethodResponse' x # to :: Rep DeleteMethodResponse' x -> DeleteMethodResponse' #
Read DeleteMethodResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods readsPrec :: Int -> ReadS DeleteMethodResponse' # readList :: ReadS [DeleteMethodResponse'] # readPrec :: ReadPrec DeleteMethodResponse' # readListPrec :: ReadPrec [DeleteMethodResponse'] #
Show DeleteMethodResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods showsPrec :: Int -> DeleteMethodResponse' -> ShowS # show :: DeleteMethodResponse' -> String # showList :: [DeleteMethodResponse'] -> ShowS #
NFData DeleteMethodResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods rnf :: DeleteMethodResponse' -> () #
Eq DeleteMethodResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod Methods (==) :: DeleteMethodResponse' -> DeleteMethodResponse' -> Bool # (/=) :: DeleteMethodResponse' -> DeleteMethodResponse' -> Bool #
type Rep DeleteMethodResponse' Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethod type Rep DeleteMethodResponse' = D1 ('MetaData "DeleteMethodResponse'" "Amazonka.APIGateway.DeleteMethod" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteMethodResponse''" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteMethodResponse' :: DeleteMethodResponse' Source #

Create a value of DeleteMethodResponse' with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteMethodResponse

data DeleteMethodResponse Source #

A request to delete an existing MethodResponse resource.

See: newDeleteMethodResponse smart constructor.

Constructors

DeleteMethodResponse' Text Text Text Text

Instances

Instances details

ToHeaders DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods toHeaders :: DeleteMethodResponse -> [Header] #
ToPath DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods toPath :: DeleteMethodResponse -> ByteString #
ToQuery DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods toQuery :: DeleteMethodResponse -> QueryString #
AWSRequest DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Associated Types type AWSResponse DeleteMethodResponse # Methods request :: (Service -> Service) -> DeleteMethodResponse -> Request DeleteMethodResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteMethodResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteMethodResponse))) #
Generic DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Associated Types type Rep DeleteMethodResponse :: Type -> Type # Methods from :: DeleteMethodResponse -> Rep DeleteMethodResponse x # to :: Rep DeleteMethodResponse x -> DeleteMethodResponse #
Read DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods readsPrec :: Int -> ReadS DeleteMethodResponse # readList :: ReadS [DeleteMethodResponse] # readPrec :: ReadPrec DeleteMethodResponse # readListPrec :: ReadPrec [DeleteMethodResponse] #
Show DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods showsPrec :: Int -> DeleteMethodResponse -> ShowS # show :: DeleteMethodResponse -> String # showList :: [DeleteMethodResponse] -> ShowS #
NFData DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods rnf :: DeleteMethodResponse -> () #
Eq DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods (==) :: DeleteMethodResponse -> DeleteMethodResponse -> Bool # (/=) :: DeleteMethodResponse -> DeleteMethodResponse -> Bool #
Hashable DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods hashWithSalt :: Int -> DeleteMethodResponse -> Int # hash :: DeleteMethodResponse -> Int #
type AWSResponse DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse type AWSResponse DeleteMethodResponse = DeleteMethodResponseResponse
type Rep DeleteMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse type Rep DeleteMethodResponse = D1 ('MetaData "DeleteMethodResponse" "Amazonka.APIGateway.DeleteMethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteMethodResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newDeleteMethodResponse Source #

Arguments

:: Text	`DeleteMethodResponse`
-> Text	`$sel:resourceId:DeleteMethodResponse'`
-> Text	`DeleteMethodResponse`
-> Text	`DeleteMethodResponse`
-> DeleteMethodResponse

Create a value of DeleteMethodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteMethodResponse, deleteMethodResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:DeleteMethodResponse', deleteMethodResponse_resourceId - The Resource identifier for the MethodResponse resource.

DeleteMethodResponse, deleteMethodResponse_httpMethod - The HTTP verb of the Method resource.

DeleteMethodResponse, deleteMethodResponse_statusCode - The status code identifier for the MethodResponse resource.

data DeleteMethodResponseResponse Source #

See: newDeleteMethodResponseResponse smart constructor.

Constructors

DeleteMethodResponseResponse'

Instances

Instances details

Generic DeleteMethodResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Associated Types type Rep DeleteMethodResponseResponse :: Type -> Type # Methods from :: DeleteMethodResponseResponse -> Rep DeleteMethodResponseResponse x # to :: Rep DeleteMethodResponseResponse x -> DeleteMethodResponseResponse #
Read DeleteMethodResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods readsPrec :: Int -> ReadS DeleteMethodResponseResponse # readList :: ReadS [DeleteMethodResponseResponse] # readPrec :: ReadPrec DeleteMethodResponseResponse # readListPrec :: ReadPrec [DeleteMethodResponseResponse] #
Show DeleteMethodResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods showsPrec :: Int -> DeleteMethodResponseResponse -> ShowS # show :: DeleteMethodResponseResponse -> String # showList :: [DeleteMethodResponseResponse] -> ShowS #
NFData DeleteMethodResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods rnf :: DeleteMethodResponseResponse -> () #
Eq DeleteMethodResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse Methods (==) :: DeleteMethodResponseResponse -> DeleteMethodResponseResponse -> Bool # (/=) :: DeleteMethodResponseResponse -> DeleteMethodResponseResponse -> Bool #
type Rep DeleteMethodResponseResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteMethodResponse type Rep DeleteMethodResponseResponse = D1 ('MetaData "DeleteMethodResponseResponse" "Amazonka.APIGateway.DeleteMethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteMethodResponseResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteMethodResponseResponse :: DeleteMethodResponseResponse Source #

Create a value of DeleteMethodResponseResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteModel

data DeleteModel Source #

Request to delete an existing model in an existing RestApi resource.

See: newDeleteModel smart constructor.

Constructors

DeleteModel' Text Text

Instances

Instances details

ToHeaders DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods toHeaders :: DeleteModel -> [Header] #
ToPath DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods toPath :: DeleteModel -> ByteString #
ToQuery DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods toQuery :: DeleteModel -> QueryString #
AWSRequest DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Associated Types type AWSResponse DeleteModel # Methods request :: (Service -> Service) -> DeleteModel -> Request DeleteModel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteModel))) #
Generic DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Associated Types type Rep DeleteModel :: Type -> Type # Methods from :: DeleteModel -> Rep DeleteModel x # to :: Rep DeleteModel x -> DeleteModel #
Read DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods readsPrec :: Int -> ReadS DeleteModel # readList :: ReadS [DeleteModel] # readPrec :: ReadPrec DeleteModel # readListPrec :: ReadPrec [DeleteModel] #
Show DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods showsPrec :: Int -> DeleteModel -> ShowS # show :: DeleteModel -> String # showList :: [DeleteModel] -> ShowS #
NFData DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods rnf :: DeleteModel -> () #
Eq DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods (==) :: DeleteModel -> DeleteModel -> Bool # (/=) :: DeleteModel -> DeleteModel -> Bool #
Hashable DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods hashWithSalt :: Int -> DeleteModel -> Int # hash :: DeleteModel -> Int #
type AWSResponse DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel type AWSResponse DeleteModel = DeleteModelResponse
type Rep DeleteModel Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel type Rep DeleteModel = D1 ('MetaData "DeleteModel" "Amazonka.APIGateway.DeleteModel" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteModel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteModel Source #

Arguments

:: Text	`DeleteModel`
-> Text	`$sel:modelName:DeleteModel'`
-> DeleteModel

Create a value of DeleteModel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteModel, deleteModel_restApiId - The string identifier of the associated RestApi.

$sel:modelName:DeleteModel', deleteModel_modelName - The name of the model to delete.

data DeleteModelResponse Source #

See: newDeleteModelResponse smart constructor.

Constructors

DeleteModelResponse'

Instances

Instances details

Generic DeleteModelResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Associated Types type Rep DeleteModelResponse :: Type -> Type # Methods from :: DeleteModelResponse -> Rep DeleteModelResponse x # to :: Rep DeleteModelResponse x -> DeleteModelResponse #
Read DeleteModelResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods readsPrec :: Int -> ReadS DeleteModelResponse # readList :: ReadS [DeleteModelResponse] # readPrec :: ReadPrec DeleteModelResponse # readListPrec :: ReadPrec [DeleteModelResponse] #
Show DeleteModelResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods showsPrec :: Int -> DeleteModelResponse -> ShowS # show :: DeleteModelResponse -> String # showList :: [DeleteModelResponse] -> ShowS #
NFData DeleteModelResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods rnf :: DeleteModelResponse -> () #
Eq DeleteModelResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel Methods (==) :: DeleteModelResponse -> DeleteModelResponse -> Bool # (/=) :: DeleteModelResponse -> DeleteModelResponse -> Bool #
type Rep DeleteModelResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteModel type Rep DeleteModelResponse = D1 ('MetaData "DeleteModelResponse" "Amazonka.APIGateway.DeleteModel" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteModelResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteModelResponse :: DeleteModelResponse Source #

Create a value of DeleteModelResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteRequestValidator

data DeleteRequestValidator Source #

Deletes a specified RequestValidator of a given RestApi.

See: newDeleteRequestValidator smart constructor.

Constructors

DeleteRequestValidator' Text Text

Instances

Instances details

ToHeaders DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods toHeaders :: DeleteRequestValidator -> [Header] #
ToPath DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods toPath :: DeleteRequestValidator -> ByteString #
ToQuery DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods toQuery :: DeleteRequestValidator -> QueryString #
AWSRequest DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Associated Types type AWSResponse DeleteRequestValidator # Methods request :: (Service -> Service) -> DeleteRequestValidator -> Request DeleteRequestValidator # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteRequestValidator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteRequestValidator))) #
Generic DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Associated Types type Rep DeleteRequestValidator :: Type -> Type # Methods from :: DeleteRequestValidator -> Rep DeleteRequestValidator x # to :: Rep DeleteRequestValidator x -> DeleteRequestValidator #
Read DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods readsPrec :: Int -> ReadS DeleteRequestValidator # readList :: ReadS [DeleteRequestValidator] # readPrec :: ReadPrec DeleteRequestValidator # readListPrec :: ReadPrec [DeleteRequestValidator] #
Show DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods showsPrec :: Int -> DeleteRequestValidator -> ShowS # show :: DeleteRequestValidator -> String # showList :: [DeleteRequestValidator] -> ShowS #
NFData DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods rnf :: DeleteRequestValidator -> () #
Eq DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods (==) :: DeleteRequestValidator -> DeleteRequestValidator -> Bool # (/=) :: DeleteRequestValidator -> DeleteRequestValidator -> Bool #
Hashable DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods hashWithSalt :: Int -> DeleteRequestValidator -> Int # hash :: DeleteRequestValidator -> Int #
type AWSResponse DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator type AWSResponse DeleteRequestValidator = DeleteRequestValidatorResponse
type Rep DeleteRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator type Rep DeleteRequestValidator = D1 ('MetaData "DeleteRequestValidator" "Amazonka.APIGateway.DeleteRequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteRequestValidator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "requestValidatorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteRequestValidator Source #

Arguments

:: Text	`DeleteRequestValidator`
-> Text	`DeleteRequestValidator`
-> DeleteRequestValidator

Create a value of DeleteRequestValidator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteRequestValidator, deleteRequestValidator_restApiId - The string identifier of the associated RestApi.

DeleteRequestValidator, deleteRequestValidator_requestValidatorId - The identifier of the RequestValidator to be deleted.

data DeleteRequestValidatorResponse Source #

See: newDeleteRequestValidatorResponse smart constructor.

Constructors

DeleteRequestValidatorResponse'

Instances

Instances details

Generic DeleteRequestValidatorResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Associated Types type Rep DeleteRequestValidatorResponse :: Type -> Type # Methods from :: DeleteRequestValidatorResponse -> Rep DeleteRequestValidatorResponse x # to :: Rep DeleteRequestValidatorResponse x -> DeleteRequestValidatorResponse #
Read DeleteRequestValidatorResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods readsPrec :: Int -> ReadS DeleteRequestValidatorResponse # readList :: ReadS [DeleteRequestValidatorResponse] # readPrec :: ReadPrec DeleteRequestValidatorResponse # readListPrec :: ReadPrec [DeleteRequestValidatorResponse] #
Show DeleteRequestValidatorResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods showsPrec :: Int -> DeleteRequestValidatorResponse -> ShowS # show :: DeleteRequestValidatorResponse -> String # showList :: [DeleteRequestValidatorResponse] -> ShowS #
NFData DeleteRequestValidatorResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods rnf :: DeleteRequestValidatorResponse -> () #
Eq DeleteRequestValidatorResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator Methods (==) :: DeleteRequestValidatorResponse -> DeleteRequestValidatorResponse -> Bool # (/=) :: DeleteRequestValidatorResponse -> DeleteRequestValidatorResponse -> Bool #
type Rep DeleteRequestValidatorResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRequestValidator type Rep DeleteRequestValidatorResponse = D1 ('MetaData "DeleteRequestValidatorResponse" "Amazonka.APIGateway.DeleteRequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteRequestValidatorResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteRequestValidatorResponse :: DeleteRequestValidatorResponse Source #

Create a value of DeleteRequestValidatorResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteResource

data DeleteResource Source #

Request to delete a Resource.

See: newDeleteResource smart constructor.

Constructors

DeleteResource' Text Text

Instances

Instances details

ToHeaders DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods toHeaders :: DeleteResource -> [Header] #
ToPath DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods toPath :: DeleteResource -> ByteString #
ToQuery DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods toQuery :: DeleteResource -> QueryString #
AWSRequest DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Associated Types type AWSResponse DeleteResource # Methods request :: (Service -> Service) -> DeleteResource -> Request DeleteResource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteResource))) #
Generic DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Associated Types type Rep DeleteResource :: Type -> Type # Methods from :: DeleteResource -> Rep DeleteResource x # to :: Rep DeleteResource x -> DeleteResource #
Read DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods readsPrec :: Int -> ReadS DeleteResource # readList :: ReadS [DeleteResource] # readPrec :: ReadPrec DeleteResource # readListPrec :: ReadPrec [DeleteResource] #
Show DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods showsPrec :: Int -> DeleteResource -> ShowS # show :: DeleteResource -> String # showList :: [DeleteResource] -> ShowS #
NFData DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods rnf :: DeleteResource -> () #
Eq DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods (==) :: DeleteResource -> DeleteResource -> Bool # (/=) :: DeleteResource -> DeleteResource -> Bool #
Hashable DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods hashWithSalt :: Int -> DeleteResource -> Int # hash :: DeleteResource -> Int #
type AWSResponse DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource type AWSResponse DeleteResource = DeleteResourceResponse
type Rep DeleteResource Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource type Rep DeleteResource = D1 ('MetaData "DeleteResource" "Amazonka.APIGateway.DeleteResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteResource Source #

Arguments

:: Text	`DeleteResource`
-> Text	`$sel:resourceId:DeleteResource'`
-> DeleteResource

Create a value of DeleteResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteResource, deleteResource_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:DeleteResource', deleteResource_resourceId - The identifier of the Resource resource.

data DeleteResourceResponse Source #

See: newDeleteResourceResponse smart constructor.

Constructors

DeleteResourceResponse'

Instances

Instances details

Generic DeleteResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Associated Types type Rep DeleteResourceResponse :: Type -> Type # Methods from :: DeleteResourceResponse -> Rep DeleteResourceResponse x # to :: Rep DeleteResourceResponse x -> DeleteResourceResponse #
Read DeleteResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods readsPrec :: Int -> ReadS DeleteResourceResponse # readList :: ReadS [DeleteResourceResponse] # readPrec :: ReadPrec DeleteResourceResponse # readListPrec :: ReadPrec [DeleteResourceResponse] #
Show DeleteResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods showsPrec :: Int -> DeleteResourceResponse -> ShowS # show :: DeleteResourceResponse -> String # showList :: [DeleteResourceResponse] -> ShowS #
NFData DeleteResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods rnf :: DeleteResourceResponse -> () #
Eq DeleteResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource Methods (==) :: DeleteResourceResponse -> DeleteResourceResponse -> Bool # (/=) :: DeleteResourceResponse -> DeleteResourceResponse -> Bool #
type Rep DeleteResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteResource type Rep DeleteResourceResponse = D1 ('MetaData "DeleteResourceResponse" "Amazonka.APIGateway.DeleteResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteResourceResponse :: DeleteResourceResponse Source #

Create a value of DeleteResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteRestApi

data DeleteRestApi Source #

Request to delete the specified API from your collection.

See: newDeleteRestApi smart constructor.

Constructors

DeleteRestApi' Text

Instances

Instances details

ToHeaders DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods toHeaders :: DeleteRestApi -> [Header] #
ToPath DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods toPath :: DeleteRestApi -> ByteString #
ToQuery DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods toQuery :: DeleteRestApi -> QueryString #
AWSRequest DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Associated Types type AWSResponse DeleteRestApi # Methods request :: (Service -> Service) -> DeleteRestApi -> Request DeleteRestApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteRestApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteRestApi))) #
Generic DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Associated Types type Rep DeleteRestApi :: Type -> Type # Methods from :: DeleteRestApi -> Rep DeleteRestApi x # to :: Rep DeleteRestApi x -> DeleteRestApi #
Read DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods readsPrec :: Int -> ReadS DeleteRestApi # readList :: ReadS [DeleteRestApi] # readPrec :: ReadPrec DeleteRestApi # readListPrec :: ReadPrec [DeleteRestApi] #
Show DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods showsPrec :: Int -> DeleteRestApi -> ShowS # show :: DeleteRestApi -> String # showList :: [DeleteRestApi] -> ShowS #
NFData DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods rnf :: DeleteRestApi -> () #
Eq DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods (==) :: DeleteRestApi -> DeleteRestApi -> Bool # (/=) :: DeleteRestApi -> DeleteRestApi -> Bool #
Hashable DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods hashWithSalt :: Int -> DeleteRestApi -> Int # hash :: DeleteRestApi -> Int #
type AWSResponse DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi type AWSResponse DeleteRestApi = DeleteRestApiResponse
type Rep DeleteRestApi Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi type Rep DeleteRestApi = D1 ('MetaData "DeleteRestApi" "Amazonka.APIGateway.DeleteRestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteRestApi'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteRestApi Source #

Arguments

:: Text	`DeleteRestApi`
-> DeleteRestApi

Create a value of DeleteRestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteRestApi, deleteRestApi_restApiId - The string identifier of the associated RestApi.

data DeleteRestApiResponse Source #

See: newDeleteRestApiResponse smart constructor.

Constructors

DeleteRestApiResponse'

Instances

Instances details

Generic DeleteRestApiResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Associated Types type Rep DeleteRestApiResponse :: Type -> Type # Methods from :: DeleteRestApiResponse -> Rep DeleteRestApiResponse x # to :: Rep DeleteRestApiResponse x -> DeleteRestApiResponse #
Read DeleteRestApiResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods readsPrec :: Int -> ReadS DeleteRestApiResponse # readList :: ReadS [DeleteRestApiResponse] # readPrec :: ReadPrec DeleteRestApiResponse # readListPrec :: ReadPrec [DeleteRestApiResponse] #
Show DeleteRestApiResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods showsPrec :: Int -> DeleteRestApiResponse -> ShowS # show :: DeleteRestApiResponse -> String # showList :: [DeleteRestApiResponse] -> ShowS #
NFData DeleteRestApiResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods rnf :: DeleteRestApiResponse -> () #
Eq DeleteRestApiResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi Methods (==) :: DeleteRestApiResponse -> DeleteRestApiResponse -> Bool # (/=) :: DeleteRestApiResponse -> DeleteRestApiResponse -> Bool #
type Rep DeleteRestApiResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteRestApi type Rep DeleteRestApiResponse = D1 ('MetaData "DeleteRestApiResponse" "Amazonka.APIGateway.DeleteRestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteRestApiResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteRestApiResponse :: DeleteRestApiResponse Source #

Create a value of DeleteRestApiResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteStage

data DeleteStage Source #

Requests API Gateway to delete a Stage resource.

See: newDeleteStage smart constructor.

Constructors

DeleteStage' Text Text

Instances

Instances details

ToHeaders DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods toHeaders :: DeleteStage -> [Header] #
ToPath DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods toPath :: DeleteStage -> ByteString #
ToQuery DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods toQuery :: DeleteStage -> QueryString #
AWSRequest DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Associated Types type AWSResponse DeleteStage # Methods request :: (Service -> Service) -> DeleteStage -> Request DeleteStage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteStage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteStage))) #
Generic DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Associated Types type Rep DeleteStage :: Type -> Type # Methods from :: DeleteStage -> Rep DeleteStage x # to :: Rep DeleteStage x -> DeleteStage #
Read DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods readsPrec :: Int -> ReadS DeleteStage # readList :: ReadS [DeleteStage] # readPrec :: ReadPrec DeleteStage # readListPrec :: ReadPrec [DeleteStage] #
Show DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods showsPrec :: Int -> DeleteStage -> ShowS # show :: DeleteStage -> String # showList :: [DeleteStage] -> ShowS #
NFData DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods rnf :: DeleteStage -> () #
Eq DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods (==) :: DeleteStage -> DeleteStage -> Bool # (/=) :: DeleteStage -> DeleteStage -> Bool #
Hashable DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods hashWithSalt :: Int -> DeleteStage -> Int # hash :: DeleteStage -> Int #
type AWSResponse DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage type AWSResponse DeleteStage = DeleteStageResponse
type Rep DeleteStage Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage type Rep DeleteStage = D1 ('MetaData "DeleteStage" "Amazonka.APIGateway.DeleteStage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteStage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteStage Source #

Arguments

:: Text	`DeleteStage`
-> Text	`DeleteStage`
-> DeleteStage

Create a value of DeleteStage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteStage, deleteStage_restApiId - The string identifier of the associated RestApi.

DeleteStage, deleteStage_stageName - The name of the Stage resource to delete.

data DeleteStageResponse Source #

See: newDeleteStageResponse smart constructor.

Constructors

DeleteStageResponse'

Instances

Instances details

Generic DeleteStageResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Associated Types type Rep DeleteStageResponse :: Type -> Type # Methods from :: DeleteStageResponse -> Rep DeleteStageResponse x # to :: Rep DeleteStageResponse x -> DeleteStageResponse #
Read DeleteStageResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods readsPrec :: Int -> ReadS DeleteStageResponse # readList :: ReadS [DeleteStageResponse] # readPrec :: ReadPrec DeleteStageResponse # readListPrec :: ReadPrec [DeleteStageResponse] #
Show DeleteStageResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods showsPrec :: Int -> DeleteStageResponse -> ShowS # show :: DeleteStageResponse -> String # showList :: [DeleteStageResponse] -> ShowS #
NFData DeleteStageResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods rnf :: DeleteStageResponse -> () #
Eq DeleteStageResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage Methods (==) :: DeleteStageResponse -> DeleteStageResponse -> Bool # (/=) :: DeleteStageResponse -> DeleteStageResponse -> Bool #
type Rep DeleteStageResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteStage type Rep DeleteStageResponse = D1 ('MetaData "DeleteStageResponse" "Amazonka.APIGateway.DeleteStage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteStageResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteStageResponse :: DeleteStageResponse Source #

Create a value of DeleteStageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteUsagePlan

data DeleteUsagePlan Source #

The DELETE request to delete a usage plan of a given plan Id.

See: newDeleteUsagePlan smart constructor.

Constructors

DeleteUsagePlan' Text

Instances

Instances details

ToHeaders DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods toHeaders :: DeleteUsagePlan -> [Header] #
ToPath DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods toPath :: DeleteUsagePlan -> ByteString #
ToQuery DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods toQuery :: DeleteUsagePlan -> QueryString #
AWSRequest DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Associated Types type AWSResponse DeleteUsagePlan # Methods request :: (Service -> Service) -> DeleteUsagePlan -> Request DeleteUsagePlan # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteUsagePlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteUsagePlan))) #
Generic DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Associated Types type Rep DeleteUsagePlan :: Type -> Type # Methods from :: DeleteUsagePlan -> Rep DeleteUsagePlan x # to :: Rep DeleteUsagePlan x -> DeleteUsagePlan #
Read DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods readsPrec :: Int -> ReadS DeleteUsagePlan # readList :: ReadS [DeleteUsagePlan] # readPrec :: ReadPrec DeleteUsagePlan # readListPrec :: ReadPrec [DeleteUsagePlan] #
Show DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods showsPrec :: Int -> DeleteUsagePlan -> ShowS # show :: DeleteUsagePlan -> String # showList :: [DeleteUsagePlan] -> ShowS #
NFData DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods rnf :: DeleteUsagePlan -> () #
Eq DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods (==) :: DeleteUsagePlan -> DeleteUsagePlan -> Bool # (/=) :: DeleteUsagePlan -> DeleteUsagePlan -> Bool #
Hashable DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods hashWithSalt :: Int -> DeleteUsagePlan -> Int # hash :: DeleteUsagePlan -> Int #
type AWSResponse DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan type AWSResponse DeleteUsagePlan = DeleteUsagePlanResponse
type Rep DeleteUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan type Rep DeleteUsagePlan = D1 ('MetaData "DeleteUsagePlan" "Amazonka.APIGateway.DeleteUsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteUsagePlan'" 'PrefixI 'True) (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteUsagePlan Source #

Arguments

:: Text	`DeleteUsagePlan`
-> DeleteUsagePlan

Create a value of DeleteUsagePlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteUsagePlan, deleteUsagePlan_usagePlanId - The Id of the to-be-deleted usage plan.

data DeleteUsagePlanResponse Source #

See: newDeleteUsagePlanResponse smart constructor.

Constructors

DeleteUsagePlanResponse'

Instances

Instances details

Generic DeleteUsagePlanResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Associated Types type Rep DeleteUsagePlanResponse :: Type -> Type # Methods from :: DeleteUsagePlanResponse -> Rep DeleteUsagePlanResponse x # to :: Rep DeleteUsagePlanResponse x -> DeleteUsagePlanResponse #
Read DeleteUsagePlanResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods readsPrec :: Int -> ReadS DeleteUsagePlanResponse # readList :: ReadS [DeleteUsagePlanResponse] # readPrec :: ReadPrec DeleteUsagePlanResponse # readListPrec :: ReadPrec [DeleteUsagePlanResponse] #
Show DeleteUsagePlanResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods showsPrec :: Int -> DeleteUsagePlanResponse -> ShowS # show :: DeleteUsagePlanResponse -> String # showList :: [DeleteUsagePlanResponse] -> ShowS #
NFData DeleteUsagePlanResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods rnf :: DeleteUsagePlanResponse -> () #
Eq DeleteUsagePlanResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan Methods (==) :: DeleteUsagePlanResponse -> DeleteUsagePlanResponse -> Bool # (/=) :: DeleteUsagePlanResponse -> DeleteUsagePlanResponse -> Bool #
type Rep DeleteUsagePlanResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlan type Rep DeleteUsagePlanResponse = D1 ('MetaData "DeleteUsagePlanResponse" "Amazonka.APIGateway.DeleteUsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteUsagePlanResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteUsagePlanResponse :: DeleteUsagePlanResponse Source #

Create a value of DeleteUsagePlanResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteUsagePlanKey

data DeleteUsagePlanKey Source #

The DELETE request to delete a usage plan key and remove the underlying API key from the associated usage plan.

See: newDeleteUsagePlanKey smart constructor.

Constructors

DeleteUsagePlanKey' Text Text

Instances

Instances details

ToHeaders DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods toHeaders :: DeleteUsagePlanKey -> [Header] #
ToPath DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods toPath :: DeleteUsagePlanKey -> ByteString #
ToQuery DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods toQuery :: DeleteUsagePlanKey -> QueryString #
AWSRequest DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Associated Types type AWSResponse DeleteUsagePlanKey # Methods request :: (Service -> Service) -> DeleteUsagePlanKey -> Request DeleteUsagePlanKey # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteUsagePlanKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteUsagePlanKey))) #
Generic DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Associated Types type Rep DeleteUsagePlanKey :: Type -> Type # Methods from :: DeleteUsagePlanKey -> Rep DeleteUsagePlanKey x # to :: Rep DeleteUsagePlanKey x -> DeleteUsagePlanKey #
Read DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods readsPrec :: Int -> ReadS DeleteUsagePlanKey # readList :: ReadS [DeleteUsagePlanKey] # readPrec :: ReadPrec DeleteUsagePlanKey # readListPrec :: ReadPrec [DeleteUsagePlanKey] #
Show DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods showsPrec :: Int -> DeleteUsagePlanKey -> ShowS # show :: DeleteUsagePlanKey -> String # showList :: [DeleteUsagePlanKey] -> ShowS #
NFData DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods rnf :: DeleteUsagePlanKey -> () #
Eq DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods (==) :: DeleteUsagePlanKey -> DeleteUsagePlanKey -> Bool # (/=) :: DeleteUsagePlanKey -> DeleteUsagePlanKey -> Bool #
Hashable DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods hashWithSalt :: Int -> DeleteUsagePlanKey -> Int # hash :: DeleteUsagePlanKey -> Int #
type AWSResponse DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey type AWSResponse DeleteUsagePlanKey = DeleteUsagePlanKeyResponse
type Rep DeleteUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey type Rep DeleteUsagePlanKey = D1 ('MetaData "DeleteUsagePlanKey" "Amazonka.APIGateway.DeleteUsagePlanKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteUsagePlanKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteUsagePlanKey Source #

Arguments

:: Text	`DeleteUsagePlanKey`
-> Text	`$sel:keyId:DeleteUsagePlanKey'`
-> DeleteUsagePlanKey

Create a value of DeleteUsagePlanKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DeleteUsagePlanKey, deleteUsagePlanKey_usagePlanId - The Id of the UsagePlan resource representing the usage plan containing the to-be-deleted UsagePlanKey resource representing a plan customer.

$sel:keyId:DeleteUsagePlanKey', deleteUsagePlanKey_keyId - The Id of the UsagePlanKey resource to be deleted.

data DeleteUsagePlanKeyResponse Source #

See: newDeleteUsagePlanKeyResponse smart constructor.

Constructors

DeleteUsagePlanKeyResponse'

Instances

Instances details

Generic DeleteUsagePlanKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Associated Types type Rep DeleteUsagePlanKeyResponse :: Type -> Type # Methods from :: DeleteUsagePlanKeyResponse -> Rep DeleteUsagePlanKeyResponse x # to :: Rep DeleteUsagePlanKeyResponse x -> DeleteUsagePlanKeyResponse #
Read DeleteUsagePlanKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods readsPrec :: Int -> ReadS DeleteUsagePlanKeyResponse # readList :: ReadS [DeleteUsagePlanKeyResponse] # readPrec :: ReadPrec DeleteUsagePlanKeyResponse # readListPrec :: ReadPrec [DeleteUsagePlanKeyResponse] #
Show DeleteUsagePlanKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods showsPrec :: Int -> DeleteUsagePlanKeyResponse -> ShowS # show :: DeleteUsagePlanKeyResponse -> String # showList :: [DeleteUsagePlanKeyResponse] -> ShowS #
NFData DeleteUsagePlanKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods rnf :: DeleteUsagePlanKeyResponse -> () #
Eq DeleteUsagePlanKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey Methods (==) :: DeleteUsagePlanKeyResponse -> DeleteUsagePlanKeyResponse -> Bool # (/=) :: DeleteUsagePlanKeyResponse -> DeleteUsagePlanKeyResponse -> Bool #
type Rep DeleteUsagePlanKeyResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteUsagePlanKey type Rep DeleteUsagePlanKeyResponse = D1 ('MetaData "DeleteUsagePlanKeyResponse" "Amazonka.APIGateway.DeleteUsagePlanKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteUsagePlanKeyResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteUsagePlanKeyResponse :: DeleteUsagePlanKeyResponse Source #

Create a value of DeleteUsagePlanKeyResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

DeleteVpcLink

data DeleteVpcLink Source #

Deletes an existing VpcLink of a specified identifier.

See: newDeleteVpcLink smart constructor.

Constructors

DeleteVpcLink' Text

Instances

Instances details

ToHeaders DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods toHeaders :: DeleteVpcLink -> [Header] #
ToPath DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods toPath :: DeleteVpcLink -> ByteString #
ToQuery DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods toQuery :: DeleteVpcLink -> QueryString #
AWSRequest DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Associated Types type AWSResponse DeleteVpcLink # Methods request :: (Service -> Service) -> DeleteVpcLink -> Request DeleteVpcLink # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteVpcLink -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteVpcLink))) #
Generic DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Associated Types type Rep DeleteVpcLink :: Type -> Type # Methods from :: DeleteVpcLink -> Rep DeleteVpcLink x # to :: Rep DeleteVpcLink x -> DeleteVpcLink #
Read DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods readsPrec :: Int -> ReadS DeleteVpcLink # readList :: ReadS [DeleteVpcLink] # readPrec :: ReadPrec DeleteVpcLink # readListPrec :: ReadPrec [DeleteVpcLink] #
Show DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods showsPrec :: Int -> DeleteVpcLink -> ShowS # show :: DeleteVpcLink -> String # showList :: [DeleteVpcLink] -> ShowS #
NFData DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods rnf :: DeleteVpcLink -> () #
Eq DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods (==) :: DeleteVpcLink -> DeleteVpcLink -> Bool # (/=) :: DeleteVpcLink -> DeleteVpcLink -> Bool #
Hashable DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods hashWithSalt :: Int -> DeleteVpcLink -> Int # hash :: DeleteVpcLink -> Int #
type AWSResponse DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink type AWSResponse DeleteVpcLink = DeleteVpcLinkResponse
type Rep DeleteVpcLink Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink type Rep DeleteVpcLink = D1 ('MetaData "DeleteVpcLink" "Amazonka.APIGateway.DeleteVpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteVpcLink'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpcLinkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDeleteVpcLink Source #

Arguments

:: Text	`$sel:vpcLinkId:DeleteVpcLink'`
-> DeleteVpcLink

Create a value of DeleteVpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:vpcLinkId:DeleteVpcLink', deleteVpcLink_vpcLinkId - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

data DeleteVpcLinkResponse Source #

See: newDeleteVpcLinkResponse smart constructor.

Constructors

DeleteVpcLinkResponse'

Instances

Instances details

Generic DeleteVpcLinkResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Associated Types type Rep DeleteVpcLinkResponse :: Type -> Type # Methods from :: DeleteVpcLinkResponse -> Rep DeleteVpcLinkResponse x # to :: Rep DeleteVpcLinkResponse x -> DeleteVpcLinkResponse #
Read DeleteVpcLinkResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods readsPrec :: Int -> ReadS DeleteVpcLinkResponse # readList :: ReadS [DeleteVpcLinkResponse] # readPrec :: ReadPrec DeleteVpcLinkResponse # readListPrec :: ReadPrec [DeleteVpcLinkResponse] #
Show DeleteVpcLinkResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods showsPrec :: Int -> DeleteVpcLinkResponse -> ShowS # show :: DeleteVpcLinkResponse -> String # showList :: [DeleteVpcLinkResponse] -> ShowS #
NFData DeleteVpcLinkResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods rnf :: DeleteVpcLinkResponse -> () #
Eq DeleteVpcLinkResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink Methods (==) :: DeleteVpcLinkResponse -> DeleteVpcLinkResponse -> Bool # (/=) :: DeleteVpcLinkResponse -> DeleteVpcLinkResponse -> Bool #
type Rep DeleteVpcLinkResponse Source #
Instance details Defined in Amazonka.APIGateway.DeleteVpcLink type Rep DeleteVpcLinkResponse = D1 ('MetaData "DeleteVpcLinkResponse" "Amazonka.APIGateway.DeleteVpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeleteVpcLinkResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newDeleteVpcLinkResponse :: DeleteVpcLinkResponse Source #

Create a value of DeleteVpcLinkResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

FlushStageAuthorizersCache

data FlushStageAuthorizersCache Source #

Request to flush authorizer cache entries on a specified stage.

See: newFlushStageAuthorizersCache smart constructor.

Constructors

FlushStageAuthorizersCache' Text Text

Instances

Instances details

ToHeaders FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods toHeaders :: FlushStageAuthorizersCache -> [Header] #
ToPath FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods toPath :: FlushStageAuthorizersCache -> ByteString #
ToQuery FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods toQuery :: FlushStageAuthorizersCache -> QueryString #
AWSRequest FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Associated Types type AWSResponse FlushStageAuthorizersCache # Methods request :: (Service -> Service) -> FlushStageAuthorizersCache -> Request FlushStageAuthorizersCache # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy FlushStageAuthorizersCache -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse FlushStageAuthorizersCache))) #
Generic FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Associated Types type Rep FlushStageAuthorizersCache :: Type -> Type # Methods from :: FlushStageAuthorizersCache -> Rep FlushStageAuthorizersCache x # to :: Rep FlushStageAuthorizersCache x -> FlushStageAuthorizersCache #
Read FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods readsPrec :: Int -> ReadS FlushStageAuthorizersCache # readList :: ReadS [FlushStageAuthorizersCache] # readPrec :: ReadPrec FlushStageAuthorizersCache # readListPrec :: ReadPrec [FlushStageAuthorizersCache] #
Show FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods showsPrec :: Int -> FlushStageAuthorizersCache -> ShowS # show :: FlushStageAuthorizersCache -> String # showList :: [FlushStageAuthorizersCache] -> ShowS #
NFData FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods rnf :: FlushStageAuthorizersCache -> () #
Eq FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods (==) :: FlushStageAuthorizersCache -> FlushStageAuthorizersCache -> Bool # (/=) :: FlushStageAuthorizersCache -> FlushStageAuthorizersCache -> Bool #
Hashable FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods hashWithSalt :: Int -> FlushStageAuthorizersCache -> Int # hash :: FlushStageAuthorizersCache -> Int #
type AWSResponse FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache type AWSResponse FlushStageAuthorizersCache = FlushStageAuthorizersCacheResponse
type Rep FlushStageAuthorizersCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache type Rep FlushStageAuthorizersCache = D1 ('MetaData "FlushStageAuthorizersCache" "Amazonka.APIGateway.FlushStageAuthorizersCache" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "FlushStageAuthorizersCache'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newFlushStageAuthorizersCache Source #

Arguments

:: Text	`FlushStageAuthorizersCache`
-> Text	`FlushStageAuthorizersCache`
-> FlushStageAuthorizersCache

Create a value of FlushStageAuthorizersCache with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

FlushStageAuthorizersCache, flushStageAuthorizersCache_restApiId - The string identifier of the associated RestApi.

FlushStageAuthorizersCache, flushStageAuthorizersCache_stageName - The name of the stage to flush.

data FlushStageAuthorizersCacheResponse Source #

See: newFlushStageAuthorizersCacheResponse smart constructor.

Constructors

FlushStageAuthorizersCacheResponse'

Instances

Instances details

Generic FlushStageAuthorizersCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Associated Types type Rep FlushStageAuthorizersCacheResponse :: Type -> Type # Methods from :: FlushStageAuthorizersCacheResponse -> Rep FlushStageAuthorizersCacheResponse x # to :: Rep FlushStageAuthorizersCacheResponse x -> FlushStageAuthorizersCacheResponse #
Read FlushStageAuthorizersCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods readsPrec :: Int -> ReadS FlushStageAuthorizersCacheResponse # readList :: ReadS [FlushStageAuthorizersCacheResponse] # readPrec :: ReadPrec FlushStageAuthorizersCacheResponse # readListPrec :: ReadPrec [FlushStageAuthorizersCacheResponse] #
Show FlushStageAuthorizersCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods showsPrec :: Int -> FlushStageAuthorizersCacheResponse -> ShowS # show :: FlushStageAuthorizersCacheResponse -> String # showList :: [FlushStageAuthorizersCacheResponse] -> ShowS #
NFData FlushStageAuthorizersCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods rnf :: FlushStageAuthorizersCacheResponse -> () #
Eq FlushStageAuthorizersCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache Methods (==) :: FlushStageAuthorizersCacheResponse -> FlushStageAuthorizersCacheResponse -> Bool # (/=) :: FlushStageAuthorizersCacheResponse -> FlushStageAuthorizersCacheResponse -> Bool #
type Rep FlushStageAuthorizersCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageAuthorizersCache type Rep FlushStageAuthorizersCacheResponse = D1 ('MetaData "FlushStageAuthorizersCacheResponse" "Amazonka.APIGateway.FlushStageAuthorizersCache" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "FlushStageAuthorizersCacheResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newFlushStageAuthorizersCacheResponse :: FlushStageAuthorizersCacheResponse Source #

Create a value of FlushStageAuthorizersCacheResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

FlushStageCache

data FlushStageCache Source #

Requests API Gateway to flush a stage's cache.

See: newFlushStageCache smart constructor.

Constructors

FlushStageCache' Text Text

Instances

Instances details

ToHeaders FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods toHeaders :: FlushStageCache -> [Header] #
ToPath FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods toPath :: FlushStageCache -> ByteString #
ToQuery FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods toQuery :: FlushStageCache -> QueryString #
AWSRequest FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Associated Types type AWSResponse FlushStageCache # Methods request :: (Service -> Service) -> FlushStageCache -> Request FlushStageCache # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy FlushStageCache -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse FlushStageCache))) #
Generic FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Associated Types type Rep FlushStageCache :: Type -> Type # Methods from :: FlushStageCache -> Rep FlushStageCache x # to :: Rep FlushStageCache x -> FlushStageCache #
Read FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods readsPrec :: Int -> ReadS FlushStageCache # readList :: ReadS [FlushStageCache] # readPrec :: ReadPrec FlushStageCache # readListPrec :: ReadPrec [FlushStageCache] #
Show FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods showsPrec :: Int -> FlushStageCache -> ShowS # show :: FlushStageCache -> String # showList :: [FlushStageCache] -> ShowS #
NFData FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods rnf :: FlushStageCache -> () #
Eq FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods (==) :: FlushStageCache -> FlushStageCache -> Bool # (/=) :: FlushStageCache -> FlushStageCache -> Bool #
Hashable FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods hashWithSalt :: Int -> FlushStageCache -> Int # hash :: FlushStageCache -> Int #
type AWSResponse FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache type AWSResponse FlushStageCache = FlushStageCacheResponse
type Rep FlushStageCache Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache type Rep FlushStageCache = D1 ('MetaData "FlushStageCache" "Amazonka.APIGateway.FlushStageCache" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "FlushStageCache'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newFlushStageCache Source #

Arguments

:: Text	`FlushStageCache`
-> Text	`FlushStageCache`
-> FlushStageCache

Create a value of FlushStageCache with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

FlushStageCache, flushStageCache_restApiId - The string identifier of the associated RestApi.

FlushStageCache, flushStageCache_stageName - The name of the stage to flush its cache.

data FlushStageCacheResponse Source #

See: newFlushStageCacheResponse smart constructor.

Constructors

FlushStageCacheResponse'

Instances

Instances details

Generic FlushStageCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Associated Types type Rep FlushStageCacheResponse :: Type -> Type # Methods from :: FlushStageCacheResponse -> Rep FlushStageCacheResponse x # to :: Rep FlushStageCacheResponse x -> FlushStageCacheResponse #
Read FlushStageCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods readsPrec :: Int -> ReadS FlushStageCacheResponse # readList :: ReadS [FlushStageCacheResponse] # readPrec :: ReadPrec FlushStageCacheResponse # readListPrec :: ReadPrec [FlushStageCacheResponse] #
Show FlushStageCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods showsPrec :: Int -> FlushStageCacheResponse -> ShowS # show :: FlushStageCacheResponse -> String # showList :: [FlushStageCacheResponse] -> ShowS #
NFData FlushStageCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods rnf :: FlushStageCacheResponse -> () #
Eq FlushStageCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache Methods (==) :: FlushStageCacheResponse -> FlushStageCacheResponse -> Bool # (/=) :: FlushStageCacheResponse -> FlushStageCacheResponse -> Bool #
type Rep FlushStageCacheResponse Source #
Instance details Defined in Amazonka.APIGateway.FlushStageCache type Rep FlushStageCacheResponse = D1 ('MetaData "FlushStageCacheResponse" "Amazonka.APIGateway.FlushStageCache" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "FlushStageCacheResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newFlushStageCacheResponse :: FlushStageCacheResponse Source #

Create a value of FlushStageCacheResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

GenerateClientCertificate

data GenerateClientCertificate Source #

A request to generate a ClientCertificate resource.

See: newGenerateClientCertificate smart constructor.

Constructors

GenerateClientCertificate' (Maybe Text) (Maybe (HashMap Text Text))

Instances

Instances details

ToJSON GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods toJSON :: GenerateClientCertificate -> Value # toEncoding :: GenerateClientCertificate -> Encoding # toJSONList :: [GenerateClientCertificate] -> Value # toEncodingList :: [GenerateClientCertificate] -> Encoding #
ToHeaders GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods toHeaders :: GenerateClientCertificate -> [Header] #
ToPath GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods toPath :: GenerateClientCertificate -> ByteString #
ToQuery GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods toQuery :: GenerateClientCertificate -> QueryString #
AWSRequest GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Associated Types type AWSResponse GenerateClientCertificate # Methods request :: (Service -> Service) -> GenerateClientCertificate -> Request GenerateClientCertificate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GenerateClientCertificate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GenerateClientCertificate))) #
Generic GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Associated Types type Rep GenerateClientCertificate :: Type -> Type # Methods from :: GenerateClientCertificate -> Rep GenerateClientCertificate x # to :: Rep GenerateClientCertificate x -> GenerateClientCertificate #
Read GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods readsPrec :: Int -> ReadS GenerateClientCertificate # readList :: ReadS [GenerateClientCertificate] # readPrec :: ReadPrec GenerateClientCertificate # readListPrec :: ReadPrec [GenerateClientCertificate] #
Show GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods showsPrec :: Int -> GenerateClientCertificate -> ShowS # show :: GenerateClientCertificate -> String # showList :: [GenerateClientCertificate] -> ShowS #
NFData GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods rnf :: GenerateClientCertificate -> () #
Eq GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods (==) :: GenerateClientCertificate -> GenerateClientCertificate -> Bool # (/=) :: GenerateClientCertificate -> GenerateClientCertificate -> Bool #
Hashable GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate Methods hashWithSalt :: Int -> GenerateClientCertificate -> Int # hash :: GenerateClientCertificate -> Int #
type AWSResponse GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate type AWSResponse GenerateClientCertificate = ClientCertificate
type Rep GenerateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GenerateClientCertificate type Rep GenerateClientCertificate = D1 ('MetaData "GenerateClientCertificate" "Amazonka.APIGateway.GenerateClientCertificate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GenerateClientCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))

newGenerateClientCertificate :: GenerateClientCertificate Source #

Create a value of GenerateClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GenerateClientCertificate, generateClientCertificate_description - The description of the ClientCertificate.

GenerateClientCertificate, generateClientCertificate_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

data ClientCertificate Source #

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

See: newClientCertificate smart constructor.

Constructors

ClientCertificate' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text))

Instances

Instances details

FromJSON ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods parseJSON :: Value -> Parser ClientCertificate # parseJSONList :: Value -> Parser [ClientCertificate] #
Generic ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Associated Types type Rep ClientCertificate :: Type -> Type # Methods from :: ClientCertificate -> Rep ClientCertificate x # to :: Rep ClientCertificate x -> ClientCertificate #
Read ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods readsPrec :: Int -> ReadS ClientCertificate # readList :: ReadS [ClientCertificate] # readPrec :: ReadPrec ClientCertificate # readListPrec :: ReadPrec [ClientCertificate] #
Show ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods showsPrec :: Int -> ClientCertificate -> ShowS # show :: ClientCertificate -> String # showList :: [ClientCertificate] -> ShowS #
NFData ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods rnf :: ClientCertificate -> () #
Eq ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods (==) :: ClientCertificate -> ClientCertificate -> Bool # (/=) :: ClientCertificate -> ClientCertificate -> Bool #
Hashable ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods hashWithSalt :: Int -> ClientCertificate -> Int # hash :: ClientCertificate -> Int #
type Rep ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate type Rep ClientCertificate = D1 ('MetaData "ClientCertificate" "Amazonka.APIGateway.Types.ClientCertificate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ClientCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "pemEncodedCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newClientCertificate :: ClientCertificate Source #

Create a value of ClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientCertificateId:ClientCertificate', clientCertificate_clientCertificateId - The identifier of the client certificate.

$sel:createdDate:ClientCertificate', clientCertificate_createdDate - The timestamp when the client certificate was created.

$sel:description:ClientCertificate', clientCertificate_description - The description of the client certificate.

$sel:expirationDate:ClientCertificate', clientCertificate_expirationDate - The timestamp when the client certificate will expire.

$sel:pemEncodedCertificate:ClientCertificate', clientCertificate_pemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

$sel:tags:ClientCertificate', clientCertificate_tags - The collection of tags. Each tag element is associated with a given resource.

GetAccount

data GetAccount Source #

Requests API Gateway to get information about the current Account resource.

See: newGetAccount smart constructor.

Constructors

GetAccount'

Instances

Instances details

ToHeaders GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Methods toHeaders :: GetAccount -> [Header] #
ToPath GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Methods toPath :: GetAccount -> ByteString #
ToQuery GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Methods toQuery :: GetAccount -> QueryString #
AWSRequest GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Associated Types type AWSResponse GetAccount # Methods request :: (Service -> Service) -> GetAccount -> Request GetAccount # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetAccount -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAccount))) #
Generic GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Associated Types type Rep GetAccount :: Type -> Type # Methods from :: GetAccount -> Rep GetAccount x # to :: Rep GetAccount x -> GetAccount #
Read GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Methods readsPrec :: Int -> ReadS GetAccount # readList :: ReadS [GetAccount] # readPrec :: ReadPrec GetAccount # readListPrec :: ReadPrec [GetAccount] #
Show GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Methods showsPrec :: Int -> GetAccount -> ShowS # show :: GetAccount -> String # showList :: [GetAccount] -> ShowS #
NFData GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Methods rnf :: GetAccount -> () #
Eq GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Methods (==) :: GetAccount -> GetAccount -> Bool # (/=) :: GetAccount -> GetAccount -> Bool #
Hashable GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount Methods hashWithSalt :: Int -> GetAccount -> Int # hash :: GetAccount -> Int #
type AWSResponse GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount type AWSResponse GetAccount = Account
type Rep GetAccount Source #
Instance details Defined in Amazonka.APIGateway.GetAccount type Rep GetAccount = D1 ('MetaData "GetAccount" "Amazonka.APIGateway.GetAccount" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetAccount'" 'PrefixI 'False) (U1 :: Type -> Type))

newGetAccount :: GetAccount Source #

Create a value of GetAccount with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

data Account Source #

Represents an AWS account that is associated with API Gateway.

See: newAccount smart constructor.

Constructors

Account' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ThrottleSettings)

Instances

Instances details

FromJSON Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods parseJSON :: Value -> Parser Account # parseJSONList :: Value -> Parser [Account] #
Generic Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Associated Types type Rep Account :: Type -> Type # Methods from :: Account -> Rep Account x # to :: Rep Account x -> Account #
Read Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods readsPrec :: Int -> ReadS Account # readList :: ReadS [Account] # readPrec :: ReadPrec Account # readListPrec :: ReadPrec [Account] #
Show Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #
NFData Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods rnf :: Account -> () #
Eq Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods (==) :: Account -> Account -> Bool # (/=) :: Account -> Account -> Bool #
Hashable Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods hashWithSalt :: Int -> Account -> Int # hash :: Account -> Int #
type Rep Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account type Rep Account = D1 ('MetaData "Account" "Amazonka.APIGateway.Types.Account" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Account'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiKeyVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cloudwatchRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "features") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "throttleSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings)))))

newAccount :: Account Source #

Create a value of Account with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyVersion:Account', account_apiKeyVersion - The version of the API keys used for the account.

$sel:cloudwatchRoleArn:Account', account_cloudwatchRoleArn - The ARN of an Amazon CloudWatch role for the current Account.

$sel:features:Account', account_features - A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

$sel:throttleSettings:Account', account_throttleSettings - Specifies the API request limits configured for the current Account.

GetApiKey

data GetApiKey Source #

A request to get information about the current ApiKey resource.

See: newGetApiKey smart constructor.

Constructors

GetApiKey' (Maybe Bool) Text

Instances

Instances details

ToHeaders GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods toHeaders :: GetApiKey -> [Header] #
ToPath GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods toPath :: GetApiKey -> ByteString #
ToQuery GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods toQuery :: GetApiKey -> QueryString #
AWSRequest GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Associated Types type AWSResponse GetApiKey # Methods request :: (Service -> Service) -> GetApiKey -> Request GetApiKey # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetApiKey))) #
Generic GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Associated Types type Rep GetApiKey :: Type -> Type # Methods from :: GetApiKey -> Rep GetApiKey x # to :: Rep GetApiKey x -> GetApiKey #
Read GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods readsPrec :: Int -> ReadS GetApiKey # readList :: ReadS [GetApiKey] # readPrec :: ReadPrec GetApiKey # readListPrec :: ReadPrec [GetApiKey] #
Show GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods showsPrec :: Int -> GetApiKey -> ShowS # show :: GetApiKey -> String # showList :: [GetApiKey] -> ShowS #
NFData GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods rnf :: GetApiKey -> () #
Eq GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods (==) :: GetApiKey -> GetApiKey -> Bool # (/=) :: GetApiKey -> GetApiKey -> Bool #
Hashable GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey Methods hashWithSalt :: Int -> GetApiKey -> Int # hash :: GetApiKey -> Int #
type AWSResponse GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey type AWSResponse GetApiKey = ApiKey
type Rep GetApiKey Source #
Instance details Defined in Amazonka.APIGateway.GetApiKey type Rep GetApiKey = D1 ('MetaData "GetApiKey" "Amazonka.APIGateway.GetApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetApiKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "includeValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetApiKey Source #

Arguments

:: Text	`$sel:apiKey:GetApiKey'`
-> GetApiKey

Create a value of GetApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:includeValue:GetApiKey', getApiKey_includeValue - A boolean flag to specify whether (true) or not (false) the result contains the key value.

$sel:apiKey:GetApiKey', getApiKey_apiKey - The identifier of the ApiKey resource.

data ApiKey Source #

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See: newApiKey smart constructor.

Constructors

ApiKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text)

Instances

Instances details

FromJSON ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods parseJSON :: Value -> Parser ApiKey # parseJSONList :: Value -> Parser [ApiKey] #
Generic ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Associated Types type Rep ApiKey :: Type -> Type # Methods from :: ApiKey -> Rep ApiKey x # to :: Rep ApiKey x -> ApiKey #
Read ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods readsPrec :: Int -> ReadS ApiKey # readList :: ReadS [ApiKey] # readPrec :: ReadPrec ApiKey # readListPrec :: ReadPrec [ApiKey] #
Show ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods showsPrec :: Int -> ApiKey -> ShowS # show :: ApiKey -> String # showList :: [ApiKey] -> ShowS #
NFData ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods rnf :: ApiKey -> () #
Eq ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods (==) :: ApiKey -> ApiKey -> Bool # (/=) :: ApiKey -> ApiKey -> Bool #
Hashable ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods hashWithSalt :: Int -> ApiKey -> Int # hash :: ApiKey -> Int #
type Rep ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newApiKey :: ApiKey Source #

Create a value of ApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

$sel:customerId:ApiKey', apiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

$sel:description:ApiKey', apiKey_description - The description of the API Key.

$sel:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

$sel:id:ApiKey', apiKey_id - The identifier of the API Key.

$sel:lastUpdatedDate:ApiKey', apiKey_lastUpdatedDate - The timestamp when the API Key was last updated.

$sel:name:ApiKey', apiKey_name - The name of the API Key.

$sel:stageKeys:ApiKey', apiKey_stageKeys - A list of Stage resources that are associated with the ApiKey resource.

$sel:tags:ApiKey', apiKey_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:value:ApiKey', apiKey_value - The value of the API Key.

GetApiKeys (Paginated)

data GetApiKeys Source #

A request to get information about the current ApiKeys resource.

See: newGetApiKeys smart constructor.

Constructors

GetApiKeys' (Maybe Text) (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Text)

Instances

Instances details

ToHeaders GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods toHeaders :: GetApiKeys -> [Header] #
ToPath GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods toPath :: GetApiKeys -> ByteString #
ToQuery GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods toQuery :: GetApiKeys -> QueryString #
AWSPager GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods page :: GetApiKeys -> AWSResponse GetApiKeys -> Maybe GetApiKeys #
AWSRequest GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Associated Types type AWSResponse GetApiKeys # Methods request :: (Service -> Service) -> GetApiKeys -> Request GetApiKeys # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetApiKeys -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetApiKeys))) #
Generic GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Associated Types type Rep GetApiKeys :: Type -> Type # Methods from :: GetApiKeys -> Rep GetApiKeys x # to :: Rep GetApiKeys x -> GetApiKeys #
Read GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods readsPrec :: Int -> ReadS GetApiKeys # readList :: ReadS [GetApiKeys] # readPrec :: ReadPrec GetApiKeys # readListPrec :: ReadPrec [GetApiKeys] #
Show GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods showsPrec :: Int -> GetApiKeys -> ShowS # show :: GetApiKeys -> String # showList :: [GetApiKeys] -> ShowS #
NFData GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods rnf :: GetApiKeys -> () #
Eq GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods (==) :: GetApiKeys -> GetApiKeys -> Bool # (/=) :: GetApiKeys -> GetApiKeys -> Bool #
Hashable GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods hashWithSalt :: Int -> GetApiKeys -> Int # hash :: GetApiKeys -> Int #
type AWSResponse GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys type AWSResponse GetApiKeys = GetApiKeysResponse
type Rep GetApiKeys Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys type Rep GetApiKeys = D1 ('MetaData "GetApiKeys" "Amazonka.APIGateway.GetApiKeys" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetApiKeys'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "includeValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "nameQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGetApiKeys :: GetApiKeys Source #

Create a value of GetApiKeys with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetApiKeys, getApiKeys_customerId - The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

$sel:includeValues:GetApiKeys', getApiKeys_includeValues - A boolean flag to specify whether (true) or not (false) the result contains key values.

GetApiKeys, getApiKeys_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:nameQuery:GetApiKeys', getApiKeys_nameQuery - The name of queried API keys.

GetApiKeys, getApiKeys_position - The current pagination position in the paged result set.

data GetApiKeysResponse Source #

Represents a collection of API keys as represented by an ApiKeys resource.

See: newGetApiKeysResponse smart constructor.

Constructors

GetApiKeysResponse' (Maybe [ApiKey]) (Maybe Text) (Maybe [Text]) Int

Instances

Instances details

Generic GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Associated Types type Rep GetApiKeysResponse :: Type -> Type # Methods from :: GetApiKeysResponse -> Rep GetApiKeysResponse x # to :: Rep GetApiKeysResponse x -> GetApiKeysResponse #
Read GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods readsPrec :: Int -> ReadS GetApiKeysResponse # readList :: ReadS [GetApiKeysResponse] # readPrec :: ReadPrec GetApiKeysResponse # readListPrec :: ReadPrec [GetApiKeysResponse] #
Show GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods showsPrec :: Int -> GetApiKeysResponse -> ShowS # show :: GetApiKeysResponse -> String # showList :: [GetApiKeysResponse] -> ShowS #
NFData GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods rnf :: GetApiKeysResponse -> () #
Eq GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys Methods (==) :: GetApiKeysResponse -> GetApiKeysResponse -> Bool # (/=) :: GetApiKeysResponse -> GetApiKeysResponse -> Bool #
type Rep GetApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetApiKeys type Rep GetApiKeysResponse = D1 ('MetaData "GetApiKeysResponse" "Amazonka.APIGateway.GetApiKeys" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetApiKeysResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiKey])) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetApiKeysResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetApiKeysResponse'`
-> GetApiKeysResponse

Create a value of GetApiKeysResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetApiKeysResponse, getApiKeysResponse_items - The current page of elements from this collection.

GetApiKeys, getApiKeysResponse_position - Undocumented member.

GetApiKeysResponse, getApiKeysResponse_warnings - A list of warning messages logged during the import of API keys when the failOnWarnings option is set to true.

$sel:httpStatus:GetApiKeysResponse', getApiKeysResponse_httpStatus - The response's http status code.

GetAuthorizer

data GetAuthorizer Source #

Request to describe an existing Authorizer resource.

See: newGetAuthorizer smart constructor.

Constructors

GetAuthorizer' Text Text

Instances

Instances details

ToHeaders GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Methods toHeaders :: GetAuthorizer -> [Header] #
ToPath GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Methods toPath :: GetAuthorizer -> ByteString #
ToQuery GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Methods toQuery :: GetAuthorizer -> QueryString #
AWSRequest GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Associated Types type AWSResponse GetAuthorizer # Methods request :: (Service -> Service) -> GetAuthorizer -> Request GetAuthorizer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetAuthorizer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAuthorizer))) #
Generic GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Associated Types type Rep GetAuthorizer :: Type -> Type # Methods from :: GetAuthorizer -> Rep GetAuthorizer x # to :: Rep GetAuthorizer x -> GetAuthorizer #
Read GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Methods readsPrec :: Int -> ReadS GetAuthorizer # readList :: ReadS [GetAuthorizer] # readPrec :: ReadPrec GetAuthorizer # readListPrec :: ReadPrec [GetAuthorizer] #
Show GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Methods showsPrec :: Int -> GetAuthorizer -> ShowS # show :: GetAuthorizer -> String # showList :: [GetAuthorizer] -> ShowS #
NFData GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Methods rnf :: GetAuthorizer -> () #
Eq GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Methods (==) :: GetAuthorizer -> GetAuthorizer -> Bool # (/=) :: GetAuthorizer -> GetAuthorizer -> Bool #
Hashable GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer Methods hashWithSalt :: Int -> GetAuthorizer -> Int # hash :: GetAuthorizer -> Int #
type AWSResponse GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer type AWSResponse GetAuthorizer = Authorizer
type Rep GetAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizer type Rep GetAuthorizer = D1 ('MetaData "GetAuthorizer" "Amazonka.APIGateway.GetAuthorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetAuthorizer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetAuthorizer Source #

Arguments

:: Text	`GetAuthorizer`
-> Text	`GetAuthorizer`
-> GetAuthorizer

Create a value of GetAuthorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetAuthorizer, getAuthorizer_restApiId - The string identifier of the associated RestApi.

GetAuthorizer, getAuthorizer_authorizerId - The identifier of the Authorizer resource.

data Authorizer Source #

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

See: newAuthorizer smart constructor.

Constructors

Authorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe AuthorizerType)

Instances

Instances details

FromJSON Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods parseJSON :: Value -> Parser Authorizer # parseJSONList :: Value -> Parser [Authorizer] #
Generic Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Associated Types type Rep Authorizer :: Type -> Type # Methods from :: Authorizer -> Rep Authorizer x # to :: Rep Authorizer x -> Authorizer #
Read Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods readsPrec :: Int -> ReadS Authorizer # readList :: ReadS [Authorizer] # readPrec :: ReadPrec Authorizer # readListPrec :: ReadPrec [Authorizer] #
Show Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods showsPrec :: Int -> Authorizer -> ShowS # show :: Authorizer -> String # showList :: [Authorizer] -> ShowS #
NFData Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods rnf :: Authorizer -> () #
Eq Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods (==) :: Authorizer -> Authorizer -> Bool # (/=) :: Authorizer -> Authorizer -> Bool #
Hashable Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods hashWithSalt :: Int -> Authorizer -> Int # hash :: Authorizer -> Int #
type Rep Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer type Rep Authorizer = D1 ('MetaData "Authorizer" "Amazonka.APIGateway.Types.Authorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Authorizer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorizerCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "authorizerResultTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "authorizerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "identitySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityValidationExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "providerARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerType)))))))

newAuthorizer :: Authorizer Source #

Create a value of Authorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authType:Authorizer', authorizer_authType - Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

$sel:authorizerCredentials:Authorizer', authorizer_authorizerCredentials - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

$sel:authorizerResultTtlInSeconds:Authorizer', authorizer_authorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

$sel:authorizerUri:Authorizer', authorizer_authorizerUri - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

$sel:id:Authorizer', authorizer_id - The identifier for the authorizer resource.

$sel:identitySource:Authorizer', authorizer_identitySource - The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

$sel:identityValidationExpression:Authorizer', authorizer_identityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

$sel:name:Authorizer', authorizer_name - The name of the authorizer.

$sel:providerARNs:Authorizer', authorizer_providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

$sel:type':Authorizer', authorizer_type - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

GetAuthorizers (Paginated)

data GetAuthorizers Source #

Request to describe an existing Authorizers resource.

See: newGetAuthorizers smart constructor.

Constructors

GetAuthorizers' (Maybe Int) (Maybe Text) Text

Instances

Instances details

ToHeaders GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods toHeaders :: GetAuthorizers -> [Header] #
ToPath GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods toPath :: GetAuthorizers -> ByteString #
ToQuery GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods toQuery :: GetAuthorizers -> QueryString #
AWSPager GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods page :: GetAuthorizers -> AWSResponse GetAuthorizers -> Maybe GetAuthorizers #
AWSRequest GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Associated Types type AWSResponse GetAuthorizers # Methods request :: (Service -> Service) -> GetAuthorizers -> Request GetAuthorizers # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetAuthorizers -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetAuthorizers))) #
Generic GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Associated Types type Rep GetAuthorizers :: Type -> Type # Methods from :: GetAuthorizers -> Rep GetAuthorizers x # to :: Rep GetAuthorizers x -> GetAuthorizers #
Read GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods readsPrec :: Int -> ReadS GetAuthorizers # readList :: ReadS [GetAuthorizers] # readPrec :: ReadPrec GetAuthorizers # readListPrec :: ReadPrec [GetAuthorizers] #
Show GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods showsPrec :: Int -> GetAuthorizers -> ShowS # show :: GetAuthorizers -> String # showList :: [GetAuthorizers] -> ShowS #
NFData GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods rnf :: GetAuthorizers -> () #
Eq GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods (==) :: GetAuthorizers -> GetAuthorizers -> Bool # (/=) :: GetAuthorizers -> GetAuthorizers -> Bool #
Hashable GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods hashWithSalt :: Int -> GetAuthorizers -> Int # hash :: GetAuthorizers -> Int #
type AWSResponse GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers type AWSResponse GetAuthorizers = GetAuthorizersResponse
type Rep GetAuthorizers Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers type Rep GetAuthorizers = D1 ('MetaData "GetAuthorizers" "Amazonka.APIGateway.GetAuthorizers" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetAuthorizers'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetAuthorizers Source #

Arguments

:: Text	`GetAuthorizers`
-> GetAuthorizers

Create a value of GetAuthorizers with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetAuthorizers, getAuthorizers_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetAuthorizers, getAuthorizers_position - The current pagination position in the paged result set.

GetAuthorizers, getAuthorizers_restApiId - The string identifier of the associated RestApi.

data GetAuthorizersResponse Source #

Represents a collection of Authorizer resources.

See: newGetAuthorizersResponse smart constructor.

Constructors

GetAuthorizersResponse' (Maybe [Authorizer]) (Maybe Text) Int

Instances

Instances details

Generic GetAuthorizersResponse Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Associated Types type Rep GetAuthorizersResponse :: Type -> Type # Methods from :: GetAuthorizersResponse -> Rep GetAuthorizersResponse x # to :: Rep GetAuthorizersResponse x -> GetAuthorizersResponse #
Read GetAuthorizersResponse Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods readsPrec :: Int -> ReadS GetAuthorizersResponse # readList :: ReadS [GetAuthorizersResponse] # readPrec :: ReadPrec GetAuthorizersResponse # readListPrec :: ReadPrec [GetAuthorizersResponse] #
Show GetAuthorizersResponse Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods showsPrec :: Int -> GetAuthorizersResponse -> ShowS # show :: GetAuthorizersResponse -> String # showList :: [GetAuthorizersResponse] -> ShowS #
NFData GetAuthorizersResponse Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods rnf :: GetAuthorizersResponse -> () #
Eq GetAuthorizersResponse Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers Methods (==) :: GetAuthorizersResponse -> GetAuthorizersResponse -> Bool # (/=) :: GetAuthorizersResponse -> GetAuthorizersResponse -> Bool #
type Rep GetAuthorizersResponse Source #
Instance details Defined in Amazonka.APIGateway.GetAuthorizers type Rep GetAuthorizersResponse = D1 ('MetaData "GetAuthorizersResponse" "Amazonka.APIGateway.GetAuthorizers" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetAuthorizersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Authorizer])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetAuthorizersResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetAuthorizersResponse'`
-> GetAuthorizersResponse

Create a value of GetAuthorizersResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetAuthorizersResponse, getAuthorizersResponse_items - The current page of elements from this collection.

GetAuthorizers, getAuthorizersResponse_position - Undocumented member.

$sel:httpStatus:GetAuthorizersResponse', getAuthorizersResponse_httpStatus - The response's http status code.

GetBasePathMapping

data GetBasePathMapping Source #

Request to describe a BasePathMapping resource.

See: newGetBasePathMapping smart constructor.

Constructors

GetBasePathMapping' Text Text

Instances

Instances details

ToHeaders GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods toHeaders :: GetBasePathMapping -> [Header] #
ToPath GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods toPath :: GetBasePathMapping -> ByteString #
ToQuery GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods toQuery :: GetBasePathMapping -> QueryString #
AWSRequest GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Associated Types type AWSResponse GetBasePathMapping # Methods request :: (Service -> Service) -> GetBasePathMapping -> Request GetBasePathMapping # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBasePathMapping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBasePathMapping))) #
Generic GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Associated Types type Rep GetBasePathMapping :: Type -> Type # Methods from :: GetBasePathMapping -> Rep GetBasePathMapping x # to :: Rep GetBasePathMapping x -> GetBasePathMapping #
Read GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods readsPrec :: Int -> ReadS GetBasePathMapping # readList :: ReadS [GetBasePathMapping] # readPrec :: ReadPrec GetBasePathMapping # readListPrec :: ReadPrec [GetBasePathMapping] #
Show GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods showsPrec :: Int -> GetBasePathMapping -> ShowS # show :: GetBasePathMapping -> String # showList :: [GetBasePathMapping] -> ShowS #
NFData GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods rnf :: GetBasePathMapping -> () #
Eq GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods (==) :: GetBasePathMapping -> GetBasePathMapping -> Bool # (/=) :: GetBasePathMapping -> GetBasePathMapping -> Bool #
Hashable GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping Methods hashWithSalt :: Int -> GetBasePathMapping -> Int # hash :: GetBasePathMapping -> Int #
type AWSResponse GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping type AWSResponse GetBasePathMapping = BasePathMapping
type Rep GetBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMapping type Rep GetBasePathMapping = D1 ('MetaData "GetBasePathMapping" "Amazonka.APIGateway.GetBasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetBasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetBasePathMapping Source #

Arguments

:: Text	`GetBasePathMapping`
-> Text	`GetBasePathMapping`
-> GetBasePathMapping

Create a value of GetBasePathMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetBasePathMapping, getBasePathMapping_domainName - The domain name of the BasePathMapping resource to be described.

GetBasePathMapping, getBasePathMapping_basePath - The base path name that callers of the API must provide as part of the URL after the domain name. This value must be unique for all of the mappings across a single API. Specify '(none)' if you do not want callers to specify any base path name after the domain name.

data BasePathMapping Source #

Represents the base path that callers of the API must provide as part of the URL after the domain name.

See: newBasePathMapping smart constructor.

Constructors

BasePathMapping' (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods parseJSON :: Value -> Parser BasePathMapping # parseJSONList :: Value -> Parser [BasePathMapping] #
Generic BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Associated Types type Rep BasePathMapping :: Type -> Type # Methods from :: BasePathMapping -> Rep BasePathMapping x # to :: Rep BasePathMapping x -> BasePathMapping #
Read BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods readsPrec :: Int -> ReadS BasePathMapping # readList :: ReadS [BasePathMapping] # readPrec :: ReadPrec BasePathMapping # readListPrec :: ReadPrec [BasePathMapping] #
Show BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods showsPrec :: Int -> BasePathMapping -> ShowS # show :: BasePathMapping -> String # showList :: [BasePathMapping] -> ShowS #
NFData BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods rnf :: BasePathMapping -> () #
Eq BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods (==) :: BasePathMapping -> BasePathMapping -> Bool # (/=) :: BasePathMapping -> BasePathMapping -> Bool #
Hashable BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods hashWithSalt :: Int -> BasePathMapping -> Int # hash :: BasePathMapping -> Int #
type Rep BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping type Rep BasePathMapping = D1 ('MetaData "BasePathMapping" "Amazonka.APIGateway.Types.BasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "BasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBasePathMapping :: BasePathMapping Source #

Create a value of BasePathMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:basePath:BasePathMapping', basePathMapping_basePath - The base path name that callers of the API must provide as part of the URL after the domain name.

$sel:restApiId:BasePathMapping', basePathMapping_restApiId - The string identifier of the associated RestApi.

$sel:stage:BasePathMapping', basePathMapping_stage - The name of the associated stage.

GetBasePathMappings (Paginated)

data GetBasePathMappings Source #

A request to get information about a collection of BasePathMapping resources.

See: newGetBasePathMappings smart constructor.

Constructors

GetBasePathMappings' (Maybe Int) (Maybe Text) Text

Instances

Instances details

ToHeaders GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods toHeaders :: GetBasePathMappings -> [Header] #
ToPath GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods toPath :: GetBasePathMappings -> ByteString #
ToQuery GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods toQuery :: GetBasePathMappings -> QueryString #
AWSPager GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods page :: GetBasePathMappings -> AWSResponse GetBasePathMappings -> Maybe GetBasePathMappings #
AWSRequest GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Associated Types type AWSResponse GetBasePathMappings # Methods request :: (Service -> Service) -> GetBasePathMappings -> Request GetBasePathMappings # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetBasePathMappings -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetBasePathMappings))) #
Generic GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Associated Types type Rep GetBasePathMappings :: Type -> Type # Methods from :: GetBasePathMappings -> Rep GetBasePathMappings x # to :: Rep GetBasePathMappings x -> GetBasePathMappings #
Read GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods readsPrec :: Int -> ReadS GetBasePathMappings # readList :: ReadS [GetBasePathMappings] # readPrec :: ReadPrec GetBasePathMappings # readListPrec :: ReadPrec [GetBasePathMappings] #
Show GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods showsPrec :: Int -> GetBasePathMappings -> ShowS # show :: GetBasePathMappings -> String # showList :: [GetBasePathMappings] -> ShowS #
NFData GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods rnf :: GetBasePathMappings -> () #
Eq GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods (==) :: GetBasePathMappings -> GetBasePathMappings -> Bool # (/=) :: GetBasePathMappings -> GetBasePathMappings -> Bool #
Hashable GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods hashWithSalt :: Int -> GetBasePathMappings -> Int # hash :: GetBasePathMappings -> Int #
type AWSResponse GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings type AWSResponse GetBasePathMappings = GetBasePathMappingsResponse
type Rep GetBasePathMappings Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings type Rep GetBasePathMappings = D1 ('MetaData "GetBasePathMappings" "Amazonka.APIGateway.GetBasePathMappings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetBasePathMappings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetBasePathMappings Source #

Arguments

:: Text	`GetBasePathMappings`
-> GetBasePathMappings

Create a value of GetBasePathMappings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetBasePathMappings, getBasePathMappings_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetBasePathMappings, getBasePathMappings_position - The current pagination position in the paged result set.

GetBasePathMappings, getBasePathMappings_domainName - The domain name of a BasePathMapping resource.

data GetBasePathMappingsResponse Source #

Represents a collection of BasePathMapping resources.

See: newGetBasePathMappingsResponse smart constructor.

Constructors

GetBasePathMappingsResponse' (Maybe [BasePathMapping]) (Maybe Text) Int

Instances

Instances details

Generic GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Associated Types type Rep GetBasePathMappingsResponse :: Type -> Type # Methods from :: GetBasePathMappingsResponse -> Rep GetBasePathMappingsResponse x # to :: Rep GetBasePathMappingsResponse x -> GetBasePathMappingsResponse #
Read GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods readsPrec :: Int -> ReadS GetBasePathMappingsResponse # readList :: ReadS [GetBasePathMappingsResponse] # readPrec :: ReadPrec GetBasePathMappingsResponse # readListPrec :: ReadPrec [GetBasePathMappingsResponse] #
Show GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods showsPrec :: Int -> GetBasePathMappingsResponse -> ShowS # show :: GetBasePathMappingsResponse -> String # showList :: [GetBasePathMappingsResponse] -> ShowS #
NFData GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods rnf :: GetBasePathMappingsResponse -> () #
Eq GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings Methods (==) :: GetBasePathMappingsResponse -> GetBasePathMappingsResponse -> Bool # (/=) :: GetBasePathMappingsResponse -> GetBasePathMappingsResponse -> Bool #
type Rep GetBasePathMappingsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetBasePathMappings type Rep GetBasePathMappingsResponse = D1 ('MetaData "GetBasePathMappingsResponse" "Amazonka.APIGateway.GetBasePathMappings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetBasePathMappingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [BasePathMapping])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetBasePathMappingsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetBasePathMappingsResponse'`
-> GetBasePathMappingsResponse

Create a value of GetBasePathMappingsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetBasePathMappingsResponse, getBasePathMappingsResponse_items - The current page of elements from this collection.

GetBasePathMappings, getBasePathMappingsResponse_position - Undocumented member.

$sel:httpStatus:GetBasePathMappingsResponse', getBasePathMappingsResponse_httpStatus - The response's http status code.

GetClientCertificate

data GetClientCertificate Source #

A request to get information about the current ClientCertificate resource.

See: newGetClientCertificate smart constructor.

Constructors

GetClientCertificate' Text

Instances

Instances details

ToHeaders GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Methods toHeaders :: GetClientCertificate -> [Header] #
ToPath GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Methods toPath :: GetClientCertificate -> ByteString #
ToQuery GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Methods toQuery :: GetClientCertificate -> QueryString #
AWSRequest GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Associated Types type AWSResponse GetClientCertificate # Methods request :: (Service -> Service) -> GetClientCertificate -> Request GetClientCertificate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetClientCertificate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetClientCertificate))) #
Generic GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Associated Types type Rep GetClientCertificate :: Type -> Type # Methods from :: GetClientCertificate -> Rep GetClientCertificate x # to :: Rep GetClientCertificate x -> GetClientCertificate #
Read GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Methods readsPrec :: Int -> ReadS GetClientCertificate # readList :: ReadS [GetClientCertificate] # readPrec :: ReadPrec GetClientCertificate # readListPrec :: ReadPrec [GetClientCertificate] #
Show GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Methods showsPrec :: Int -> GetClientCertificate -> ShowS # show :: GetClientCertificate -> String # showList :: [GetClientCertificate] -> ShowS #
NFData GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Methods rnf :: GetClientCertificate -> () #
Eq GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Methods (==) :: GetClientCertificate -> GetClientCertificate -> Bool # (/=) :: GetClientCertificate -> GetClientCertificate -> Bool #
Hashable GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate Methods hashWithSalt :: Int -> GetClientCertificate -> Int # hash :: GetClientCertificate -> Int #
type AWSResponse GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate type AWSResponse GetClientCertificate = ClientCertificate
type Rep GetClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificate type Rep GetClientCertificate = D1 ('MetaData "GetClientCertificate" "Amazonka.APIGateway.GetClientCertificate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetClientCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetClientCertificate Source #

Arguments

:: Text	`GetClientCertificate`
-> GetClientCertificate

Create a value of GetClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetClientCertificate, getClientCertificate_clientCertificateId - The identifier of the ClientCertificate resource to be described.

data ClientCertificate Source #

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

See: newClientCertificate smart constructor.

Constructors

ClientCertificate' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text))

Instances

Instances details

FromJSON ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods parseJSON :: Value -> Parser ClientCertificate # parseJSONList :: Value -> Parser [ClientCertificate] #
Generic ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Associated Types type Rep ClientCertificate :: Type -> Type # Methods from :: ClientCertificate -> Rep ClientCertificate x # to :: Rep ClientCertificate x -> ClientCertificate #
Read ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods readsPrec :: Int -> ReadS ClientCertificate # readList :: ReadS [ClientCertificate] # readPrec :: ReadPrec ClientCertificate # readListPrec :: ReadPrec [ClientCertificate] #
Show ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods showsPrec :: Int -> ClientCertificate -> ShowS # show :: ClientCertificate -> String # showList :: [ClientCertificate] -> ShowS #
NFData ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods rnf :: ClientCertificate -> () #
Eq ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods (==) :: ClientCertificate -> ClientCertificate -> Bool # (/=) :: ClientCertificate -> ClientCertificate -> Bool #
Hashable ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods hashWithSalt :: Int -> ClientCertificate -> Int # hash :: ClientCertificate -> Int #
type Rep ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate type Rep ClientCertificate = D1 ('MetaData "ClientCertificate" "Amazonka.APIGateway.Types.ClientCertificate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ClientCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "pemEncodedCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newClientCertificate :: ClientCertificate Source #

Create a value of ClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientCertificateId:ClientCertificate', clientCertificate_clientCertificateId - The identifier of the client certificate.

$sel:createdDate:ClientCertificate', clientCertificate_createdDate - The timestamp when the client certificate was created.

$sel:description:ClientCertificate', clientCertificate_description - The description of the client certificate.

$sel:expirationDate:ClientCertificate', clientCertificate_expirationDate - The timestamp when the client certificate will expire.

$sel:pemEncodedCertificate:ClientCertificate', clientCertificate_pemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

$sel:tags:ClientCertificate', clientCertificate_tags - The collection of tags. Each tag element is associated with a given resource.

GetClientCertificates (Paginated)

data GetClientCertificates Source #

A request to get information about a collection of ClientCertificate resources.

See: newGetClientCertificates smart constructor.

Constructors

GetClientCertificates' (Maybe Int) (Maybe Text)

Instances

Instances details

ToHeaders GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods toHeaders :: GetClientCertificates -> [Header] #
ToPath GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods toPath :: GetClientCertificates -> ByteString #
ToQuery GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods toQuery :: GetClientCertificates -> QueryString #
AWSPager GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods page :: GetClientCertificates -> AWSResponse GetClientCertificates -> Maybe GetClientCertificates #
AWSRequest GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Associated Types type AWSResponse GetClientCertificates # Methods request :: (Service -> Service) -> GetClientCertificates -> Request GetClientCertificates # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetClientCertificates -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetClientCertificates))) #
Generic GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Associated Types type Rep GetClientCertificates :: Type -> Type # Methods from :: GetClientCertificates -> Rep GetClientCertificates x # to :: Rep GetClientCertificates x -> GetClientCertificates #
Read GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods readsPrec :: Int -> ReadS GetClientCertificates # readList :: ReadS [GetClientCertificates] # readPrec :: ReadPrec GetClientCertificates # readListPrec :: ReadPrec [GetClientCertificates] #
Show GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods showsPrec :: Int -> GetClientCertificates -> ShowS # show :: GetClientCertificates -> String # showList :: [GetClientCertificates] -> ShowS #
NFData GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods rnf :: GetClientCertificates -> () #
Eq GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods (==) :: GetClientCertificates -> GetClientCertificates -> Bool # (/=) :: GetClientCertificates -> GetClientCertificates -> Bool #
Hashable GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods hashWithSalt :: Int -> GetClientCertificates -> Int # hash :: GetClientCertificates -> Int #
type AWSResponse GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates type AWSResponse GetClientCertificates = GetClientCertificatesResponse
type Rep GetClientCertificates Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates type Rep GetClientCertificates = D1 ('MetaData "GetClientCertificates" "Amazonka.APIGateway.GetClientCertificates" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetClientCertificates'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetClientCertificates :: GetClientCertificates Source #

Create a value of GetClientCertificates with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetClientCertificates, getClientCertificates_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetClientCertificates, getClientCertificates_position - The current pagination position in the paged result set.

data GetClientCertificatesResponse Source #

Represents a collection of ClientCertificate resources.

See: newGetClientCertificatesResponse smart constructor.

Constructors

GetClientCertificatesResponse' (Maybe [ClientCertificate]) (Maybe Text) Int

Instances

Instances details

Generic GetClientCertificatesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Associated Types type Rep GetClientCertificatesResponse :: Type -> Type # Methods from :: GetClientCertificatesResponse -> Rep GetClientCertificatesResponse x # to :: Rep GetClientCertificatesResponse x -> GetClientCertificatesResponse #
Read GetClientCertificatesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods readsPrec :: Int -> ReadS GetClientCertificatesResponse # readList :: ReadS [GetClientCertificatesResponse] # readPrec :: ReadPrec GetClientCertificatesResponse # readListPrec :: ReadPrec [GetClientCertificatesResponse] #
Show GetClientCertificatesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods showsPrec :: Int -> GetClientCertificatesResponse -> ShowS # show :: GetClientCertificatesResponse -> String # showList :: [GetClientCertificatesResponse] -> ShowS #
NFData GetClientCertificatesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods rnf :: GetClientCertificatesResponse -> () #
Eq GetClientCertificatesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates Methods (==) :: GetClientCertificatesResponse -> GetClientCertificatesResponse -> Bool # (/=) :: GetClientCertificatesResponse -> GetClientCertificatesResponse -> Bool #
type Rep GetClientCertificatesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetClientCertificates type Rep GetClientCertificatesResponse = D1 ('MetaData "GetClientCertificatesResponse" "Amazonka.APIGateway.GetClientCertificates" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetClientCertificatesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ClientCertificate])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetClientCertificatesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetClientCertificatesResponse'`
-> GetClientCertificatesResponse

Create a value of GetClientCertificatesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetClientCertificatesResponse, getClientCertificatesResponse_items - The current page of elements from this collection.

GetClientCertificates, getClientCertificatesResponse_position - Undocumented member.

$sel:httpStatus:GetClientCertificatesResponse', getClientCertificatesResponse_httpStatus - The response's http status code.

GetDeployment

data GetDeployment Source #

Requests API Gateway to get information about a Deployment resource.

See: newGetDeployment smart constructor.

Constructors

GetDeployment' (Maybe [Text]) Text Text

Instances

Instances details

ToHeaders GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Methods toHeaders :: GetDeployment -> [Header] #
ToPath GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Methods toPath :: GetDeployment -> ByteString #
ToQuery GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Methods toQuery :: GetDeployment -> QueryString #
AWSRequest GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Associated Types type AWSResponse GetDeployment # Methods request :: (Service -> Service) -> GetDeployment -> Request GetDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDeployment))) #
Generic GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Associated Types type Rep GetDeployment :: Type -> Type # Methods from :: GetDeployment -> Rep GetDeployment x # to :: Rep GetDeployment x -> GetDeployment #
Read GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Methods readsPrec :: Int -> ReadS GetDeployment # readList :: ReadS [GetDeployment] # readPrec :: ReadPrec GetDeployment # readListPrec :: ReadPrec [GetDeployment] #
Show GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Methods showsPrec :: Int -> GetDeployment -> ShowS # show :: GetDeployment -> String # showList :: [GetDeployment] -> ShowS #
NFData GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Methods rnf :: GetDeployment -> () #
Eq GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Methods (==) :: GetDeployment -> GetDeployment -> Bool # (/=) :: GetDeployment -> GetDeployment -> Bool #
Hashable GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment Methods hashWithSalt :: Int -> GetDeployment -> Int # hash :: GetDeployment -> Int #
type AWSResponse GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment type AWSResponse GetDeployment = Deployment
type Rep GetDeployment Source #
Instance details Defined in Amazonka.APIGateway.GetDeployment type Rep GetDeployment = D1 ('MetaData "GetDeployment" "Amazonka.APIGateway.GetDeployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "embed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetDeployment Source #

Arguments

:: Text	`GetDeployment`
-> Text	`GetDeployment`
-> GetDeployment

Create a value of GetDeployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:embed:GetDeployment', getDeployment_embed - A query parameter to retrieve the specified embedded resources of the returned Deployment resource in the response. In a REST API call, this embed parameter value is a list of comma-separated strings, as in GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=var1,var2. The SDK and other platform-dependent libraries might use a different format for the list. Currently, this request supports only retrieval of the embedded API summary this way. Hence, the parameter value must be a single-valued list containing only the "apisummary" string. For example, GET /restapis/{restapi_id}/deployments/{deployment_id}?embed=apisummary.

GetDeployment, getDeployment_restApiId - The string identifier of the associated RestApi.

GetDeployment, getDeployment_deploymentId - The identifier of the Deployment resource to get information about.

data Deployment Source #

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

See: newDeployment smart constructor.

Constructors

Deployment' (Maybe (HashMap Text (HashMap Text MethodSnapshot))) (Maybe POSIX) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods parseJSON :: Value -> Parser Deployment # parseJSONList :: Value -> Parser [Deployment] #
Generic Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Associated Types type Rep Deployment :: Type -> Type # Methods from :: Deployment -> Rep Deployment x # to :: Rep Deployment x -> Deployment #
Read Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods readsPrec :: Int -> ReadS Deployment # readList :: ReadS [Deployment] # readPrec :: ReadPrec Deployment # readListPrec :: ReadPrec [Deployment] #
Show Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods showsPrec :: Int -> Deployment -> ShowS # show :: Deployment -> String # showList :: [Deployment] -> ShowS #
NFData Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods rnf :: Deployment -> () #
Eq Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods (==) :: Deployment -> Deployment -> Bool # (/=) :: Deployment -> Deployment -> Bool #
Hashable Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods hashWithSalt :: Int -> Deployment -> Int # hash :: Deployment -> Int #
type Rep Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.APIGateway.Types.Deployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text MethodSnapshot)))) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDeployment :: Deployment Source #

Create a value of Deployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiSummary:Deployment', deployment_apiSummary - A summary of the RestApi at the date and time that the deployment resource was created.

$sel:createdDate:Deployment', deployment_createdDate - The date and time that the deployment resource was created.

$sel:description:Deployment', deployment_description - The description for the deployment resource.

$sel:id:Deployment', deployment_id - The identifier for the deployment resource.

GetDeployments (Paginated)

data GetDeployments Source #

Requests API Gateway to get information about a Deployments collection.

See: newGetDeployments smart constructor.

Constructors

GetDeployments' (Maybe Int) (Maybe Text) Text

Instances

Instances details

ToHeaders GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods toHeaders :: GetDeployments -> [Header] #
ToPath GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods toPath :: GetDeployments -> ByteString #
ToQuery GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods toQuery :: GetDeployments -> QueryString #
AWSPager GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods page :: GetDeployments -> AWSResponse GetDeployments -> Maybe GetDeployments #
AWSRequest GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Associated Types type AWSResponse GetDeployments # Methods request :: (Service -> Service) -> GetDeployments -> Request GetDeployments # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDeployments -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDeployments))) #
Generic GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Associated Types type Rep GetDeployments :: Type -> Type # Methods from :: GetDeployments -> Rep GetDeployments x # to :: Rep GetDeployments x -> GetDeployments #
Read GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods readsPrec :: Int -> ReadS GetDeployments # readList :: ReadS [GetDeployments] # readPrec :: ReadPrec GetDeployments # readListPrec :: ReadPrec [GetDeployments] #
Show GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods showsPrec :: Int -> GetDeployments -> ShowS # show :: GetDeployments -> String # showList :: [GetDeployments] -> ShowS #
NFData GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods rnf :: GetDeployments -> () #
Eq GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods (==) :: GetDeployments -> GetDeployments -> Bool # (/=) :: GetDeployments -> GetDeployments -> Bool #
Hashable GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods hashWithSalt :: Int -> GetDeployments -> Int # hash :: GetDeployments -> Int #
type AWSResponse GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments type AWSResponse GetDeployments = GetDeploymentsResponse
type Rep GetDeployments Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments type Rep GetDeployments = D1 ('MetaData "GetDeployments" "Amazonka.APIGateway.GetDeployments" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDeployments'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetDeployments Source #

Arguments

:: Text	`GetDeployments`
-> GetDeployments

Create a value of GetDeployments with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDeployments, getDeployments_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetDeployments, getDeployments_position - The current pagination position in the paged result set.

GetDeployments, getDeployments_restApiId - The string identifier of the associated RestApi.

data GetDeploymentsResponse Source #

Represents a collection resource that contains zero or more references to your existing deployments, and links that guide you on how to interact with your collection. The collection offers a paginated view of the contained deployments.

See: newGetDeploymentsResponse smart constructor.

Constructors

GetDeploymentsResponse' (Maybe [Deployment]) (Maybe Text) Int

Instances

Instances details

Generic GetDeploymentsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Associated Types type Rep GetDeploymentsResponse :: Type -> Type # Methods from :: GetDeploymentsResponse -> Rep GetDeploymentsResponse x # to :: Rep GetDeploymentsResponse x -> GetDeploymentsResponse #
Read GetDeploymentsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods readsPrec :: Int -> ReadS GetDeploymentsResponse # readList :: ReadS [GetDeploymentsResponse] # readPrec :: ReadPrec GetDeploymentsResponse # readListPrec :: ReadPrec [GetDeploymentsResponse] #
Show GetDeploymentsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods showsPrec :: Int -> GetDeploymentsResponse -> ShowS # show :: GetDeploymentsResponse -> String # showList :: [GetDeploymentsResponse] -> ShowS #
NFData GetDeploymentsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods rnf :: GetDeploymentsResponse -> () #
Eq GetDeploymentsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments Methods (==) :: GetDeploymentsResponse -> GetDeploymentsResponse -> Bool # (/=) :: GetDeploymentsResponse -> GetDeploymentsResponse -> Bool #
type Rep GetDeploymentsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDeployments type Rep GetDeploymentsResponse = D1 ('MetaData "GetDeploymentsResponse" "Amazonka.APIGateway.GetDeployments" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDeploymentsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Deployment])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDeploymentsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDeploymentsResponse'`
-> GetDeploymentsResponse

Create a value of GetDeploymentsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDeploymentsResponse, getDeploymentsResponse_items - The current page of elements from this collection.

GetDeployments, getDeploymentsResponse_position - Undocumented member.

$sel:httpStatus:GetDeploymentsResponse', getDeploymentsResponse_httpStatus - The response's http status code.

GetDocumentationPart

data GetDocumentationPart Source #

Gets a specified documentation part of a given API.

See: newGetDocumentationPart smart constructor.

Constructors

GetDocumentationPart' Text Text

Instances

Instances details

ToHeaders GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods toHeaders :: GetDocumentationPart -> [Header] #
ToPath GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods toPath :: GetDocumentationPart -> ByteString #
ToQuery GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods toQuery :: GetDocumentationPart -> QueryString #
AWSRequest GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Associated Types type AWSResponse GetDocumentationPart # Methods request :: (Service -> Service) -> GetDocumentationPart -> Request GetDocumentationPart # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDocumentationPart -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDocumentationPart))) #
Generic GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Associated Types type Rep GetDocumentationPart :: Type -> Type # Methods from :: GetDocumentationPart -> Rep GetDocumentationPart x # to :: Rep GetDocumentationPart x -> GetDocumentationPart #
Read GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods readsPrec :: Int -> ReadS GetDocumentationPart # readList :: ReadS [GetDocumentationPart] # readPrec :: ReadPrec GetDocumentationPart # readListPrec :: ReadPrec [GetDocumentationPart] #
Show GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods showsPrec :: Int -> GetDocumentationPart -> ShowS # show :: GetDocumentationPart -> String # showList :: [GetDocumentationPart] -> ShowS #
NFData GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods rnf :: GetDocumentationPart -> () #
Eq GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods (==) :: GetDocumentationPart -> GetDocumentationPart -> Bool # (/=) :: GetDocumentationPart -> GetDocumentationPart -> Bool #
Hashable GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart Methods hashWithSalt :: Int -> GetDocumentationPart -> Int # hash :: GetDocumentationPart -> Int #
type AWSResponse GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart type AWSResponse GetDocumentationPart = DocumentationPart
type Rep GetDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationPart type Rep GetDocumentationPart = D1 ('MetaData "GetDocumentationPart" "Amazonka.APIGateway.GetDocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentationPartId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDocumentationPart Source #

Arguments

:: Text	`GetDocumentationPart`
-> Text	`$sel:documentationPartId:GetDocumentationPart'`
-> GetDocumentationPart

Create a value of GetDocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDocumentationPart, getDocumentationPart_restApiId - The string identifier of the associated RestApi.

$sel:documentationPartId:GetDocumentationPart', getDocumentationPart_documentationPartId - The string identifier of the associated RestApi.

data DocumentationPart Source #

A documentation part for a targeted API entity.

See: newDocumentationPart smart constructor.

Constructors

DocumentationPart' (Maybe Text) (Maybe DocumentationPartLocation) (Maybe Text)

Instances

Instances details

FromJSON DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods parseJSON :: Value -> Parser DocumentationPart # parseJSONList :: Value -> Parser [DocumentationPart] #
Generic DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Associated Types type Rep DocumentationPart :: Type -> Type # Methods from :: DocumentationPart -> Rep DocumentationPart x # to :: Rep DocumentationPart x -> DocumentationPart #
Read DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods readsPrec :: Int -> ReadS DocumentationPart # readList :: ReadS [DocumentationPart] # readPrec :: ReadPrec DocumentationPart # readListPrec :: ReadPrec [DocumentationPart] #
Show DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods showsPrec :: Int -> DocumentationPart -> ShowS # show :: DocumentationPart -> String # showList :: [DocumentationPart] -> ShowS #
NFData DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods rnf :: DocumentationPart -> () #
Eq DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods (==) :: DocumentationPart -> DocumentationPart -> Bool # (/=) :: DocumentationPart -> DocumentationPart -> Bool #
Hashable DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods hashWithSalt :: Int -> DocumentationPart -> Int # hash :: DocumentationPart -> Int #
type Rep DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart type Rep DocumentationPart = D1 ('MetaData "DocumentationPart" "Amazonka.APIGateway.Types.DocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentationPartLocation)) :: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationPart :: DocumentationPart Source #

Create a value of DocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:DocumentationPart', documentationPart_id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

$sel:location:DocumentationPart', documentationPart_location - The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

$sel:properties:DocumentationPart', documentationPart_properties - A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

GetDocumentationParts (Paginated)

data GetDocumentationParts Source #

Gets the documentation parts of an API. The result may be filtered by the type, name, or path of API entities (targets).

See: newGetDocumentationParts smart constructor.

Constructors

GetDocumentationParts' (Maybe Int) (Maybe LocationStatusType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DocumentationPartType) Text

Instances

Instances details

ToHeaders GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods toHeaders :: GetDocumentationParts -> [Header] #
ToPath GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods toPath :: GetDocumentationParts -> ByteString #
ToQuery GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods toQuery :: GetDocumentationParts -> QueryString #
AWSPager GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods page :: GetDocumentationParts -> AWSResponse GetDocumentationParts -> Maybe GetDocumentationParts #
AWSRequest GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Associated Types type AWSResponse GetDocumentationParts # Methods request :: (Service -> Service) -> GetDocumentationParts -> Request GetDocumentationParts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDocumentationParts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDocumentationParts))) #
Generic GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Associated Types type Rep GetDocumentationParts :: Type -> Type # Methods from :: GetDocumentationParts -> Rep GetDocumentationParts x # to :: Rep GetDocumentationParts x -> GetDocumentationParts #
Read GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods readsPrec :: Int -> ReadS GetDocumentationParts # readList :: ReadS [GetDocumentationParts] # readPrec :: ReadPrec GetDocumentationParts # readListPrec :: ReadPrec [GetDocumentationParts] #
Show GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods showsPrec :: Int -> GetDocumentationParts -> ShowS # show :: GetDocumentationParts -> String # showList :: [GetDocumentationParts] -> ShowS #
NFData GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods rnf :: GetDocumentationParts -> () #
Eq GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods (==) :: GetDocumentationParts -> GetDocumentationParts -> Bool # (/=) :: GetDocumentationParts -> GetDocumentationParts -> Bool #
Hashable GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods hashWithSalt :: Int -> GetDocumentationParts -> Int # hash :: GetDocumentationParts -> Int #
type AWSResponse GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts type AWSResponse GetDocumentationParts = GetDocumentationPartsResponse
type Rep GetDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts type Rep GetDocumentationParts = D1 ('MetaData "GetDocumentationParts" "Amazonka.APIGateway.GetDocumentationParts" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDocumentationParts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "locationStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LocationStatusType)) :: S1 ('MetaSel ('Just "nameQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentationPartType)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetDocumentationParts Source #

Arguments

:: Text	`GetDocumentationParts`
-> GetDocumentationParts

Create a value of GetDocumentationParts with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDocumentationParts, getDocumentationParts_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:locationStatus:GetDocumentationParts', getDocumentationParts_locationStatus - The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.

$sel:nameQuery:GetDocumentationParts', getDocumentationParts_nameQuery - The name of API entities of the to-be-retrieved documentation parts.

GetDocumentationParts, getDocumentationParts_path - The path of API entities of the to-be-retrieved documentation parts.

GetDocumentationParts, getDocumentationParts_position - The current pagination position in the paged result set.

GetDocumentationParts, getDocumentationParts_type - The type of API entities of the to-be-retrieved documentation parts.

GetDocumentationParts, getDocumentationParts_restApiId - The string identifier of the associated RestApi.

data GetDocumentationPartsResponse Source #

The collection of documentation parts of an API.

See: newGetDocumentationPartsResponse smart constructor.

Constructors

GetDocumentationPartsResponse' (Maybe [DocumentationPart]) (Maybe Text) Int

Instances

Instances details

Generic GetDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Associated Types type Rep GetDocumentationPartsResponse :: Type -> Type # Methods from :: GetDocumentationPartsResponse -> Rep GetDocumentationPartsResponse x # to :: Rep GetDocumentationPartsResponse x -> GetDocumentationPartsResponse #
Read GetDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods readsPrec :: Int -> ReadS GetDocumentationPartsResponse # readList :: ReadS [GetDocumentationPartsResponse] # readPrec :: ReadPrec GetDocumentationPartsResponse # readListPrec :: ReadPrec [GetDocumentationPartsResponse] #
Show GetDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods showsPrec :: Int -> GetDocumentationPartsResponse -> ShowS # show :: GetDocumentationPartsResponse -> String # showList :: [GetDocumentationPartsResponse] -> ShowS #
NFData GetDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods rnf :: GetDocumentationPartsResponse -> () #
Eq GetDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts Methods (==) :: GetDocumentationPartsResponse -> GetDocumentationPartsResponse -> Bool # (/=) :: GetDocumentationPartsResponse -> GetDocumentationPartsResponse -> Bool #
type Rep GetDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationParts type Rep GetDocumentationPartsResponse = D1 ('MetaData "GetDocumentationPartsResponse" "Amazonka.APIGateway.GetDocumentationParts" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDocumentationPartsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentationPart])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDocumentationPartsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDocumentationPartsResponse'`
-> GetDocumentationPartsResponse

Create a value of GetDocumentationPartsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDocumentationPartsResponse, getDocumentationPartsResponse_items - The current page of elements from this collection.

GetDocumentationParts, getDocumentationPartsResponse_position - Undocumented member.

$sel:httpStatus:GetDocumentationPartsResponse', getDocumentationPartsResponse_httpStatus - The response's http status code.

GetDocumentationVersion

data GetDocumentationVersion Source #

Gets a documentation snapshot of an API.

See: newGetDocumentationVersion smart constructor.

Constructors

GetDocumentationVersion' Text Text

Instances

Instances details

ToHeaders GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Methods toHeaders :: GetDocumentationVersion -> [Header] #
ToPath GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Methods toPath :: GetDocumentationVersion -> ByteString #
ToQuery GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Methods toQuery :: GetDocumentationVersion -> QueryString #
AWSRequest GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Associated Types type AWSResponse GetDocumentationVersion # Methods request :: (Service -> Service) -> GetDocumentationVersion -> Request GetDocumentationVersion # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDocumentationVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDocumentationVersion))) #
Generic GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Associated Types type Rep GetDocumentationVersion :: Type -> Type # Methods from :: GetDocumentationVersion -> Rep GetDocumentationVersion x # to :: Rep GetDocumentationVersion x -> GetDocumentationVersion #
Read GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Methods readsPrec :: Int -> ReadS GetDocumentationVersion # readList :: ReadS [GetDocumentationVersion] # readPrec :: ReadPrec GetDocumentationVersion # readListPrec :: ReadPrec [GetDocumentationVersion] #
Show GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Methods showsPrec :: Int -> GetDocumentationVersion -> ShowS # show :: GetDocumentationVersion -> String # showList :: [GetDocumentationVersion] -> ShowS #
NFData GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Methods rnf :: GetDocumentationVersion -> () #
Eq GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Methods (==) :: GetDocumentationVersion -> GetDocumentationVersion -> Bool # (/=) :: GetDocumentationVersion -> GetDocumentationVersion -> Bool #
Hashable GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion Methods hashWithSalt :: Int -> GetDocumentationVersion -> Int # hash :: GetDocumentationVersion -> Int #
type AWSResponse GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion type AWSResponse GetDocumentationVersion = DocumentationVersion
type Rep GetDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersion type Rep GetDocumentationVersion = D1 ('MetaData "GetDocumentationVersion" "Amazonka.APIGateway.GetDocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDocumentationVersion Source #

Arguments

:: Text	`GetDocumentationVersion`
-> Text	`GetDocumentationVersion`
-> GetDocumentationVersion

Create a value of GetDocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDocumentationVersion, getDocumentationVersion_restApiId - The string identifier of the associated RestApi.

GetDocumentationVersion, getDocumentationVersion_documentationVersion - The version identifier of the to-be-retrieved documentation snapshot.

data DocumentationVersion Source #

A snapshot of the documentation of an API.

See: newDocumentationVersion smart constructor.

Constructors

DocumentationVersion' (Maybe POSIX) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods parseJSON :: Value -> Parser DocumentationVersion # parseJSONList :: Value -> Parser [DocumentationVersion] #
Generic DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Associated Types type Rep DocumentationVersion :: Type -> Type # Methods from :: DocumentationVersion -> Rep DocumentationVersion x # to :: Rep DocumentationVersion x -> DocumentationVersion #
Read DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods readsPrec :: Int -> ReadS DocumentationVersion # readList :: ReadS [DocumentationVersion] # readPrec :: ReadPrec DocumentationVersion # readListPrec :: ReadPrec [DocumentationVersion] #
Show DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods showsPrec :: Int -> DocumentationVersion -> ShowS # show :: DocumentationVersion -> String # showList :: [DocumentationVersion] -> ShowS #
NFData DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods rnf :: DocumentationVersion -> () #
Eq DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods (==) :: DocumentationVersion -> DocumentationVersion -> Bool # (/=) :: DocumentationVersion -> DocumentationVersion -> Bool #
Hashable DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods hashWithSalt :: Int -> DocumentationVersion -> Int # hash :: DocumentationVersion -> Int #
type Rep DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion type Rep DocumentationVersion = D1 ('MetaData "DocumentationVersion" "Amazonka.APIGateway.Types.DocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationVersion :: DocumentationVersion Source #

Create a value of DocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdDate:DocumentationVersion', documentationVersion_createdDate - The date when the API documentation snapshot is created.

$sel:description:DocumentationVersion', documentationVersion_description - The description of the API documentation snapshot.

$sel:version:DocumentationVersion', documentationVersion_version - The version identifier of the API documentation snapshot.

GetDocumentationVersions (Paginated)

data GetDocumentationVersions Source #

Gets the documentation versions of an API.

See: newGetDocumentationVersions smart constructor.

Constructors

GetDocumentationVersions' (Maybe Int) (Maybe Text) Text

Instances

Instances details

ToHeaders GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods toHeaders :: GetDocumentationVersions -> [Header] #
ToPath GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods toPath :: GetDocumentationVersions -> ByteString #
ToQuery GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods toQuery :: GetDocumentationVersions -> QueryString #
AWSPager GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods page :: GetDocumentationVersions -> AWSResponse GetDocumentationVersions -> Maybe GetDocumentationVersions #
AWSRequest GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Associated Types type AWSResponse GetDocumentationVersions # Methods request :: (Service -> Service) -> GetDocumentationVersions -> Request GetDocumentationVersions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDocumentationVersions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDocumentationVersions))) #
Generic GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Associated Types type Rep GetDocumentationVersions :: Type -> Type # Methods from :: GetDocumentationVersions -> Rep GetDocumentationVersions x # to :: Rep GetDocumentationVersions x -> GetDocumentationVersions #
Read GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods readsPrec :: Int -> ReadS GetDocumentationVersions # readList :: ReadS [GetDocumentationVersions] # readPrec :: ReadPrec GetDocumentationVersions # readListPrec :: ReadPrec [GetDocumentationVersions] #
Show GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods showsPrec :: Int -> GetDocumentationVersions -> ShowS # show :: GetDocumentationVersions -> String # showList :: [GetDocumentationVersions] -> ShowS #
NFData GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods rnf :: GetDocumentationVersions -> () #
Eq GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods (==) :: GetDocumentationVersions -> GetDocumentationVersions -> Bool # (/=) :: GetDocumentationVersions -> GetDocumentationVersions -> Bool #
Hashable GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods hashWithSalt :: Int -> GetDocumentationVersions -> Int # hash :: GetDocumentationVersions -> Int #
type AWSResponse GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions type AWSResponse GetDocumentationVersions = GetDocumentationVersionsResponse
type Rep GetDocumentationVersions Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions type Rep GetDocumentationVersions = D1 ('MetaData "GetDocumentationVersions" "Amazonka.APIGateway.GetDocumentationVersions" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDocumentationVersions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetDocumentationVersions Source #

Arguments

:: Text	`GetDocumentationVersions`
-> GetDocumentationVersions

Create a value of GetDocumentationVersions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDocumentationVersions, getDocumentationVersions_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetDocumentationVersions, getDocumentationVersions_position - The current pagination position in the paged result set.

GetDocumentationVersions, getDocumentationVersions_restApiId - The string identifier of the associated RestApi.

data GetDocumentationVersionsResponse Source #

The collection of documentation snapshots of an API.

See: newGetDocumentationVersionsResponse smart constructor.

Constructors

GetDocumentationVersionsResponse' (Maybe [DocumentationVersion]) (Maybe Text) Int

Instances

Instances details

Generic GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Associated Types type Rep GetDocumentationVersionsResponse :: Type -> Type # Methods from :: GetDocumentationVersionsResponse -> Rep GetDocumentationVersionsResponse x # to :: Rep GetDocumentationVersionsResponse x -> GetDocumentationVersionsResponse #
Read GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods readsPrec :: Int -> ReadS GetDocumentationVersionsResponse # readList :: ReadS [GetDocumentationVersionsResponse] # readPrec :: ReadPrec GetDocumentationVersionsResponse # readListPrec :: ReadPrec [GetDocumentationVersionsResponse] #
Show GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods showsPrec :: Int -> GetDocumentationVersionsResponse -> ShowS # show :: GetDocumentationVersionsResponse -> String # showList :: [GetDocumentationVersionsResponse] -> ShowS #
NFData GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods rnf :: GetDocumentationVersionsResponse -> () #
Eq GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions Methods (==) :: GetDocumentationVersionsResponse -> GetDocumentationVersionsResponse -> Bool # (/=) :: GetDocumentationVersionsResponse -> GetDocumentationVersionsResponse -> Bool #
type Rep GetDocumentationVersionsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDocumentationVersions type Rep GetDocumentationVersionsResponse = D1 ('MetaData "GetDocumentationVersionsResponse" "Amazonka.APIGateway.GetDocumentationVersions" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDocumentationVersionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DocumentationVersion])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDocumentationVersionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDocumentationVersionsResponse'`
-> GetDocumentationVersionsResponse

Create a value of GetDocumentationVersionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDocumentationVersionsResponse, getDocumentationVersionsResponse_items - The current page of elements from this collection.

GetDocumentationVersions, getDocumentationVersionsResponse_position - Undocumented member.

$sel:httpStatus:GetDocumentationVersionsResponse', getDocumentationVersionsResponse_httpStatus - The response's http status code.

GetDomainName

data GetDomainName Source #

Request to get the name of a DomainName resource.

See: newGetDomainName smart constructor.

Constructors

GetDomainName' Text

Instances

Instances details

ToHeaders GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Methods toHeaders :: GetDomainName -> [Header] #
ToPath GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Methods toPath :: GetDomainName -> ByteString #
ToQuery GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Methods toQuery :: GetDomainName -> QueryString #
AWSRequest GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Associated Types type AWSResponse GetDomainName # Methods request :: (Service -> Service) -> GetDomainName -> Request GetDomainName # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDomainName -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDomainName))) #
Generic GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Associated Types type Rep GetDomainName :: Type -> Type # Methods from :: GetDomainName -> Rep GetDomainName x # to :: Rep GetDomainName x -> GetDomainName #
Read GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Methods readsPrec :: Int -> ReadS GetDomainName # readList :: ReadS [GetDomainName] # readPrec :: ReadPrec GetDomainName # readListPrec :: ReadPrec [GetDomainName] #
Show GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Methods showsPrec :: Int -> GetDomainName -> ShowS # show :: GetDomainName -> String # showList :: [GetDomainName] -> ShowS #
NFData GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Methods rnf :: GetDomainName -> () #
Eq GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Methods (==) :: GetDomainName -> GetDomainName -> Bool # (/=) :: GetDomainName -> GetDomainName -> Bool #
Hashable GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName Methods hashWithSalt :: Int -> GetDomainName -> Int # hash :: GetDomainName -> Int #
type AWSResponse GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName type AWSResponse GetDomainName = DomainName
type Rep GetDomainName Source #
Instance details Defined in Amazonka.APIGateway.GetDomainName type Rep GetDomainName = D1 ('MetaData "GetDomainName" "Amazonka.APIGateway.GetDomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDomainName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetDomainName Source #

Arguments

:: Text	`GetDomainName`
-> GetDomainName

Create a value of GetDomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDomainName, getDomainName_domainName - The name of the DomainName resource.

data DomainName Source #

Represents a custom domain name as a user-friendly host name of an API (RestApi).

See: newDomainName smart constructor.

Constructors

DomainName' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text))

Instances

Instances details

FromJSON DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods parseJSON :: Value -> Parser DomainName # parseJSONList :: Value -> Parser [DomainName] #
Generic DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Associated Types type Rep DomainName :: Type -> Type # Methods from :: DomainName -> Rep DomainName x # to :: Rep DomainName x -> DomainName #
Read DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods readsPrec :: Int -> ReadS DomainName # readList :: ReadS [DomainName] # readPrec :: ReadPrec DomainName # readListPrec :: ReadPrec [DomainName] #
Show DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods showsPrec :: Int -> DomainName -> ShowS # show :: DomainName -> String # showList :: [DomainName] -> ShowS #
NFData DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods rnf :: DomainName -> () #
Eq DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods (==) :: DomainName -> DomainName -> Bool # (/=) :: DomainName -> DomainName -> Bool #
Hashable DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods hashWithSalt :: Int -> DomainName -> Int # hash :: DomainName -> Int #
type Rep DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName type Rep DomainName = D1 ('MetaData "DomainName" "Amazonka.APIGateway.Types.DomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DomainName'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "certificateUploadDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "distributionDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "distributionHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domainNameStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainNameStatus)) :: S1 ('MetaSel ('Just "domainNameStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration)) :: S1 ('MetaSel ('Just "mutualTlsAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MutualTlsAuthentication))) :: (S1 ('MetaSel ('Just "ownershipVerificationCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "regionalCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "regionalHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityPolicy)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))))

newDomainName :: DomainName Source #

Create a value of DomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:certificateArn:DomainName', domainName_certificateArn - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

$sel:certificateName:DomainName', domainName_certificateName - The name of the certificate that will be used by edge-optimized endpoint for this domain name.

$sel:certificateUploadDate:DomainName', domainName_certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

$sel:distributionDomainName:DomainName', domainName_distributionDomainName - The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

$sel:distributionHostedZoneId:DomainName', domainName_distributionHostedZoneId - The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:domainName:DomainName', domainName_domainName - The custom domain name as an API host name, for example, my-api.example.com.

$sel:domainNameStatus:DomainName', domainName_domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

$sel:domainNameStatusMessage:DomainName', domainName_domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.

$sel:endpointConfiguration:DomainName', domainName_endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

$sel:mutualTlsAuthentication:DomainName', domainName_mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

$sel:ownershipVerificationCertificateArn:DomainName', domainName_ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

$sel:regionalCertificateArn:DomainName', domainName_regionalCertificateArn - The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

$sel:regionalCertificateName:DomainName', domainName_regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.

$sel:regionalDomainName:DomainName', domainName_regionalDomainName - The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

$sel:regionalHostedZoneId:DomainName', domainName_regionalHostedZoneId - The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:securityPolicy:DomainName', domainName_securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

$sel:tags:DomainName', domainName_tags - The collection of tags. Each tag element is associated with a given resource.

GetDomainNames (Paginated)

data GetDomainNames Source #

Request to describe a collection of DomainName resources.

See: newGetDomainNames smart constructor.

Constructors

GetDomainNames' (Maybe Int) (Maybe Text)

Instances

Instances details

ToHeaders GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods toHeaders :: GetDomainNames -> [Header] #
ToPath GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods toPath :: GetDomainNames -> ByteString #
ToQuery GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods toQuery :: GetDomainNames -> QueryString #
AWSPager GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods page :: GetDomainNames -> AWSResponse GetDomainNames -> Maybe GetDomainNames #
AWSRequest GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Associated Types type AWSResponse GetDomainNames # Methods request :: (Service -> Service) -> GetDomainNames -> Request GetDomainNames # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetDomainNames -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetDomainNames))) #
Generic GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Associated Types type Rep GetDomainNames :: Type -> Type # Methods from :: GetDomainNames -> Rep GetDomainNames x # to :: Rep GetDomainNames x -> GetDomainNames #
Read GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods readsPrec :: Int -> ReadS GetDomainNames # readList :: ReadS [GetDomainNames] # readPrec :: ReadPrec GetDomainNames # readListPrec :: ReadPrec [GetDomainNames] #
Show GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods showsPrec :: Int -> GetDomainNames -> ShowS # show :: GetDomainNames -> String # showList :: [GetDomainNames] -> ShowS #
NFData GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods rnf :: GetDomainNames -> () #
Eq GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods (==) :: GetDomainNames -> GetDomainNames -> Bool # (/=) :: GetDomainNames -> GetDomainNames -> Bool #
Hashable GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods hashWithSalt :: Int -> GetDomainNames -> Int # hash :: GetDomainNames -> Int #
type AWSResponse GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames type AWSResponse GetDomainNames = GetDomainNamesResponse
type Rep GetDomainNames Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames type Rep GetDomainNames = D1 ('MetaData "GetDomainNames" "Amazonka.APIGateway.GetDomainNames" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDomainNames'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetDomainNames :: GetDomainNames Source #

Create a value of GetDomainNames with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDomainNames, getDomainNames_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetDomainNames, getDomainNames_position - The current pagination position in the paged result set.

data GetDomainNamesResponse Source #

Represents a collection of DomainName resources.

See: newGetDomainNamesResponse smart constructor.

Constructors

GetDomainNamesResponse' (Maybe [DomainName]) (Maybe Text) Int

Instances

Instances details

Generic GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Associated Types type Rep GetDomainNamesResponse :: Type -> Type # Methods from :: GetDomainNamesResponse -> Rep GetDomainNamesResponse x # to :: Rep GetDomainNamesResponse x -> GetDomainNamesResponse #
Read GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods readsPrec :: Int -> ReadS GetDomainNamesResponse # readList :: ReadS [GetDomainNamesResponse] # readPrec :: ReadPrec GetDomainNamesResponse # readListPrec :: ReadPrec [GetDomainNamesResponse] #
Show GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods showsPrec :: Int -> GetDomainNamesResponse -> ShowS # show :: GetDomainNamesResponse -> String # showList :: [GetDomainNamesResponse] -> ShowS #
NFData GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods rnf :: GetDomainNamesResponse -> () #
Eq GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames Methods (==) :: GetDomainNamesResponse -> GetDomainNamesResponse -> Bool # (/=) :: GetDomainNamesResponse -> GetDomainNamesResponse -> Bool #
type Rep GetDomainNamesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetDomainNames type Rep GetDomainNamesResponse = D1 ('MetaData "GetDomainNamesResponse" "Amazonka.APIGateway.GetDomainNames" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetDomainNamesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DomainName])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetDomainNamesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetDomainNamesResponse'`
-> GetDomainNamesResponse

Create a value of GetDomainNamesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetDomainNamesResponse, getDomainNamesResponse_items - The current page of elements from this collection.

GetDomainNames, getDomainNamesResponse_position - Undocumented member.

$sel:httpStatus:GetDomainNamesResponse', getDomainNamesResponse_httpStatus - The response's http status code.

GetExport

data GetExport Source #

Request a new export of a RestApi for a particular Stage.

See: newGetExport smart constructor.

Constructors

GetExport' (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text

Instances

Instances details

ToHeaders GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods toHeaders :: GetExport -> [Header] #
ToPath GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods toPath :: GetExport -> ByteString #
ToQuery GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods toQuery :: GetExport -> QueryString #
AWSRequest GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Associated Types type AWSResponse GetExport # Methods request :: (Service -> Service) -> GetExport -> Request GetExport # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetExport -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetExport))) #
Generic GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Associated Types type Rep GetExport :: Type -> Type # Methods from :: GetExport -> Rep GetExport x # to :: Rep GetExport x -> GetExport #
Read GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods readsPrec :: Int -> ReadS GetExport # readList :: ReadS [GetExport] # readPrec :: ReadPrec GetExport # readListPrec :: ReadPrec [GetExport] #
Show GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods showsPrec :: Int -> GetExport -> ShowS # show :: GetExport -> String # showList :: [GetExport] -> ShowS #
NFData GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods rnf :: GetExport -> () #
Eq GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods (==) :: GetExport -> GetExport -> Bool # (/=) :: GetExport -> GetExport -> Bool #
Hashable GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods hashWithSalt :: Int -> GetExport -> Int # hash :: GetExport -> Int #
type AWSResponse GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport type AWSResponse GetExport = GetExportResponse
type Rep GetExport Source #
Instance details Defined in Amazonka.APIGateway.GetExport type Rep GetExport = D1 ('MetaData "GetExport" "Amazonka.APIGateway.GetExport" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetExport'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "accepts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "exportType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetExport Source #

Arguments

:: Text	`GetExport`
-> Text	`GetExport`
-> Text	`$sel:exportType:GetExport'`
-> GetExport

Create a value of GetExport with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accepts:GetExport', getExport_accepts - The content-type of the export, for example application/json. Currently application/json and application/yaml are supported for exportType ofoas30 and swagger. This should be specified in the Accept header for direct API requests.

$sel:parameters:GetExport', getExport_parameters - A key-value map of query string parameters that specify properties of the export, depending on the requested exportType. For exportType oas30 and swagger, any combination of the following parameters are supported: extensions='integrations' or extensions='apigateway' will export the API with x-amazon-apigateway-integration extensions. extensions='authorizers' will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

GetExport, getExport_restApiId - The string identifier of the associated RestApi.

GetExport, getExport_stageName - The name of the Stage that will be exported.

$sel:exportType:GetExport', getExport_exportType - The type of export. Acceptable values are 'oas30' for OpenAPI 3.0.x and 'swagger' for Swagger/OpenAPI 2.0.

data GetExportResponse Source #

The binary blob response to GetExport, which contains the generated SDK.

See: newGetExportResponse smart constructor.

Constructors

GetExportResponse' (Maybe ByteString) (Maybe Text) (Maybe Text) Int

Instances

Instances details

Generic GetExportResponse Source #
Instance details Defined in Amazonka.APIGateway.GetExport Associated Types type Rep GetExportResponse :: Type -> Type # Methods from :: GetExportResponse -> Rep GetExportResponse x # to :: Rep GetExportResponse x -> GetExportResponse #
Show GetExportResponse Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods showsPrec :: Int -> GetExportResponse -> ShowS # show :: GetExportResponse -> String # showList :: [GetExportResponse] -> ShowS #
NFData GetExportResponse Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods rnf :: GetExportResponse -> () #
Eq GetExportResponse Source #
Instance details Defined in Amazonka.APIGateway.GetExport Methods (==) :: GetExportResponse -> GetExportResponse -> Bool # (/=) :: GetExportResponse -> GetExportResponse -> Bool #
type Rep GetExportResponse Source #
Instance details Defined in Amazonka.APIGateway.GetExport type Rep GetExportResponse = D1 ('MetaData "GetExportResponse" "Amazonka.APIGateway.GetExport" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetExportResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :: S1 ('MetaSel ('Just "contentDisposition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetExportResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetExportResponse'`
-> GetExportResponse

Create a value of GetExportResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:body:GetExportResponse', getExportResponse_body - The binary blob response to GetExport, which contains the export.

$sel:contentDisposition:GetExportResponse', getExportResponse_contentDisposition - The content-disposition header value in the HTTP response.

GetExportResponse, getExportResponse_contentType - The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.

$sel:httpStatus:GetExportResponse', getExportResponse_httpStatus - The response's http status code.

GetGatewayResponse

data GetGatewayResponse Source #

Gets a GatewayResponse of a specified response type on the given RestApi.

See: newGetGatewayResponse smart constructor.

Constructors

GetGatewayResponse' Text GatewayResponseType

Instances

Instances details

ToHeaders GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Methods toHeaders :: GetGatewayResponse -> [Header] #
ToPath GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Methods toPath :: GetGatewayResponse -> ByteString #
ToQuery GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Methods toQuery :: GetGatewayResponse -> QueryString #
AWSRequest GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Associated Types type AWSResponse GetGatewayResponse # Methods request :: (Service -> Service) -> GetGatewayResponse -> Request GetGatewayResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetGatewayResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetGatewayResponse))) #
Generic GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Associated Types type Rep GetGatewayResponse :: Type -> Type # Methods from :: GetGatewayResponse -> Rep GetGatewayResponse x # to :: Rep GetGatewayResponse x -> GetGatewayResponse #
Read GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Methods readsPrec :: Int -> ReadS GetGatewayResponse # readList :: ReadS [GetGatewayResponse] # readPrec :: ReadPrec GetGatewayResponse # readListPrec :: ReadPrec [GetGatewayResponse] #
Show GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Methods showsPrec :: Int -> GetGatewayResponse -> ShowS # show :: GetGatewayResponse -> String # showList :: [GetGatewayResponse] -> ShowS #
NFData GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Methods rnf :: GetGatewayResponse -> () #
Eq GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Methods (==) :: GetGatewayResponse -> GetGatewayResponse -> Bool # (/=) :: GetGatewayResponse -> GetGatewayResponse -> Bool #
Hashable GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse Methods hashWithSalt :: Int -> GetGatewayResponse -> Int # hash :: GetGatewayResponse -> Int #
type AWSResponse GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse type AWSResponse GetGatewayResponse = GatewayResponse
type Rep GetGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponse type Rep GetGatewayResponse = D1 ('MetaData "GetGatewayResponse" "Amazonka.APIGateway.GetGatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetGatewayResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayResponseType)))

newGetGatewayResponse Source #

Arguments

:: Text	`GetGatewayResponse`
-> GatewayResponseType	`GetGatewayResponse`
-> GetGatewayResponse

Create a value of GetGatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetGatewayResponse, getGatewayResponse_restApiId - The string identifier of the associated RestApi.

GetGatewayResponse, getGatewayResponse_responseType - The response type of the associated GatewayResponse.

data GatewayResponse Source #

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

See: newGatewayResponse smart constructor.

Constructors

GatewayResponse' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe GatewayResponseType) (Maybe Text)

Instances

Instances details

FromJSON GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods parseJSON :: Value -> Parser GatewayResponse # parseJSONList :: Value -> Parser [GatewayResponse] #
Generic GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Associated Types type Rep GatewayResponse :: Type -> Type # Methods from :: GatewayResponse -> Rep GatewayResponse x # to :: Rep GatewayResponse x -> GatewayResponse #
Read GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods readsPrec :: Int -> ReadS GatewayResponse # readList :: ReadS [GatewayResponse] # readPrec :: ReadPrec GatewayResponse # readListPrec :: ReadPrec [GatewayResponse] #
Show GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods showsPrec :: Int -> GatewayResponse -> ShowS # show :: GatewayResponse -> String # showList :: [GatewayResponse] -> ShowS #
NFData GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods rnf :: GatewayResponse -> () #
Eq GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods (==) :: GatewayResponse -> GatewayResponse -> Bool # (/=) :: GatewayResponse -> GatewayResponse -> Bool #
Hashable GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods hashWithSalt :: Int -> GatewayResponse -> Int # hash :: GatewayResponse -> Int #
type Rep GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse type Rep GatewayResponse = D1 ('MetaData "GatewayResponse" "Amazonka.APIGateway.Types.GatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GatewayResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayResponseType)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGatewayResponse :: GatewayResponse Source #

Create a value of GatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultResponse:GatewayResponse', gatewayResponse_defaultResponse - A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

$sel:responseParameters:GatewayResponse', gatewayResponse_responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseTemplates:GatewayResponse', gatewayResponse_responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseType:GatewayResponse', gatewayResponse_responseType - The response type of the associated GatewayResponse.

$sel:statusCode:GatewayResponse', gatewayResponse_statusCode - The HTTP status code for this GatewayResponse.

GetGatewayResponses (Paginated)

data GetGatewayResponses Source #

Gets the GatewayResponses collection on the given RestApi. If an API developer has not added any definitions for gateway responses, the result will be the API Gateway-generated default GatewayResponses collection for the supported response types.

See: newGetGatewayResponses smart constructor.

Constructors

GetGatewayResponses' (Maybe Int) (Maybe Text) Text

Instances

Instances details

ToHeaders GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods toHeaders :: GetGatewayResponses -> [Header] #
ToPath GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods toPath :: GetGatewayResponses -> ByteString #
ToQuery GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods toQuery :: GetGatewayResponses -> QueryString #
AWSPager GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods page :: GetGatewayResponses -> AWSResponse GetGatewayResponses -> Maybe GetGatewayResponses #
AWSRequest GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Associated Types type AWSResponse GetGatewayResponses # Methods request :: (Service -> Service) -> GetGatewayResponses -> Request GetGatewayResponses # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetGatewayResponses -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetGatewayResponses))) #
Generic GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Associated Types type Rep GetGatewayResponses :: Type -> Type # Methods from :: GetGatewayResponses -> Rep GetGatewayResponses x # to :: Rep GetGatewayResponses x -> GetGatewayResponses #
Read GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods readsPrec :: Int -> ReadS GetGatewayResponses # readList :: ReadS [GetGatewayResponses] # readPrec :: ReadPrec GetGatewayResponses # readListPrec :: ReadPrec [GetGatewayResponses] #
Show GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods showsPrec :: Int -> GetGatewayResponses -> ShowS # show :: GetGatewayResponses -> String # showList :: [GetGatewayResponses] -> ShowS #
NFData GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods rnf :: GetGatewayResponses -> () #
Eq GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods (==) :: GetGatewayResponses -> GetGatewayResponses -> Bool # (/=) :: GetGatewayResponses -> GetGatewayResponses -> Bool #
Hashable GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods hashWithSalt :: Int -> GetGatewayResponses -> Int # hash :: GetGatewayResponses -> Int #
type AWSResponse GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses type AWSResponse GetGatewayResponses = GetGatewayResponsesResponse
type Rep GetGatewayResponses Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses type Rep GetGatewayResponses = D1 ('MetaData "GetGatewayResponses" "Amazonka.APIGateway.GetGatewayResponses" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetGatewayResponses'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetGatewayResponses Source #

Arguments

:: Text	`GetGatewayResponses`
-> GetGatewayResponses

Create a value of GetGatewayResponses with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetGatewayResponses, getGatewayResponses_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500. The GatewayResponses collection does not support pagination and the limit does not apply here.

GetGatewayResponses, getGatewayResponses_position - The current pagination position in the paged result set. The GatewayResponse collection does not support pagination and the position does not apply here.

GetGatewayResponses, getGatewayResponses_restApiId - The string identifier of the associated RestApi.

data GetGatewayResponsesResponse Source #

The collection of the GatewayResponse instances of a RestApi as a responseType-to-GatewayResponse object map of key-value pairs. As such, pagination is not supported for querying this collection.

See: newGetGatewayResponsesResponse smart constructor.

Constructors

GetGatewayResponsesResponse' (Maybe [GatewayResponse]) (Maybe Text) Int

Instances

Instances details

Generic GetGatewayResponsesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Associated Types type Rep GetGatewayResponsesResponse :: Type -> Type # Methods from :: GetGatewayResponsesResponse -> Rep GetGatewayResponsesResponse x # to :: Rep GetGatewayResponsesResponse x -> GetGatewayResponsesResponse #
Read GetGatewayResponsesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods readsPrec :: Int -> ReadS GetGatewayResponsesResponse # readList :: ReadS [GetGatewayResponsesResponse] # readPrec :: ReadPrec GetGatewayResponsesResponse # readListPrec :: ReadPrec [GetGatewayResponsesResponse] #
Show GetGatewayResponsesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods showsPrec :: Int -> GetGatewayResponsesResponse -> ShowS # show :: GetGatewayResponsesResponse -> String # showList :: [GetGatewayResponsesResponse] -> ShowS #
NFData GetGatewayResponsesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods rnf :: GetGatewayResponsesResponse -> () #
Eq GetGatewayResponsesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses Methods (==) :: GetGatewayResponsesResponse -> GetGatewayResponsesResponse -> Bool # (/=) :: GetGatewayResponsesResponse -> GetGatewayResponsesResponse -> Bool #
type Rep GetGatewayResponsesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetGatewayResponses type Rep GetGatewayResponsesResponse = D1 ('MetaData "GetGatewayResponsesResponse" "Amazonka.APIGateway.GetGatewayResponses" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetGatewayResponsesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GatewayResponse])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetGatewayResponsesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetGatewayResponsesResponse'`
-> GetGatewayResponsesResponse

Create a value of GetGatewayResponsesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetGatewayResponsesResponse, getGatewayResponsesResponse_items - Returns the entire collection, because of no pagination support.

GetGatewayResponses, getGatewayResponsesResponse_position - Undocumented member.

$sel:httpStatus:GetGatewayResponsesResponse', getGatewayResponsesResponse_httpStatus - The response's http status code.

GetIntegration

data GetIntegration Source #

Represents a request to get the integration configuration.

See: newGetIntegration smart constructor.

Constructors

GetIntegration' Text Text Text

Instances

Instances details

ToHeaders GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Methods toHeaders :: GetIntegration -> [Header] #
ToPath GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Methods toPath :: GetIntegration -> ByteString #
ToQuery GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Methods toQuery :: GetIntegration -> QueryString #
AWSRequest GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Associated Types type AWSResponse GetIntegration # Methods request :: (Service -> Service) -> GetIntegration -> Request GetIntegration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIntegration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIntegration))) #
Generic GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Associated Types type Rep GetIntegration :: Type -> Type # Methods from :: GetIntegration -> Rep GetIntegration x # to :: Rep GetIntegration x -> GetIntegration #
Read GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Methods readsPrec :: Int -> ReadS GetIntegration # readList :: ReadS [GetIntegration] # readPrec :: ReadPrec GetIntegration # readListPrec :: ReadPrec [GetIntegration] #
Show GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Methods showsPrec :: Int -> GetIntegration -> ShowS # show :: GetIntegration -> String # showList :: [GetIntegration] -> ShowS #
NFData GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Methods rnf :: GetIntegration -> () #
Eq GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Methods (==) :: GetIntegration -> GetIntegration -> Bool # (/=) :: GetIntegration -> GetIntegration -> Bool #
Hashable GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration Methods hashWithSalt :: Int -> GetIntegration -> Int # hash :: GetIntegration -> Int #
type AWSResponse GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration type AWSResponse GetIntegration = Integration
type Rep GetIntegration Source #
Instance details Defined in Amazonka.APIGateway.GetIntegration type Rep GetIntegration = D1 ('MetaData "GetIntegration" "Amazonka.APIGateway.GetIntegration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetIntegration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetIntegration Source #

Arguments

:: Text	`GetIntegration`
-> Text	`$sel:resourceId:GetIntegration'`
-> Text	`GetIntegration`
-> GetIntegration

Create a value of GetIntegration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetIntegration, getIntegration_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:GetIntegration', getIntegration_resourceId - Specifies a get integration request's resource identifier

GetIntegration, getIntegration_httpMethod - Specifies a get integration request's HTTP method.

data Integration Source #

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

See: newIntegration smart constructor.

Constructors

Integration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text IntegrationResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe IntegrationType) (Maybe Text)

Instances

Instances details

FromJSON Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods parseJSON :: Value -> Parser Integration # parseJSONList :: Value -> Parser [Integration] #
Generic Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Associated Types type Rep Integration :: Type -> Type # Methods from :: Integration -> Rep Integration x # to :: Rep Integration x -> Integration #
Read Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods readsPrec :: Int -> ReadS Integration # readList :: ReadS [Integration] # readPrec :: ReadPrec Integration # readListPrec :: ReadPrec [Integration] #
Show Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods showsPrec :: Int -> Integration -> ShowS # show :: Integration -> String # showList :: [Integration] -> ShowS #
NFData Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods rnf :: Integration -> () #
Eq Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods (==) :: Integration -> Integration -> Bool # (/=) :: Integration -> Integration -> Bool #
Hashable Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods hashWithSalt :: Int -> Integration -> Int # hash :: Integration -> Int #
type Rep Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration type Rep Integration = D1 ('MetaData "Integration" "Amazonka.APIGateway.Types.Integration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Integration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheKeyParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "cacheNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "connectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionType)) :: S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy))) :: (S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "integrationResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text IntegrationResponse))) :: S1 ('MetaSel ('Just "passthroughBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "requestTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "timeoutInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "tlsConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TlsConfig))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntegrationType)) :: S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newIntegration :: Integration Source #

Create a value of Integration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheKeyParameters:Integration', integration_cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

$sel:cacheNamespace:Integration', integration_cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

$sel:connectionId:Integration', integration_connectionId - The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

$sel:connectionType:Integration', integration_connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Integration, integration_contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

$sel:credentials:Integration', integration_credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

$sel:httpMethod:Integration', integration_httpMethod - Specifies the integration's HTTP method type.

$sel:integrationResponses:Integration', integration_integrationResponses - Specifies the integration's responses.

$sel:passthroughBehavior:Integration', integration_passthroughBehavior - Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

$sel:requestParameters:Integration', integration_requestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

$sel:requestTemplates:Integration', integration_requestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

$sel:timeoutInMillis:Integration', integration_timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

$sel:tlsConfig:Integration', integration_tlsConfig - Specifies the TLS configuration for an integration.

$sel:type':Integration', integration_type - Specifies an API method integration type. The valid value is one of the following:

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

$sel:uri:Integration', integration_uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint.

For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

GetIntegrationResponse

data GetIntegrationResponse Source #

Represents a get integration response request.

See: newGetIntegrationResponse smart constructor.

Constructors

GetIntegrationResponse' Text Text Text Text

Instances

Instances details

ToHeaders GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Methods toHeaders :: GetIntegrationResponse -> [Header] #
ToPath GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Methods toPath :: GetIntegrationResponse -> ByteString #
ToQuery GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Methods toQuery :: GetIntegrationResponse -> QueryString #
AWSRequest GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Associated Types type AWSResponse GetIntegrationResponse # Methods request :: (Service -> Service) -> GetIntegrationResponse -> Request GetIntegrationResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetIntegrationResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetIntegrationResponse))) #
Generic GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Associated Types type Rep GetIntegrationResponse :: Type -> Type # Methods from :: GetIntegrationResponse -> Rep GetIntegrationResponse x # to :: Rep GetIntegrationResponse x -> GetIntegrationResponse #
Read GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Methods readsPrec :: Int -> ReadS GetIntegrationResponse # readList :: ReadS [GetIntegrationResponse] # readPrec :: ReadPrec GetIntegrationResponse # readListPrec :: ReadPrec [GetIntegrationResponse] #
Show GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Methods showsPrec :: Int -> GetIntegrationResponse -> ShowS # show :: GetIntegrationResponse -> String # showList :: [GetIntegrationResponse] -> ShowS #
NFData GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Methods rnf :: GetIntegrationResponse -> () #
Eq GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Methods (==) :: GetIntegrationResponse -> GetIntegrationResponse -> Bool # (/=) :: GetIntegrationResponse -> GetIntegrationResponse -> Bool #
Hashable GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse Methods hashWithSalt :: Int -> GetIntegrationResponse -> Int # hash :: GetIntegrationResponse -> Int #
type AWSResponse GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse type AWSResponse GetIntegrationResponse = IntegrationResponse
type Rep GetIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.GetIntegrationResponse type Rep GetIntegrationResponse = D1 ('MetaData "GetIntegrationResponse" "Amazonka.APIGateway.GetIntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetIntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetIntegrationResponse Source #

Arguments

:: Text	`GetIntegrationResponse`
-> Text	`$sel:resourceId:GetIntegrationResponse'`
-> Text	`GetIntegrationResponse`
-> Text	`GetIntegrationResponse`
-> GetIntegrationResponse

Create a value of GetIntegrationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetIntegrationResponse, getIntegrationResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:GetIntegrationResponse', getIntegrationResponse_resourceId - Specifies a get integration response request's resource identifier.

GetIntegrationResponse, getIntegrationResponse_httpMethod - Specifies a get integration response request's HTTP method.

GetIntegrationResponse, getIntegrationResponse_statusCode - Specifies a get integration response request's status code.

data IntegrationResponse Source #

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

See: newIntegrationResponse smart constructor.

Constructors

IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods parseJSON :: Value -> Parser IntegrationResponse # parseJSONList :: Value -> Parser [IntegrationResponse] #
Generic IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Associated Types type Rep IntegrationResponse :: Type -> Type # Methods from :: IntegrationResponse -> Rep IntegrationResponse x # to :: Rep IntegrationResponse x -> IntegrationResponse #
Read IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods readsPrec :: Int -> ReadS IntegrationResponse # readList :: ReadS [IntegrationResponse] # readPrec :: ReadPrec IntegrationResponse # readListPrec :: ReadPrec [IntegrationResponse] #
Show IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods showsPrec :: Int -> IntegrationResponse -> ShowS # show :: IntegrationResponse -> String # showList :: [IntegrationResponse] -> ShowS #
NFData IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods rnf :: IntegrationResponse -> () #
Eq IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods (==) :: IntegrationResponse -> IntegrationResponse -> Bool # (/=) :: IntegrationResponse -> IntegrationResponse -> Bool #
Hashable IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods hashWithSalt :: Int -> IntegrationResponse -> Int # hash :: IntegrationResponse -> Int #
type Rep IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse type Rep IntegrationResponse = D1 ('MetaData "IntegrationResponse" "Amazonka.APIGateway.Types.IntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "IntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "selectionPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newIntegrationResponse :: IntegrationResponse Source #

Create a value of IntegrationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentHandling:IntegrationResponse', integrationResponse_contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

$sel:responseParameters:IntegrationResponse', integrationResponse_responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

$sel:responseTemplates:IntegrationResponse', integrationResponse_responseTemplates - Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

$sel:selectionPattern:IntegrationResponse', integrationResponse_selectionPattern - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

$sel:statusCode:IntegrationResponse', integrationResponse_statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

GetMethod

data GetMethod Source #

Request to describe an existing Method resource.

See: newGetMethod smart constructor.

Constructors

GetMethod' Text Text Text

Instances

Instances details

ToHeaders GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Methods toHeaders :: GetMethod -> [Header] #
ToPath GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Methods toPath :: GetMethod -> ByteString #
ToQuery GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Methods toQuery :: GetMethod -> QueryString #
AWSRequest GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Associated Types type AWSResponse GetMethod # Methods request :: (Service -> Service) -> GetMethod -> Request GetMethod # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetMethod -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMethod))) #
Generic GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Associated Types type Rep GetMethod :: Type -> Type # Methods from :: GetMethod -> Rep GetMethod x # to :: Rep GetMethod x -> GetMethod #
Read GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Methods readsPrec :: Int -> ReadS GetMethod # readList :: ReadS [GetMethod] # readPrec :: ReadPrec GetMethod # readListPrec :: ReadPrec [GetMethod] #
Show GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Methods showsPrec :: Int -> GetMethod -> ShowS # show :: GetMethod -> String # showList :: [GetMethod] -> ShowS #
NFData GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Methods rnf :: GetMethod -> () #
Eq GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Methods (==) :: GetMethod -> GetMethod -> Bool # (/=) :: GetMethod -> GetMethod -> Bool #
Hashable GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod Methods hashWithSalt :: Int -> GetMethod -> Int # hash :: GetMethod -> Int #
type AWSResponse GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod type AWSResponse GetMethod = Method
type Rep GetMethod Source #
Instance details Defined in Amazonka.APIGateway.GetMethod type Rep GetMethod = D1 ('MetaData "GetMethod" "Amazonka.APIGateway.GetMethod" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetMethod'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetMethod Source #

Arguments

:: Text	`GetMethod`
-> Text	`$sel:resourceId:GetMethod'`
-> Text	`GetMethod`
-> GetMethod

Create a value of GetMethod with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetMethod, getMethod_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:GetMethod', getMethod_resourceId - The Resource identifier for the Method resource.

GetMethod, getMethod_httpMethod - Specifies the method request's HTTP method type.

data Method Source #

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

See: newMethod smart constructor.

Constructors

Method' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integration) (Maybe (HashMap Text MethodResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)

Instances

Instances details

FromJSON Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods parseJSON :: Value -> Parser Method # parseJSONList :: Value -> Parser [Method] #
Generic Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Associated Types type Rep Method :: Type -> Type # Methods from :: Method -> Rep Method x # to :: Rep Method x -> Method #
Read Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods readsPrec :: Int -> ReadS Method # readList :: ReadS [Method] # readPrec :: ReadPrec Method # readListPrec :: ReadPrec [Method] #
Show Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
NFData Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods rnf :: Method -> () #
Eq Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Hashable Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods hashWithSalt :: Int -> Method -> Int # hash :: Method -> Int #
type Rep Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method type Rep Method = D1 ('MetaData "Method" "Amazonka.APIGateway.Types.Method" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Method'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "authorizationScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "authorizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "methodIntegration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integration)) :: (S1 ('MetaSel ('Just "methodResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MethodResponse))) :: S1 ('MetaSel ('Just "operationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "requestModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: S1 ('MetaSel ('Just "requestValidatorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newMethod :: Method Source #

Create a value of Method with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyRequired:Method', method_apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke this method.

$sel:authorizationScopes:Method', method_authorizationScopes - A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

$sel:authorizationType:Method', method_authorizationType - The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

$sel:authorizerId:Method', method_authorizerId - The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Method, method_httpMethod - The method's HTTP verb.

$sel:methodIntegration:Method', method_methodIntegration - Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

$sel:methodResponses:Method', method_methodResponses - Gets a method response associated with a given HTTP status code.

$sel:operationName:Method', method_operationName - A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

$sel:requestModels:Method', method_requestModels - A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Method, method_requestParameters - A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

$sel:requestValidatorId:Method', method_requestValidatorId - The identifier of a RequestValidator for request validation.

GetMethodResponse

data GetMethodResponse Source #

Request to describe a MethodResponse resource.

See: newGetMethodResponse smart constructor.

Constructors

GetMethodResponse' Text Text Text Text

Instances

Instances details

ToHeaders GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Methods toHeaders :: GetMethodResponse -> [Header] #
ToPath GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Methods toPath :: GetMethodResponse -> ByteString #
ToQuery GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Methods toQuery :: GetMethodResponse -> QueryString #
AWSRequest GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Associated Types type AWSResponse GetMethodResponse # Methods request :: (Service -> Service) -> GetMethodResponse -> Request GetMethodResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetMethodResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetMethodResponse))) #
Generic GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Associated Types type Rep GetMethodResponse :: Type -> Type # Methods from :: GetMethodResponse -> Rep GetMethodResponse x # to :: Rep GetMethodResponse x -> GetMethodResponse #
Read GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Methods readsPrec :: Int -> ReadS GetMethodResponse # readList :: ReadS [GetMethodResponse] # readPrec :: ReadPrec GetMethodResponse # readListPrec :: ReadPrec [GetMethodResponse] #
Show GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Methods showsPrec :: Int -> GetMethodResponse -> ShowS # show :: GetMethodResponse -> String # showList :: [GetMethodResponse] -> ShowS #
NFData GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Methods rnf :: GetMethodResponse -> () #
Eq GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Methods (==) :: GetMethodResponse -> GetMethodResponse -> Bool # (/=) :: GetMethodResponse -> GetMethodResponse -> Bool #
Hashable GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse Methods hashWithSalt :: Int -> GetMethodResponse -> Int # hash :: GetMethodResponse -> Int #
type AWSResponse GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse type AWSResponse GetMethodResponse = MethodResponse
type Rep GetMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.GetMethodResponse type Rep GetMethodResponse = D1 ('MetaData "GetMethodResponse" "Amazonka.APIGateway.GetMethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetMethodResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetMethodResponse Source #

Arguments

:: Text	`GetMethodResponse`
-> Text	`$sel:resourceId:GetMethodResponse'`
-> Text	`GetMethodResponse`
-> Text	`GetMethodResponse`
-> GetMethodResponse

Create a value of GetMethodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetMethodResponse, getMethodResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:GetMethodResponse', getMethodResponse_resourceId - The Resource identifier for the MethodResponse resource.

GetMethodResponse, getMethodResponse_httpMethod - The HTTP verb of the Method resource.

GetMethodResponse, getMethodResponse_statusCode - The status code for the MethodResponse resource.

data MethodResponse Source #

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

See: newMethodResponse smart constructor.

Constructors

MethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)

Instances

Instances details

FromJSON MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods parseJSON :: Value -> Parser MethodResponse # parseJSONList :: Value -> Parser [MethodResponse] #
Generic MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Associated Types type Rep MethodResponse :: Type -> Type # Methods from :: MethodResponse -> Rep MethodResponse x # to :: Rep MethodResponse x -> MethodResponse #
Read MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods readsPrec :: Int -> ReadS MethodResponse # readList :: ReadS [MethodResponse] # readPrec :: ReadPrec MethodResponse # readListPrec :: ReadPrec [MethodResponse] #
Show MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods showsPrec :: Int -> MethodResponse -> ShowS # show :: MethodResponse -> String # showList :: [MethodResponse] -> ShowS #
NFData MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods rnf :: MethodResponse -> () #
Eq MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods (==) :: MethodResponse -> MethodResponse -> Bool # (/=) :: MethodResponse -> MethodResponse -> Bool #
Hashable MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods hashWithSalt :: Int -> MethodResponse -> Int # hash :: MethodResponse -> Int #
type Rep MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse type Rep MethodResponse = D1 ('MetaData "MethodResponse" "Amazonka.APIGateway.Types.MethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MethodResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "responseModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMethodResponse :: MethodResponse Source #

Create a value of MethodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:responseModels:MethodResponse', methodResponse_responseModels - Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

$sel:responseParameters:MethodResponse', methodResponse_responseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

$sel:statusCode:MethodResponse', methodResponse_statusCode - The method response's status code.

GetModel

data GetModel Source #

Request to list information about a model in an existing RestApi resource.

See: newGetModel smart constructor.

Constructors

GetModel' (Maybe Bool) Text Text

Instances

Instances details

ToHeaders GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Methods toHeaders :: GetModel -> [Header] #
ToPath GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Methods toPath :: GetModel -> ByteString #
ToQuery GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Methods toQuery :: GetModel -> QueryString #
AWSRequest GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Associated Types type AWSResponse GetModel # Methods request :: (Service -> Service) -> GetModel -> Request GetModel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetModel))) #
Generic GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Associated Types type Rep GetModel :: Type -> Type # Methods from :: GetModel -> Rep GetModel x # to :: Rep GetModel x -> GetModel #
Read GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Methods readsPrec :: Int -> ReadS GetModel # readList :: ReadS [GetModel] # readPrec :: ReadPrec GetModel # readListPrec :: ReadPrec [GetModel] #
Show GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Methods showsPrec :: Int -> GetModel -> ShowS # show :: GetModel -> String # showList :: [GetModel] -> ShowS #
NFData GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Methods rnf :: GetModel -> () #
Eq GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Methods (==) :: GetModel -> GetModel -> Bool # (/=) :: GetModel -> GetModel -> Bool #
Hashable GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel Methods hashWithSalt :: Int -> GetModel -> Int # hash :: GetModel -> Int #
type AWSResponse GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel type AWSResponse GetModel = Model
type Rep GetModel Source #
Instance details Defined in Amazonka.APIGateway.GetModel type Rep GetModel = D1 ('MetaData "GetModel" "Amazonka.APIGateway.GetModel" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetModel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "flatten") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetModel Source #

Arguments

:: Text	`GetModel`
-> Text	`$sel:modelName:GetModel'`
-> GetModel

Create a value of GetModel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:flatten:GetModel', getModel_flatten - A query parameter of a Boolean value to resolve (true) all external model references and returns a flattened model schema or not (false) The default is false.

GetModel, getModel_restApiId - The RestApi identifier under which the Model exists.

$sel:modelName:GetModel', getModel_modelName - The name of the model as an identifier.

data Model Source #

Represents the data structure of a method's request or response payload.

See: newModel smart constructor.

Constructors

Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods parseJSON :: Value -> Parser Model # parseJSONList :: Value -> Parser [Model] #
Generic Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Associated Types type Rep Model :: Type -> Type # Methods from :: Model -> Rep Model x # to :: Rep Model x -> Model #
Read Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods readsPrec :: Int -> ReadS Model # readList :: ReadS [Model] # readPrec :: ReadPrec Model # readListPrec :: ReadPrec [Model] #
Show Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods showsPrec :: Int -> Model -> ShowS # show :: Model -> String # showList :: [Model] -> ShowS #
NFData Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods rnf :: Model -> () #
Eq Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #
Hashable Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods hashWithSalt :: Int -> Model -> Int # hash :: Model -> Int #
type Rep Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model type Rep Model = D1 ('MetaData "Model" "Amazonka.APIGateway.Types.Model" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Model'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newModel :: Model Source #

Create a value of Model with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentType:Model', model_contentType - The content-type for the model.

$sel:description:Model', model_description - The description of the model.

$sel:id:Model', model_id - The identifier for the model resource.

$sel:name:Model', model_name - The name of the model. Must be an alphanumeric string.

$sel:schema:Model', model_schema - The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

GetModelTemplate

data GetModelTemplate Source #

Request to generate a sample mapping template used to transform the payload.

See: newGetModelTemplate smart constructor.

Constructors

GetModelTemplate' Text Text

Instances

Instances details

ToHeaders GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods toHeaders :: GetModelTemplate -> [Header] #
ToPath GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods toPath :: GetModelTemplate -> ByteString #
ToQuery GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods toQuery :: GetModelTemplate -> QueryString #
AWSRequest GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Associated Types type AWSResponse GetModelTemplate # Methods request :: (Service -> Service) -> GetModelTemplate -> Request GetModelTemplate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetModelTemplate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetModelTemplate))) #
Generic GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Associated Types type Rep GetModelTemplate :: Type -> Type # Methods from :: GetModelTemplate -> Rep GetModelTemplate x # to :: Rep GetModelTemplate x -> GetModelTemplate #
Read GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods readsPrec :: Int -> ReadS GetModelTemplate # readList :: ReadS [GetModelTemplate] # readPrec :: ReadPrec GetModelTemplate # readListPrec :: ReadPrec [GetModelTemplate] #
Show GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods showsPrec :: Int -> GetModelTemplate -> ShowS # show :: GetModelTemplate -> String # showList :: [GetModelTemplate] -> ShowS #
NFData GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods rnf :: GetModelTemplate -> () #
Eq GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods (==) :: GetModelTemplate -> GetModelTemplate -> Bool # (/=) :: GetModelTemplate -> GetModelTemplate -> Bool #
Hashable GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods hashWithSalt :: Int -> GetModelTemplate -> Int # hash :: GetModelTemplate -> Int #
type AWSResponse GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate type AWSResponse GetModelTemplate = GetModelTemplateResponse
type Rep GetModelTemplate Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate type Rep GetModelTemplate = D1 ('MetaData "GetModelTemplate" "Amazonka.APIGateway.GetModelTemplate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetModelTemplate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetModelTemplate Source #

Arguments

:: Text	`GetModelTemplate`
-> Text	`$sel:modelName:GetModelTemplate'`
-> GetModelTemplate

Create a value of GetModelTemplate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetModelTemplate, getModelTemplate_restApiId - The string identifier of the associated RestApi.

$sel:modelName:GetModelTemplate', getModelTemplate_modelName - The name of the model for which to generate a template.

data GetModelTemplateResponse Source #

Represents a mapping template used to transform a payload.

See: newGetModelTemplateResponse smart constructor.

Constructors

GetModelTemplateResponse' (Maybe Text) Int

Instances

Instances details

Generic GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Associated Types type Rep GetModelTemplateResponse :: Type -> Type # Methods from :: GetModelTemplateResponse -> Rep GetModelTemplateResponse x # to :: Rep GetModelTemplateResponse x -> GetModelTemplateResponse #
Read GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods readsPrec :: Int -> ReadS GetModelTemplateResponse # readList :: ReadS [GetModelTemplateResponse] # readPrec :: ReadPrec GetModelTemplateResponse # readListPrec :: ReadPrec [GetModelTemplateResponse] #
Show GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods showsPrec :: Int -> GetModelTemplateResponse -> ShowS # show :: GetModelTemplateResponse -> String # showList :: [GetModelTemplateResponse] -> ShowS #
NFData GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods rnf :: GetModelTemplateResponse -> () #
Eq GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate Methods (==) :: GetModelTemplateResponse -> GetModelTemplateResponse -> Bool # (/=) :: GetModelTemplateResponse -> GetModelTemplateResponse -> Bool #
type Rep GetModelTemplateResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModelTemplate type Rep GetModelTemplateResponse = D1 ('MetaData "GetModelTemplateResponse" "Amazonka.APIGateway.GetModelTemplate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetModelTemplateResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetModelTemplateResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetModelTemplateResponse'`
-> GetModelTemplateResponse

Create a value of GetModelTemplateResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetModelTemplateResponse, getModelTemplateResponse_value - The Apache Velocity Template Language (VTL) template content used for the template resource.

$sel:httpStatus:GetModelTemplateResponse', getModelTemplateResponse_httpStatus - The response's http status code.

GetModels (Paginated)

data GetModels Source #

Request to list existing Models defined for a RestApi resource.

See: newGetModels smart constructor.

Constructors

GetModels' (Maybe Int) (Maybe Text) Text

Instances

Instances details

ToHeaders GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods toHeaders :: GetModels -> [Header] #
ToPath GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods toPath :: GetModels -> ByteString #
ToQuery GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods toQuery :: GetModels -> QueryString #
AWSPager GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods page :: GetModels -> AWSResponse GetModels -> Maybe GetModels #
AWSRequest GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Associated Types type AWSResponse GetModels # Methods request :: (Service -> Service) -> GetModels -> Request GetModels # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetModels -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetModels))) #
Generic GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Associated Types type Rep GetModels :: Type -> Type # Methods from :: GetModels -> Rep GetModels x # to :: Rep GetModels x -> GetModels #
Read GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods readsPrec :: Int -> ReadS GetModels # readList :: ReadS [GetModels] # readPrec :: ReadPrec GetModels # readListPrec :: ReadPrec [GetModels] #
Show GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods showsPrec :: Int -> GetModels -> ShowS # show :: GetModels -> String # showList :: [GetModels] -> ShowS #
NFData GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods rnf :: GetModels -> () #
Eq GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods (==) :: GetModels -> GetModels -> Bool # (/=) :: GetModels -> GetModels -> Bool #
Hashable GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods hashWithSalt :: Int -> GetModels -> Int # hash :: GetModels -> Int #
type AWSResponse GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels type AWSResponse GetModels = GetModelsResponse
type Rep GetModels Source #
Instance details Defined in Amazonka.APIGateway.GetModels type Rep GetModels = D1 ('MetaData "GetModels" "Amazonka.APIGateway.GetModels" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetModels'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetModels Source #

Arguments

:: Text	`GetModels`
-> GetModels

Create a value of GetModels with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetModels, getModels_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetModels, getModels_position - The current pagination position in the paged result set.

GetModels, getModels_restApiId - The string identifier of the associated RestApi.

data GetModelsResponse Source #

Represents a collection of Model resources.

See: newGetModelsResponse smart constructor.

Constructors

GetModelsResponse' (Maybe [Model]) (Maybe Text) Int

Instances

Instances details

Generic GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Associated Types type Rep GetModelsResponse :: Type -> Type # Methods from :: GetModelsResponse -> Rep GetModelsResponse x # to :: Rep GetModelsResponse x -> GetModelsResponse #
Read GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods readsPrec :: Int -> ReadS GetModelsResponse # readList :: ReadS [GetModelsResponse] # readPrec :: ReadPrec GetModelsResponse # readListPrec :: ReadPrec [GetModelsResponse] #
Show GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods showsPrec :: Int -> GetModelsResponse -> ShowS # show :: GetModelsResponse -> String # showList :: [GetModelsResponse] -> ShowS #
NFData GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods rnf :: GetModelsResponse -> () #
Eq GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels Methods (==) :: GetModelsResponse -> GetModelsResponse -> Bool # (/=) :: GetModelsResponse -> GetModelsResponse -> Bool #
type Rep GetModelsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetModels type Rep GetModelsResponse = D1 ('MetaData "GetModelsResponse" "Amazonka.APIGateway.GetModels" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetModelsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Model])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetModelsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetModelsResponse'`
-> GetModelsResponse

Create a value of GetModelsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetModelsResponse, getModelsResponse_items - The current page of elements from this collection.

GetModels, getModelsResponse_position - Undocumented member.

$sel:httpStatus:GetModelsResponse', getModelsResponse_httpStatus - The response's http status code.

GetRequestValidator

data GetRequestValidator Source #

Gets a RequestValidator of a given RestApi.

See: newGetRequestValidator smart constructor.

Constructors

GetRequestValidator' Text Text

Instances

Instances details

ToHeaders GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Methods toHeaders :: GetRequestValidator -> [Header] #
ToPath GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Methods toPath :: GetRequestValidator -> ByteString #
ToQuery GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Methods toQuery :: GetRequestValidator -> QueryString #
AWSRequest GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Associated Types type AWSResponse GetRequestValidator # Methods request :: (Service -> Service) -> GetRequestValidator -> Request GetRequestValidator # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRequestValidator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRequestValidator))) #
Generic GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Associated Types type Rep GetRequestValidator :: Type -> Type # Methods from :: GetRequestValidator -> Rep GetRequestValidator x # to :: Rep GetRequestValidator x -> GetRequestValidator #
Read GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Methods readsPrec :: Int -> ReadS GetRequestValidator # readList :: ReadS [GetRequestValidator] # readPrec :: ReadPrec GetRequestValidator # readListPrec :: ReadPrec [GetRequestValidator] #
Show GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Methods showsPrec :: Int -> GetRequestValidator -> ShowS # show :: GetRequestValidator -> String # showList :: [GetRequestValidator] -> ShowS #
NFData GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Methods rnf :: GetRequestValidator -> () #
Eq GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Methods (==) :: GetRequestValidator -> GetRequestValidator -> Bool # (/=) :: GetRequestValidator -> GetRequestValidator -> Bool #
Hashable GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator Methods hashWithSalt :: Int -> GetRequestValidator -> Int # hash :: GetRequestValidator -> Int #
type AWSResponse GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator type AWSResponse GetRequestValidator = RequestValidator
type Rep GetRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidator type Rep GetRequestValidator = D1 ('MetaData "GetRequestValidator" "Amazonka.APIGateway.GetRequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetRequestValidator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "requestValidatorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetRequestValidator Source #

Arguments

:: Text	`GetRequestValidator`
-> Text	`GetRequestValidator`
-> GetRequestValidator

Create a value of GetRequestValidator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetRequestValidator, getRequestValidator_restApiId - The string identifier of the associated RestApi.

GetRequestValidator, getRequestValidator_requestValidatorId - The identifier of the RequestValidator to be retrieved.

data RequestValidator Source #

A set of validation rules for incoming Method requests.

See: newRequestValidator smart constructor.

Constructors

RequestValidator' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool)

Instances

Instances details

FromJSON RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods parseJSON :: Value -> Parser RequestValidator # parseJSONList :: Value -> Parser [RequestValidator] #
Generic RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Associated Types type Rep RequestValidator :: Type -> Type # Methods from :: RequestValidator -> Rep RequestValidator x # to :: Rep RequestValidator x -> RequestValidator #
Read RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods readsPrec :: Int -> ReadS RequestValidator # readList :: ReadS [RequestValidator] # readPrec :: ReadPrec RequestValidator # readListPrec :: ReadPrec [RequestValidator] #
Show RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods showsPrec :: Int -> RequestValidator -> ShowS # show :: RequestValidator -> String # showList :: [RequestValidator] -> ShowS #
NFData RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods rnf :: RequestValidator -> () #
Eq RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods (==) :: RequestValidator -> RequestValidator -> Bool # (/=) :: RequestValidator -> RequestValidator -> Bool #
Hashable RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods hashWithSalt :: Int -> RequestValidator -> Int # hash :: RequestValidator -> Int #
type Rep RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator type Rep RequestValidator = D1 ('MetaData "RequestValidator" "Amazonka.APIGateway.Types.RequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RequestValidator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "validateRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "validateRequestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newRequestValidator :: RequestValidator Source #

Create a value of RequestValidator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:RequestValidator', requestValidator_id - The identifier of this RequestValidator.

$sel:name:RequestValidator', requestValidator_name - The name of this RequestValidator

$sel:validateRequestBody:RequestValidator', requestValidator_validateRequestBody - A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

$sel:validateRequestParameters:RequestValidator', requestValidator_validateRequestParameters - A Boolean flag to indicate whether to validate request parameters (true) or not (false).

GetRequestValidators (Paginated)

data GetRequestValidators Source #

Gets the RequestValidators collection of a given RestApi.

See: newGetRequestValidators smart constructor.

Constructors

GetRequestValidators' (Maybe Int) (Maybe Text) Text

Instances

Instances details

ToHeaders GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods toHeaders :: GetRequestValidators -> [Header] #
ToPath GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods toPath :: GetRequestValidators -> ByteString #
ToQuery GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods toQuery :: GetRequestValidators -> QueryString #
AWSPager GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods page :: GetRequestValidators -> AWSResponse GetRequestValidators -> Maybe GetRequestValidators #
AWSRequest GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Associated Types type AWSResponse GetRequestValidators # Methods request :: (Service -> Service) -> GetRequestValidators -> Request GetRequestValidators # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRequestValidators -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRequestValidators))) #
Generic GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Associated Types type Rep GetRequestValidators :: Type -> Type # Methods from :: GetRequestValidators -> Rep GetRequestValidators x # to :: Rep GetRequestValidators x -> GetRequestValidators #
Read GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods readsPrec :: Int -> ReadS GetRequestValidators # readList :: ReadS [GetRequestValidators] # readPrec :: ReadPrec GetRequestValidators # readListPrec :: ReadPrec [GetRequestValidators] #
Show GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods showsPrec :: Int -> GetRequestValidators -> ShowS # show :: GetRequestValidators -> String # showList :: [GetRequestValidators] -> ShowS #
NFData GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods rnf :: GetRequestValidators -> () #
Eq GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods (==) :: GetRequestValidators -> GetRequestValidators -> Bool # (/=) :: GetRequestValidators -> GetRequestValidators -> Bool #
Hashable GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods hashWithSalt :: Int -> GetRequestValidators -> Int # hash :: GetRequestValidators -> Int #
type AWSResponse GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators type AWSResponse GetRequestValidators = GetRequestValidatorsResponse
type Rep GetRequestValidators Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators type Rep GetRequestValidators = D1 ('MetaData "GetRequestValidators" "Amazonka.APIGateway.GetRequestValidators" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetRequestValidators'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetRequestValidators Source #

Arguments

:: Text	`GetRequestValidators`
-> GetRequestValidators

Create a value of GetRequestValidators with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetRequestValidators, getRequestValidators_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetRequestValidators, getRequestValidators_position - The current pagination position in the paged result set.

GetRequestValidators, getRequestValidators_restApiId - The string identifier of the associated RestApi.

data GetRequestValidatorsResponse Source #

A collection of RequestValidator resources of a given RestApi.

See: newGetRequestValidatorsResponse smart constructor.

Constructors

GetRequestValidatorsResponse' (Maybe [RequestValidator]) (Maybe Text) Int

Instances

Instances details

Generic GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Associated Types type Rep GetRequestValidatorsResponse :: Type -> Type # Methods from :: GetRequestValidatorsResponse -> Rep GetRequestValidatorsResponse x # to :: Rep GetRequestValidatorsResponse x -> GetRequestValidatorsResponse #
Read GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods readsPrec :: Int -> ReadS GetRequestValidatorsResponse # readList :: ReadS [GetRequestValidatorsResponse] # readPrec :: ReadPrec GetRequestValidatorsResponse # readListPrec :: ReadPrec [GetRequestValidatorsResponse] #
Show GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods showsPrec :: Int -> GetRequestValidatorsResponse -> ShowS # show :: GetRequestValidatorsResponse -> String # showList :: [GetRequestValidatorsResponse] -> ShowS #
NFData GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods rnf :: GetRequestValidatorsResponse -> () #
Eq GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators Methods (==) :: GetRequestValidatorsResponse -> GetRequestValidatorsResponse -> Bool # (/=) :: GetRequestValidatorsResponse -> GetRequestValidatorsResponse -> Bool #
type Rep GetRequestValidatorsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRequestValidators type Rep GetRequestValidatorsResponse = D1 ('MetaData "GetRequestValidatorsResponse" "Amazonka.APIGateway.GetRequestValidators" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetRequestValidatorsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RequestValidator])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRequestValidatorsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRequestValidatorsResponse'`
-> GetRequestValidatorsResponse

Create a value of GetRequestValidatorsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetRequestValidatorsResponse, getRequestValidatorsResponse_items - The current page of elements from this collection.

GetRequestValidators, getRequestValidatorsResponse_position - Undocumented member.

$sel:httpStatus:GetRequestValidatorsResponse', getRequestValidatorsResponse_httpStatus - The response's http status code.

GetResource

data GetResource Source #

Request to list information about a resource.

See: newGetResource smart constructor.

Constructors

GetResource' (Maybe [Text]) Text Text

Instances

Instances details

ToHeaders GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Methods toHeaders :: GetResource -> [Header] #
ToPath GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Methods toPath :: GetResource -> ByteString #
ToQuery GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Methods toQuery :: GetResource -> QueryString #
AWSRequest GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Associated Types type AWSResponse GetResource # Methods request :: (Service -> Service) -> GetResource -> Request GetResource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetResource))) #
Generic GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Associated Types type Rep GetResource :: Type -> Type # Methods from :: GetResource -> Rep GetResource x # to :: Rep GetResource x -> GetResource #
Read GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Methods readsPrec :: Int -> ReadS GetResource # readList :: ReadS [GetResource] # readPrec :: ReadPrec GetResource # readListPrec :: ReadPrec [GetResource] #
Show GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Methods showsPrec :: Int -> GetResource -> ShowS # show :: GetResource -> String # showList :: [GetResource] -> ShowS #
NFData GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Methods rnf :: GetResource -> () #
Eq GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Methods (==) :: GetResource -> GetResource -> Bool # (/=) :: GetResource -> GetResource -> Bool #
Hashable GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource Methods hashWithSalt :: Int -> GetResource -> Int # hash :: GetResource -> Int #
type AWSResponse GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource type AWSResponse GetResource = Resource
type Rep GetResource Source #
Instance details Defined in Amazonka.APIGateway.GetResource type Rep GetResource = D1 ('MetaData "GetResource" "Amazonka.APIGateway.GetResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "embed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetResource Source #

Arguments

:: Text	`GetResource`
-> Text	`$sel:resourceId:GetResource'`
-> GetResource

Create a value of GetResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:embed:GetResource', getResource_embed - A query parameter to retrieve the specified resources embedded in the returned Resource representation in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods.

GetResource, getResource_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:GetResource', getResource_resourceId - The identifier for the Resource resource.

data Resource Source #

Represents an API resource.

See: newResource smart constructor.

Constructors

Resource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Method))

Instances

Instances details

FromJSON Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods parseJSON :: Value -> Parser Resource # parseJSONList :: Value -> Parser [Resource] #
Generic Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Associated Types type Rep Resource :: Type -> Type # Methods from :: Resource -> Rep Resource x # to :: Rep Resource x -> Resource #
Read Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods readsPrec :: Int -> ReadS Resource # readList :: ReadS [Resource] # readPrec :: ReadPrec Resource # readListPrec :: ReadPrec [Resource] #
Show Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods showsPrec :: Int -> Resource -> ShowS # show :: Resource -> String # showList :: [Resource] -> ShowS #
NFData Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods rnf :: Resource -> () #
Eq Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods (==) :: Resource -> Resource -> Bool # (/=) :: Resource -> Resource -> Bool #
Hashable Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods hashWithSalt :: Int -> Resource -> Int # hash :: Resource -> Int #
type Rep Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource type Rep Resource = D1 ('MetaData "Resource" "Amazonka.APIGateway.Types.Resource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Resource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pathPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceMethods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Method)))))))

newResource :: Resource Source #

Create a value of Resource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:Resource', resource_id - The resource's identifier.

$sel:parentId:Resource', resource_parentId - The parent resource's identifier.

$sel:path:Resource', resource_path - The full path for this resource.

$sel:pathPart:Resource', resource_pathPart - The last path segment for this resource.

$sel:resourceMethods:Resource', resource_resourceMethods - Gets an API resource's method of a given HTTP verb.

GetResources (Paginated)

data GetResources Source #

Request to list information about a collection of resources.

See: newGetResources smart constructor.

Constructors

GetResources' (Maybe [Text]) (Maybe Int) (Maybe Text) Text

Instances

Instances details

ToHeaders GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods toHeaders :: GetResources -> [Header] #
ToPath GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods toPath :: GetResources -> ByteString #
ToQuery GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods toQuery :: GetResources -> QueryString #
AWSPager GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods page :: GetResources -> AWSResponse GetResources -> Maybe GetResources #
AWSRequest GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Associated Types type AWSResponse GetResources # Methods request :: (Service -> Service) -> GetResources -> Request GetResources # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetResources -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetResources))) #
Generic GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Associated Types type Rep GetResources :: Type -> Type # Methods from :: GetResources -> Rep GetResources x # to :: Rep GetResources x -> GetResources #
Read GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods readsPrec :: Int -> ReadS GetResources # readList :: ReadS [GetResources] # readPrec :: ReadPrec GetResources # readListPrec :: ReadPrec [GetResources] #
Show GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods showsPrec :: Int -> GetResources -> ShowS # show :: GetResources -> String # showList :: [GetResources] -> ShowS #
NFData GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods rnf :: GetResources -> () #
Eq GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods (==) :: GetResources -> GetResources -> Bool # (/=) :: GetResources -> GetResources -> Bool #
Hashable GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods hashWithSalt :: Int -> GetResources -> Int # hash :: GetResources -> Int #
type AWSResponse GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources type AWSResponse GetResources = GetResourcesResponse
type Rep GetResources Source #
Instance details Defined in Amazonka.APIGateway.GetResources type Rep GetResources = D1 ('MetaData "GetResources" "Amazonka.APIGateway.GetResources" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetResources'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "embed") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetResources Source #

Arguments

:: Text	`GetResources`
-> GetResources

Create a value of GetResources with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:embed:GetResources', getResources_embed - A query parameter used to retrieve the specified resources embedded in the returned Resources resource in the response. This embed parameter value is a list of comma-separated strings. Currently, the request supports only retrieval of the embedded Method resources this way. The query parameter value must be a single-valued list and contain the "methods" string. For example, GET /restapis/{restapi_id}/resources?embed=methods.

GetResources, getResources_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetResources, getResources_position - The current pagination position in the paged result set.

GetResources, getResources_restApiId - The string identifier of the associated RestApi.

data GetResourcesResponse Source #

Represents a collection of Resource resources.

See: newGetResourcesResponse smart constructor.

Constructors

GetResourcesResponse' (Maybe [Resource]) (Maybe Text) Int

Instances

Instances details

Generic GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Associated Types type Rep GetResourcesResponse :: Type -> Type # Methods from :: GetResourcesResponse -> Rep GetResourcesResponse x # to :: Rep GetResourcesResponse x -> GetResourcesResponse #
Read GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods readsPrec :: Int -> ReadS GetResourcesResponse # readList :: ReadS [GetResourcesResponse] # readPrec :: ReadPrec GetResourcesResponse # readListPrec :: ReadPrec [GetResourcesResponse] #
Show GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods showsPrec :: Int -> GetResourcesResponse -> ShowS # show :: GetResourcesResponse -> String # showList :: [GetResourcesResponse] -> ShowS #
NFData GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods rnf :: GetResourcesResponse -> () #
Eq GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources Methods (==) :: GetResourcesResponse -> GetResourcesResponse -> Bool # (/=) :: GetResourcesResponse -> GetResourcesResponse -> Bool #
type Rep GetResourcesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetResources type Rep GetResourcesResponse = D1 ('MetaData "GetResourcesResponse" "Amazonka.APIGateway.GetResources" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetResourcesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Resource])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetResourcesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetResourcesResponse'`
-> GetResourcesResponse

Create a value of GetResourcesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetResourcesResponse, getResourcesResponse_items - The current page of elements from this collection.

GetResources, getResourcesResponse_position - Undocumented member.

$sel:httpStatus:GetResourcesResponse', getResourcesResponse_httpStatus - The response's http status code.

GetRestApi

data GetRestApi Source #

The GET request to list an existing RestApi defined for your collection.

See: newGetRestApi smart constructor.

Constructors

GetRestApi' Text

Instances

Instances details

ToHeaders GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Methods toHeaders :: GetRestApi -> [Header] #
ToPath GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Methods toPath :: GetRestApi -> ByteString #
ToQuery GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Methods toQuery :: GetRestApi -> QueryString #
AWSRequest GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Associated Types type AWSResponse GetRestApi # Methods request :: (Service -> Service) -> GetRestApi -> Request GetRestApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRestApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRestApi))) #
Generic GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Associated Types type Rep GetRestApi :: Type -> Type # Methods from :: GetRestApi -> Rep GetRestApi x # to :: Rep GetRestApi x -> GetRestApi #
Read GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Methods readsPrec :: Int -> ReadS GetRestApi # readList :: ReadS [GetRestApi] # readPrec :: ReadPrec GetRestApi # readListPrec :: ReadPrec [GetRestApi] #
Show GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Methods showsPrec :: Int -> GetRestApi -> ShowS # show :: GetRestApi -> String # showList :: [GetRestApi] -> ShowS #
NFData GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Methods rnf :: GetRestApi -> () #
Eq GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Methods (==) :: GetRestApi -> GetRestApi -> Bool # (/=) :: GetRestApi -> GetRestApi -> Bool #
Hashable GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi Methods hashWithSalt :: Int -> GetRestApi -> Int # hash :: GetRestApi -> Int #
type AWSResponse GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi type AWSResponse GetRestApi = RestApi
type Rep GetRestApi Source #
Instance details Defined in Amazonka.APIGateway.GetRestApi type Rep GetRestApi = D1 ('MetaData "GetRestApi" "Amazonka.APIGateway.GetRestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetRestApi'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetRestApi Source #

Arguments

:: Text	`GetRestApi`
-> GetRestApi

Create a value of GetRestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetRestApi, getRestApi_restApiId - The string identifier of the associated RestApi.

data RestApi Source #

Represents a REST API.

See: newRestApi smart constructor.

Constructors

RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])

Instances

Instances details

FromJSON RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods parseJSON :: Value -> Parser RestApi # parseJSONList :: Value -> Parser [RestApi] #
Generic RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Associated Types type Rep RestApi :: Type -> Type # Methods from :: RestApi -> Rep RestApi x # to :: Rep RestApi x -> RestApi #
Read RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods readsPrec :: Int -> ReadS RestApi # readList :: ReadS [RestApi] # readPrec :: ReadPrec RestApi # readListPrec :: ReadPrec [RestApi] #
Show RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods showsPrec :: Int -> RestApi -> ShowS # show :: RestApi -> String # showList :: [RestApi] -> ShowS #
NFData RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods rnf :: RestApi -> () #
Eq RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods (==) :: RestApi -> RestApi -> Bool # (/=) :: RestApi -> RestApi -> Bool #
Hashable RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods hashWithSalt :: Int -> RestApi -> Int # hash :: RestApi -> Int #
type Rep RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi type Rep RestApi = D1 ('MetaData "RestApi" "Amazonka.APIGateway.Types.RestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RestApi'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiKeySourceType)) :: (S1 ('MetaSel ('Just "binaryMediaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "minimumCompressionSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newRestApi :: RestApi Source #

Create a value of RestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeySource:RestApi', restApi_apiKeySource - The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

$sel:binaryMediaTypes:RestApi', restApi_binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

$sel:createdDate:RestApi', restApi_createdDate - The timestamp when the API was created.

$sel:description:RestApi', restApi_description - The API's description.

$sel:disableExecuteApiEndpoint:RestApi', restApi_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

$sel:endpointConfiguration:RestApi', restApi_endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

$sel:id:RestApi', restApi_id - The API's identifier. This identifier is unique across all of your APIs in API Gateway.

$sel:minimumCompressionSize:RestApi', restApi_minimumCompressionSize - A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

$sel:name:RestApi', restApi_name - The API's name.

$sel:policy:RestApi', restApi_policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

$sel:tags:RestApi', restApi_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:version:RestApi', restApi_version - A version identifier for the API.

$sel:warnings:RestApi', restApi_warnings - The warning messages reported when failonwarnings is turned on during API import.

GetRestApis (Paginated)

data GetRestApis Source #

The GET request to list existing RestApis defined for your collection.

See: newGetRestApis smart constructor.

Constructors

GetRestApis' (Maybe Int) (Maybe Text)

Instances

Instances details

ToHeaders GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods toHeaders :: GetRestApis -> [Header] #
ToPath GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods toPath :: GetRestApis -> ByteString #
ToQuery GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods toQuery :: GetRestApis -> QueryString #
AWSPager GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods page :: GetRestApis -> AWSResponse GetRestApis -> Maybe GetRestApis #
AWSRequest GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Associated Types type AWSResponse GetRestApis # Methods request :: (Service -> Service) -> GetRestApis -> Request GetRestApis # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetRestApis -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetRestApis))) #
Generic GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Associated Types type Rep GetRestApis :: Type -> Type # Methods from :: GetRestApis -> Rep GetRestApis x # to :: Rep GetRestApis x -> GetRestApis #
Read GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods readsPrec :: Int -> ReadS GetRestApis # readList :: ReadS [GetRestApis] # readPrec :: ReadPrec GetRestApis # readListPrec :: ReadPrec [GetRestApis] #
Show GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods showsPrec :: Int -> GetRestApis -> ShowS # show :: GetRestApis -> String # showList :: [GetRestApis] -> ShowS #
NFData GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods rnf :: GetRestApis -> () #
Eq GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods (==) :: GetRestApis -> GetRestApis -> Bool # (/=) :: GetRestApis -> GetRestApis -> Bool #
Hashable GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods hashWithSalt :: Int -> GetRestApis -> Int # hash :: GetRestApis -> Int #
type AWSResponse GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis type AWSResponse GetRestApis = GetRestApisResponse
type Rep GetRestApis Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis type Rep GetRestApis = D1 ('MetaData "GetRestApis" "Amazonka.APIGateway.GetRestApis" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetRestApis'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetRestApis :: GetRestApis Source #

Create a value of GetRestApis with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetRestApis, getRestApis_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetRestApis, getRestApis_position - The current pagination position in the paged result set.

data GetRestApisResponse Source #

Contains references to your APIs and links that guide you in how to interact with your collection. A collection offers a paginated view of your APIs.

See: newGetRestApisResponse smart constructor.

Constructors

GetRestApisResponse' (Maybe [RestApi]) (Maybe Text) Int

Instances

Instances details

Generic GetRestApisResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Associated Types type Rep GetRestApisResponse :: Type -> Type # Methods from :: GetRestApisResponse -> Rep GetRestApisResponse x # to :: Rep GetRestApisResponse x -> GetRestApisResponse #
Read GetRestApisResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods readsPrec :: Int -> ReadS GetRestApisResponse # readList :: ReadS [GetRestApisResponse] # readPrec :: ReadPrec GetRestApisResponse # readListPrec :: ReadPrec [GetRestApisResponse] #
Show GetRestApisResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods showsPrec :: Int -> GetRestApisResponse -> ShowS # show :: GetRestApisResponse -> String # showList :: [GetRestApisResponse] -> ShowS #
NFData GetRestApisResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods rnf :: GetRestApisResponse -> () #
Eq GetRestApisResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis Methods (==) :: GetRestApisResponse -> GetRestApisResponse -> Bool # (/=) :: GetRestApisResponse -> GetRestApisResponse -> Bool #
type Rep GetRestApisResponse Source #
Instance details Defined in Amazonka.APIGateway.GetRestApis type Rep GetRestApisResponse = D1 ('MetaData "GetRestApisResponse" "Amazonka.APIGateway.GetRestApis" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetRestApisResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [RestApi])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetRestApisResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetRestApisResponse'`
-> GetRestApisResponse

Create a value of GetRestApisResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetRestApisResponse, getRestApisResponse_items - The current page of elements from this collection.

GetRestApis, getRestApisResponse_position - Undocumented member.

$sel:httpStatus:GetRestApisResponse', getRestApisResponse_httpStatus - The response's http status code.

GetSdk

data GetSdk Source #

Request a new generated client SDK for a RestApi and Stage.

See: newGetSdk smart constructor.

Constructors

GetSdk' (Maybe (HashMap Text Text)) Text Text Text

Instances

Instances details

ToHeaders GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods toHeaders :: GetSdk -> [Header] #
ToPath GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods toPath :: GetSdk -> ByteString #
ToQuery GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods toQuery :: GetSdk -> QueryString #
AWSRequest GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Associated Types type AWSResponse GetSdk # Methods request :: (Service -> Service) -> GetSdk -> Request GetSdk # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSdk -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSdk))) #
Generic GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Associated Types type Rep GetSdk :: Type -> Type # Methods from :: GetSdk -> Rep GetSdk x # to :: Rep GetSdk x -> GetSdk #
Read GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods readsPrec :: Int -> ReadS GetSdk # readList :: ReadS [GetSdk] # readPrec :: ReadPrec GetSdk # readListPrec :: ReadPrec [GetSdk] #
Show GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods showsPrec :: Int -> GetSdk -> ShowS # show :: GetSdk -> String # showList :: [GetSdk] -> ShowS #
NFData GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods rnf :: GetSdk -> () #
Eq GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods (==) :: GetSdk -> GetSdk -> Bool # (/=) :: GetSdk -> GetSdk -> Bool #
Hashable GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods hashWithSalt :: Int -> GetSdk -> Int # hash :: GetSdk -> Int #
type AWSResponse GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk type AWSResponse GetSdk = GetSdkResponse
type Rep GetSdk Source #
Instance details Defined in Amazonka.APIGateway.GetSdk type Rep GetSdk = D1 ('MetaData "GetSdk" "Amazonka.APIGateway.GetSdk" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetSdk'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "sdkType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetSdk Source #

Arguments

:: Text	`GetSdk`
-> Text	`GetSdk`
-> Text	`$sel:sdkType:GetSdk'`
-> GetSdk

Create a value of GetSdk with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:parameters:GetSdk', getSdk_parameters - A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.

GetSdk, getSdk_restApiId - The string identifier of the associated RestApi.

GetSdk, getSdk_stageName - The name of the Stage that the SDK will use.

$sel:sdkType:GetSdk', getSdk_sdkType - The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

data GetSdkResponse Source #

The binary blob response to GetSdk, which contains the generated SDK.

See: newGetSdkResponse smart constructor.

Constructors

GetSdkResponse' (Maybe ByteString) (Maybe Text) (Maybe Text) Int

Instances

Instances details

Generic GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Associated Types type Rep GetSdkResponse :: Type -> Type # Methods from :: GetSdkResponse -> Rep GetSdkResponse x # to :: Rep GetSdkResponse x -> GetSdkResponse #
Show GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods showsPrec :: Int -> GetSdkResponse -> ShowS # show :: GetSdkResponse -> String # showList :: [GetSdkResponse] -> ShowS #
NFData GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods rnf :: GetSdkResponse -> () #
Eq GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods (==) :: GetSdkResponse -> GetSdkResponse -> Bool # (/=) :: GetSdkResponse -> GetSdkResponse -> Bool #
type Rep GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk type Rep GetSdkResponse = D1 ('MetaData "GetSdkResponse" "Amazonka.APIGateway.GetSdk" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetSdkResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :: S1 ('MetaSel ('Just "contentDisposition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetSdkResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSdkResponse'`
-> GetSdkResponse

Create a value of GetSdkResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:body:GetSdkResponse', getSdkResponse_body - The binary blob response to GetSdk, which contains the generated SDK.

$sel:contentDisposition:GetSdkResponse', getSdkResponse_contentDisposition - The content-disposition header value in the HTTP response.

GetSdkResponse, getSdkResponse_contentType - The content-type header value in the HTTP response.

$sel:httpStatus:GetSdkResponse', getSdkResponse_httpStatus - The response's http status code.

GetSdkType

data GetSdkType Source #

Get an SdkType instance.

See: newGetSdkType smart constructor.

Constructors

GetSdkType' Text

Instances

Instances details

ToHeaders GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Methods toHeaders :: GetSdkType -> [Header] #
ToPath GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Methods toPath :: GetSdkType -> ByteString #
ToQuery GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Methods toQuery :: GetSdkType -> QueryString #
AWSRequest GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Associated Types type AWSResponse GetSdkType # Methods request :: (Service -> Service) -> GetSdkType -> Request GetSdkType # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSdkType -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSdkType))) #
Generic GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Associated Types type Rep GetSdkType :: Type -> Type # Methods from :: GetSdkType -> Rep GetSdkType x # to :: Rep GetSdkType x -> GetSdkType #
Read GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Methods readsPrec :: Int -> ReadS GetSdkType # readList :: ReadS [GetSdkType] # readPrec :: ReadPrec GetSdkType # readListPrec :: ReadPrec [GetSdkType] #
Show GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Methods showsPrec :: Int -> GetSdkType -> ShowS # show :: GetSdkType -> String # showList :: [GetSdkType] -> ShowS #
NFData GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Methods rnf :: GetSdkType -> () #
Eq GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Methods (==) :: GetSdkType -> GetSdkType -> Bool # (/=) :: GetSdkType -> GetSdkType -> Bool #
Hashable GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType Methods hashWithSalt :: Int -> GetSdkType -> Int # hash :: GetSdkType -> Int #
type AWSResponse GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType type AWSResponse GetSdkType = SdkType
type Rep GetSdkType Source #
Instance details Defined in Amazonka.APIGateway.GetSdkType type Rep GetSdkType = D1 ('MetaData "GetSdkType" "Amazonka.APIGateway.GetSdkType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetSdkType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetSdkType Source #

Arguments

:: Text	`GetSdkType`
-> GetSdkType

Create a value of GetSdkType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSdkType, getSdkType_id - The identifier of the queried SdkType instance.

data SdkType Source #

A type of SDK that API Gateway can generate.

See: newSdkType smart constructor.

Constructors

SdkType' (Maybe [SdkConfigurationProperty]) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods parseJSON :: Value -> Parser SdkType # parseJSONList :: Value -> Parser [SdkType] #
Generic SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Associated Types type Rep SdkType :: Type -> Type # Methods from :: SdkType -> Rep SdkType x # to :: Rep SdkType x -> SdkType #
Read SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods readsPrec :: Int -> ReadS SdkType # readList :: ReadS [SdkType] # readPrec :: ReadPrec SdkType # readListPrec :: ReadPrec [SdkType] #
Show SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods showsPrec :: Int -> SdkType -> ShowS # show :: SdkType -> String # showList :: [SdkType] -> ShowS #
NFData SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods rnf :: SdkType -> () #
Eq SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods (==) :: SdkType -> SdkType -> Bool # (/=) :: SdkType -> SdkType -> Bool #
Hashable SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods hashWithSalt :: Int -> SdkType -> Int # hash :: SdkType -> Int #
type Rep SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType type Rep SdkType = D1 ('MetaData "SdkType" "Amazonka.APIGateway.Types.SdkType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "SdkType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configurationProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SdkConfigurationProperty])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "friendlyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSdkType :: SdkType Source #

Create a value of SdkType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:configurationProperties:SdkType', sdkType_configurationProperties - A list of configuration properties of an SdkType.

SdkType, sdkType_description - The description of an SdkType.

SdkType, sdkType_friendlyName - The user-friendly name of an SdkType instance.

$sel:id:SdkType', sdkType_id - The identifier of an SdkType instance.

GetSdkTypes (Paginated)

data GetSdkTypes Source #

Get the SdkTypes collection.

See: newGetSdkTypes smart constructor.

Constructors

GetSdkTypes' (Maybe Int) (Maybe Text)

Instances

Instances details

ToHeaders GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods toHeaders :: GetSdkTypes -> [Header] #
ToPath GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods toPath :: GetSdkTypes -> ByteString #
ToQuery GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods toQuery :: GetSdkTypes -> QueryString #
AWSPager GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods page :: GetSdkTypes -> AWSResponse GetSdkTypes -> Maybe GetSdkTypes #
AWSRequest GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Associated Types type AWSResponse GetSdkTypes # Methods request :: (Service -> Service) -> GetSdkTypes -> Request GetSdkTypes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetSdkTypes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetSdkTypes))) #
Generic GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Associated Types type Rep GetSdkTypes :: Type -> Type # Methods from :: GetSdkTypes -> Rep GetSdkTypes x # to :: Rep GetSdkTypes x -> GetSdkTypes #
Read GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods readsPrec :: Int -> ReadS GetSdkTypes # readList :: ReadS [GetSdkTypes] # readPrec :: ReadPrec GetSdkTypes # readListPrec :: ReadPrec [GetSdkTypes] #
Show GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods showsPrec :: Int -> GetSdkTypes -> ShowS # show :: GetSdkTypes -> String # showList :: [GetSdkTypes] -> ShowS #
NFData GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods rnf :: GetSdkTypes -> () #
Eq GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods (==) :: GetSdkTypes -> GetSdkTypes -> Bool # (/=) :: GetSdkTypes -> GetSdkTypes -> Bool #
Hashable GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods hashWithSalt :: Int -> GetSdkTypes -> Int # hash :: GetSdkTypes -> Int #
type AWSResponse GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes type AWSResponse GetSdkTypes = GetSdkTypesResponse
type Rep GetSdkTypes Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes type Rep GetSdkTypes = D1 ('MetaData "GetSdkTypes" "Amazonka.APIGateway.GetSdkTypes" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetSdkTypes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetSdkTypes :: GetSdkTypes Source #

Create a value of GetSdkTypes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSdkTypes, getSdkTypes_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetSdkTypes, getSdkTypes_position - The current pagination position in the paged result set.

data GetSdkTypesResponse Source #

The collection of SdkType instances.

See: newGetSdkTypesResponse smart constructor.

Constructors

GetSdkTypesResponse' (Maybe [SdkType]) (Maybe Text) Int

Instances

Instances details

Generic GetSdkTypesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Associated Types type Rep GetSdkTypesResponse :: Type -> Type # Methods from :: GetSdkTypesResponse -> Rep GetSdkTypesResponse x # to :: Rep GetSdkTypesResponse x -> GetSdkTypesResponse #
Read GetSdkTypesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods readsPrec :: Int -> ReadS GetSdkTypesResponse # readList :: ReadS [GetSdkTypesResponse] # readPrec :: ReadPrec GetSdkTypesResponse # readListPrec :: ReadPrec [GetSdkTypesResponse] #
Show GetSdkTypesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods showsPrec :: Int -> GetSdkTypesResponse -> ShowS # show :: GetSdkTypesResponse -> String # showList :: [GetSdkTypesResponse] -> ShowS #
NFData GetSdkTypesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods rnf :: GetSdkTypesResponse -> () #
Eq GetSdkTypesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes Methods (==) :: GetSdkTypesResponse -> GetSdkTypesResponse -> Bool # (/=) :: GetSdkTypesResponse -> GetSdkTypesResponse -> Bool #
type Rep GetSdkTypesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdkTypes type Rep GetSdkTypesResponse = D1 ('MetaData "GetSdkTypesResponse" "Amazonka.APIGateway.GetSdkTypes" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetSdkTypesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SdkType])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetSdkTypesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetSdkTypesResponse'`
-> GetSdkTypesResponse

Create a value of GetSdkTypesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetSdkTypesResponse, getSdkTypesResponse_items - The current page of elements from this collection.

GetSdkTypes, getSdkTypesResponse_position - Undocumented member.

$sel:httpStatus:GetSdkTypesResponse', getSdkTypesResponse_httpStatus - The response's http status code.

GetStage

data GetStage Source #

Requests API Gateway to get information about a Stage resource.

See: newGetStage smart constructor.

Constructors

GetStage' Text Text

Instances

Instances details

ToHeaders GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Methods toHeaders :: GetStage -> [Header] #
ToPath GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Methods toPath :: GetStage -> ByteString #
ToQuery GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Methods toQuery :: GetStage -> QueryString #
AWSRequest GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Associated Types type AWSResponse GetStage # Methods request :: (Service -> Service) -> GetStage -> Request GetStage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetStage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetStage))) #
Generic GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Associated Types type Rep GetStage :: Type -> Type # Methods from :: GetStage -> Rep GetStage x # to :: Rep GetStage x -> GetStage #
Read GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Methods readsPrec :: Int -> ReadS GetStage # readList :: ReadS [GetStage] # readPrec :: ReadPrec GetStage # readListPrec :: ReadPrec [GetStage] #
Show GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Methods showsPrec :: Int -> GetStage -> ShowS # show :: GetStage -> String # showList :: [GetStage] -> ShowS #
NFData GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Methods rnf :: GetStage -> () #
Eq GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Methods (==) :: GetStage -> GetStage -> Bool # (/=) :: GetStage -> GetStage -> Bool #
Hashable GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage Methods hashWithSalt :: Int -> GetStage -> Int # hash :: GetStage -> Int #
type AWSResponse GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage type AWSResponse GetStage = Stage
type Rep GetStage Source #
Instance details Defined in Amazonka.APIGateway.GetStage type Rep GetStage = D1 ('MetaData "GetStage" "Amazonka.APIGateway.GetStage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetStage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetStage Source #

Arguments

:: Text	`GetStage`
-> Text	`GetStage`
-> GetStage

Create a value of GetStage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetStage, getStage_restApiId - The string identifier of the associated RestApi.

GetStage, getStage_stageName - The name of the Stage resource to get information about.

data Stage Source #

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

See: newStage smart constructor.

Constructors

Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe CacheClusterSize) (Maybe CacheClusterStatus) (Maybe CanarySettings) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text MethodSetting)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text)

Instances

Instances details

FromJSON Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods parseJSON :: Value -> Parser Stage # parseJSONList :: Value -> Parser [Stage] #
Generic Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Associated Types type Rep Stage :: Type -> Type # Methods from :: Stage -> Rep Stage x # to :: Rep Stage x -> Stage #
Read Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods readsPrec :: Int -> ReadS Stage # readList :: ReadS [Stage] # readPrec :: ReadPrec Stage # readListPrec :: ReadPrec [Stage] #
Show Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods showsPrec :: Int -> Stage -> ShowS # show :: Stage -> String # showList :: [Stage] -> ShowS #
NFData Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods rnf :: Stage -> () #
Eq Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods (==) :: Stage -> Stage -> Bool # (/=) :: Stage -> Stage -> Bool #
Hashable Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods hashWithSalt :: Int -> Stage -> Int # hash :: Stage -> Int #
type Rep Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage type Rep Stage = D1 ('MetaData "Stage" "Amazonka.APIGateway.Types.Stage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Stage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :: S1 ('MetaSel ('Just "cacheClusterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "cacheClusterSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterSize)) :: S1 ('MetaSel ('Just "cacheClusterStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterStatus)))) :: ((S1 ('MetaSel ('Just "canarySettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanarySettings)) :: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "methodSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MethodSetting))))) :: ((S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "tracingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "webAclArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newStage :: Stage Source #

Create a value of Stage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessLogSettings:Stage', stage_accessLogSettings - Settings for logging access in this stage.

$sel:cacheClusterEnabled:Stage', stage_cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.

$sel:cacheClusterSize:Stage', stage_cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

$sel:cacheClusterStatus:Stage', stage_cacheClusterStatus - The status of the cache cluster for the stage, if enabled.

$sel:canarySettings:Stage', stage_canarySettings - Settings for the canary deployment in this stage.

$sel:clientCertificateId:Stage', stage_clientCertificateId - The identifier of a client certificate for an API stage.

$sel:createdDate:Stage', stage_createdDate - The timestamp when the stage was created.

Stage, stage_deploymentId - The identifier of the Deployment that the stage points to.

$sel:description:Stage', stage_description - The stage's description.

$sel:documentationVersion:Stage', stage_documentationVersion - The version of the associated API documentation.

$sel:lastUpdatedDate:Stage', stage_lastUpdatedDate - The timestamp when the stage last updated.

$sel:methodSettings:Stage', stage_methodSettings - A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

$sel:stageName:Stage', stage_stageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

$sel:tags:Stage', stage_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:tracingEnabled:Stage', stage_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

$sel:variables:Stage', stage_variables - A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

$sel:webAclArn:Stage', stage_webAclArn - The ARN of the WebAcl associated with the Stage.

GetStages

data GetStages Source #

Requests API Gateway to get information about one or more Stage resources.

See: newGetStages smart constructor.

Constructors

GetStages' (Maybe Text) Text

Instances

Instances details

ToHeaders GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods toHeaders :: GetStages -> [Header] #
ToPath GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods toPath :: GetStages -> ByteString #
ToQuery GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods toQuery :: GetStages -> QueryString #
AWSRequest GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Associated Types type AWSResponse GetStages # Methods request :: (Service -> Service) -> GetStages -> Request GetStages # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetStages -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetStages))) #
Generic GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Associated Types type Rep GetStages :: Type -> Type # Methods from :: GetStages -> Rep GetStages x # to :: Rep GetStages x -> GetStages #
Read GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods readsPrec :: Int -> ReadS GetStages # readList :: ReadS [GetStages] # readPrec :: ReadPrec GetStages # readListPrec :: ReadPrec [GetStages] #
Show GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods showsPrec :: Int -> GetStages -> ShowS # show :: GetStages -> String # showList :: [GetStages] -> ShowS #
NFData GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods rnf :: GetStages -> () #
Eq GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods (==) :: GetStages -> GetStages -> Bool # (/=) :: GetStages -> GetStages -> Bool #
Hashable GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods hashWithSalt :: Int -> GetStages -> Int # hash :: GetStages -> Int #
type AWSResponse GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages type AWSResponse GetStages = GetStagesResponse
type Rep GetStages Source #
Instance details Defined in Amazonka.APIGateway.GetStages type Rep GetStages = D1 ('MetaData "GetStages" "Amazonka.APIGateway.GetStages" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetStages'" 'PrefixI 'True) (S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetStages Source #

Arguments

:: Text	`GetStages`
-> GetStages

Create a value of GetStages with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetStages, getStages_deploymentId - The stages' deployment identifiers.

GetStages, getStages_restApiId - The string identifier of the associated RestApi.

data GetStagesResponse Source #

A list of Stage resources that are associated with the ApiKey resource.

See: newGetStagesResponse smart constructor.

Constructors

GetStagesResponse' (Maybe [Stage]) Int

Instances

Instances details

Generic GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Associated Types type Rep GetStagesResponse :: Type -> Type # Methods from :: GetStagesResponse -> Rep GetStagesResponse x # to :: Rep GetStagesResponse x -> GetStagesResponse #
Read GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods readsPrec :: Int -> ReadS GetStagesResponse # readList :: ReadS [GetStagesResponse] # readPrec :: ReadPrec GetStagesResponse # readListPrec :: ReadPrec [GetStagesResponse] #
Show GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods showsPrec :: Int -> GetStagesResponse -> ShowS # show :: GetStagesResponse -> String # showList :: [GetStagesResponse] -> ShowS #
NFData GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods rnf :: GetStagesResponse -> () #
Eq GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages Methods (==) :: GetStagesResponse -> GetStagesResponse -> Bool # (/=) :: GetStagesResponse -> GetStagesResponse -> Bool #
type Rep GetStagesResponse Source #
Instance details Defined in Amazonka.APIGateway.GetStages type Rep GetStagesResponse = D1 ('MetaData "GetStagesResponse" "Amazonka.APIGateway.GetStages" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetStagesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "item") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Stage])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetStagesResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetStagesResponse'`
-> GetStagesResponse

Create a value of GetStagesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:item:GetStagesResponse', getStagesResponse_item - The current page of elements from this collection.

$sel:httpStatus:GetStagesResponse', getStagesResponse_httpStatus - The response's http status code.

GetTags

data GetTags Source #

Gets the Tags collection for a given resource.

See: newGetTags smart constructor.

Constructors

GetTags' (Maybe Int) (Maybe Text) Text

Instances

Instances details

ToHeaders GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods toHeaders :: GetTags -> [Header] #
ToPath GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods toPath :: GetTags -> ByteString #
ToQuery GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods toQuery :: GetTags -> QueryString #
AWSRequest GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Associated Types type AWSResponse GetTags # Methods request :: (Service -> Service) -> GetTags -> Request GetTags # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetTags -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetTags))) #
Generic GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Associated Types type Rep GetTags :: Type -> Type # Methods from :: GetTags -> Rep GetTags x # to :: Rep GetTags x -> GetTags #
Read GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods readsPrec :: Int -> ReadS GetTags # readList :: ReadS [GetTags] # readPrec :: ReadPrec GetTags # readListPrec :: ReadPrec [GetTags] #
Show GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods showsPrec :: Int -> GetTags -> ShowS # show :: GetTags -> String # showList :: [GetTags] -> ShowS #
NFData GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods rnf :: GetTags -> () #
Eq GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods (==) :: GetTags -> GetTags -> Bool # (/=) :: GetTags -> GetTags -> Bool #
Hashable GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods hashWithSalt :: Int -> GetTags -> Int # hash :: GetTags -> Int #
type AWSResponse GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags type AWSResponse GetTags = GetTagsResponse
type Rep GetTags Source #
Instance details Defined in Amazonka.APIGateway.GetTags type Rep GetTags = D1 ('MetaData "GetTags" "Amazonka.APIGateway.GetTags" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetTags'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetTags Source #

Arguments

:: Text	`$sel:resourceArn:GetTags'`
-> GetTags

Create a value of GetTags with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetTags, getTags_limit - (Not currently supported) The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetTags, getTags_position - (Not currently supported) The current pagination position in the paged result set.

$sel:resourceArn:GetTags', getTags_resourceArn - The ARN of a resource that can be tagged.

data GetTagsResponse Source #

The collection of tags. Each tag element is associated with a given resource.

See: newGetTagsResponse smart constructor.

Constructors

GetTagsResponse' (Maybe (HashMap Text Text)) Int

Instances

Instances details

Generic GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Associated Types type Rep GetTagsResponse :: Type -> Type # Methods from :: GetTagsResponse -> Rep GetTagsResponse x # to :: Rep GetTagsResponse x -> GetTagsResponse #
Read GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods readsPrec :: Int -> ReadS GetTagsResponse # readList :: ReadS [GetTagsResponse] # readPrec :: ReadPrec GetTagsResponse # readListPrec :: ReadPrec [GetTagsResponse] #
Show GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods showsPrec :: Int -> GetTagsResponse -> ShowS # show :: GetTagsResponse -> String # showList :: [GetTagsResponse] -> ShowS #
NFData GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods rnf :: GetTagsResponse -> () #
Eq GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags Methods (==) :: GetTagsResponse -> GetTagsResponse -> Bool # (/=) :: GetTagsResponse -> GetTagsResponse -> Bool #
type Rep GetTagsResponse Source #
Instance details Defined in Amazonka.APIGateway.GetTags type Rep GetTagsResponse = D1 ('MetaData "GetTagsResponse" "Amazonka.APIGateway.GetTags" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetTagsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetTagsResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetTagsResponse'`
-> GetTagsResponse

Create a value of GetTagsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetTagsResponse, getTagsResponse_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:httpStatus:GetTagsResponse', getTagsResponse_httpStatus - The response's http status code.

GetUsage (Paginated)

data GetUsage Source #

The GET request to get the usage data of a usage plan in a specified time interval.

See: newGetUsage smart constructor.

Constructors

GetUsage' (Maybe Text) (Maybe Int) (Maybe Text) Text Text Text

Instances

Instances details

ToHeaders GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Methods toHeaders :: GetUsage -> [Header] #
ToPath GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Methods toPath :: GetUsage -> ByteString #
ToQuery GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Methods toQuery :: GetUsage -> QueryString #
AWSPager GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Methods page :: GetUsage -> AWSResponse GetUsage -> Maybe GetUsage #
AWSRequest GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Associated Types type AWSResponse GetUsage # Methods request :: (Service -> Service) -> GetUsage -> Request GetUsage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetUsage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUsage))) #
Generic GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Associated Types type Rep GetUsage :: Type -> Type # Methods from :: GetUsage -> Rep GetUsage x # to :: Rep GetUsage x -> GetUsage #
Read GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Methods readsPrec :: Int -> ReadS GetUsage # readList :: ReadS [GetUsage] # readPrec :: ReadPrec GetUsage # readListPrec :: ReadPrec [GetUsage] #
Show GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Methods showsPrec :: Int -> GetUsage -> ShowS # show :: GetUsage -> String # showList :: [GetUsage] -> ShowS #
NFData GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Methods rnf :: GetUsage -> () #
Eq GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Methods (==) :: GetUsage -> GetUsage -> Bool # (/=) :: GetUsage -> GetUsage -> Bool #
Hashable GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage Methods hashWithSalt :: Int -> GetUsage -> Int # hash :: GetUsage -> Int #
type AWSResponse GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage type AWSResponse GetUsage = Usage
type Rep GetUsage Source #
Instance details Defined in Amazonka.APIGateway.GetUsage type Rep GetUsage = D1 ('MetaData "GetUsage" "Amazonka.APIGateway.GetUsage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetUsage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newGetUsage Source #

Arguments

:: Text	`GetUsage`
-> Text	`GetUsage`
-> Text	`GetUsage`
-> GetUsage

Create a value of GetUsage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyId:GetUsage', getUsage_keyId - The Id of the API key associated with the resultant usage data.

GetUsage, getUsage_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetUsage, getUsage_position - The current pagination position in the paged result set.

GetUsage, getUsage_usagePlanId - The Id of the usage plan associated with the usage data.

GetUsage, getUsage_startDate - The starting date (e.g., 2016-01-01) of the usage data.

GetUsage, getUsage_endDate - The ending date (e.g., 2016-12-31) of the usage data.

data Usage Source #

Represents the usage data of a usage plan.

See: newUsage smart constructor.

Constructors

Usage' (Maybe Text) (Maybe (HashMap Text [[Integer]])) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods parseJSON :: Value -> Parser Usage # parseJSONList :: Value -> Parser [Usage] #
Generic Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Associated Types type Rep Usage :: Type -> Type # Methods from :: Usage -> Rep Usage x # to :: Rep Usage x -> Usage #
Read Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods readsPrec :: Int -> ReadS Usage # readList :: ReadS [Usage] # readPrec :: ReadPrec Usage # readListPrec :: ReadPrec [Usage] #
Show Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods showsPrec :: Int -> Usage -> ShowS # show :: Usage -> String # showList :: [Usage] -> ShowS #
NFData Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods rnf :: Usage -> () #
Eq Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods (==) :: Usage -> Usage -> Bool # (/=) :: Usage -> Usage -> Bool #
Hashable Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods hashWithSalt :: Int -> Usage -> Int # hash :: Usage -> Int #
type Rep Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage type Rep Usage = D1 ('MetaData "Usage" "Amazonka.APIGateway.Types.Usage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Usage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [[Integer]])))) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newUsage :: Usage Source #

Create a value of Usage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endDate:Usage', usage_endDate - The ending date of the usage data.

$sel:items:Usage', usage_items - The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

$sel:position:Usage', usage_position - Undocumented member.

$sel:startDate:Usage', usage_startDate - The starting date of the usage data.

$sel:usagePlanId:Usage', usage_usagePlanId - The plan Id associated with this usage data.

GetUsagePlan

data GetUsagePlan Source #

The GET request to get a usage plan of a given plan identifier.

See: newGetUsagePlan smart constructor.

Constructors

GetUsagePlan' Text

Instances

Instances details

ToHeaders GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Methods toHeaders :: GetUsagePlan -> [Header] #
ToPath GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Methods toPath :: GetUsagePlan -> ByteString #
ToQuery GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Methods toQuery :: GetUsagePlan -> QueryString #
AWSRequest GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Associated Types type AWSResponse GetUsagePlan # Methods request :: (Service -> Service) -> GetUsagePlan -> Request GetUsagePlan # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetUsagePlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUsagePlan))) #
Generic GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Associated Types type Rep GetUsagePlan :: Type -> Type # Methods from :: GetUsagePlan -> Rep GetUsagePlan x # to :: Rep GetUsagePlan x -> GetUsagePlan #
Read GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Methods readsPrec :: Int -> ReadS GetUsagePlan # readList :: ReadS [GetUsagePlan] # readPrec :: ReadPrec GetUsagePlan # readListPrec :: ReadPrec [GetUsagePlan] #
Show GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Methods showsPrec :: Int -> GetUsagePlan -> ShowS # show :: GetUsagePlan -> String # showList :: [GetUsagePlan] -> ShowS #
NFData GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Methods rnf :: GetUsagePlan -> () #
Eq GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Methods (==) :: GetUsagePlan -> GetUsagePlan -> Bool # (/=) :: GetUsagePlan -> GetUsagePlan -> Bool #
Hashable GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan Methods hashWithSalt :: Int -> GetUsagePlan -> Int # hash :: GetUsagePlan -> Int #
type AWSResponse GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan type AWSResponse GetUsagePlan = UsagePlan
type Rep GetUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlan type Rep GetUsagePlan = D1 ('MetaData "GetUsagePlan" "Amazonka.APIGateway.GetUsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetUsagePlan'" 'PrefixI 'True) (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetUsagePlan Source #

Arguments

:: Text	`GetUsagePlan`
-> GetUsagePlan

Create a value of GetUsagePlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetUsagePlan, getUsagePlan_usagePlanId - The identifier of the UsagePlan resource to be retrieved.

data UsagePlan Source #

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.

See: newUsagePlan smart constructor.

Constructors

UsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings)

Instances

Instances details

FromJSON UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods parseJSON :: Value -> Parser UsagePlan # parseJSONList :: Value -> Parser [UsagePlan] #
Generic UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Associated Types type Rep UsagePlan :: Type -> Type # Methods from :: UsagePlan -> Rep UsagePlan x # to :: Rep UsagePlan x -> UsagePlan #
Read UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods readsPrec :: Int -> ReadS UsagePlan # readList :: ReadS [UsagePlan] # readPrec :: ReadPrec UsagePlan # readListPrec :: ReadPrec [UsagePlan] #
Show UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods showsPrec :: Int -> UsagePlan -> ShowS # show :: UsagePlan -> String # showList :: [UsagePlan] -> ShowS #
NFData UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods rnf :: UsagePlan -> () #
Eq UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods (==) :: UsagePlan -> UsagePlan -> Bool # (/=) :: UsagePlan -> UsagePlan -> Bool #
Hashable UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods hashWithSalt :: Int -> UsagePlan -> Int # hash :: UsagePlan -> Int #
type Rep UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan type Rep UsagePlan = D1 ('MetaData "UsagePlan" "Amazonka.APIGateway.Types.UsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UsagePlan'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiStage])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "quota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaSettings))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings))))))

newUsagePlan :: UsagePlan Source #

Create a value of UsagePlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiStages:UsagePlan', usagePlan_apiStages - The associated API stages of a usage plan.

$sel:description:UsagePlan', usagePlan_description - The description of a usage plan.

$sel:id:UsagePlan', usagePlan_id - The identifier of a UsagePlan resource.

$sel:name:UsagePlan', usagePlan_name - The name of a usage plan.

$sel:productCode:UsagePlan', usagePlan_productCode - The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

$sel:quota:UsagePlan', usagePlan_quota - The target maximum number of permitted requests per a given unit time interval.

$sel:tags:UsagePlan', usagePlan_tags - The collection of tags. Each tag element is associated with a given resource.

UsagePlan, usagePlan_throttle - A map containing method level throttling information for API stage in a usage plan.

GetUsagePlanKey

data GetUsagePlanKey Source #

The GET request to get a usage plan key of a given key identifier.

See: newGetUsagePlanKey smart constructor.

Constructors

GetUsagePlanKey' Text Text

Instances

Instances details

ToHeaders GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods toHeaders :: GetUsagePlanKey -> [Header] #
ToPath GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods toPath :: GetUsagePlanKey -> ByteString #
ToQuery GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods toQuery :: GetUsagePlanKey -> QueryString #
AWSRequest GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Associated Types type AWSResponse GetUsagePlanKey # Methods request :: (Service -> Service) -> GetUsagePlanKey -> Request GetUsagePlanKey # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetUsagePlanKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUsagePlanKey))) #
Generic GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Associated Types type Rep GetUsagePlanKey :: Type -> Type # Methods from :: GetUsagePlanKey -> Rep GetUsagePlanKey x # to :: Rep GetUsagePlanKey x -> GetUsagePlanKey #
Read GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods readsPrec :: Int -> ReadS GetUsagePlanKey # readList :: ReadS [GetUsagePlanKey] # readPrec :: ReadPrec GetUsagePlanKey # readListPrec :: ReadPrec [GetUsagePlanKey] #
Show GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods showsPrec :: Int -> GetUsagePlanKey -> ShowS # show :: GetUsagePlanKey -> String # showList :: [GetUsagePlanKey] -> ShowS #
NFData GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods rnf :: GetUsagePlanKey -> () #
Eq GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods (==) :: GetUsagePlanKey -> GetUsagePlanKey -> Bool # (/=) :: GetUsagePlanKey -> GetUsagePlanKey -> Bool #
Hashable GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey Methods hashWithSalt :: Int -> GetUsagePlanKey -> Int # hash :: GetUsagePlanKey -> Int #
type AWSResponse GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey type AWSResponse GetUsagePlanKey = UsagePlanKey
type Rep GetUsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKey type Rep GetUsagePlanKey = D1 ('MetaData "GetUsagePlanKey" "Amazonka.APIGateway.GetUsagePlanKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetUsagePlanKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetUsagePlanKey Source #

Arguments

:: Text	`GetUsagePlanKey`
-> Text	`$sel:keyId:GetUsagePlanKey'`
-> GetUsagePlanKey

Create a value of GetUsagePlanKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetUsagePlanKey, getUsagePlanKey_usagePlanId - The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

$sel:keyId:GetUsagePlanKey', getUsagePlanKey_keyId - The key Id of the to-be-retrieved UsagePlanKey resource representing a plan customer.

data UsagePlanKey Source #

Represents a usage plan key to identify a plan customer.

See: newUsagePlanKey smart constructor.

Constructors

UsagePlanKey' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods parseJSON :: Value -> Parser UsagePlanKey # parseJSONList :: Value -> Parser [UsagePlanKey] #
Generic UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Associated Types type Rep UsagePlanKey :: Type -> Type # Methods from :: UsagePlanKey -> Rep UsagePlanKey x # to :: Rep UsagePlanKey x -> UsagePlanKey #
Read UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods readsPrec :: Int -> ReadS UsagePlanKey # readList :: ReadS [UsagePlanKey] # readPrec :: ReadPrec UsagePlanKey # readListPrec :: ReadPrec [UsagePlanKey] #
Show UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods showsPrec :: Int -> UsagePlanKey -> ShowS # show :: UsagePlanKey -> String # showList :: [UsagePlanKey] -> ShowS #
NFData UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods rnf :: UsagePlanKey -> () #
Eq UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods (==) :: UsagePlanKey -> UsagePlanKey -> Bool # (/=) :: UsagePlanKey -> UsagePlanKey -> Bool #
Hashable UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods hashWithSalt :: Int -> UsagePlanKey -> Int # hash :: UsagePlanKey -> Int #
type Rep UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey type Rep UsagePlanKey = D1 ('MetaData "UsagePlanKey" "Amazonka.APIGateway.Types.UsagePlanKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UsagePlanKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newUsagePlanKey :: UsagePlanKey Source #

Create a value of UsagePlanKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:UsagePlanKey', usagePlanKey_id - The Id of a usage plan key.

$sel:name:UsagePlanKey', usagePlanKey_name - The name of a usage plan key.

$sel:type':UsagePlanKey', usagePlanKey_type - The type of a usage plan key. Currently, the valid key type is API_KEY.

$sel:value:UsagePlanKey', usagePlanKey_value - The value of a usage plan key.

GetUsagePlanKeys (Paginated)

data GetUsagePlanKeys Source #

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

See: newGetUsagePlanKeys smart constructor.

Constructors

GetUsagePlanKeys' (Maybe Int) (Maybe Text) (Maybe Text) Text

Instances

Instances details

ToHeaders GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods toHeaders :: GetUsagePlanKeys -> [Header] #
ToPath GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods toPath :: GetUsagePlanKeys -> ByteString #
ToQuery GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods toQuery :: GetUsagePlanKeys -> QueryString #
AWSPager GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods page :: GetUsagePlanKeys -> AWSResponse GetUsagePlanKeys -> Maybe GetUsagePlanKeys #
AWSRequest GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Associated Types type AWSResponse GetUsagePlanKeys # Methods request :: (Service -> Service) -> GetUsagePlanKeys -> Request GetUsagePlanKeys # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetUsagePlanKeys -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUsagePlanKeys))) #
Generic GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Associated Types type Rep GetUsagePlanKeys :: Type -> Type # Methods from :: GetUsagePlanKeys -> Rep GetUsagePlanKeys x # to :: Rep GetUsagePlanKeys x -> GetUsagePlanKeys #
Read GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods readsPrec :: Int -> ReadS GetUsagePlanKeys # readList :: ReadS [GetUsagePlanKeys] # readPrec :: ReadPrec GetUsagePlanKeys # readListPrec :: ReadPrec [GetUsagePlanKeys] #
Show GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods showsPrec :: Int -> GetUsagePlanKeys -> ShowS # show :: GetUsagePlanKeys -> String # showList :: [GetUsagePlanKeys] -> ShowS #
NFData GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods rnf :: GetUsagePlanKeys -> () #
Eq GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods (==) :: GetUsagePlanKeys -> GetUsagePlanKeys -> Bool # (/=) :: GetUsagePlanKeys -> GetUsagePlanKeys -> Bool #
Hashable GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods hashWithSalt :: Int -> GetUsagePlanKeys -> Int # hash :: GetUsagePlanKeys -> Int #
type AWSResponse GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys type AWSResponse GetUsagePlanKeys = GetUsagePlanKeysResponse
type Rep GetUsagePlanKeys Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys type Rep GetUsagePlanKeys = D1 ('MetaData "GetUsagePlanKeys" "Amazonka.APIGateway.GetUsagePlanKeys" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetUsagePlanKeys'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "nameQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetUsagePlanKeys Source #

Arguments

:: Text	`GetUsagePlanKeys`
-> GetUsagePlanKeys

Create a value of GetUsagePlanKeys with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetUsagePlanKeys, getUsagePlanKeys_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

$sel:nameQuery:GetUsagePlanKeys', getUsagePlanKeys_nameQuery - A query parameter specifying the name of the to-be-returned usage plan keys.

GetUsagePlanKeys, getUsagePlanKeys_position - The current pagination position in the paged result set.

GetUsagePlanKeys, getUsagePlanKeys_usagePlanId - The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

data GetUsagePlanKeysResponse Source #

Represents the collection of usage plan keys added to usage plans for the associated API keys and, possibly, other types of keys.

See: newGetUsagePlanKeysResponse smart constructor.

Constructors

GetUsagePlanKeysResponse' (Maybe [UsagePlanKey]) (Maybe Text) Int

Instances

Instances details

Generic GetUsagePlanKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Associated Types type Rep GetUsagePlanKeysResponse :: Type -> Type # Methods from :: GetUsagePlanKeysResponse -> Rep GetUsagePlanKeysResponse x # to :: Rep GetUsagePlanKeysResponse x -> GetUsagePlanKeysResponse #
Read GetUsagePlanKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods readsPrec :: Int -> ReadS GetUsagePlanKeysResponse # readList :: ReadS [GetUsagePlanKeysResponse] # readPrec :: ReadPrec GetUsagePlanKeysResponse # readListPrec :: ReadPrec [GetUsagePlanKeysResponse] #
Show GetUsagePlanKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods showsPrec :: Int -> GetUsagePlanKeysResponse -> ShowS # show :: GetUsagePlanKeysResponse -> String # showList :: [GetUsagePlanKeysResponse] -> ShowS #
NFData GetUsagePlanKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods rnf :: GetUsagePlanKeysResponse -> () #
Eq GetUsagePlanKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys Methods (==) :: GetUsagePlanKeysResponse -> GetUsagePlanKeysResponse -> Bool # (/=) :: GetUsagePlanKeysResponse -> GetUsagePlanKeysResponse -> Bool #
type Rep GetUsagePlanKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlanKeys type Rep GetUsagePlanKeysResponse = D1 ('MetaData "GetUsagePlanKeysResponse" "Amazonka.APIGateway.GetUsagePlanKeys" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetUsagePlanKeysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UsagePlanKey])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetUsagePlanKeysResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetUsagePlanKeysResponse'`
-> GetUsagePlanKeysResponse

Create a value of GetUsagePlanKeysResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetUsagePlanKeysResponse, getUsagePlanKeysResponse_items - The current page of elements from this collection.

GetUsagePlanKeys, getUsagePlanKeysResponse_position - Undocumented member.

$sel:httpStatus:GetUsagePlanKeysResponse', getUsagePlanKeysResponse_httpStatus - The response's http status code.

GetUsagePlans (Paginated)

data GetUsagePlans Source #

The GET request to get all the usage plans of the caller's account.

See: newGetUsagePlans smart constructor.

Constructors

GetUsagePlans' (Maybe Text) (Maybe Int) (Maybe Text)

Instances

Instances details

ToHeaders GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods toHeaders :: GetUsagePlans -> [Header] #
ToPath GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods toPath :: GetUsagePlans -> ByteString #
ToQuery GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods toQuery :: GetUsagePlans -> QueryString #
AWSPager GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods page :: GetUsagePlans -> AWSResponse GetUsagePlans -> Maybe GetUsagePlans #
AWSRequest GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Associated Types type AWSResponse GetUsagePlans # Methods request :: (Service -> Service) -> GetUsagePlans -> Request GetUsagePlans # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetUsagePlans -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetUsagePlans))) #
Generic GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Associated Types type Rep GetUsagePlans :: Type -> Type # Methods from :: GetUsagePlans -> Rep GetUsagePlans x # to :: Rep GetUsagePlans x -> GetUsagePlans #
Read GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods readsPrec :: Int -> ReadS GetUsagePlans # readList :: ReadS [GetUsagePlans] # readPrec :: ReadPrec GetUsagePlans # readListPrec :: ReadPrec [GetUsagePlans] #
Show GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods showsPrec :: Int -> GetUsagePlans -> ShowS # show :: GetUsagePlans -> String # showList :: [GetUsagePlans] -> ShowS #
NFData GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods rnf :: GetUsagePlans -> () #
Eq GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods (==) :: GetUsagePlans -> GetUsagePlans -> Bool # (/=) :: GetUsagePlans -> GetUsagePlans -> Bool #
Hashable GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods hashWithSalt :: Int -> GetUsagePlans -> Int # hash :: GetUsagePlans -> Int #
type AWSResponse GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans type AWSResponse GetUsagePlans = GetUsagePlansResponse
type Rep GetUsagePlans Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans type Rep GetUsagePlans = D1 ('MetaData "GetUsagePlans" "Amazonka.APIGateway.GetUsagePlans" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetUsagePlans'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newGetUsagePlans :: GetUsagePlans Source #

Create a value of GetUsagePlans with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:keyId:GetUsagePlans', getUsagePlans_keyId - The identifier of the API key associated with the usage plans.

GetUsagePlans, getUsagePlans_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetUsagePlans, getUsagePlans_position - The current pagination position in the paged result set.

data GetUsagePlansResponse Source #

Represents a collection of usage plans for an AWS account.

See: newGetUsagePlansResponse smart constructor.

Constructors

GetUsagePlansResponse' (Maybe [UsagePlan]) (Maybe Text) Int

Instances

Instances details

Generic GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Associated Types type Rep GetUsagePlansResponse :: Type -> Type # Methods from :: GetUsagePlansResponse -> Rep GetUsagePlansResponse x # to :: Rep GetUsagePlansResponse x -> GetUsagePlansResponse #
Read GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods readsPrec :: Int -> ReadS GetUsagePlansResponse # readList :: ReadS [GetUsagePlansResponse] # readPrec :: ReadPrec GetUsagePlansResponse # readListPrec :: ReadPrec [GetUsagePlansResponse] #
Show GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods showsPrec :: Int -> GetUsagePlansResponse -> ShowS # show :: GetUsagePlansResponse -> String # showList :: [GetUsagePlansResponse] -> ShowS #
NFData GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods rnf :: GetUsagePlansResponse -> () #
Eq GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans Methods (==) :: GetUsagePlansResponse -> GetUsagePlansResponse -> Bool # (/=) :: GetUsagePlansResponse -> GetUsagePlansResponse -> Bool #
type Rep GetUsagePlansResponse Source #
Instance details Defined in Amazonka.APIGateway.GetUsagePlans type Rep GetUsagePlansResponse = D1 ('MetaData "GetUsagePlansResponse" "Amazonka.APIGateway.GetUsagePlans" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetUsagePlansResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [UsagePlan])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetUsagePlansResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetUsagePlansResponse'`
-> GetUsagePlansResponse

Create a value of GetUsagePlansResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetUsagePlansResponse, getUsagePlansResponse_items - The current page of elements from this collection.

GetUsagePlans, getUsagePlansResponse_position - Undocumented member.

$sel:httpStatus:GetUsagePlansResponse', getUsagePlansResponse_httpStatus - The response's http status code.

GetVpcLink

data GetVpcLink Source #

Gets a specified VPC link under the caller's account in a region.

See: newGetVpcLink smart constructor.

Constructors

GetVpcLink' Text

Instances

Instances details

ToHeaders GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods toHeaders :: GetVpcLink -> [Header] #
ToPath GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods toPath :: GetVpcLink -> ByteString #
ToQuery GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods toQuery :: GetVpcLink -> QueryString #
AWSRequest GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Associated Types type AWSResponse GetVpcLink # Methods request :: (Service -> Service) -> GetVpcLink -> Request GetVpcLink # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetVpcLink -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetVpcLink))) #
Generic GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Associated Types type Rep GetVpcLink :: Type -> Type # Methods from :: GetVpcLink -> Rep GetVpcLink x # to :: Rep GetVpcLink x -> GetVpcLink #
Read GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods readsPrec :: Int -> ReadS GetVpcLink # readList :: ReadS [GetVpcLink] # readPrec :: ReadPrec GetVpcLink # readListPrec :: ReadPrec [GetVpcLink] #
Show GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods showsPrec :: Int -> GetVpcLink -> ShowS # show :: GetVpcLink -> String # showList :: [GetVpcLink] -> ShowS #
NFData GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods rnf :: GetVpcLink -> () #
Eq GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods (==) :: GetVpcLink -> GetVpcLink -> Bool # (/=) :: GetVpcLink -> GetVpcLink -> Bool #
Hashable GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink Methods hashWithSalt :: Int -> GetVpcLink -> Int # hash :: GetVpcLink -> Int #
type AWSResponse GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink type AWSResponse GetVpcLink = VpcLink
type Rep GetVpcLink Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLink type Rep GetVpcLink = D1 ('MetaData "GetVpcLink" "Amazonka.APIGateway.GetVpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetVpcLink'" 'PrefixI 'True) (S1 ('MetaSel ('Just "vpcLinkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetVpcLink Source #

Arguments

:: Text	`$sel:vpcLinkId:GetVpcLink'`
-> GetVpcLink

Create a value of GetVpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:vpcLinkId:GetVpcLink', getVpcLink_vpcLinkId - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

data VpcLink Source #

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

See: newVpcLink smart constructor.

Constructors

VpcLink' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text])

Instances

Instances details

FromJSON VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods parseJSON :: Value -> Parser VpcLink # parseJSONList :: Value -> Parser [VpcLink] #
Generic VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Associated Types type Rep VpcLink :: Type -> Type # Methods from :: VpcLink -> Rep VpcLink x # to :: Rep VpcLink x -> VpcLink #
Read VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods readsPrec :: Int -> ReadS VpcLink # readList :: ReadS [VpcLink] # readPrec :: ReadPrec VpcLink # readListPrec :: ReadPrec [VpcLink] #
Show VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods showsPrec :: Int -> VpcLink -> ShowS # show :: VpcLink -> String # showList :: [VpcLink] -> ShowS #
NFData VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods rnf :: VpcLink -> () #
Eq VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods (==) :: VpcLink -> VpcLink -> Bool # (/=) :: VpcLink -> VpcLink -> Bool #
Hashable VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods hashWithSalt :: Int -> VpcLink -> Int # hash :: VpcLink -> Int #
type Rep VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink type Rep VpcLink = D1 ('MetaData "VpcLink" "Amazonka.APIGateway.Types.VpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "VpcLink'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcLinkStatus)) :: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "targetArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newVpcLink :: VpcLink Source #

Create a value of VpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:VpcLink', vpcLink_description - The description of the VPC link.

$sel:id:VpcLink', vpcLink_id - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

$sel:name:VpcLink', vpcLink_name - The name used to label and identify the VPC link.

$sel:status:VpcLink', vpcLink_status - The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

$sel:statusMessage:VpcLink', vpcLink_statusMessage - A description about the VPC link status.

$sel:tags:VpcLink', vpcLink_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:targetArns:VpcLink', vpcLink_targetArns - The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

GetVpcLinks (Paginated)

data GetVpcLinks Source #

Gets the VpcLinks collection under the caller's account in a selected region.

See: newGetVpcLinks smart constructor.

Constructors

GetVpcLinks' (Maybe Int) (Maybe Text)

Instances

Instances details

ToHeaders GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods toHeaders :: GetVpcLinks -> [Header] #
ToPath GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods toPath :: GetVpcLinks -> ByteString #
ToQuery GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods toQuery :: GetVpcLinks -> QueryString #
AWSPager GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods page :: GetVpcLinks -> AWSResponse GetVpcLinks -> Maybe GetVpcLinks #
AWSRequest GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Associated Types type AWSResponse GetVpcLinks # Methods request :: (Service -> Service) -> GetVpcLinks -> Request GetVpcLinks # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetVpcLinks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetVpcLinks))) #
Generic GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Associated Types type Rep GetVpcLinks :: Type -> Type # Methods from :: GetVpcLinks -> Rep GetVpcLinks x # to :: Rep GetVpcLinks x -> GetVpcLinks #
Read GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods readsPrec :: Int -> ReadS GetVpcLinks # readList :: ReadS [GetVpcLinks] # readPrec :: ReadPrec GetVpcLinks # readListPrec :: ReadPrec [GetVpcLinks] #
Show GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods showsPrec :: Int -> GetVpcLinks -> ShowS # show :: GetVpcLinks -> String # showList :: [GetVpcLinks] -> ShowS #
NFData GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods rnf :: GetVpcLinks -> () #
Eq GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods (==) :: GetVpcLinks -> GetVpcLinks -> Bool # (/=) :: GetVpcLinks -> GetVpcLinks -> Bool #
Hashable GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods hashWithSalt :: Int -> GetVpcLinks -> Int # hash :: GetVpcLinks -> Int #
type AWSResponse GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks type AWSResponse GetVpcLinks = GetVpcLinksResponse
type Rep GetVpcLinks Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks type Rep GetVpcLinks = D1 ('MetaData "GetVpcLinks" "Amazonka.APIGateway.GetVpcLinks" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetVpcLinks'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newGetVpcLinks :: GetVpcLinks Source #

Create a value of GetVpcLinks with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetVpcLinks, getVpcLinks_limit - The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

GetVpcLinks, getVpcLinks_position - The current pagination position in the paged result set.

data GetVpcLinksResponse Source #

The collection of VPC links under the caller's account in a region.

See: newGetVpcLinksResponse smart constructor.

Constructors

GetVpcLinksResponse' (Maybe [VpcLink]) (Maybe Text) Int

Instances

Instances details

Generic GetVpcLinksResponse Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Associated Types type Rep GetVpcLinksResponse :: Type -> Type # Methods from :: GetVpcLinksResponse -> Rep GetVpcLinksResponse x # to :: Rep GetVpcLinksResponse x -> GetVpcLinksResponse #
Read GetVpcLinksResponse Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods readsPrec :: Int -> ReadS GetVpcLinksResponse # readList :: ReadS [GetVpcLinksResponse] # readPrec :: ReadPrec GetVpcLinksResponse # readListPrec :: ReadPrec [GetVpcLinksResponse] #
Show GetVpcLinksResponse Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods showsPrec :: Int -> GetVpcLinksResponse -> ShowS # show :: GetVpcLinksResponse -> String # showList :: [GetVpcLinksResponse] -> ShowS #
NFData GetVpcLinksResponse Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods rnf :: GetVpcLinksResponse -> () #
Eq GetVpcLinksResponse Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks Methods (==) :: GetVpcLinksResponse -> GetVpcLinksResponse -> Bool # (/=) :: GetVpcLinksResponse -> GetVpcLinksResponse -> Bool #
type Rep GetVpcLinksResponse Source #
Instance details Defined in Amazonka.APIGateway.GetVpcLinks type Rep GetVpcLinksResponse = D1 ('MetaData "GetVpcLinksResponse" "Amazonka.APIGateway.GetVpcLinks" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetVpcLinksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [VpcLink])) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetVpcLinksResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetVpcLinksResponse'`
-> GetVpcLinksResponse

Create a value of GetVpcLinksResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

GetVpcLinksResponse, getVpcLinksResponse_items - The current page of elements from this collection.

GetVpcLinks, getVpcLinksResponse_position - Undocumented member.

$sel:httpStatus:GetVpcLinksResponse', getVpcLinksResponse_httpStatus - The response's http status code.

ImportApiKeys

data ImportApiKeys Source #

The POST request to import API keys from an external source, such as a CSV-formatted file.

See: newImportApiKeys smart constructor.

Constructors

ImportApiKeys' (Maybe Bool) ByteString ApiKeysFormat

Instances

Instances details

ToBody ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods toBody :: ImportApiKeys -> RequestBody #
ToHeaders ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods toHeaders :: ImportApiKeys -> [Header] #
ToPath ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods toPath :: ImportApiKeys -> ByteString #
ToQuery ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods toQuery :: ImportApiKeys -> QueryString #
AWSRequest ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Associated Types type AWSResponse ImportApiKeys # Methods request :: (Service -> Service) -> ImportApiKeys -> Request ImportApiKeys # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportApiKeys -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportApiKeys))) #
Generic ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Associated Types type Rep ImportApiKeys :: Type -> Type # Methods from :: ImportApiKeys -> Rep ImportApiKeys x # to :: Rep ImportApiKeys x -> ImportApiKeys #
Show ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods showsPrec :: Int -> ImportApiKeys -> ShowS # show :: ImportApiKeys -> String # showList :: [ImportApiKeys] -> ShowS #
NFData ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods rnf :: ImportApiKeys -> () #
Eq ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods (==) :: ImportApiKeys -> ImportApiKeys -> Bool # (/=) :: ImportApiKeys -> ImportApiKeys -> Bool #
Hashable ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods hashWithSalt :: Int -> ImportApiKeys -> Int # hash :: ImportApiKeys -> Int #
type AWSResponse ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys type AWSResponse ImportApiKeys = ImportApiKeysResponse
type Rep ImportApiKeys Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys type Rep ImportApiKeys = D1 ('MetaData "ImportApiKeys" "Amazonka.APIGateway.ImportApiKeys" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ImportApiKeys'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failOnWarnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString) :: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ApiKeysFormat))))

newImportApiKeys Source #

Arguments

:: ByteString	`$sel:body:ImportApiKeys'`
-> ApiKeysFormat	`ImportApiKeys`
-> ImportApiKeys

Create a value of ImportApiKeys with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failOnWarnings:ImportApiKeys', importApiKeys_failOnWarnings - A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

$sel:body:ImportApiKeys', importApiKeys_body - The payload of the POST request to import API keys. For the payload format, see API Key File Format.

ImportApiKeys, importApiKeys_format - A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

data ImportApiKeysResponse Source #

The identifier of an ApiKey used in a UsagePlan.

See: newImportApiKeysResponse smart constructor.

Constructors

ImportApiKeysResponse' (Maybe [Text]) (Maybe [Text]) Int

Instances

Instances details

Generic ImportApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Associated Types type Rep ImportApiKeysResponse :: Type -> Type # Methods from :: ImportApiKeysResponse -> Rep ImportApiKeysResponse x # to :: Rep ImportApiKeysResponse x -> ImportApiKeysResponse #
Read ImportApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods readsPrec :: Int -> ReadS ImportApiKeysResponse # readList :: ReadS [ImportApiKeysResponse] # readPrec :: ReadPrec ImportApiKeysResponse # readListPrec :: ReadPrec [ImportApiKeysResponse] #
Show ImportApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods showsPrec :: Int -> ImportApiKeysResponse -> ShowS # show :: ImportApiKeysResponse -> String # showList :: [ImportApiKeysResponse] -> ShowS #
NFData ImportApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods rnf :: ImportApiKeysResponse -> () #
Eq ImportApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys Methods (==) :: ImportApiKeysResponse -> ImportApiKeysResponse -> Bool # (/=) :: ImportApiKeysResponse -> ImportApiKeysResponse -> Bool #
type Rep ImportApiKeysResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportApiKeys type Rep ImportApiKeysResponse = D1 ('MetaData "ImportApiKeysResponse" "Amazonka.APIGateway.ImportApiKeys" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ImportApiKeysResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newImportApiKeysResponse Source #

Arguments

:: Int	`$sel:httpStatus:ImportApiKeysResponse'`
-> ImportApiKeysResponse

Create a value of ImportApiKeysResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ids:ImportApiKeysResponse', importApiKeysResponse_ids - A list of all the ApiKey identifiers.

ImportApiKeysResponse, importApiKeysResponse_warnings - A list of warning messages.

$sel:httpStatus:ImportApiKeysResponse', importApiKeysResponse_httpStatus - The response's http status code.

ImportDocumentationParts

data ImportDocumentationParts Source #

Import documentation parts from an external (e.g., OpenAPI) definition file.

See: newImportDocumentationParts smart constructor.

Constructors

ImportDocumentationParts' (Maybe Bool) (Maybe PutMode) Text ByteString

Instances

Instances details

ToBody ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods toBody :: ImportDocumentationParts -> RequestBody #
ToHeaders ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods toHeaders :: ImportDocumentationParts -> [Header] #
ToPath ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods toPath :: ImportDocumentationParts -> ByteString #
ToQuery ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods toQuery :: ImportDocumentationParts -> QueryString #
AWSRequest ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Associated Types type AWSResponse ImportDocumentationParts # Methods request :: (Service -> Service) -> ImportDocumentationParts -> Request ImportDocumentationParts # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportDocumentationParts -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportDocumentationParts))) #
Generic ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Associated Types type Rep ImportDocumentationParts :: Type -> Type # Methods from :: ImportDocumentationParts -> Rep ImportDocumentationParts x # to :: Rep ImportDocumentationParts x -> ImportDocumentationParts #
Show ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods showsPrec :: Int -> ImportDocumentationParts -> ShowS # show :: ImportDocumentationParts -> String # showList :: [ImportDocumentationParts] -> ShowS #
NFData ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods rnf :: ImportDocumentationParts -> () #
Eq ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods (==) :: ImportDocumentationParts -> ImportDocumentationParts -> Bool # (/=) :: ImportDocumentationParts -> ImportDocumentationParts -> Bool #
Hashable ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods hashWithSalt :: Int -> ImportDocumentationParts -> Int # hash :: ImportDocumentationParts -> Int #
type AWSResponse ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts type AWSResponse ImportDocumentationParts = ImportDocumentationPartsResponse
type Rep ImportDocumentationParts Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts type Rep ImportDocumentationParts = D1 ('MetaData "ImportDocumentationParts" "Amazonka.APIGateway.ImportDocumentationParts" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ImportDocumentationParts'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failOnWarnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PutMode))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString))))

newImportDocumentationParts Source #

Arguments

:: Text	`ImportDocumentationParts`
-> ByteString	`$sel:body:ImportDocumentationParts'`
-> ImportDocumentationParts

Create a value of ImportDocumentationParts with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failOnWarnings:ImportDocumentationParts', importDocumentationParts_failOnWarnings - A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

$sel:mode:ImportDocumentationParts', importDocumentationParts_mode - A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

ImportDocumentationParts, importDocumentationParts_restApiId - The string identifier of the associated RestApi.

$sel:body:ImportDocumentationParts', importDocumentationParts_body - Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

data ImportDocumentationPartsResponse Source #

A collection of the imported DocumentationPart identifiers.

See: newImportDocumentationPartsResponse smart constructor.

Constructors

ImportDocumentationPartsResponse' (Maybe [Text]) (Maybe [Text]) Int

Instances

Instances details

Generic ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Associated Types type Rep ImportDocumentationPartsResponse :: Type -> Type # Methods from :: ImportDocumentationPartsResponse -> Rep ImportDocumentationPartsResponse x # to :: Rep ImportDocumentationPartsResponse x -> ImportDocumentationPartsResponse #
Read ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods readsPrec :: Int -> ReadS ImportDocumentationPartsResponse # readList :: ReadS [ImportDocumentationPartsResponse] # readPrec :: ReadPrec ImportDocumentationPartsResponse # readListPrec :: ReadPrec [ImportDocumentationPartsResponse] #
Show ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods showsPrec :: Int -> ImportDocumentationPartsResponse -> ShowS # show :: ImportDocumentationPartsResponse -> String # showList :: [ImportDocumentationPartsResponse] -> ShowS #
NFData ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods rnf :: ImportDocumentationPartsResponse -> () #
Eq ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods (==) :: ImportDocumentationPartsResponse -> ImportDocumentationPartsResponse -> Bool # (/=) :: ImportDocumentationPartsResponse -> ImportDocumentationPartsResponse -> Bool #
type Rep ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts type Rep ImportDocumentationPartsResponse = D1 ('MetaData "ImportDocumentationPartsResponse" "Amazonka.APIGateway.ImportDocumentationParts" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ImportDocumentationPartsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newImportDocumentationPartsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ImportDocumentationPartsResponse'`
-> ImportDocumentationPartsResponse

Create a value of ImportDocumentationPartsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ids:ImportDocumentationPartsResponse', importDocumentationPartsResponse_ids - A list of the returned documentation part identifiers.

ImportDocumentationPartsResponse, importDocumentationPartsResponse_warnings - A list of warning messages reported during import of documentation parts.

$sel:httpStatus:ImportDocumentationPartsResponse', importDocumentationPartsResponse_httpStatus - The response's http status code.

ImportRestApi

data ImportRestApi Source #

A POST request to import an API to API Gateway using an input of an API definition file.

See: newImportRestApi smart constructor.

Constructors

ImportRestApi' (Maybe Bool) (Maybe (HashMap Text Text)) ByteString

Instances

Instances details

ToBody ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Methods toBody :: ImportRestApi -> RequestBody #
ToHeaders ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Methods toHeaders :: ImportRestApi -> [Header] #
ToPath ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Methods toPath :: ImportRestApi -> ByteString #
ToQuery ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Methods toQuery :: ImportRestApi -> QueryString #
AWSRequest ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Associated Types type AWSResponse ImportRestApi # Methods request :: (Service -> Service) -> ImportRestApi -> Request ImportRestApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ImportRestApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ImportRestApi))) #
Generic ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Associated Types type Rep ImportRestApi :: Type -> Type # Methods from :: ImportRestApi -> Rep ImportRestApi x # to :: Rep ImportRestApi x -> ImportRestApi #
Show ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Methods showsPrec :: Int -> ImportRestApi -> ShowS # show :: ImportRestApi -> String # showList :: [ImportRestApi] -> ShowS #
NFData ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Methods rnf :: ImportRestApi -> () #
Eq ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Methods (==) :: ImportRestApi -> ImportRestApi -> Bool # (/=) :: ImportRestApi -> ImportRestApi -> Bool #
Hashable ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi Methods hashWithSalt :: Int -> ImportRestApi -> Int # hash :: ImportRestApi -> Int #
type AWSResponse ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi type AWSResponse ImportRestApi = RestApi
type Rep ImportRestApi Source #
Instance details Defined in Amazonka.APIGateway.ImportRestApi type Rep ImportRestApi = D1 ('MetaData "ImportRestApi" "Amazonka.APIGateway.ImportRestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ImportRestApi'" 'PrefixI 'True) (S1 ('MetaSel ('Just "failOnWarnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString))))

newImportRestApi Source #

Arguments

:: ByteString	`$sel:body:ImportRestApi'`
-> ImportRestApi

Create a value of ImportRestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failOnWarnings:ImportRestApi', importRestApi_failOnWarnings - A query parameter to indicate whether to rollback the API creation (true) or not (false) when a warning is encountered. The default value is false.

$sel:parameters:ImportRestApi', importRestApi_parameters - A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set parameters as ignore=documentation.

To configure the endpoint type, set parameters as endpointConfigurationTypes=EDGE, endpointConfigurationTypes=REGIONAL, or endpointConfigurationTypes=PRIVATE. The default endpoint type is EDGE.

To handle imported basepath, set parameters as basepath=ignore, basepath=prepend or basepath=split.

For example, the AWS CLI command to exclude documentation from the imported API is:

The AWS CLI command to set the regional endpoint on the imported API is:

$sel:body:ImportRestApi', importRestApi_body - The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

data RestApi Source #

Represents a REST API.

See: newRestApi smart constructor.

Constructors

RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])

Instances

Instances details

FromJSON RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods parseJSON :: Value -> Parser RestApi # parseJSONList :: Value -> Parser [RestApi] #
Generic RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Associated Types type Rep RestApi :: Type -> Type # Methods from :: RestApi -> Rep RestApi x # to :: Rep RestApi x -> RestApi #
Read RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods readsPrec :: Int -> ReadS RestApi # readList :: ReadS [RestApi] # readPrec :: ReadPrec RestApi # readListPrec :: ReadPrec [RestApi] #
Show RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods showsPrec :: Int -> RestApi -> ShowS # show :: RestApi -> String # showList :: [RestApi] -> ShowS #
NFData RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods rnf :: RestApi -> () #
Eq RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods (==) :: RestApi -> RestApi -> Bool # (/=) :: RestApi -> RestApi -> Bool #
Hashable RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods hashWithSalt :: Int -> RestApi -> Int # hash :: RestApi -> Int #
type Rep RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi type Rep RestApi = D1 ('MetaData "RestApi" "Amazonka.APIGateway.Types.RestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RestApi'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiKeySourceType)) :: (S1 ('MetaSel ('Just "binaryMediaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "minimumCompressionSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newRestApi :: RestApi Source #

Create a value of RestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeySource:RestApi', restApi_apiKeySource - The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

$sel:binaryMediaTypes:RestApi', restApi_binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

$sel:createdDate:RestApi', restApi_createdDate - The timestamp when the API was created.

$sel:description:RestApi', restApi_description - The API's description.

$sel:disableExecuteApiEndpoint:RestApi', restApi_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

$sel:endpointConfiguration:RestApi', restApi_endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

$sel:id:RestApi', restApi_id - The API's identifier. This identifier is unique across all of your APIs in API Gateway.

$sel:minimumCompressionSize:RestApi', restApi_minimumCompressionSize - A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

$sel:name:RestApi', restApi_name - The API's name.

$sel:policy:RestApi', restApi_policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

$sel:tags:RestApi', restApi_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:version:RestApi', restApi_version - A version identifier for the API.

$sel:warnings:RestApi', restApi_warnings - The warning messages reported when failonwarnings is turned on during API import.

PutGatewayResponse

data PutGatewayResponse Source #

Creates a customization of a GatewayResponse of a specified response type and status code on the given RestApi.

See: newPutGatewayResponse smart constructor.

Constructors

PutGatewayResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text GatewayResponseType

Instances

Instances details

ToJSON PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Methods toJSON :: PutGatewayResponse -> Value # toEncoding :: PutGatewayResponse -> Encoding # toJSONList :: [PutGatewayResponse] -> Value # toEncodingList :: [PutGatewayResponse] -> Encoding #
ToHeaders PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Methods toHeaders :: PutGatewayResponse -> [Header] #
ToPath PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Methods toPath :: PutGatewayResponse -> ByteString #
ToQuery PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Methods toQuery :: PutGatewayResponse -> QueryString #
AWSRequest PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Associated Types type AWSResponse PutGatewayResponse # Methods request :: (Service -> Service) -> PutGatewayResponse -> Request PutGatewayResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutGatewayResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutGatewayResponse))) #
Generic PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Associated Types type Rep PutGatewayResponse :: Type -> Type # Methods from :: PutGatewayResponse -> Rep PutGatewayResponse x # to :: Rep PutGatewayResponse x -> PutGatewayResponse #
Read PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Methods readsPrec :: Int -> ReadS PutGatewayResponse # readList :: ReadS [PutGatewayResponse] # readPrec :: ReadPrec PutGatewayResponse # readListPrec :: ReadPrec [PutGatewayResponse] #
Show PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Methods showsPrec :: Int -> PutGatewayResponse -> ShowS # show :: PutGatewayResponse -> String # showList :: [PutGatewayResponse] -> ShowS #
NFData PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Methods rnf :: PutGatewayResponse -> () #
Eq PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Methods (==) :: PutGatewayResponse -> PutGatewayResponse -> Bool # (/=) :: PutGatewayResponse -> PutGatewayResponse -> Bool #
Hashable PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse Methods hashWithSalt :: Int -> PutGatewayResponse -> Int # hash :: PutGatewayResponse -> Int #
type AWSResponse PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse type AWSResponse PutGatewayResponse = GatewayResponse
type Rep PutGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.PutGatewayResponse type Rep PutGatewayResponse = D1 ('MetaData "PutGatewayResponse" "Amazonka.APIGateway.PutGatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PutGatewayResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayResponseType)))))

newPutGatewayResponse Source #

Arguments

:: Text	`PutGatewayResponse`
-> GatewayResponseType	`PutGatewayResponse`
-> PutGatewayResponse

Create a value of PutGatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutGatewayResponse, putGatewayResponse_responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

PutGatewayResponse, putGatewayResponse_responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

PutGatewayResponse, putGatewayResponse_statusCode - The HTTP status code of the GatewayResponse.

PutGatewayResponse, putGatewayResponse_restApiId - The string identifier of the associated RestApi.

PutGatewayResponse, putGatewayResponse_responseType - The response type of the associated GatewayResponse

data GatewayResponse Source #

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

See: newGatewayResponse smart constructor.

Constructors

GatewayResponse' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe GatewayResponseType) (Maybe Text)

Instances

Instances details

FromJSON GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods parseJSON :: Value -> Parser GatewayResponse # parseJSONList :: Value -> Parser [GatewayResponse] #
Generic GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Associated Types type Rep GatewayResponse :: Type -> Type # Methods from :: GatewayResponse -> Rep GatewayResponse x # to :: Rep GatewayResponse x -> GatewayResponse #
Read GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods readsPrec :: Int -> ReadS GatewayResponse # readList :: ReadS [GatewayResponse] # readPrec :: ReadPrec GatewayResponse # readListPrec :: ReadPrec [GatewayResponse] #
Show GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods showsPrec :: Int -> GatewayResponse -> ShowS # show :: GatewayResponse -> String # showList :: [GatewayResponse] -> ShowS #
NFData GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods rnf :: GatewayResponse -> () #
Eq GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods (==) :: GatewayResponse -> GatewayResponse -> Bool # (/=) :: GatewayResponse -> GatewayResponse -> Bool #
Hashable GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods hashWithSalt :: Int -> GatewayResponse -> Int # hash :: GatewayResponse -> Int #
type Rep GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse type Rep GatewayResponse = D1 ('MetaData "GatewayResponse" "Amazonka.APIGateway.Types.GatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GatewayResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayResponseType)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGatewayResponse :: GatewayResponse Source #

Create a value of GatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultResponse:GatewayResponse', gatewayResponse_defaultResponse - A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

$sel:responseParameters:GatewayResponse', gatewayResponse_responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseTemplates:GatewayResponse', gatewayResponse_responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseType:GatewayResponse', gatewayResponse_responseType - The response type of the associated GatewayResponse.

$sel:statusCode:GatewayResponse', gatewayResponse_statusCode - The HTTP status code for this GatewayResponse.

PutIntegration

data PutIntegration Source #

Sets up a method's integration.

See: newPutIntegration smart constructor.

Constructors

PutIntegration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe Text) Text Text Text IntegrationType

Instances

Instances details

ToJSON PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Methods toJSON :: PutIntegration -> Value # toEncoding :: PutIntegration -> Encoding # toJSONList :: [PutIntegration] -> Value # toEncodingList :: [PutIntegration] -> Encoding #
ToHeaders PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Methods toHeaders :: PutIntegration -> [Header] #
ToPath PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Methods toPath :: PutIntegration -> ByteString #
ToQuery PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Methods toQuery :: PutIntegration -> QueryString #
AWSRequest PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Associated Types type AWSResponse PutIntegration # Methods request :: (Service -> Service) -> PutIntegration -> Request PutIntegration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutIntegration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutIntegration))) #
Generic PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Associated Types type Rep PutIntegration :: Type -> Type # Methods from :: PutIntegration -> Rep PutIntegration x # to :: Rep PutIntegration x -> PutIntegration #
Read PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Methods readsPrec :: Int -> ReadS PutIntegration # readList :: ReadS [PutIntegration] # readPrec :: ReadPrec PutIntegration # readListPrec :: ReadPrec [PutIntegration] #
Show PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Methods showsPrec :: Int -> PutIntegration -> ShowS # show :: PutIntegration -> String # showList :: [PutIntegration] -> ShowS #
NFData PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Methods rnf :: PutIntegration -> () #
Eq PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Methods (==) :: PutIntegration -> PutIntegration -> Bool # (/=) :: PutIntegration -> PutIntegration -> Bool #
Hashable PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration Methods hashWithSalt :: Int -> PutIntegration -> Int # hash :: PutIntegration -> Int #
type AWSResponse PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration type AWSResponse PutIntegration = Integration
type Rep PutIntegration Source #
Instance details Defined in Amazonka.APIGateway.PutIntegration type Rep PutIntegration = D1 ('MetaData "PutIntegration" "Amazonka.APIGateway.PutIntegration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PutIntegration'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "cacheKeyParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "cacheNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionType)))) :: ((S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :: S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "integrationHttpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "passthroughBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "requestTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "timeoutInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "tlsConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TlsConfig)))) :: ((S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IntegrationType)))))))

newPutIntegration Source #

Arguments

:: Text	`PutIntegration`
-> Text	`$sel:resourceId:PutIntegration'`
-> Text	`PutIntegration`
-> IntegrationType	`PutIntegration`
-> PutIntegration

Create a value of PutIntegration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutIntegration, putIntegration_cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

PutIntegration, putIntegration_cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

PutIntegration, putIntegration_connectionId - The ID of the VpcLink used for the integration. Specify this value only if you specify VPC_LINK as the connection type.

PutIntegration, putIntegration_connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

PutIntegration, putIntegration_contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

PutIntegration, putIntegration_credentials - Specifies whether credentials are required for a put integration.

$sel:integrationHttpMethod:PutIntegration', putIntegration_integrationHttpMethod - The HTTP method for the integration.

PutIntegration, putIntegration_passthroughBehavior - Specifies the pass-through behavior for incoming requests based on the Content-Type header in the request, and the available mapping templates specified as the requestTemplates property on the Integration resource. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

PutIntegration, putIntegration_requestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

PutIntegration, putIntegration_requestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

PutIntegration, putIntegration_timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

PutIntegration, putIntegration_tlsConfig - Undocumented member.

PutIntegration, putIntegration_uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint. For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an Amazon Web Services service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}.

PutIntegration, putIntegration_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:PutIntegration', putIntegration_resourceId - Specifies a put integration request's resource ID.

PutIntegration, putIntegration_httpMethod - Specifies the HTTP method for the integration.

PutIntegration, putIntegration_type - Specifies a put integration input's type.

data Integration Source #

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

See: newIntegration smart constructor.

Constructors

Integration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text IntegrationResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe IntegrationType) (Maybe Text)

Instances

Instances details

FromJSON Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods parseJSON :: Value -> Parser Integration # parseJSONList :: Value -> Parser [Integration] #
Generic Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Associated Types type Rep Integration :: Type -> Type # Methods from :: Integration -> Rep Integration x # to :: Rep Integration x -> Integration #
Read Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods readsPrec :: Int -> ReadS Integration # readList :: ReadS [Integration] # readPrec :: ReadPrec Integration # readListPrec :: ReadPrec [Integration] #
Show Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods showsPrec :: Int -> Integration -> ShowS # show :: Integration -> String # showList :: [Integration] -> ShowS #
NFData Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods rnf :: Integration -> () #
Eq Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods (==) :: Integration -> Integration -> Bool # (/=) :: Integration -> Integration -> Bool #
Hashable Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods hashWithSalt :: Int -> Integration -> Int # hash :: Integration -> Int #
type Rep Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration type Rep Integration = D1 ('MetaData "Integration" "Amazonka.APIGateway.Types.Integration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Integration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheKeyParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "cacheNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "connectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionType)) :: S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy))) :: (S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "integrationResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text IntegrationResponse))) :: S1 ('MetaSel ('Just "passthroughBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "requestTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "timeoutInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "tlsConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TlsConfig))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntegrationType)) :: S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newIntegration :: Integration Source #

Create a value of Integration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheKeyParameters:Integration', integration_cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

$sel:cacheNamespace:Integration', integration_cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

$sel:connectionId:Integration', integration_connectionId - The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

$sel:connectionType:Integration', integration_connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Integration, integration_contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

$sel:credentials:Integration', integration_credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

$sel:httpMethod:Integration', integration_httpMethod - Specifies the integration's HTTP method type.

$sel:integrationResponses:Integration', integration_integrationResponses - Specifies the integration's responses.

$sel:passthroughBehavior:Integration', integration_passthroughBehavior - Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

$sel:requestParameters:Integration', integration_requestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

$sel:requestTemplates:Integration', integration_requestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

$sel:timeoutInMillis:Integration', integration_timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

$sel:tlsConfig:Integration', integration_tlsConfig - Specifies the TLS configuration for an integration.

$sel:type':Integration', integration_type - Specifies an API method integration type. The valid value is one of the following:

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

$sel:uri:Integration', integration_uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint.

For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

PutIntegrationResponse

data PutIntegrationResponse Source #

Represents a put integration response request.

See: newPutIntegrationResponse smart constructor.

Constructors

PutIntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text Text

Instances

Instances details

ToJSON PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods toJSON :: PutIntegrationResponse -> Value # toEncoding :: PutIntegrationResponse -> Encoding # toJSONList :: [PutIntegrationResponse] -> Value # toEncodingList :: [PutIntegrationResponse] -> Encoding #
ToHeaders PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods toHeaders :: PutIntegrationResponse -> [Header] #
ToPath PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods toPath :: PutIntegrationResponse -> ByteString #
ToQuery PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods toQuery :: PutIntegrationResponse -> QueryString #
AWSRequest PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Associated Types type AWSResponse PutIntegrationResponse # Methods request :: (Service -> Service) -> PutIntegrationResponse -> Request PutIntegrationResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutIntegrationResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutIntegrationResponse))) #
Generic PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Associated Types type Rep PutIntegrationResponse :: Type -> Type # Methods from :: PutIntegrationResponse -> Rep PutIntegrationResponse x # to :: Rep PutIntegrationResponse x -> PutIntegrationResponse #
Read PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods readsPrec :: Int -> ReadS PutIntegrationResponse # readList :: ReadS [PutIntegrationResponse] # readPrec :: ReadPrec PutIntegrationResponse # readListPrec :: ReadPrec [PutIntegrationResponse] #
Show PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods showsPrec :: Int -> PutIntegrationResponse -> ShowS # show :: PutIntegrationResponse -> String # showList :: [PutIntegrationResponse] -> ShowS #
NFData PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods rnf :: PutIntegrationResponse -> () #
Eq PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods (==) :: PutIntegrationResponse -> PutIntegrationResponse -> Bool # (/=) :: PutIntegrationResponse -> PutIntegrationResponse -> Bool #
Hashable PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse Methods hashWithSalt :: Int -> PutIntegrationResponse -> Int # hash :: PutIntegrationResponse -> Int #
type AWSResponse PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse type AWSResponse PutIntegrationResponse = IntegrationResponse
type Rep PutIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.PutIntegrationResponse type Rep PutIntegrationResponse = D1 ('MetaData "PutIntegrationResponse" "Amazonka.APIGateway.PutIntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PutIntegrationResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "selectionPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPutIntegrationResponse Source #

Arguments

:: Text	`PutIntegrationResponse`
-> Text	`$sel:resourceId:PutIntegrationResponse'`
-> Text	`PutIntegrationResponse`
-> Text	`PutIntegrationResponse`
-> PutIntegrationResponse

Create a value of PutIntegrationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutIntegrationResponse, putIntegrationResponse_contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

PutIntegrationResponse, putIntegrationResponse_responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name must be a valid and unique response header name and JSON-expression a valid JSON expression without the $ prefix.

PutIntegrationResponse, putIntegrationResponse_responseTemplates - Specifies a put integration response's templates.

PutIntegrationResponse, putIntegrationResponse_selectionPattern - Specifies the selection pattern of a put integration response.

PutIntegrationResponse, putIntegrationResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:PutIntegrationResponse', putIntegrationResponse_resourceId - Specifies a put integration response request's resource identifier.

PutIntegrationResponse, putIntegrationResponse_httpMethod - Specifies a put integration response request's HTTP method.

PutIntegrationResponse, putIntegrationResponse_statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

data IntegrationResponse Source #

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

See: newIntegrationResponse smart constructor.

Constructors

IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods parseJSON :: Value -> Parser IntegrationResponse # parseJSONList :: Value -> Parser [IntegrationResponse] #
Generic IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Associated Types type Rep IntegrationResponse :: Type -> Type # Methods from :: IntegrationResponse -> Rep IntegrationResponse x # to :: Rep IntegrationResponse x -> IntegrationResponse #
Read IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods readsPrec :: Int -> ReadS IntegrationResponse # readList :: ReadS [IntegrationResponse] # readPrec :: ReadPrec IntegrationResponse # readListPrec :: ReadPrec [IntegrationResponse] #
Show IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods showsPrec :: Int -> IntegrationResponse -> ShowS # show :: IntegrationResponse -> String # showList :: [IntegrationResponse] -> ShowS #
NFData IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods rnf :: IntegrationResponse -> () #
Eq IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods (==) :: IntegrationResponse -> IntegrationResponse -> Bool # (/=) :: IntegrationResponse -> IntegrationResponse -> Bool #
Hashable IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods hashWithSalt :: Int -> IntegrationResponse -> Int # hash :: IntegrationResponse -> Int #
type Rep IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse type Rep IntegrationResponse = D1 ('MetaData "IntegrationResponse" "Amazonka.APIGateway.Types.IntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "IntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "selectionPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newIntegrationResponse :: IntegrationResponse Source #

Create a value of IntegrationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentHandling:IntegrationResponse', integrationResponse_contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

$sel:responseParameters:IntegrationResponse', integrationResponse_responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

$sel:responseTemplates:IntegrationResponse', integrationResponse_responseTemplates - Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

$sel:selectionPattern:IntegrationResponse', integrationResponse_selectionPattern - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

$sel:statusCode:IntegrationResponse', integrationResponse_statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

PutMethod

data PutMethod Source #

Request to add a method to an existing Resource resource.

See: newPutMethod smart constructor.

Constructors

PutMethod' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text) Text Text Text Text

Instances

Instances details

ToJSON PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Methods toJSON :: PutMethod -> Value # toEncoding :: PutMethod -> Encoding # toJSONList :: [PutMethod] -> Value # toEncodingList :: [PutMethod] -> Encoding #
ToHeaders PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Methods toHeaders :: PutMethod -> [Header] #
ToPath PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Methods toPath :: PutMethod -> ByteString #
ToQuery PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Methods toQuery :: PutMethod -> QueryString #
AWSRequest PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Associated Types type AWSResponse PutMethod # Methods request :: (Service -> Service) -> PutMethod -> Request PutMethod # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutMethod -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutMethod))) #
Generic PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Associated Types type Rep PutMethod :: Type -> Type # Methods from :: PutMethod -> Rep PutMethod x # to :: Rep PutMethod x -> PutMethod #
Read PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Methods readsPrec :: Int -> ReadS PutMethod # readList :: ReadS [PutMethod] # readPrec :: ReadPrec PutMethod # readListPrec :: ReadPrec [PutMethod] #
Show PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Methods showsPrec :: Int -> PutMethod -> ShowS # show :: PutMethod -> String # showList :: [PutMethod] -> ShowS #
NFData PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Methods rnf :: PutMethod -> () #
Eq PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Methods (==) :: PutMethod -> PutMethod -> Bool # (/=) :: PutMethod -> PutMethod -> Bool #
Hashable PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod Methods hashWithSalt :: Int -> PutMethod -> Int # hash :: PutMethod -> Int #
type AWSResponse PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod type AWSResponse PutMethod = Method
type Rep PutMethod Source #
Instance details Defined in Amazonka.APIGateway.PutMethod type Rep PutMethod = D1 ('MetaData "PutMethod" "Amazonka.APIGateway.PutMethod" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PutMethod'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "authorizationScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "operationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "requestModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))) :: ((S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: (S1 ('MetaSel ('Just "requestValidatorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "authorizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newPutMethod Source #

Arguments

:: Text	`PutMethod`
-> Text	`$sel:resourceId:PutMethod'`
-> Text	`PutMethod`
-> Text	`PutMethod`
-> PutMethod

Create a value of PutMethod with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutMethod, putMethod_apiKeyRequired - Specifies whether the method required a valid ApiKey.

PutMethod, putMethod_authorizationScopes - A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

PutMethod, putMethod_authorizerId - Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

PutMethod, putMethod_operationName - A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

PutMethod, putMethod_requestModels - Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

PutMethod, putMethod_requestParameters - A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

PutMethod, putMethod_requestValidatorId - The identifier of a RequestValidator for validating the method request.

PutMethod, putMethod_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:PutMethod', putMethod_resourceId - The Resource identifier for the new Method resource.

PutMethod, putMethod_httpMethod - Specifies the method request's HTTP method type.

PutMethod, putMethod_authorizationType - The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

data Method Source #

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

See: newMethod smart constructor.

Constructors

Method' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integration) (Maybe (HashMap Text MethodResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)

Instances

Instances details

FromJSON Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods parseJSON :: Value -> Parser Method # parseJSONList :: Value -> Parser [Method] #
Generic Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Associated Types type Rep Method :: Type -> Type # Methods from :: Method -> Rep Method x # to :: Rep Method x -> Method #
Read Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods readsPrec :: Int -> ReadS Method # readList :: ReadS [Method] # readPrec :: ReadPrec Method # readListPrec :: ReadPrec [Method] #
Show Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
NFData Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods rnf :: Method -> () #
Eq Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Hashable Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods hashWithSalt :: Int -> Method -> Int # hash :: Method -> Int #
type Rep Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method type Rep Method = D1 ('MetaData "Method" "Amazonka.APIGateway.Types.Method" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Method'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "authorizationScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "authorizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "methodIntegration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integration)) :: (S1 ('MetaSel ('Just "methodResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MethodResponse))) :: S1 ('MetaSel ('Just "operationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "requestModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: S1 ('MetaSel ('Just "requestValidatorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newMethod :: Method Source #

Create a value of Method with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyRequired:Method', method_apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke this method.

$sel:authorizationScopes:Method', method_authorizationScopes - A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

$sel:authorizationType:Method', method_authorizationType - The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

$sel:authorizerId:Method', method_authorizerId - The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Method, method_httpMethod - The method's HTTP verb.

$sel:methodIntegration:Method', method_methodIntegration - Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

$sel:methodResponses:Method', method_methodResponses - Gets a method response associated with a given HTTP status code.

$sel:operationName:Method', method_operationName - A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

$sel:requestModels:Method', method_requestModels - A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Method, method_requestParameters - A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

$sel:requestValidatorId:Method', method_requestValidatorId - The identifier of a RequestValidator for request validation.

PutMethodResponse

data PutMethodResponse Source #

Request to add a MethodResponse to an existing Method resource.

See: newPutMethodResponse smart constructor.

Constructors

PutMethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) Text Text Text Text

Instances

Instances details

ToJSON PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Methods toJSON :: PutMethodResponse -> Value # toEncoding :: PutMethodResponse -> Encoding # toJSONList :: [PutMethodResponse] -> Value # toEncodingList :: [PutMethodResponse] -> Encoding #
ToHeaders PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Methods toHeaders :: PutMethodResponse -> [Header] #
ToPath PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Methods toPath :: PutMethodResponse -> ByteString #
ToQuery PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Methods toQuery :: PutMethodResponse -> QueryString #
AWSRequest PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Associated Types type AWSResponse PutMethodResponse # Methods request :: (Service -> Service) -> PutMethodResponse -> Request PutMethodResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutMethodResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutMethodResponse))) #
Generic PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Associated Types type Rep PutMethodResponse :: Type -> Type # Methods from :: PutMethodResponse -> Rep PutMethodResponse x # to :: Rep PutMethodResponse x -> PutMethodResponse #
Read PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Methods readsPrec :: Int -> ReadS PutMethodResponse # readList :: ReadS [PutMethodResponse] # readPrec :: ReadPrec PutMethodResponse # readListPrec :: ReadPrec [PutMethodResponse] #
Show PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Methods showsPrec :: Int -> PutMethodResponse -> ShowS # show :: PutMethodResponse -> String # showList :: [PutMethodResponse] -> ShowS #
NFData PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Methods rnf :: PutMethodResponse -> () #
Eq PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Methods (==) :: PutMethodResponse -> PutMethodResponse -> Bool # (/=) :: PutMethodResponse -> PutMethodResponse -> Bool #
Hashable PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse Methods hashWithSalt :: Int -> PutMethodResponse -> Int # hash :: PutMethodResponse -> Int #
type AWSResponse PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse type AWSResponse PutMethodResponse = MethodResponse
type Rep PutMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.PutMethodResponse type Rep PutMethodResponse = D1 ('MetaData "PutMethodResponse" "Amazonka.APIGateway.PutMethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PutMethodResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "responseModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newPutMethodResponse Source #

Arguments

:: Text	`PutMethodResponse`
-> Text	`$sel:resourceId:PutMethodResponse'`
-> Text	`PutMethodResponse`
-> Text	`PutMethodResponse`
-> PutMethodResponse

Create a value of PutMethodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

PutMethodResponse, putMethodResponse_responseModels - Specifies the Model resources used for the response's content type. Response models are represented as a key/value map, with a content type as the key and a Model name as the value.

PutMethodResponse, putMethodResponse_responseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header name and the associated value is a Boolean flag indicating whether the method response parameter is required or not. The method response header names must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The response parameter names defined here are available in the integration response to be mapped from an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

PutMethodResponse, putMethodResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:PutMethodResponse', putMethodResponse_resourceId - The Resource identifier for the Method resource.

PutMethodResponse, putMethodResponse_httpMethod - The HTTP verb of the Method resource.

PutMethodResponse, putMethodResponse_statusCode - The method response's status code.

data MethodResponse Source #

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

See: newMethodResponse smart constructor.

Constructors

MethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)

Instances

Instances details

FromJSON MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods parseJSON :: Value -> Parser MethodResponse # parseJSONList :: Value -> Parser [MethodResponse] #
Generic MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Associated Types type Rep MethodResponse :: Type -> Type # Methods from :: MethodResponse -> Rep MethodResponse x # to :: Rep MethodResponse x -> MethodResponse #
Read MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods readsPrec :: Int -> ReadS MethodResponse # readList :: ReadS [MethodResponse] # readPrec :: ReadPrec MethodResponse # readListPrec :: ReadPrec [MethodResponse] #
Show MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods showsPrec :: Int -> MethodResponse -> ShowS # show :: MethodResponse -> String # showList :: [MethodResponse] -> ShowS #
NFData MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods rnf :: MethodResponse -> () #
Eq MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods (==) :: MethodResponse -> MethodResponse -> Bool # (/=) :: MethodResponse -> MethodResponse -> Bool #
Hashable MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods hashWithSalt :: Int -> MethodResponse -> Int # hash :: MethodResponse -> Int #
type Rep MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse type Rep MethodResponse = D1 ('MetaData "MethodResponse" "Amazonka.APIGateway.Types.MethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MethodResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "responseModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMethodResponse :: MethodResponse Source #

Create a value of MethodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:responseModels:MethodResponse', methodResponse_responseModels - Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

$sel:responseParameters:MethodResponse', methodResponse_responseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

$sel:statusCode:MethodResponse', methodResponse_statusCode - The method response's status code.

PutRestApi

data PutRestApi Source #

A PUT request to update an existing API, with external API definitions specified as the request body.

See: newPutRestApi smart constructor.

Constructors

PutRestApi' (Maybe Bool) (Maybe PutMode) (Maybe (HashMap Text Text)) Text ByteString

Instances

Instances details

ToBody PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Methods toBody :: PutRestApi -> RequestBody #
ToHeaders PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Methods toHeaders :: PutRestApi -> [Header] #
ToPath PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Methods toPath :: PutRestApi -> ByteString #
ToQuery PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Methods toQuery :: PutRestApi -> QueryString #
AWSRequest PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Associated Types type AWSResponse PutRestApi # Methods request :: (Service -> Service) -> PutRestApi -> Request PutRestApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutRestApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutRestApi))) #
Generic PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Associated Types type Rep PutRestApi :: Type -> Type # Methods from :: PutRestApi -> Rep PutRestApi x # to :: Rep PutRestApi x -> PutRestApi #
Show PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Methods showsPrec :: Int -> PutRestApi -> ShowS # show :: PutRestApi -> String # showList :: [PutRestApi] -> ShowS #
NFData PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Methods rnf :: PutRestApi -> () #
Eq PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Methods (==) :: PutRestApi -> PutRestApi -> Bool # (/=) :: PutRestApi -> PutRestApi -> Bool #
Hashable PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi Methods hashWithSalt :: Int -> PutRestApi -> Int # hash :: PutRestApi -> Int #
type AWSResponse PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi type AWSResponse PutRestApi = RestApi
type Rep PutRestApi Source #
Instance details Defined in Amazonka.APIGateway.PutRestApi type Rep PutRestApi = D1 ('MetaData "PutRestApi" "Amazonka.APIGateway.PutRestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PutRestApi'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "failOnWarnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PutMode))) :: (S1 ('MetaSel ('Just "parameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ByteString)))))

newPutRestApi Source #

Arguments

:: Text	`PutRestApi`
-> ByteString	`$sel:body:PutRestApi'`
-> PutRestApi

Create a value of PutRestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:failOnWarnings:PutRestApi', putRestApi_failOnWarnings - A query parameter to indicate whether to rollback the API update (true) or not (false) when a warning is encountered. The default value is false.

$sel:mode:PutRestApi', putRestApi_mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

$sel:parameters:PutRestApi', putRestApi_parameters - Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json'.

PutRestApi, putRestApi_restApiId - The string identifier of the associated RestApi.

$sel:body:PutRestApi', putRestApi_body - The PUT request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

data RestApi Source #

Represents a REST API.

See: newRestApi smart constructor.

Constructors

RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])

Instances

Instances details

FromJSON RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods parseJSON :: Value -> Parser RestApi # parseJSONList :: Value -> Parser [RestApi] #
Generic RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Associated Types type Rep RestApi :: Type -> Type # Methods from :: RestApi -> Rep RestApi x # to :: Rep RestApi x -> RestApi #
Read RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods readsPrec :: Int -> ReadS RestApi # readList :: ReadS [RestApi] # readPrec :: ReadPrec RestApi # readListPrec :: ReadPrec [RestApi] #
Show RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods showsPrec :: Int -> RestApi -> ShowS # show :: RestApi -> String # showList :: [RestApi] -> ShowS #
NFData RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods rnf :: RestApi -> () #
Eq RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods (==) :: RestApi -> RestApi -> Bool # (/=) :: RestApi -> RestApi -> Bool #
Hashable RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods hashWithSalt :: Int -> RestApi -> Int # hash :: RestApi -> Int #
type Rep RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi type Rep RestApi = D1 ('MetaData "RestApi" "Amazonka.APIGateway.Types.RestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RestApi'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiKeySourceType)) :: (S1 ('MetaSel ('Just "binaryMediaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "minimumCompressionSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newRestApi :: RestApi Source #

Create a value of RestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeySource:RestApi', restApi_apiKeySource - The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

$sel:binaryMediaTypes:RestApi', restApi_binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

$sel:createdDate:RestApi', restApi_createdDate - The timestamp when the API was created.

$sel:description:RestApi', restApi_description - The API's description.

$sel:disableExecuteApiEndpoint:RestApi', restApi_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

$sel:endpointConfiguration:RestApi', restApi_endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

$sel:id:RestApi', restApi_id - The API's identifier. This identifier is unique across all of your APIs in API Gateway.

$sel:minimumCompressionSize:RestApi', restApi_minimumCompressionSize - A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

$sel:name:RestApi', restApi_name - The API's name.

$sel:policy:RestApi', restApi_policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

$sel:tags:RestApi', restApi_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:version:RestApi', restApi_version - A version identifier for the API.

$sel:warnings:RestApi', restApi_warnings - The warning messages reported when failonwarnings is turned on during API import.

TagResource

data TagResource Source #

Adds or updates a tag on a given resource.

See: newTagResource smart constructor.

Constructors

TagResource' Text (HashMap Text Text)

Instances

Instances details

ToJSON TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods toJSON :: TagResource -> Value # toEncoding :: TagResource -> Encoding # toJSONList :: [TagResource] -> Value # toEncodingList :: [TagResource] -> Encoding #
ToHeaders TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods toHeaders :: TagResource -> [Header] #
ToPath TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods toPath :: TagResource -> ByteString #
ToQuery TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods toQuery :: TagResource -> QueryString #
AWSRequest TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Associated Types type AWSResponse TagResource # Methods request :: (Service -> Service) -> TagResource -> Request TagResource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TagResource))) #
Generic TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Associated Types type Rep TagResource :: Type -> Type # Methods from :: TagResource -> Rep TagResource x # to :: Rep TagResource x -> TagResource #
Read TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods readsPrec :: Int -> ReadS TagResource # readList :: ReadS [TagResource] # readPrec :: ReadPrec TagResource # readListPrec :: ReadPrec [TagResource] #
Show TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods showsPrec :: Int -> TagResource -> ShowS # show :: TagResource -> String # showList :: [TagResource] -> ShowS #
NFData TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods rnf :: TagResource -> () #
Eq TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods (==) :: TagResource -> TagResource -> Bool # (/=) :: TagResource -> TagResource -> Bool #
Hashable TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods hashWithSalt :: Int -> TagResource -> Int # hash :: TagResource -> Int #
type AWSResponse TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource type AWSResponse TagResource = TagResourceResponse
type Rep TagResource Source #
Instance details Defined in Amazonka.APIGateway.TagResource type Rep TagResource = D1 ('MetaData "TagResource" "Amazonka.APIGateway.TagResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))

newTagResource Source #

Arguments

:: Text	`$sel:resourceArn:TagResource'`
-> TagResource

Create a value of TagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:TagResource', tagResource_resourceArn - The ARN of a resource that can be tagged.

TagResource, tagResource_tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

data TagResourceResponse Source #

See: newTagResourceResponse smart constructor.

Constructors

TagResourceResponse'

Instances

Instances details

Generic TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Associated Types type Rep TagResourceResponse :: Type -> Type # Methods from :: TagResourceResponse -> Rep TagResourceResponse x # to :: Rep TagResourceResponse x -> TagResourceResponse #
Read TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods readsPrec :: Int -> ReadS TagResourceResponse # readList :: ReadS [TagResourceResponse] # readPrec :: ReadPrec TagResourceResponse # readListPrec :: ReadPrec [TagResourceResponse] #
Show TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods showsPrec :: Int -> TagResourceResponse -> ShowS # show :: TagResourceResponse -> String # showList :: [TagResourceResponse] -> ShowS #
NFData TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods rnf :: TagResourceResponse -> () #
Eq TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource Methods (==) :: TagResourceResponse -> TagResourceResponse -> Bool # (/=) :: TagResourceResponse -> TagResourceResponse -> Bool #
type Rep TagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.TagResource type Rep TagResourceResponse = D1 ('MetaData "TagResourceResponse" "Amazonka.APIGateway.TagResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newTagResourceResponse :: TagResourceResponse Source #

Create a value of TagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

TestInvokeAuthorizer

data TestInvokeAuthorizer Source #

Make a request to simulate the invocation of an Authorizer.

See: newTestInvokeAuthorizer smart constructor.

Constructors

TestInvokeAuthorizer' (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text [Text])) (Maybe Text) (Maybe (HashMap Text Text)) Text Text

Instances

Instances details

ToJSON TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods toJSON :: TestInvokeAuthorizer -> Value # toEncoding :: TestInvokeAuthorizer -> Encoding # toJSONList :: [TestInvokeAuthorizer] -> Value # toEncodingList :: [TestInvokeAuthorizer] -> Encoding #
ToHeaders TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods toHeaders :: TestInvokeAuthorizer -> [Header] #
ToPath TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods toPath :: TestInvokeAuthorizer -> ByteString #
ToQuery TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods toQuery :: TestInvokeAuthorizer -> QueryString #
AWSRequest TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Associated Types type AWSResponse TestInvokeAuthorizer # Methods request :: (Service -> Service) -> TestInvokeAuthorizer -> Request TestInvokeAuthorizer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TestInvokeAuthorizer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestInvokeAuthorizer))) #
Generic TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Associated Types type Rep TestInvokeAuthorizer :: Type -> Type # Methods from :: TestInvokeAuthorizer -> Rep TestInvokeAuthorizer x # to :: Rep TestInvokeAuthorizer x -> TestInvokeAuthorizer #
Read TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods readsPrec :: Int -> ReadS TestInvokeAuthorizer # readList :: ReadS [TestInvokeAuthorizer] # readPrec :: ReadPrec TestInvokeAuthorizer # readListPrec :: ReadPrec [TestInvokeAuthorizer] #
Show TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods showsPrec :: Int -> TestInvokeAuthorizer -> ShowS # show :: TestInvokeAuthorizer -> String # showList :: [TestInvokeAuthorizer] -> ShowS #
NFData TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods rnf :: TestInvokeAuthorizer -> () #
Eq TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods (==) :: TestInvokeAuthorizer -> TestInvokeAuthorizer -> Bool # (/=) :: TestInvokeAuthorizer -> TestInvokeAuthorizer -> Bool #
Hashable TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods hashWithSalt :: Int -> TestInvokeAuthorizer -> Int # hash :: TestInvokeAuthorizer -> Int #
type AWSResponse TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer type AWSResponse TestInvokeAuthorizer = TestInvokeAuthorizerResponse
type Rep TestInvokeAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer type Rep TestInvokeAuthorizer = D1 ('MetaData "TestInvokeAuthorizer" "Amazonka.APIGateway.TestInvokeAuthorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TestInvokeAuthorizer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "additionalContext") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "multiValueHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))))) :: ((S1 ('MetaSel ('Just "pathWithQueryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newTestInvokeAuthorizer Source #

Arguments

:: Text	`TestInvokeAuthorizer`
-> Text	`TestInvokeAuthorizer`
-> TestInvokeAuthorizer

Create a value of TestInvokeAuthorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:additionalContext:TestInvokeAuthorizer', testInvokeAuthorizer_additionalContext - A key-value map of additional context variables.

$sel:body:TestInvokeAuthorizer', testInvokeAuthorizer_body - The simulated request body of an incoming invocation request.

$sel:headers:TestInvokeAuthorizer', testInvokeAuthorizer_headers - A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

$sel:multiValueHeaders:TestInvokeAuthorizer', testInvokeAuthorizer_multiValueHeaders - The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

$sel:pathWithQueryString:TestInvokeAuthorizer', testInvokeAuthorizer_pathWithQueryString - The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

$sel:stageVariables:TestInvokeAuthorizer', testInvokeAuthorizer_stageVariables - A key-value map of stage variables to simulate an invocation on a deployed Stage.

TestInvokeAuthorizer, testInvokeAuthorizer_restApiId - The string identifier of the associated RestApi.

TestInvokeAuthorizer, testInvokeAuthorizer_authorizerId - Specifies a test invoke authorizer request's Authorizer ID.

data TestInvokeAuthorizerResponse Source #

Represents the response of the test invoke request for a custom Authorizer

See: newTestInvokeAuthorizerResponse smart constructor.

Constructors

TestInvokeAuthorizerResponse' (Maybe (HashMap Text [Text])) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) Int

Instances

Instances details

Generic TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Associated Types type Rep TestInvokeAuthorizerResponse :: Type -> Type # Methods from :: TestInvokeAuthorizerResponse -> Rep TestInvokeAuthorizerResponse x # to :: Rep TestInvokeAuthorizerResponse x -> TestInvokeAuthorizerResponse #
Read TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods readsPrec :: Int -> ReadS TestInvokeAuthorizerResponse # readList :: ReadS [TestInvokeAuthorizerResponse] # readPrec :: ReadPrec TestInvokeAuthorizerResponse # readListPrec :: ReadPrec [TestInvokeAuthorizerResponse] #
Show TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods showsPrec :: Int -> TestInvokeAuthorizerResponse -> ShowS # show :: TestInvokeAuthorizerResponse -> String # showList :: [TestInvokeAuthorizerResponse] -> ShowS #
NFData TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods rnf :: TestInvokeAuthorizerResponse -> () #
Eq TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer Methods (==) :: TestInvokeAuthorizerResponse -> TestInvokeAuthorizerResponse -> Bool # (/=) :: TestInvokeAuthorizerResponse -> TestInvokeAuthorizerResponse -> Bool #
type Rep TestInvokeAuthorizerResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeAuthorizer type Rep TestInvokeAuthorizerResponse = D1 ('MetaData "TestInvokeAuthorizerResponse" "Amazonka.APIGateway.TestInvokeAuthorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TestInvokeAuthorizerResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authorization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))) :: S1 ('MetaSel ('Just "claims") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "clientStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "latency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "log") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "principalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newTestInvokeAuthorizerResponse Source #

Arguments

:: Int	`$sel:httpStatus:TestInvokeAuthorizerResponse'`
-> TestInvokeAuthorizerResponse

Create a value of TestInvokeAuthorizerResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authorization:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_authorization - The authorization response.

$sel:claims:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_claims - The open identity claims, with any supported custom attributes, returned from the Cognito Your User Pool configured for the API.

$sel:clientStatus:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_clientStatus - The HTTP status code that the client would have received. Value is 0 if the authorizer succeeded.

$sel:latency:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_latency - The execution latency of the test authorizer request.

$sel:log:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_log - The API Gateway execution log for the test authorizer request.

TestInvokeAuthorizerResponse, testInvokeAuthorizerResponse_policy - The JSON policy document returned by the Authorizer

$sel:principalId:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_principalId - The principal identity returned by the Authorizer

$sel:httpStatus:TestInvokeAuthorizerResponse', testInvokeAuthorizerResponse_httpStatus - The response's http status code.

TestInvokeMethod

data TestInvokeMethod Source #

Make a request to simulate the invocation of a Method.

See: newTestInvokeMethod smart constructor.

Constructors

TestInvokeMethod' (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text [Text])) (Maybe Text) (Maybe (HashMap Text Text)) Text Text Text

Instances

Instances details

ToJSON TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods toJSON :: TestInvokeMethod -> Value # toEncoding :: TestInvokeMethod -> Encoding # toJSONList :: [TestInvokeMethod] -> Value # toEncodingList :: [TestInvokeMethod] -> Encoding #
ToHeaders TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods toHeaders :: TestInvokeMethod -> [Header] #
ToPath TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods toPath :: TestInvokeMethod -> ByteString #
ToQuery TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods toQuery :: TestInvokeMethod -> QueryString #
AWSRequest TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Associated Types type AWSResponse TestInvokeMethod # Methods request :: (Service -> Service) -> TestInvokeMethod -> Request TestInvokeMethod # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy TestInvokeMethod -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse TestInvokeMethod))) #
Generic TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Associated Types type Rep TestInvokeMethod :: Type -> Type # Methods from :: TestInvokeMethod -> Rep TestInvokeMethod x # to :: Rep TestInvokeMethod x -> TestInvokeMethod #
Read TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods readsPrec :: Int -> ReadS TestInvokeMethod # readList :: ReadS [TestInvokeMethod] # readPrec :: ReadPrec TestInvokeMethod # readListPrec :: ReadPrec [TestInvokeMethod] #
Show TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods showsPrec :: Int -> TestInvokeMethod -> ShowS # show :: TestInvokeMethod -> String # showList :: [TestInvokeMethod] -> ShowS #
NFData TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods rnf :: TestInvokeMethod -> () #
Eq TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods (==) :: TestInvokeMethod -> TestInvokeMethod -> Bool # (/=) :: TestInvokeMethod -> TestInvokeMethod -> Bool #
Hashable TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods hashWithSalt :: Int -> TestInvokeMethod -> Int # hash :: TestInvokeMethod -> Int #
type AWSResponse TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod type AWSResponse TestInvokeMethod = TestInvokeMethodResponse
type Rep TestInvokeMethod Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod type Rep TestInvokeMethod = D1 ('MetaData "TestInvokeMethod" "Amazonka.APIGateway.TestInvokeMethod" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TestInvokeMethod'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "multiValueHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text]))))) :: ((S1 ('MetaSel ('Just "pathWithQueryString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stageVariables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newTestInvokeMethod Source #

Arguments

:: Text	`TestInvokeMethod`
-> Text	`$sel:resourceId:TestInvokeMethod'`
-> Text	`TestInvokeMethod`
-> TestInvokeMethod

Create a value of TestInvokeMethod with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TestInvokeMethod, testInvokeMethod_body - The simulated request body of an incoming invocation request.

TestInvokeMethod, testInvokeMethod_clientCertificateId - A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

TestInvokeMethod, testInvokeMethod_headers - A key-value map of headers to simulate an incoming invocation request.

TestInvokeMethod, testInvokeMethod_multiValueHeaders - The headers as a map from string to list of values to simulate an incoming invocation request.

$sel:pathWithQueryString:TestInvokeMethod', testInvokeMethod_pathWithQueryString - The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

$sel:stageVariables:TestInvokeMethod', testInvokeMethod_stageVariables - A key-value map of stage variables to simulate an invocation on a deployed Stage.

TestInvokeMethod, testInvokeMethod_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:TestInvokeMethod', testInvokeMethod_resourceId - Specifies a test invoke method request's resource ID.

TestInvokeMethod, testInvokeMethod_httpMethod - Specifies a test invoke method request's HTTP method.

data TestInvokeMethodResponse Source #

Represents the response of the test invoke request in the HTTP method.

See: newTestInvokeMethodResponse smart constructor.

Constructors

TestInvokeMethodResponse' (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Integer) (Maybe Text) (Maybe (HashMap Text [Text])) (Maybe Int) Int

Instances

Instances details

Generic TestInvokeMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Associated Types type Rep TestInvokeMethodResponse :: Type -> Type # Methods from :: TestInvokeMethodResponse -> Rep TestInvokeMethodResponse x # to :: Rep TestInvokeMethodResponse x -> TestInvokeMethodResponse #
Read TestInvokeMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods readsPrec :: Int -> ReadS TestInvokeMethodResponse # readList :: ReadS [TestInvokeMethodResponse] # readPrec :: ReadPrec TestInvokeMethodResponse # readListPrec :: ReadPrec [TestInvokeMethodResponse] #
Show TestInvokeMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods showsPrec :: Int -> TestInvokeMethodResponse -> ShowS # show :: TestInvokeMethodResponse -> String # showList :: [TestInvokeMethodResponse] -> ShowS #
NFData TestInvokeMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods rnf :: TestInvokeMethodResponse -> () #
Eq TestInvokeMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod Methods (==) :: TestInvokeMethodResponse -> TestInvokeMethodResponse -> Bool # (/=) :: TestInvokeMethodResponse -> TestInvokeMethodResponse -> Bool #
type Rep TestInvokeMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.TestInvokeMethod type Rep TestInvokeMethodResponse = D1 ('MetaData "TestInvokeMethodResponse" "Amazonka.APIGateway.TestInvokeMethod" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TestInvokeMethodResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "headers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "latency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)))) :: ((S1 ('MetaSel ('Just "log") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "multiValueHeaders") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [Text])))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newTestInvokeMethodResponse Source #

Arguments

:: Int	`$sel:httpStatus:TestInvokeMethodResponse'`
-> TestInvokeMethodResponse

Create a value of TestInvokeMethodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

TestInvokeMethod, testInvokeMethodResponse_body - The body of the HTTP response.

TestInvokeMethod, testInvokeMethodResponse_headers - The headers of the HTTP response.

$sel:latency:TestInvokeMethodResponse', testInvokeMethodResponse_latency - The execution latency of the test invoke request.

$sel:log:TestInvokeMethodResponse', testInvokeMethodResponse_log - The API Gateway execution log for the test invoke request.

TestInvokeMethod, testInvokeMethodResponse_multiValueHeaders - The headers of the HTTP response as a map from string to list of values.

TestInvokeMethodResponse, testInvokeMethodResponse_status - The HTTP status code.

$sel:httpStatus:TestInvokeMethodResponse', testInvokeMethodResponse_httpStatus - The response's http status code.

UntagResource

data UntagResource Source #

Removes a tag from a given resource.

See: newUntagResource smart constructor.

Constructors

UntagResource' Text [Text]

Instances

Instances details

ToHeaders UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods toHeaders :: UntagResource -> [Header] #
ToPath UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods toPath :: UntagResource -> ByteString #
ToQuery UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods toQuery :: UntagResource -> QueryString #
AWSRequest UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Associated Types type AWSResponse UntagResource # Methods request :: (Service -> Service) -> UntagResource -> Request UntagResource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UntagResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UntagResource))) #
Generic UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Associated Types type Rep UntagResource :: Type -> Type # Methods from :: UntagResource -> Rep UntagResource x # to :: Rep UntagResource x -> UntagResource #
Read UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods readsPrec :: Int -> ReadS UntagResource # readList :: ReadS [UntagResource] # readPrec :: ReadPrec UntagResource # readListPrec :: ReadPrec [UntagResource] #
Show UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods showsPrec :: Int -> UntagResource -> ShowS # show :: UntagResource -> String # showList :: [UntagResource] -> ShowS #
NFData UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods rnf :: UntagResource -> () #
Eq UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods (==) :: UntagResource -> UntagResource -> Bool # (/=) :: UntagResource -> UntagResource -> Bool #
Hashable UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods hashWithSalt :: Int -> UntagResource -> Int # hash :: UntagResource -> Int #
type AWSResponse UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource type AWSResponse UntagResource = UntagResourceResponse
type Rep UntagResource Source #
Instance details Defined in Amazonka.APIGateway.UntagResource type Rep UntagResource = D1 ('MetaData "UntagResource" "Amazonka.APIGateway.UntagResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UntagResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "tagKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text])))

newUntagResource Source #

Arguments

:: Text	`$sel:resourceArn:UntagResource'`
-> UntagResource

Create a value of UntagResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:UntagResource', untagResource_resourceArn - The ARN of a resource that can be tagged.

$sel:tagKeys:UntagResource', untagResource_tagKeys - The Tag keys to delete.

data UntagResourceResponse Source #

See: newUntagResourceResponse smart constructor.

Constructors

UntagResourceResponse'

Instances

Instances details

Generic UntagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Associated Types type Rep UntagResourceResponse :: Type -> Type # Methods from :: UntagResourceResponse -> Rep UntagResourceResponse x # to :: Rep UntagResourceResponse x -> UntagResourceResponse #
Read UntagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods readsPrec :: Int -> ReadS UntagResourceResponse # readList :: ReadS [UntagResourceResponse] # readPrec :: ReadPrec UntagResourceResponse # readListPrec :: ReadPrec [UntagResourceResponse] #
Show UntagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods showsPrec :: Int -> UntagResourceResponse -> ShowS # show :: UntagResourceResponse -> String # showList :: [UntagResourceResponse] -> ShowS #
NFData UntagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods rnf :: UntagResourceResponse -> () #
Eq UntagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.UntagResource Methods (==) :: UntagResourceResponse -> UntagResourceResponse -> Bool # (/=) :: UntagResourceResponse -> UntagResourceResponse -> Bool #
type Rep UntagResourceResponse Source #
Instance details Defined in Amazonka.APIGateway.UntagResource type Rep UntagResourceResponse = D1 ('MetaData "UntagResourceResponse" "Amazonka.APIGateway.UntagResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UntagResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUntagResourceResponse :: UntagResourceResponse Source #

Create a value of UntagResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

UpdateAccount

data UpdateAccount Source #

Requests API Gateway to change information about the current Account resource.

See: newUpdateAccount smart constructor.

Constructors

UpdateAccount' (Maybe [PatchOperation])

Instances

Instances details

ToJSON UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods toJSON :: UpdateAccount -> Value # toEncoding :: UpdateAccount -> Encoding # toJSONList :: [UpdateAccount] -> Value # toEncodingList :: [UpdateAccount] -> Encoding #
ToHeaders UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods toHeaders :: UpdateAccount -> [Header] #
ToPath UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods toPath :: UpdateAccount -> ByteString #
ToQuery UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods toQuery :: UpdateAccount -> QueryString #
AWSRequest UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Associated Types type AWSResponse UpdateAccount # Methods request :: (Service -> Service) -> UpdateAccount -> Request UpdateAccount # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateAccount -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAccount))) #
Generic UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Associated Types type Rep UpdateAccount :: Type -> Type # Methods from :: UpdateAccount -> Rep UpdateAccount x # to :: Rep UpdateAccount x -> UpdateAccount #
Read UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods readsPrec :: Int -> ReadS UpdateAccount # readList :: ReadS [UpdateAccount] # readPrec :: ReadPrec UpdateAccount # readListPrec :: ReadPrec [UpdateAccount] #
Show UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods showsPrec :: Int -> UpdateAccount -> ShowS # show :: UpdateAccount -> String # showList :: [UpdateAccount] -> ShowS #
NFData UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods rnf :: UpdateAccount -> () #
Eq UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods (==) :: UpdateAccount -> UpdateAccount -> Bool # (/=) :: UpdateAccount -> UpdateAccount -> Bool #
Hashable UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount Methods hashWithSalt :: Int -> UpdateAccount -> Int # hash :: UpdateAccount -> Int #
type AWSResponse UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount type AWSResponse UpdateAccount = Account
type Rep UpdateAccount Source #
Instance details Defined in Amazonka.APIGateway.UpdateAccount type Rep UpdateAccount = D1 ('MetaData "UpdateAccount" "Amazonka.APIGateway.UpdateAccount" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateAccount'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation]))))

newUpdateAccount :: UpdateAccount Source #

Create a value of UpdateAccount with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateAccount', updateAccount_patchOperations - For more information about supported patch operations, see Patch Operations.

data Account Source #

Represents an AWS account that is associated with API Gateway.

See: newAccount smart constructor.

Constructors

Account' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ThrottleSettings)

Instances

Instances details

FromJSON Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods parseJSON :: Value -> Parser Account # parseJSONList :: Value -> Parser [Account] #
Generic Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Associated Types type Rep Account :: Type -> Type # Methods from :: Account -> Rep Account x # to :: Rep Account x -> Account #
Read Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods readsPrec :: Int -> ReadS Account # readList :: ReadS [Account] # readPrec :: ReadPrec Account # readListPrec :: ReadPrec [Account] #
Show Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #
NFData Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods rnf :: Account -> () #
Eq Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods (==) :: Account -> Account -> Bool # (/=) :: Account -> Account -> Bool #
Hashable Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods hashWithSalt :: Int -> Account -> Int # hash :: Account -> Int #
type Rep Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account type Rep Account = D1 ('MetaData "Account" "Amazonka.APIGateway.Types.Account" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Account'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiKeyVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cloudwatchRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "features") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "throttleSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings)))))

newAccount :: Account Source #

Create a value of Account with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyVersion:Account', account_apiKeyVersion - The version of the API keys used for the account.

$sel:cloudwatchRoleArn:Account', account_cloudwatchRoleArn - The ARN of an Amazon CloudWatch role for the current Account.

$sel:features:Account', account_features - A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

$sel:throttleSettings:Account', account_throttleSettings - Specifies the API request limits configured for the current Account.

UpdateApiKey

data UpdateApiKey Source #

A request to change information about an ApiKey resource.

See: newUpdateApiKey smart constructor.

Constructors

UpdateApiKey' (Maybe [PatchOperation]) Text

Instances

Instances details

ToJSON UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods toJSON :: UpdateApiKey -> Value # toEncoding :: UpdateApiKey -> Encoding # toJSONList :: [UpdateApiKey] -> Value # toEncodingList :: [UpdateApiKey] -> Encoding #
ToHeaders UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods toHeaders :: UpdateApiKey -> [Header] #
ToPath UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods toPath :: UpdateApiKey -> ByteString #
ToQuery UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods toQuery :: UpdateApiKey -> QueryString #
AWSRequest UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Associated Types type AWSResponse UpdateApiKey # Methods request :: (Service -> Service) -> UpdateApiKey -> Request UpdateApiKey # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateApiKey -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateApiKey))) #
Generic UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Associated Types type Rep UpdateApiKey :: Type -> Type # Methods from :: UpdateApiKey -> Rep UpdateApiKey x # to :: Rep UpdateApiKey x -> UpdateApiKey #
Read UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods readsPrec :: Int -> ReadS UpdateApiKey # readList :: ReadS [UpdateApiKey] # readPrec :: ReadPrec UpdateApiKey # readListPrec :: ReadPrec [UpdateApiKey] #
Show UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods showsPrec :: Int -> UpdateApiKey -> ShowS # show :: UpdateApiKey -> String # showList :: [UpdateApiKey] -> ShowS #
NFData UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods rnf :: UpdateApiKey -> () #
Eq UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods (==) :: UpdateApiKey -> UpdateApiKey -> Bool # (/=) :: UpdateApiKey -> UpdateApiKey -> Bool #
Hashable UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey Methods hashWithSalt :: Int -> UpdateApiKey -> Int # hash :: UpdateApiKey -> Int #
type AWSResponse UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey type AWSResponse UpdateApiKey = ApiKey
type Rep UpdateApiKey Source #
Instance details Defined in Amazonka.APIGateway.UpdateApiKey type Rep UpdateApiKey = D1 ('MetaData "UpdateApiKey" "Amazonka.APIGateway.UpdateApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateApiKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "apiKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateApiKey Source #

Arguments

:: Text	`$sel:apiKey:UpdateApiKey'`
-> UpdateApiKey

Create a value of UpdateApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateApiKey', updateApiKey_patchOperations - For more information about supported patch operations, see Patch Operations.

$sel:apiKey:UpdateApiKey', updateApiKey_apiKey - The identifier of the ApiKey resource to be updated.

data ApiKey Source #

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See: newApiKey smart constructor.

Constructors

ApiKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text)

Instances

Instances details

FromJSON ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods parseJSON :: Value -> Parser ApiKey # parseJSONList :: Value -> Parser [ApiKey] #
Generic ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Associated Types type Rep ApiKey :: Type -> Type # Methods from :: ApiKey -> Rep ApiKey x # to :: Rep ApiKey x -> ApiKey #
Read ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods readsPrec :: Int -> ReadS ApiKey # readList :: ReadS [ApiKey] # readPrec :: ReadPrec ApiKey # readListPrec :: ReadPrec [ApiKey] #
Show ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods showsPrec :: Int -> ApiKey -> ShowS # show :: ApiKey -> String # showList :: [ApiKey] -> ShowS #
NFData ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods rnf :: ApiKey -> () #
Eq ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods (==) :: ApiKey -> ApiKey -> Bool # (/=) :: ApiKey -> ApiKey -> Bool #
Hashable ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods hashWithSalt :: Int -> ApiKey -> Int # hash :: ApiKey -> Int #
type Rep ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newApiKey :: ApiKey Source #

Create a value of ApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

$sel:customerId:ApiKey', apiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

$sel:description:ApiKey', apiKey_description - The description of the API Key.

$sel:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

$sel:id:ApiKey', apiKey_id - The identifier of the API Key.

$sel:lastUpdatedDate:ApiKey', apiKey_lastUpdatedDate - The timestamp when the API Key was last updated.

$sel:name:ApiKey', apiKey_name - The name of the API Key.

$sel:stageKeys:ApiKey', apiKey_stageKeys - A list of Stage resources that are associated with the ApiKey resource.

$sel:tags:ApiKey', apiKey_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:value:ApiKey', apiKey_value - The value of the API Key.

UpdateAuthorizer

data UpdateAuthorizer Source #

Request to update an existing Authorizer resource.

See: newUpdateAuthorizer smart constructor.

Constructors

UpdateAuthorizer' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Methods toJSON :: UpdateAuthorizer -> Value # toEncoding :: UpdateAuthorizer -> Encoding # toJSONList :: [UpdateAuthorizer] -> Value # toEncodingList :: [UpdateAuthorizer] -> Encoding #
ToHeaders UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Methods toHeaders :: UpdateAuthorizer -> [Header] #
ToPath UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Methods toPath :: UpdateAuthorizer -> ByteString #
ToQuery UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Methods toQuery :: UpdateAuthorizer -> QueryString #
AWSRequest UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Associated Types type AWSResponse UpdateAuthorizer # Methods request :: (Service -> Service) -> UpdateAuthorizer -> Request UpdateAuthorizer # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateAuthorizer -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateAuthorizer))) #
Generic UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Associated Types type Rep UpdateAuthorizer :: Type -> Type # Methods from :: UpdateAuthorizer -> Rep UpdateAuthorizer x # to :: Rep UpdateAuthorizer x -> UpdateAuthorizer #
Read UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Methods readsPrec :: Int -> ReadS UpdateAuthorizer # readList :: ReadS [UpdateAuthorizer] # readPrec :: ReadPrec UpdateAuthorizer # readListPrec :: ReadPrec [UpdateAuthorizer] #
Show UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Methods showsPrec :: Int -> UpdateAuthorizer -> ShowS # show :: UpdateAuthorizer -> String # showList :: [UpdateAuthorizer] -> ShowS #
NFData UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Methods rnf :: UpdateAuthorizer -> () #
Eq UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Methods (==) :: UpdateAuthorizer -> UpdateAuthorizer -> Bool # (/=) :: UpdateAuthorizer -> UpdateAuthorizer -> Bool #
Hashable UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer Methods hashWithSalt :: Int -> UpdateAuthorizer -> Int # hash :: UpdateAuthorizer -> Int #
type AWSResponse UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer type AWSResponse UpdateAuthorizer = Authorizer
type Rep UpdateAuthorizer Source #
Instance details Defined in Amazonka.APIGateway.UpdateAuthorizer type Rep UpdateAuthorizer = D1 ('MetaData "UpdateAuthorizer" "Amazonka.APIGateway.UpdateAuthorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateAuthorizer'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateAuthorizer Source #

Arguments

:: Text	`UpdateAuthorizer`
-> Text	`UpdateAuthorizer`
-> UpdateAuthorizer

Create a value of UpdateAuthorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateAuthorizer', updateAuthorizer_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateAuthorizer, updateAuthorizer_restApiId - The string identifier of the associated RestApi.

UpdateAuthorizer, updateAuthorizer_authorizerId - The identifier of the Authorizer resource.

data Authorizer Source #

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

See: newAuthorizer smart constructor.

Constructors

Authorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe AuthorizerType)

Instances

Instances details

FromJSON Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods parseJSON :: Value -> Parser Authorizer # parseJSONList :: Value -> Parser [Authorizer] #
Generic Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Associated Types type Rep Authorizer :: Type -> Type # Methods from :: Authorizer -> Rep Authorizer x # to :: Rep Authorizer x -> Authorizer #
Read Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods readsPrec :: Int -> ReadS Authorizer # readList :: ReadS [Authorizer] # readPrec :: ReadPrec Authorizer # readListPrec :: ReadPrec [Authorizer] #
Show Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods showsPrec :: Int -> Authorizer -> ShowS # show :: Authorizer -> String # showList :: [Authorizer] -> ShowS #
NFData Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods rnf :: Authorizer -> () #
Eq Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods (==) :: Authorizer -> Authorizer -> Bool # (/=) :: Authorizer -> Authorizer -> Bool #
Hashable Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods hashWithSalt :: Int -> Authorizer -> Int # hash :: Authorizer -> Int #
type Rep Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer type Rep Authorizer = D1 ('MetaData "Authorizer" "Amazonka.APIGateway.Types.Authorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Authorizer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorizerCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "authorizerResultTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "authorizerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "identitySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityValidationExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "providerARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerType)))))))

newAuthorizer :: Authorizer Source #

Create a value of Authorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authType:Authorizer', authorizer_authType - Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

$sel:authorizerCredentials:Authorizer', authorizer_authorizerCredentials - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

$sel:authorizerResultTtlInSeconds:Authorizer', authorizer_authorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

$sel:authorizerUri:Authorizer', authorizer_authorizerUri - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

$sel:id:Authorizer', authorizer_id - The identifier for the authorizer resource.

$sel:identitySource:Authorizer', authorizer_identitySource - The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

$sel:identityValidationExpression:Authorizer', authorizer_identityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

$sel:name:Authorizer', authorizer_name - The name of the authorizer.

$sel:providerARNs:Authorizer', authorizer_providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

$sel:type':Authorizer', authorizer_type - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

UpdateBasePathMapping

data UpdateBasePathMapping Source #

A request to change information about the BasePathMapping resource.

See: newUpdateBasePathMapping smart constructor.

Constructors

UpdateBasePathMapping' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Methods toJSON :: UpdateBasePathMapping -> Value # toEncoding :: UpdateBasePathMapping -> Encoding # toJSONList :: [UpdateBasePathMapping] -> Value # toEncodingList :: [UpdateBasePathMapping] -> Encoding #
ToHeaders UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Methods toHeaders :: UpdateBasePathMapping -> [Header] #
ToPath UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Methods toPath :: UpdateBasePathMapping -> ByteString #
ToQuery UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Methods toQuery :: UpdateBasePathMapping -> QueryString #
AWSRequest UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Associated Types type AWSResponse UpdateBasePathMapping # Methods request :: (Service -> Service) -> UpdateBasePathMapping -> Request UpdateBasePathMapping # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateBasePathMapping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateBasePathMapping))) #
Generic UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Associated Types type Rep UpdateBasePathMapping :: Type -> Type # Methods from :: UpdateBasePathMapping -> Rep UpdateBasePathMapping x # to :: Rep UpdateBasePathMapping x -> UpdateBasePathMapping #
Read UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Methods readsPrec :: Int -> ReadS UpdateBasePathMapping # readList :: ReadS [UpdateBasePathMapping] # readPrec :: ReadPrec UpdateBasePathMapping # readListPrec :: ReadPrec [UpdateBasePathMapping] #
Show UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Methods showsPrec :: Int -> UpdateBasePathMapping -> ShowS # show :: UpdateBasePathMapping -> String # showList :: [UpdateBasePathMapping] -> ShowS #
NFData UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Methods rnf :: UpdateBasePathMapping -> () #
Eq UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Methods (==) :: UpdateBasePathMapping -> UpdateBasePathMapping -> Bool # (/=) :: UpdateBasePathMapping -> UpdateBasePathMapping -> Bool #
Hashable UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping Methods hashWithSalt :: Int -> UpdateBasePathMapping -> Int # hash :: UpdateBasePathMapping -> Int #
type AWSResponse UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping type AWSResponse UpdateBasePathMapping = BasePathMapping
type Rep UpdateBasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.UpdateBasePathMapping type Rep UpdateBasePathMapping = D1 ('MetaData "UpdateBasePathMapping" "Amazonka.APIGateway.UpdateBasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateBasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateBasePathMapping Source #

Arguments

:: Text	`UpdateBasePathMapping`
-> Text	`UpdateBasePathMapping`
-> UpdateBasePathMapping

Create a value of UpdateBasePathMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateBasePathMapping', updateBasePathMapping_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateBasePathMapping, updateBasePathMapping_domainName - The domain name of the BasePathMapping resource to change.

UpdateBasePathMapping, updateBasePathMapping_basePath - The base path of the BasePathMapping resource to change.

To specify an empty base path, set this parameter to '(none)'.

data BasePathMapping Source #

Represents the base path that callers of the API must provide as part of the URL after the domain name.

See: newBasePathMapping smart constructor.

Constructors

BasePathMapping' (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods parseJSON :: Value -> Parser BasePathMapping # parseJSONList :: Value -> Parser [BasePathMapping] #
Generic BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Associated Types type Rep BasePathMapping :: Type -> Type # Methods from :: BasePathMapping -> Rep BasePathMapping x # to :: Rep BasePathMapping x -> BasePathMapping #
Read BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods readsPrec :: Int -> ReadS BasePathMapping # readList :: ReadS [BasePathMapping] # readPrec :: ReadPrec BasePathMapping # readListPrec :: ReadPrec [BasePathMapping] #
Show BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods showsPrec :: Int -> BasePathMapping -> ShowS # show :: BasePathMapping -> String # showList :: [BasePathMapping] -> ShowS #
NFData BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods rnf :: BasePathMapping -> () #
Eq BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods (==) :: BasePathMapping -> BasePathMapping -> Bool # (/=) :: BasePathMapping -> BasePathMapping -> Bool #
Hashable BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods hashWithSalt :: Int -> BasePathMapping -> Int # hash :: BasePathMapping -> Int #
type Rep BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping type Rep BasePathMapping = D1 ('MetaData "BasePathMapping" "Amazonka.APIGateway.Types.BasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "BasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBasePathMapping :: BasePathMapping Source #

Create a value of BasePathMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:basePath:BasePathMapping', basePathMapping_basePath - The base path name that callers of the API must provide as part of the URL after the domain name.

$sel:restApiId:BasePathMapping', basePathMapping_restApiId - The string identifier of the associated RestApi.

$sel:stage:BasePathMapping', basePathMapping_stage - The name of the associated stage.

UpdateClientCertificate

data UpdateClientCertificate Source #

A request to change information about an ClientCertificate resource.

See: newUpdateClientCertificate smart constructor.

Constructors

UpdateClientCertificate' (Maybe [PatchOperation]) Text

Instances

Instances details

ToJSON UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods toJSON :: UpdateClientCertificate -> Value # toEncoding :: UpdateClientCertificate -> Encoding # toJSONList :: [UpdateClientCertificate] -> Value # toEncodingList :: [UpdateClientCertificate] -> Encoding #
ToHeaders UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods toHeaders :: UpdateClientCertificate -> [Header] #
ToPath UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods toPath :: UpdateClientCertificate -> ByteString #
ToQuery UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods toQuery :: UpdateClientCertificate -> QueryString #
AWSRequest UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Associated Types type AWSResponse UpdateClientCertificate # Methods request :: (Service -> Service) -> UpdateClientCertificate -> Request UpdateClientCertificate # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateClientCertificate -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateClientCertificate))) #
Generic UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Associated Types type Rep UpdateClientCertificate :: Type -> Type # Methods from :: UpdateClientCertificate -> Rep UpdateClientCertificate x # to :: Rep UpdateClientCertificate x -> UpdateClientCertificate #
Read UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods readsPrec :: Int -> ReadS UpdateClientCertificate # readList :: ReadS [UpdateClientCertificate] # readPrec :: ReadPrec UpdateClientCertificate # readListPrec :: ReadPrec [UpdateClientCertificate] #
Show UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods showsPrec :: Int -> UpdateClientCertificate -> ShowS # show :: UpdateClientCertificate -> String # showList :: [UpdateClientCertificate] -> ShowS #
NFData UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods rnf :: UpdateClientCertificate -> () #
Eq UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods (==) :: UpdateClientCertificate -> UpdateClientCertificate -> Bool # (/=) :: UpdateClientCertificate -> UpdateClientCertificate -> Bool #
Hashable UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate Methods hashWithSalt :: Int -> UpdateClientCertificate -> Int # hash :: UpdateClientCertificate -> Int #
type AWSResponse UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate type AWSResponse UpdateClientCertificate = ClientCertificate
type Rep UpdateClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.UpdateClientCertificate type Rep UpdateClientCertificate = D1 ('MetaData "UpdateClientCertificate" "Amazonka.APIGateway.UpdateClientCertificate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateClientCertificate'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateClientCertificate Source #

Arguments

:: Text	`UpdateClientCertificate`
-> UpdateClientCertificate

Create a value of UpdateClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateClientCertificate', updateClientCertificate_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateClientCertificate, updateClientCertificate_clientCertificateId - The identifier of the ClientCertificate resource to be updated.

data ClientCertificate Source #

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

See: newClientCertificate smart constructor.

Constructors

ClientCertificate' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text))

Instances

Instances details

FromJSON ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods parseJSON :: Value -> Parser ClientCertificate # parseJSONList :: Value -> Parser [ClientCertificate] #
Generic ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Associated Types type Rep ClientCertificate :: Type -> Type # Methods from :: ClientCertificate -> Rep ClientCertificate x # to :: Rep ClientCertificate x -> ClientCertificate #
Read ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods readsPrec :: Int -> ReadS ClientCertificate # readList :: ReadS [ClientCertificate] # readPrec :: ReadPrec ClientCertificate # readListPrec :: ReadPrec [ClientCertificate] #
Show ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods showsPrec :: Int -> ClientCertificate -> ShowS # show :: ClientCertificate -> String # showList :: [ClientCertificate] -> ShowS #
NFData ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods rnf :: ClientCertificate -> () #
Eq ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods (==) :: ClientCertificate -> ClientCertificate -> Bool # (/=) :: ClientCertificate -> ClientCertificate -> Bool #
Hashable ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods hashWithSalt :: Int -> ClientCertificate -> Int # hash :: ClientCertificate -> Int #
type Rep ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate type Rep ClientCertificate = D1 ('MetaData "ClientCertificate" "Amazonka.APIGateway.Types.ClientCertificate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ClientCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "pemEncodedCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newClientCertificate :: ClientCertificate Source #

Create a value of ClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientCertificateId:ClientCertificate', clientCertificate_clientCertificateId - The identifier of the client certificate.

$sel:createdDate:ClientCertificate', clientCertificate_createdDate - The timestamp when the client certificate was created.

$sel:description:ClientCertificate', clientCertificate_description - The description of the client certificate.

$sel:expirationDate:ClientCertificate', clientCertificate_expirationDate - The timestamp when the client certificate will expire.

$sel:pemEncodedCertificate:ClientCertificate', clientCertificate_pemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

$sel:tags:ClientCertificate', clientCertificate_tags - The collection of tags. Each tag element is associated with a given resource.

UpdateDeployment

data UpdateDeployment Source #

Requests API Gateway to change information about a Deployment resource.

See: newUpdateDeployment smart constructor.

Constructors

UpdateDeployment' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods toJSON :: UpdateDeployment -> Value # toEncoding :: UpdateDeployment -> Encoding # toJSONList :: [UpdateDeployment] -> Value # toEncodingList :: [UpdateDeployment] -> Encoding #
ToHeaders UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods toHeaders :: UpdateDeployment -> [Header] #
ToPath UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods toPath :: UpdateDeployment -> ByteString #
ToQuery UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods toQuery :: UpdateDeployment -> QueryString #
AWSRequest UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Associated Types type AWSResponse UpdateDeployment # Methods request :: (Service -> Service) -> UpdateDeployment -> Request UpdateDeployment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDeployment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDeployment))) #
Generic UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Associated Types type Rep UpdateDeployment :: Type -> Type # Methods from :: UpdateDeployment -> Rep UpdateDeployment x # to :: Rep UpdateDeployment x -> UpdateDeployment #
Read UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods readsPrec :: Int -> ReadS UpdateDeployment # readList :: ReadS [UpdateDeployment] # readPrec :: ReadPrec UpdateDeployment # readListPrec :: ReadPrec [UpdateDeployment] #
Show UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods showsPrec :: Int -> UpdateDeployment -> ShowS # show :: UpdateDeployment -> String # showList :: [UpdateDeployment] -> ShowS #
NFData UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods rnf :: UpdateDeployment -> () #
Eq UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods (==) :: UpdateDeployment -> UpdateDeployment -> Bool # (/=) :: UpdateDeployment -> UpdateDeployment -> Bool #
Hashable UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment Methods hashWithSalt :: Int -> UpdateDeployment -> Int # hash :: UpdateDeployment -> Int #
type AWSResponse UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment type AWSResponse UpdateDeployment = Deployment
type Rep UpdateDeployment Source #
Instance details Defined in Amazonka.APIGateway.UpdateDeployment type Rep UpdateDeployment = D1 ('MetaData "UpdateDeployment" "Amazonka.APIGateway.UpdateDeployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateDeployment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateDeployment Source #

Arguments

:: Text	`UpdateDeployment`
-> Text	`UpdateDeployment`
-> UpdateDeployment

Create a value of UpdateDeployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateDeployment', updateDeployment_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateDeployment, updateDeployment_restApiId - The string identifier of the associated RestApi.

UpdateDeployment, updateDeployment_deploymentId - The replacement identifier for the Deployment resource to change information about.

data Deployment Source #

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

See: newDeployment smart constructor.

Constructors

Deployment' (Maybe (HashMap Text (HashMap Text MethodSnapshot))) (Maybe POSIX) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods parseJSON :: Value -> Parser Deployment # parseJSONList :: Value -> Parser [Deployment] #
Generic Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Associated Types type Rep Deployment :: Type -> Type # Methods from :: Deployment -> Rep Deployment x # to :: Rep Deployment x -> Deployment #
Read Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods readsPrec :: Int -> ReadS Deployment # readList :: ReadS [Deployment] # readPrec :: ReadPrec Deployment # readListPrec :: ReadPrec [Deployment] #
Show Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods showsPrec :: Int -> Deployment -> ShowS # show :: Deployment -> String # showList :: [Deployment] -> ShowS #
NFData Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods rnf :: Deployment -> () #
Eq Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods (==) :: Deployment -> Deployment -> Bool # (/=) :: Deployment -> Deployment -> Bool #
Hashable Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods hashWithSalt :: Int -> Deployment -> Int # hash :: Deployment -> Int #
type Rep Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.APIGateway.Types.Deployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text MethodSnapshot)))) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDeployment :: Deployment Source #

Create a value of Deployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiSummary:Deployment', deployment_apiSummary - A summary of the RestApi at the date and time that the deployment resource was created.

$sel:createdDate:Deployment', deployment_createdDate - The date and time that the deployment resource was created.

$sel:description:Deployment', deployment_description - The description for the deployment resource.

$sel:id:Deployment', deployment_id - The identifier for the deployment resource.

UpdateDocumentationPart

data UpdateDocumentationPart Source #

Updates an existing documentation part of a given API.

See: newUpdateDocumentationPart smart constructor.

Constructors

UpdateDocumentationPart' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Methods toJSON :: UpdateDocumentationPart -> Value # toEncoding :: UpdateDocumentationPart -> Encoding # toJSONList :: [UpdateDocumentationPart] -> Value # toEncodingList :: [UpdateDocumentationPart] -> Encoding #
ToHeaders UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Methods toHeaders :: UpdateDocumentationPart -> [Header] #
ToPath UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Methods toPath :: UpdateDocumentationPart -> ByteString #
ToQuery UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Methods toQuery :: UpdateDocumentationPart -> QueryString #
AWSRequest UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Associated Types type AWSResponse UpdateDocumentationPart # Methods request :: (Service -> Service) -> UpdateDocumentationPart -> Request UpdateDocumentationPart # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDocumentationPart -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDocumentationPart))) #
Generic UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Associated Types type Rep UpdateDocumentationPart :: Type -> Type # Methods from :: UpdateDocumentationPart -> Rep UpdateDocumentationPart x # to :: Rep UpdateDocumentationPart x -> UpdateDocumentationPart #
Read UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Methods readsPrec :: Int -> ReadS UpdateDocumentationPart # readList :: ReadS [UpdateDocumentationPart] # readPrec :: ReadPrec UpdateDocumentationPart # readListPrec :: ReadPrec [UpdateDocumentationPart] #
Show UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Methods showsPrec :: Int -> UpdateDocumentationPart -> ShowS # show :: UpdateDocumentationPart -> String # showList :: [UpdateDocumentationPart] -> ShowS #
NFData UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Methods rnf :: UpdateDocumentationPart -> () #
Eq UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Methods (==) :: UpdateDocumentationPart -> UpdateDocumentationPart -> Bool # (/=) :: UpdateDocumentationPart -> UpdateDocumentationPart -> Bool #
Hashable UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart Methods hashWithSalt :: Int -> UpdateDocumentationPart -> Int # hash :: UpdateDocumentationPart -> Int #
type AWSResponse UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart type AWSResponse UpdateDocumentationPart = DocumentationPart
type Rep UpdateDocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationPart type Rep UpdateDocumentationPart = D1 ('MetaData "UpdateDocumentationPart" "Amazonka.APIGateway.UpdateDocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateDocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "documentationPartId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateDocumentationPart Source #

Arguments

:: Text	`UpdateDocumentationPart`
-> Text	`$sel:documentationPartId:UpdateDocumentationPart'`
-> UpdateDocumentationPart

Create a value of UpdateDocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateDocumentationPart', updateDocumentationPart_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateDocumentationPart, updateDocumentationPart_restApiId - The string identifier of the associated RestApi.

$sel:documentationPartId:UpdateDocumentationPart', updateDocumentationPart_documentationPartId - The identifier of the to-be-updated documentation part.

data DocumentationPart Source #

A documentation part for a targeted API entity.

See: newDocumentationPart smart constructor.

Constructors

DocumentationPart' (Maybe Text) (Maybe DocumentationPartLocation) (Maybe Text)

Instances

Instances details

FromJSON DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods parseJSON :: Value -> Parser DocumentationPart # parseJSONList :: Value -> Parser [DocumentationPart] #
Generic DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Associated Types type Rep DocumentationPart :: Type -> Type # Methods from :: DocumentationPart -> Rep DocumentationPart x # to :: Rep DocumentationPart x -> DocumentationPart #
Read DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods readsPrec :: Int -> ReadS DocumentationPart # readList :: ReadS [DocumentationPart] # readPrec :: ReadPrec DocumentationPart # readListPrec :: ReadPrec [DocumentationPart] #
Show DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods showsPrec :: Int -> DocumentationPart -> ShowS # show :: DocumentationPart -> String # showList :: [DocumentationPart] -> ShowS #
NFData DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods rnf :: DocumentationPart -> () #
Eq DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods (==) :: DocumentationPart -> DocumentationPart -> Bool # (/=) :: DocumentationPart -> DocumentationPart -> Bool #
Hashable DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods hashWithSalt :: Int -> DocumentationPart -> Int # hash :: DocumentationPart -> Int #
type Rep DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart type Rep DocumentationPart = D1 ('MetaData "DocumentationPart" "Amazonka.APIGateway.Types.DocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentationPartLocation)) :: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationPart :: DocumentationPart Source #

Create a value of DocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:DocumentationPart', documentationPart_id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

$sel:location:DocumentationPart', documentationPart_location - The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

$sel:properties:DocumentationPart', documentationPart_properties - A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

UpdateDocumentationVersion

data UpdateDocumentationVersion Source #

Updates an existing documentation version of an API.

See: newUpdateDocumentationVersion smart constructor.

Constructors

UpdateDocumentationVersion' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods toJSON :: UpdateDocumentationVersion -> Value # toEncoding :: UpdateDocumentationVersion -> Encoding # toJSONList :: [UpdateDocumentationVersion] -> Value # toEncodingList :: [UpdateDocumentationVersion] -> Encoding #
ToHeaders UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods toHeaders :: UpdateDocumentationVersion -> [Header] #
ToPath UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods toPath :: UpdateDocumentationVersion -> ByteString #
ToQuery UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods toQuery :: UpdateDocumentationVersion -> QueryString #
AWSRequest UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Associated Types type AWSResponse UpdateDocumentationVersion # Methods request :: (Service -> Service) -> UpdateDocumentationVersion -> Request UpdateDocumentationVersion # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDocumentationVersion -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDocumentationVersion))) #
Generic UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Associated Types type Rep UpdateDocumentationVersion :: Type -> Type # Methods from :: UpdateDocumentationVersion -> Rep UpdateDocumentationVersion x # to :: Rep UpdateDocumentationVersion x -> UpdateDocumentationVersion #
Read UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods readsPrec :: Int -> ReadS UpdateDocumentationVersion # readList :: ReadS [UpdateDocumentationVersion] # readPrec :: ReadPrec UpdateDocumentationVersion # readListPrec :: ReadPrec [UpdateDocumentationVersion] #
Show UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods showsPrec :: Int -> UpdateDocumentationVersion -> ShowS # show :: UpdateDocumentationVersion -> String # showList :: [UpdateDocumentationVersion] -> ShowS #
NFData UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods rnf :: UpdateDocumentationVersion -> () #
Eq UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods (==) :: UpdateDocumentationVersion -> UpdateDocumentationVersion -> Bool # (/=) :: UpdateDocumentationVersion -> UpdateDocumentationVersion -> Bool #
Hashable UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion Methods hashWithSalt :: Int -> UpdateDocumentationVersion -> Int # hash :: UpdateDocumentationVersion -> Int #
type AWSResponse UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion type AWSResponse UpdateDocumentationVersion = DocumentationVersion
type Rep UpdateDocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.UpdateDocumentationVersion type Rep UpdateDocumentationVersion = D1 ('MetaData "UpdateDocumentationVersion" "Amazonka.APIGateway.UpdateDocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateDocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateDocumentationVersion Source #

Arguments

:: Text	`UpdateDocumentationVersion`
-> Text	`UpdateDocumentationVersion`
-> UpdateDocumentationVersion

Create a value of UpdateDocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateDocumentationVersion', updateDocumentationVersion_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateDocumentationVersion, updateDocumentationVersion_restApiId - The string identifier of the associated RestApi..

UpdateDocumentationVersion, updateDocumentationVersion_documentationVersion - The version identifier of the to-be-updated documentation version.

data DocumentationVersion Source #

A snapshot of the documentation of an API.

See: newDocumentationVersion smart constructor.

Constructors

DocumentationVersion' (Maybe POSIX) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods parseJSON :: Value -> Parser DocumentationVersion # parseJSONList :: Value -> Parser [DocumentationVersion] #
Generic DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Associated Types type Rep DocumentationVersion :: Type -> Type # Methods from :: DocumentationVersion -> Rep DocumentationVersion x # to :: Rep DocumentationVersion x -> DocumentationVersion #
Read DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods readsPrec :: Int -> ReadS DocumentationVersion # readList :: ReadS [DocumentationVersion] # readPrec :: ReadPrec DocumentationVersion # readListPrec :: ReadPrec [DocumentationVersion] #
Show DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods showsPrec :: Int -> DocumentationVersion -> ShowS # show :: DocumentationVersion -> String # showList :: [DocumentationVersion] -> ShowS #
NFData DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods rnf :: DocumentationVersion -> () #
Eq DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods (==) :: DocumentationVersion -> DocumentationVersion -> Bool # (/=) :: DocumentationVersion -> DocumentationVersion -> Bool #
Hashable DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods hashWithSalt :: Int -> DocumentationVersion -> Int # hash :: DocumentationVersion -> Int #
type Rep DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion type Rep DocumentationVersion = D1 ('MetaData "DocumentationVersion" "Amazonka.APIGateway.Types.DocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationVersion :: DocumentationVersion Source #

Create a value of DocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdDate:DocumentationVersion', documentationVersion_createdDate - The date when the API documentation snapshot is created.

$sel:description:DocumentationVersion', documentationVersion_description - The description of the API documentation snapshot.

$sel:version:DocumentationVersion', documentationVersion_version - The version identifier of the API documentation snapshot.

UpdateDomainName

data UpdateDomainName Source #

A request to change information about the DomainName resource.

See: newUpdateDomainName smart constructor.

Constructors

UpdateDomainName' (Maybe [PatchOperation]) Text

Instances

Instances details

ToJSON UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods toJSON :: UpdateDomainName -> Value # toEncoding :: UpdateDomainName -> Encoding # toJSONList :: [UpdateDomainName] -> Value # toEncodingList :: [UpdateDomainName] -> Encoding #
ToHeaders UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods toHeaders :: UpdateDomainName -> [Header] #
ToPath UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods toPath :: UpdateDomainName -> ByteString #
ToQuery UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods toQuery :: UpdateDomainName -> QueryString #
AWSRequest UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Associated Types type AWSResponse UpdateDomainName # Methods request :: (Service -> Service) -> UpdateDomainName -> Request UpdateDomainName # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateDomainName -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateDomainName))) #
Generic UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Associated Types type Rep UpdateDomainName :: Type -> Type # Methods from :: UpdateDomainName -> Rep UpdateDomainName x # to :: Rep UpdateDomainName x -> UpdateDomainName #
Read UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods readsPrec :: Int -> ReadS UpdateDomainName # readList :: ReadS [UpdateDomainName] # readPrec :: ReadPrec UpdateDomainName # readListPrec :: ReadPrec [UpdateDomainName] #
Show UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods showsPrec :: Int -> UpdateDomainName -> ShowS # show :: UpdateDomainName -> String # showList :: [UpdateDomainName] -> ShowS #
NFData UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods rnf :: UpdateDomainName -> () #
Eq UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods (==) :: UpdateDomainName -> UpdateDomainName -> Bool # (/=) :: UpdateDomainName -> UpdateDomainName -> Bool #
Hashable UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName Methods hashWithSalt :: Int -> UpdateDomainName -> Int # hash :: UpdateDomainName -> Int #
type AWSResponse UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName type AWSResponse UpdateDomainName = DomainName
type Rep UpdateDomainName Source #
Instance details Defined in Amazonka.APIGateway.UpdateDomainName type Rep UpdateDomainName = D1 ('MetaData "UpdateDomainName" "Amazonka.APIGateway.UpdateDomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateDomainName'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateDomainName Source #

Arguments

:: Text	`UpdateDomainName`
-> UpdateDomainName

Create a value of UpdateDomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateDomainName', updateDomainName_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateDomainName, updateDomainName_domainName - The name of the DomainName resource to be changed.

data DomainName Source #

Represents a custom domain name as a user-friendly host name of an API (RestApi).

See: newDomainName smart constructor.

Constructors

DomainName' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text))

Instances

Instances details

FromJSON DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods parseJSON :: Value -> Parser DomainName # parseJSONList :: Value -> Parser [DomainName] #
Generic DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Associated Types type Rep DomainName :: Type -> Type # Methods from :: DomainName -> Rep DomainName x # to :: Rep DomainName x -> DomainName #
Read DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods readsPrec :: Int -> ReadS DomainName # readList :: ReadS [DomainName] # readPrec :: ReadPrec DomainName # readListPrec :: ReadPrec [DomainName] #
Show DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods showsPrec :: Int -> DomainName -> ShowS # show :: DomainName -> String # showList :: [DomainName] -> ShowS #
NFData DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods rnf :: DomainName -> () #
Eq DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods (==) :: DomainName -> DomainName -> Bool # (/=) :: DomainName -> DomainName -> Bool #
Hashable DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods hashWithSalt :: Int -> DomainName -> Int # hash :: DomainName -> Int #
type Rep DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName type Rep DomainName = D1 ('MetaData "DomainName" "Amazonka.APIGateway.Types.DomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DomainName'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "certificateUploadDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "distributionDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "distributionHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domainNameStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainNameStatus)) :: S1 ('MetaSel ('Just "domainNameStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration)) :: S1 ('MetaSel ('Just "mutualTlsAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MutualTlsAuthentication))) :: (S1 ('MetaSel ('Just "ownershipVerificationCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "regionalCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "regionalHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityPolicy)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))))

newDomainName :: DomainName Source #

Create a value of DomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:certificateArn:DomainName', domainName_certificateArn - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

$sel:certificateName:DomainName', domainName_certificateName - The name of the certificate that will be used by edge-optimized endpoint for this domain name.

$sel:certificateUploadDate:DomainName', domainName_certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

$sel:distributionDomainName:DomainName', domainName_distributionDomainName - The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

$sel:distributionHostedZoneId:DomainName', domainName_distributionHostedZoneId - The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:domainName:DomainName', domainName_domainName - The custom domain name as an API host name, for example, my-api.example.com.

$sel:domainNameStatus:DomainName', domainName_domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

$sel:domainNameStatusMessage:DomainName', domainName_domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.

$sel:endpointConfiguration:DomainName', domainName_endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

$sel:mutualTlsAuthentication:DomainName', domainName_mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

$sel:ownershipVerificationCertificateArn:DomainName', domainName_ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

$sel:regionalCertificateArn:DomainName', domainName_regionalCertificateArn - The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

$sel:regionalCertificateName:DomainName', domainName_regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.

$sel:regionalDomainName:DomainName', domainName_regionalDomainName - The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

$sel:regionalHostedZoneId:DomainName', domainName_regionalHostedZoneId - The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:securityPolicy:DomainName', domainName_securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

$sel:tags:DomainName', domainName_tags - The collection of tags. Each tag element is associated with a given resource.

UpdateGatewayResponse

data UpdateGatewayResponse Source #

Updates a GatewayResponse of a specified response type on the given RestApi.

See: newUpdateGatewayResponse smart constructor.

Constructors

UpdateGatewayResponse' (Maybe [PatchOperation]) Text GatewayResponseType

Instances

Instances details

ToJSON UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods toJSON :: UpdateGatewayResponse -> Value # toEncoding :: UpdateGatewayResponse -> Encoding # toJSONList :: [UpdateGatewayResponse] -> Value # toEncodingList :: [UpdateGatewayResponse] -> Encoding #
ToHeaders UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods toHeaders :: UpdateGatewayResponse -> [Header] #
ToPath UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods toPath :: UpdateGatewayResponse -> ByteString #
ToQuery UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods toQuery :: UpdateGatewayResponse -> QueryString #
AWSRequest UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Associated Types type AWSResponse UpdateGatewayResponse # Methods request :: (Service -> Service) -> UpdateGatewayResponse -> Request UpdateGatewayResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateGatewayResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateGatewayResponse))) #
Generic UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Associated Types type Rep UpdateGatewayResponse :: Type -> Type # Methods from :: UpdateGatewayResponse -> Rep UpdateGatewayResponse x # to :: Rep UpdateGatewayResponse x -> UpdateGatewayResponse #
Read UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods readsPrec :: Int -> ReadS UpdateGatewayResponse # readList :: ReadS [UpdateGatewayResponse] # readPrec :: ReadPrec UpdateGatewayResponse # readListPrec :: ReadPrec [UpdateGatewayResponse] #
Show UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods showsPrec :: Int -> UpdateGatewayResponse -> ShowS # show :: UpdateGatewayResponse -> String # showList :: [UpdateGatewayResponse] -> ShowS #
NFData UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods rnf :: UpdateGatewayResponse -> () #
Eq UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods (==) :: UpdateGatewayResponse -> UpdateGatewayResponse -> Bool # (/=) :: UpdateGatewayResponse -> UpdateGatewayResponse -> Bool #
Hashable UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse Methods hashWithSalt :: Int -> UpdateGatewayResponse -> Int # hash :: UpdateGatewayResponse -> Int #
type AWSResponse UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse type AWSResponse UpdateGatewayResponse = GatewayResponse
type Rep UpdateGatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateGatewayResponse type Rep UpdateGatewayResponse = D1 ('MetaData "UpdateGatewayResponse" "Amazonka.APIGateway.UpdateGatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateGatewayResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayResponseType))))

newUpdateGatewayResponse Source #

Arguments

:: Text	`UpdateGatewayResponse`
-> GatewayResponseType	`UpdateGatewayResponse`
-> UpdateGatewayResponse

Create a value of UpdateGatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateGatewayResponse', updateGatewayResponse_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateGatewayResponse, updateGatewayResponse_restApiId - The string identifier of the associated RestApi.

UpdateGatewayResponse, updateGatewayResponse_responseType - The response type of the associated GatewayResponse.

data GatewayResponse Source #

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

See: newGatewayResponse smart constructor.

Constructors

GatewayResponse' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe GatewayResponseType) (Maybe Text)

Instances

Instances details

FromJSON GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods parseJSON :: Value -> Parser GatewayResponse # parseJSONList :: Value -> Parser [GatewayResponse] #
Generic GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Associated Types type Rep GatewayResponse :: Type -> Type # Methods from :: GatewayResponse -> Rep GatewayResponse x # to :: Rep GatewayResponse x -> GatewayResponse #
Read GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods readsPrec :: Int -> ReadS GatewayResponse # readList :: ReadS [GatewayResponse] # readPrec :: ReadPrec GatewayResponse # readListPrec :: ReadPrec [GatewayResponse] #
Show GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods showsPrec :: Int -> GatewayResponse -> ShowS # show :: GatewayResponse -> String # showList :: [GatewayResponse] -> ShowS #
NFData GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods rnf :: GatewayResponse -> () #
Eq GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods (==) :: GatewayResponse -> GatewayResponse -> Bool # (/=) :: GatewayResponse -> GatewayResponse -> Bool #
Hashable GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods hashWithSalt :: Int -> GatewayResponse -> Int # hash :: GatewayResponse -> Int #
type Rep GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse type Rep GatewayResponse = D1 ('MetaData "GatewayResponse" "Amazonka.APIGateway.Types.GatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GatewayResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayResponseType)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGatewayResponse :: GatewayResponse Source #

Create a value of GatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultResponse:GatewayResponse', gatewayResponse_defaultResponse - A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

$sel:responseParameters:GatewayResponse', gatewayResponse_responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseTemplates:GatewayResponse', gatewayResponse_responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseType:GatewayResponse', gatewayResponse_responseType - The response type of the associated GatewayResponse.

$sel:statusCode:GatewayResponse', gatewayResponse_statusCode - The HTTP status code for this GatewayResponse.

UpdateIntegration

data UpdateIntegration Source #

Represents an update integration request.

See: newUpdateIntegration smart constructor.

Constructors

UpdateIntegration' (Maybe [PatchOperation]) Text Text Text

Instances

Instances details

ToJSON UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Methods toJSON :: UpdateIntegration -> Value # toEncoding :: UpdateIntegration -> Encoding # toJSONList :: [UpdateIntegration] -> Value # toEncodingList :: [UpdateIntegration] -> Encoding #
ToHeaders UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Methods toHeaders :: UpdateIntegration -> [Header] #
ToPath UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Methods toPath :: UpdateIntegration -> ByteString #
ToQuery UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Methods toQuery :: UpdateIntegration -> QueryString #
AWSRequest UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Associated Types type AWSResponse UpdateIntegration # Methods request :: (Service -> Service) -> UpdateIntegration -> Request UpdateIntegration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateIntegration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateIntegration))) #
Generic UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Associated Types type Rep UpdateIntegration :: Type -> Type # Methods from :: UpdateIntegration -> Rep UpdateIntegration x # to :: Rep UpdateIntegration x -> UpdateIntegration #
Read UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Methods readsPrec :: Int -> ReadS UpdateIntegration # readList :: ReadS [UpdateIntegration] # readPrec :: ReadPrec UpdateIntegration # readListPrec :: ReadPrec [UpdateIntegration] #
Show UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Methods showsPrec :: Int -> UpdateIntegration -> ShowS # show :: UpdateIntegration -> String # showList :: [UpdateIntegration] -> ShowS #
NFData UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Methods rnf :: UpdateIntegration -> () #
Eq UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Methods (==) :: UpdateIntegration -> UpdateIntegration -> Bool # (/=) :: UpdateIntegration -> UpdateIntegration -> Bool #
Hashable UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration Methods hashWithSalt :: Int -> UpdateIntegration -> Int # hash :: UpdateIntegration -> Int #
type AWSResponse UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration type AWSResponse UpdateIntegration = Integration
type Rep UpdateIntegration Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegration type Rep UpdateIntegration = D1 ('MetaData "UpdateIntegration" "Amazonka.APIGateway.UpdateIntegration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateIntegration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateIntegration Source #

Arguments

:: Text	`UpdateIntegration`
-> Text	`$sel:resourceId:UpdateIntegration'`
-> Text	`UpdateIntegration`
-> UpdateIntegration

Create a value of UpdateIntegration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateIntegration', updateIntegration_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateIntegration, updateIntegration_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:UpdateIntegration', updateIntegration_resourceId - Represents an update integration request's resource identifier.

UpdateIntegration, updateIntegration_httpMethod - Represents an update integration request's HTTP method.

data Integration Source #

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

See: newIntegration smart constructor.

Constructors

Integration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text IntegrationResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe IntegrationType) (Maybe Text)

Instances

Instances details

FromJSON Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods parseJSON :: Value -> Parser Integration # parseJSONList :: Value -> Parser [Integration] #
Generic Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Associated Types type Rep Integration :: Type -> Type # Methods from :: Integration -> Rep Integration x # to :: Rep Integration x -> Integration #
Read Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods readsPrec :: Int -> ReadS Integration # readList :: ReadS [Integration] # readPrec :: ReadPrec Integration # readListPrec :: ReadPrec [Integration] #
Show Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods showsPrec :: Int -> Integration -> ShowS # show :: Integration -> String # showList :: [Integration] -> ShowS #
NFData Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods rnf :: Integration -> () #
Eq Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods (==) :: Integration -> Integration -> Bool # (/=) :: Integration -> Integration -> Bool #
Hashable Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods hashWithSalt :: Int -> Integration -> Int # hash :: Integration -> Int #
type Rep Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration type Rep Integration = D1 ('MetaData "Integration" "Amazonka.APIGateway.Types.Integration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Integration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheKeyParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "cacheNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "connectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionType)) :: S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy))) :: (S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "integrationResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text IntegrationResponse))) :: S1 ('MetaSel ('Just "passthroughBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "requestTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "timeoutInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "tlsConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TlsConfig))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntegrationType)) :: S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newIntegration :: Integration Source #

Create a value of Integration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheKeyParameters:Integration', integration_cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

$sel:cacheNamespace:Integration', integration_cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

$sel:connectionId:Integration', integration_connectionId - The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

$sel:connectionType:Integration', integration_connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Integration, integration_contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

$sel:credentials:Integration', integration_credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

$sel:httpMethod:Integration', integration_httpMethod - Specifies the integration's HTTP method type.

$sel:integrationResponses:Integration', integration_integrationResponses - Specifies the integration's responses.

$sel:passthroughBehavior:Integration', integration_passthroughBehavior - Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

$sel:requestParameters:Integration', integration_requestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

$sel:requestTemplates:Integration', integration_requestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

$sel:timeoutInMillis:Integration', integration_timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

$sel:tlsConfig:Integration', integration_tlsConfig - Specifies the TLS configuration for an integration.

$sel:type':Integration', integration_type - Specifies an API method integration type. The valid value is one of the following:

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

$sel:uri:Integration', integration_uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint.

For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

UpdateIntegrationResponse

data UpdateIntegrationResponse Source #

Represents an update integration response request.

See: newUpdateIntegrationResponse smart constructor.

Constructors

UpdateIntegrationResponse' (Maybe [PatchOperation]) Text Text Text Text

Instances

Instances details

ToJSON UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Methods toJSON :: UpdateIntegrationResponse -> Value # toEncoding :: UpdateIntegrationResponse -> Encoding # toJSONList :: [UpdateIntegrationResponse] -> Value # toEncodingList :: [UpdateIntegrationResponse] -> Encoding #
ToHeaders UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Methods toHeaders :: UpdateIntegrationResponse -> [Header] #
ToPath UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Methods toPath :: UpdateIntegrationResponse -> ByteString #
ToQuery UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Methods toQuery :: UpdateIntegrationResponse -> QueryString #
AWSRequest UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Associated Types type AWSResponse UpdateIntegrationResponse # Methods request :: (Service -> Service) -> UpdateIntegrationResponse -> Request UpdateIntegrationResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateIntegrationResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateIntegrationResponse))) #
Generic UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Associated Types type Rep UpdateIntegrationResponse :: Type -> Type # Methods from :: UpdateIntegrationResponse -> Rep UpdateIntegrationResponse x # to :: Rep UpdateIntegrationResponse x -> UpdateIntegrationResponse #
Read UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Methods readsPrec :: Int -> ReadS UpdateIntegrationResponse # readList :: ReadS [UpdateIntegrationResponse] # readPrec :: ReadPrec UpdateIntegrationResponse # readListPrec :: ReadPrec [UpdateIntegrationResponse] #
Show UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Methods showsPrec :: Int -> UpdateIntegrationResponse -> ShowS # show :: UpdateIntegrationResponse -> String # showList :: [UpdateIntegrationResponse] -> ShowS #
NFData UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Methods rnf :: UpdateIntegrationResponse -> () #
Eq UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Methods (==) :: UpdateIntegrationResponse -> UpdateIntegrationResponse -> Bool # (/=) :: UpdateIntegrationResponse -> UpdateIntegrationResponse -> Bool #
Hashable UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse Methods hashWithSalt :: Int -> UpdateIntegrationResponse -> Int # hash :: UpdateIntegrationResponse -> Int #
type AWSResponse UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse type AWSResponse UpdateIntegrationResponse = IntegrationResponse
type Rep UpdateIntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateIntegrationResponse type Rep UpdateIntegrationResponse = D1 ('MetaData "UpdateIntegrationResponse" "Amazonka.APIGateway.UpdateIntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateIntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateIntegrationResponse Source #

Arguments

:: Text	`UpdateIntegrationResponse`
-> Text	`$sel:resourceId:UpdateIntegrationResponse'`
-> Text	`UpdateIntegrationResponse`
-> Text	`UpdateIntegrationResponse`
-> UpdateIntegrationResponse

Create a value of UpdateIntegrationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateIntegrationResponse', updateIntegrationResponse_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateIntegrationResponse, updateIntegrationResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:UpdateIntegrationResponse', updateIntegrationResponse_resourceId - Specifies an update integration response request's resource identifier.

UpdateIntegrationResponse, updateIntegrationResponse_httpMethod - Specifies an update integration response request's HTTP method.

UpdateIntegrationResponse, updateIntegrationResponse_statusCode - Specifies an update integration response request's status code.

data IntegrationResponse Source #

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

See: newIntegrationResponse smart constructor.

Constructors

IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods parseJSON :: Value -> Parser IntegrationResponse # parseJSONList :: Value -> Parser [IntegrationResponse] #
Generic IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Associated Types type Rep IntegrationResponse :: Type -> Type # Methods from :: IntegrationResponse -> Rep IntegrationResponse x # to :: Rep IntegrationResponse x -> IntegrationResponse #
Read IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods readsPrec :: Int -> ReadS IntegrationResponse # readList :: ReadS [IntegrationResponse] # readPrec :: ReadPrec IntegrationResponse # readListPrec :: ReadPrec [IntegrationResponse] #
Show IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods showsPrec :: Int -> IntegrationResponse -> ShowS # show :: IntegrationResponse -> String # showList :: [IntegrationResponse] -> ShowS #
NFData IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods rnf :: IntegrationResponse -> () #
Eq IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods (==) :: IntegrationResponse -> IntegrationResponse -> Bool # (/=) :: IntegrationResponse -> IntegrationResponse -> Bool #
Hashable IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods hashWithSalt :: Int -> IntegrationResponse -> Int # hash :: IntegrationResponse -> Int #
type Rep IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse type Rep IntegrationResponse = D1 ('MetaData "IntegrationResponse" "Amazonka.APIGateway.Types.IntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "IntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "selectionPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newIntegrationResponse :: IntegrationResponse Source #

Create a value of IntegrationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentHandling:IntegrationResponse', integrationResponse_contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

$sel:responseParameters:IntegrationResponse', integrationResponse_responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

$sel:responseTemplates:IntegrationResponse', integrationResponse_responseTemplates - Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

$sel:selectionPattern:IntegrationResponse', integrationResponse_selectionPattern - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

$sel:statusCode:IntegrationResponse', integrationResponse_statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

UpdateMethod

data UpdateMethod Source #

Request to update an existing Method resource.

See: newUpdateMethod smart constructor.

Constructors

UpdateMethod' (Maybe [PatchOperation]) Text Text Text

Instances

Instances details

ToJSON UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Methods toJSON :: UpdateMethod -> Value # toEncoding :: UpdateMethod -> Encoding # toJSONList :: [UpdateMethod] -> Value # toEncodingList :: [UpdateMethod] -> Encoding #
ToHeaders UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Methods toHeaders :: UpdateMethod -> [Header] #
ToPath UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Methods toPath :: UpdateMethod -> ByteString #
ToQuery UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Methods toQuery :: UpdateMethod -> QueryString #
AWSRequest UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Associated Types type AWSResponse UpdateMethod # Methods request :: (Service -> Service) -> UpdateMethod -> Request UpdateMethod # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateMethod -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateMethod))) #
Generic UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Associated Types type Rep UpdateMethod :: Type -> Type # Methods from :: UpdateMethod -> Rep UpdateMethod x # to :: Rep UpdateMethod x -> UpdateMethod #
Read UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Methods readsPrec :: Int -> ReadS UpdateMethod # readList :: ReadS [UpdateMethod] # readPrec :: ReadPrec UpdateMethod # readListPrec :: ReadPrec [UpdateMethod] #
Show UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Methods showsPrec :: Int -> UpdateMethod -> ShowS # show :: UpdateMethod -> String # showList :: [UpdateMethod] -> ShowS #
NFData UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Methods rnf :: UpdateMethod -> () #
Eq UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Methods (==) :: UpdateMethod -> UpdateMethod -> Bool # (/=) :: UpdateMethod -> UpdateMethod -> Bool #
Hashable UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod Methods hashWithSalt :: Int -> UpdateMethod -> Int # hash :: UpdateMethod -> Int #
type AWSResponse UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod type AWSResponse UpdateMethod = Method
type Rep UpdateMethod Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethod type Rep UpdateMethod = D1 ('MetaData "UpdateMethod" "Amazonka.APIGateway.UpdateMethod" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateMethod'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateMethod Source #

Arguments

:: Text	`UpdateMethod`
-> Text	`$sel:resourceId:UpdateMethod'`
-> Text	`UpdateMethod`
-> UpdateMethod

Create a value of UpdateMethod with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateMethod', updateMethod_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateMethod, updateMethod_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:UpdateMethod', updateMethod_resourceId - The Resource identifier for the Method resource.

UpdateMethod, updateMethod_httpMethod - The HTTP verb of the Method resource.

data Method Source #

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

See: newMethod smart constructor.

Constructors

Method' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integration) (Maybe (HashMap Text MethodResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)

Instances

Instances details

FromJSON Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods parseJSON :: Value -> Parser Method # parseJSONList :: Value -> Parser [Method] #
Generic Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Associated Types type Rep Method :: Type -> Type # Methods from :: Method -> Rep Method x # to :: Rep Method x -> Method #
Read Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods readsPrec :: Int -> ReadS Method # readList :: ReadS [Method] # readPrec :: ReadPrec Method # readListPrec :: ReadPrec [Method] #
Show Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
NFData Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods rnf :: Method -> () #
Eq Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Hashable Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods hashWithSalt :: Int -> Method -> Int # hash :: Method -> Int #
type Rep Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method type Rep Method = D1 ('MetaData "Method" "Amazonka.APIGateway.Types.Method" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Method'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "authorizationScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "authorizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "methodIntegration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integration)) :: (S1 ('MetaSel ('Just "methodResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MethodResponse))) :: S1 ('MetaSel ('Just "operationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "requestModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: S1 ('MetaSel ('Just "requestValidatorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newMethod :: Method Source #

Create a value of Method with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyRequired:Method', method_apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke this method.

$sel:authorizationScopes:Method', method_authorizationScopes - A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

$sel:authorizationType:Method', method_authorizationType - The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

$sel:authorizerId:Method', method_authorizerId - The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Method, method_httpMethod - The method's HTTP verb.

$sel:methodIntegration:Method', method_methodIntegration - Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

$sel:methodResponses:Method', method_methodResponses - Gets a method response associated with a given HTTP status code.

$sel:operationName:Method', method_operationName - A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

$sel:requestModels:Method', method_requestModels - A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Method, method_requestParameters - A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

$sel:requestValidatorId:Method', method_requestValidatorId - The identifier of a RequestValidator for request validation.

UpdateMethodResponse

data UpdateMethodResponse Source #

A request to update an existing MethodResponse resource.

See: newUpdateMethodResponse smart constructor.

Constructors

UpdateMethodResponse' (Maybe [PatchOperation]) Text Text Text Text

Instances

Instances details

ToJSON UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Methods toJSON :: UpdateMethodResponse -> Value # toEncoding :: UpdateMethodResponse -> Encoding # toJSONList :: [UpdateMethodResponse] -> Value # toEncodingList :: [UpdateMethodResponse] -> Encoding #
ToHeaders UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Methods toHeaders :: UpdateMethodResponse -> [Header] #
ToPath UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Methods toPath :: UpdateMethodResponse -> ByteString #
ToQuery UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Methods toQuery :: UpdateMethodResponse -> QueryString #
AWSRequest UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Associated Types type AWSResponse UpdateMethodResponse # Methods request :: (Service -> Service) -> UpdateMethodResponse -> Request UpdateMethodResponse # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateMethodResponse -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateMethodResponse))) #
Generic UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Associated Types type Rep UpdateMethodResponse :: Type -> Type # Methods from :: UpdateMethodResponse -> Rep UpdateMethodResponse x # to :: Rep UpdateMethodResponse x -> UpdateMethodResponse #
Read UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Methods readsPrec :: Int -> ReadS UpdateMethodResponse # readList :: ReadS [UpdateMethodResponse] # readPrec :: ReadPrec UpdateMethodResponse # readListPrec :: ReadPrec [UpdateMethodResponse] #
Show UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Methods showsPrec :: Int -> UpdateMethodResponse -> ShowS # show :: UpdateMethodResponse -> String # showList :: [UpdateMethodResponse] -> ShowS #
NFData UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Methods rnf :: UpdateMethodResponse -> () #
Eq UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Methods (==) :: UpdateMethodResponse -> UpdateMethodResponse -> Bool # (/=) :: UpdateMethodResponse -> UpdateMethodResponse -> Bool #
Hashable UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse Methods hashWithSalt :: Int -> UpdateMethodResponse -> Int # hash :: UpdateMethodResponse -> Int #
type AWSResponse UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse type AWSResponse UpdateMethodResponse = MethodResponse
type Rep UpdateMethodResponse Source #
Instance details Defined in Amazonka.APIGateway.UpdateMethodResponse type Rep UpdateMethodResponse = D1 ('MetaData "UpdateMethodResponse" "Amazonka.APIGateway.UpdateMethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateMethodResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateMethodResponse Source #

Arguments

:: Text	`UpdateMethodResponse`
-> Text	`$sel:resourceId:UpdateMethodResponse'`
-> Text	`UpdateMethodResponse`
-> Text	`UpdateMethodResponse`
-> UpdateMethodResponse

Create a value of UpdateMethodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateMethodResponse', updateMethodResponse_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateMethodResponse, updateMethodResponse_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:UpdateMethodResponse', updateMethodResponse_resourceId - The Resource identifier for the MethodResponse resource.

UpdateMethodResponse, updateMethodResponse_httpMethod - The HTTP verb of the Method resource.

UpdateMethodResponse, updateMethodResponse_statusCode - The status code for the MethodResponse resource.

data MethodResponse Source #

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

See: newMethodResponse smart constructor.

Constructors

MethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)

Instances

Instances details

FromJSON MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods parseJSON :: Value -> Parser MethodResponse # parseJSONList :: Value -> Parser [MethodResponse] #
Generic MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Associated Types type Rep MethodResponse :: Type -> Type # Methods from :: MethodResponse -> Rep MethodResponse x # to :: Rep MethodResponse x -> MethodResponse #
Read MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods readsPrec :: Int -> ReadS MethodResponse # readList :: ReadS [MethodResponse] # readPrec :: ReadPrec MethodResponse # readListPrec :: ReadPrec [MethodResponse] #
Show MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods showsPrec :: Int -> MethodResponse -> ShowS # show :: MethodResponse -> String # showList :: [MethodResponse] -> ShowS #
NFData MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods rnf :: MethodResponse -> () #
Eq MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods (==) :: MethodResponse -> MethodResponse -> Bool # (/=) :: MethodResponse -> MethodResponse -> Bool #
Hashable MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods hashWithSalt :: Int -> MethodResponse -> Int # hash :: MethodResponse -> Int #
type Rep MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse type Rep MethodResponse = D1 ('MetaData "MethodResponse" "Amazonka.APIGateway.Types.MethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MethodResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "responseModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMethodResponse :: MethodResponse Source #

Create a value of MethodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:responseModels:MethodResponse', methodResponse_responseModels - Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

$sel:responseParameters:MethodResponse', methodResponse_responseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

$sel:statusCode:MethodResponse', methodResponse_statusCode - The method response's status code.

UpdateModel

data UpdateModel Source #

Request to update an existing model in an existing RestApi resource.

See: newUpdateModel smart constructor.

Constructors

UpdateModel' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Methods toJSON :: UpdateModel -> Value # toEncoding :: UpdateModel -> Encoding # toJSONList :: [UpdateModel] -> Value # toEncodingList :: [UpdateModel] -> Encoding #
ToHeaders UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Methods toHeaders :: UpdateModel -> [Header] #
ToPath UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Methods toPath :: UpdateModel -> ByteString #
ToQuery UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Methods toQuery :: UpdateModel -> QueryString #
AWSRequest UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Associated Types type AWSResponse UpdateModel # Methods request :: (Service -> Service) -> UpdateModel -> Request UpdateModel # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateModel -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateModel))) #
Generic UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Associated Types type Rep UpdateModel :: Type -> Type # Methods from :: UpdateModel -> Rep UpdateModel x # to :: Rep UpdateModel x -> UpdateModel #
Read UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Methods readsPrec :: Int -> ReadS UpdateModel # readList :: ReadS [UpdateModel] # readPrec :: ReadPrec UpdateModel # readListPrec :: ReadPrec [UpdateModel] #
Show UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Methods showsPrec :: Int -> UpdateModel -> ShowS # show :: UpdateModel -> String # showList :: [UpdateModel] -> ShowS #
NFData UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Methods rnf :: UpdateModel -> () #
Eq UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Methods (==) :: UpdateModel -> UpdateModel -> Bool # (/=) :: UpdateModel -> UpdateModel -> Bool #
Hashable UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel Methods hashWithSalt :: Int -> UpdateModel -> Int # hash :: UpdateModel -> Int #
type AWSResponse UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel type AWSResponse UpdateModel = Model
type Rep UpdateModel Source #
Instance details Defined in Amazonka.APIGateway.UpdateModel type Rep UpdateModel = D1 ('MetaData "UpdateModel" "Amazonka.APIGateway.UpdateModel" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateModel'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "modelName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateModel Source #

Arguments

:: Text	`UpdateModel`
-> Text	`$sel:modelName:UpdateModel'`
-> UpdateModel

Create a value of UpdateModel with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateModel', updateModel_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateModel, updateModel_restApiId - The string identifier of the associated RestApi.

$sel:modelName:UpdateModel', updateModel_modelName - The name of the model to update.

data Model Source #

Represents the data structure of a method's request or response payload.

See: newModel smart constructor.

Constructors

Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods parseJSON :: Value -> Parser Model # parseJSONList :: Value -> Parser [Model] #
Generic Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Associated Types type Rep Model :: Type -> Type # Methods from :: Model -> Rep Model x # to :: Rep Model x -> Model #
Read Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods readsPrec :: Int -> ReadS Model # readList :: ReadS [Model] # readPrec :: ReadPrec Model # readListPrec :: ReadPrec [Model] #
Show Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods showsPrec :: Int -> Model -> ShowS # show :: Model -> String # showList :: [Model] -> ShowS #
NFData Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods rnf :: Model -> () #
Eq Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #
Hashable Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods hashWithSalt :: Int -> Model -> Int # hash :: Model -> Int #
type Rep Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model type Rep Model = D1 ('MetaData "Model" "Amazonka.APIGateway.Types.Model" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Model'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newModel :: Model Source #

Create a value of Model with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentType:Model', model_contentType - The content-type for the model.

$sel:description:Model', model_description - The description of the model.

$sel:id:Model', model_id - The identifier for the model resource.

$sel:name:Model', model_name - The name of the model. Must be an alphanumeric string.

$sel:schema:Model', model_schema - The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

UpdateRequestValidator

data UpdateRequestValidator Source #

Updates a RequestValidator of a given RestApi.

See: newUpdateRequestValidator smart constructor.

Constructors

UpdateRequestValidator' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Methods toJSON :: UpdateRequestValidator -> Value # toEncoding :: UpdateRequestValidator -> Encoding # toJSONList :: [UpdateRequestValidator] -> Value # toEncodingList :: [UpdateRequestValidator] -> Encoding #
ToHeaders UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Methods toHeaders :: UpdateRequestValidator -> [Header] #
ToPath UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Methods toPath :: UpdateRequestValidator -> ByteString #
ToQuery UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Methods toQuery :: UpdateRequestValidator -> QueryString #
AWSRequest UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Associated Types type AWSResponse UpdateRequestValidator # Methods request :: (Service -> Service) -> UpdateRequestValidator -> Request UpdateRequestValidator # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateRequestValidator -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateRequestValidator))) #
Generic UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Associated Types type Rep UpdateRequestValidator :: Type -> Type # Methods from :: UpdateRequestValidator -> Rep UpdateRequestValidator x # to :: Rep UpdateRequestValidator x -> UpdateRequestValidator #
Read UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Methods readsPrec :: Int -> ReadS UpdateRequestValidator # readList :: ReadS [UpdateRequestValidator] # readPrec :: ReadPrec UpdateRequestValidator # readListPrec :: ReadPrec [UpdateRequestValidator] #
Show UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Methods showsPrec :: Int -> UpdateRequestValidator -> ShowS # show :: UpdateRequestValidator -> String # showList :: [UpdateRequestValidator] -> ShowS #
NFData UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Methods rnf :: UpdateRequestValidator -> () #
Eq UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Methods (==) :: UpdateRequestValidator -> UpdateRequestValidator -> Bool # (/=) :: UpdateRequestValidator -> UpdateRequestValidator -> Bool #
Hashable UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator Methods hashWithSalt :: Int -> UpdateRequestValidator -> Int # hash :: UpdateRequestValidator -> Int #
type AWSResponse UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator type AWSResponse UpdateRequestValidator = RequestValidator
type Rep UpdateRequestValidator Source #
Instance details Defined in Amazonka.APIGateway.UpdateRequestValidator type Rep UpdateRequestValidator = D1 ('MetaData "UpdateRequestValidator" "Amazonka.APIGateway.UpdateRequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateRequestValidator'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "requestValidatorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateRequestValidator Source #

Arguments

:: Text	`UpdateRequestValidator`
-> Text	`UpdateRequestValidator`
-> UpdateRequestValidator

Create a value of UpdateRequestValidator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateRequestValidator', updateRequestValidator_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateRequestValidator, updateRequestValidator_restApiId - The string identifier of the associated RestApi.

UpdateRequestValidator, updateRequestValidator_requestValidatorId - The identifier of RequestValidator to be updated.

data RequestValidator Source #

A set of validation rules for incoming Method requests.

See: newRequestValidator smart constructor.

Constructors

RequestValidator' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool)

Instances

Instances details

FromJSON RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods parseJSON :: Value -> Parser RequestValidator # parseJSONList :: Value -> Parser [RequestValidator] #
Generic RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Associated Types type Rep RequestValidator :: Type -> Type # Methods from :: RequestValidator -> Rep RequestValidator x # to :: Rep RequestValidator x -> RequestValidator #
Read RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods readsPrec :: Int -> ReadS RequestValidator # readList :: ReadS [RequestValidator] # readPrec :: ReadPrec RequestValidator # readListPrec :: ReadPrec [RequestValidator] #
Show RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods showsPrec :: Int -> RequestValidator -> ShowS # show :: RequestValidator -> String # showList :: [RequestValidator] -> ShowS #
NFData RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods rnf :: RequestValidator -> () #
Eq RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods (==) :: RequestValidator -> RequestValidator -> Bool # (/=) :: RequestValidator -> RequestValidator -> Bool #
Hashable RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods hashWithSalt :: Int -> RequestValidator -> Int # hash :: RequestValidator -> Int #
type Rep RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator type Rep RequestValidator = D1 ('MetaData "RequestValidator" "Amazonka.APIGateway.Types.RequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RequestValidator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "validateRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "validateRequestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newRequestValidator :: RequestValidator Source #

Create a value of RequestValidator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:RequestValidator', requestValidator_id - The identifier of this RequestValidator.

$sel:name:RequestValidator', requestValidator_name - The name of this RequestValidator

$sel:validateRequestBody:RequestValidator', requestValidator_validateRequestBody - A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

$sel:validateRequestParameters:RequestValidator', requestValidator_validateRequestParameters - A Boolean flag to indicate whether to validate request parameters (true) or not (false).

UpdateResource

data UpdateResource Source #

Request to change information about a Resource resource.

See: newUpdateResource smart constructor.

Constructors

UpdateResource' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Methods toJSON :: UpdateResource -> Value # toEncoding :: UpdateResource -> Encoding # toJSONList :: [UpdateResource] -> Value # toEncodingList :: [UpdateResource] -> Encoding #
ToHeaders UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Methods toHeaders :: UpdateResource -> [Header] #
ToPath UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Methods toPath :: UpdateResource -> ByteString #
ToQuery UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Methods toQuery :: UpdateResource -> QueryString #
AWSRequest UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Associated Types type AWSResponse UpdateResource # Methods request :: (Service -> Service) -> UpdateResource -> Request UpdateResource # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateResource))) #
Generic UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Associated Types type Rep UpdateResource :: Type -> Type # Methods from :: UpdateResource -> Rep UpdateResource x # to :: Rep UpdateResource x -> UpdateResource #
Read UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Methods readsPrec :: Int -> ReadS UpdateResource # readList :: ReadS [UpdateResource] # readPrec :: ReadPrec UpdateResource # readListPrec :: ReadPrec [UpdateResource] #
Show UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Methods showsPrec :: Int -> UpdateResource -> ShowS # show :: UpdateResource -> String # showList :: [UpdateResource] -> ShowS #
NFData UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Methods rnf :: UpdateResource -> () #
Eq UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Methods (==) :: UpdateResource -> UpdateResource -> Bool # (/=) :: UpdateResource -> UpdateResource -> Bool #
Hashable UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource Methods hashWithSalt :: Int -> UpdateResource -> Int # hash :: UpdateResource -> Int #
type AWSResponse UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource type AWSResponse UpdateResource = Resource
type Rep UpdateResource Source #
Instance details Defined in Amazonka.APIGateway.UpdateResource type Rep UpdateResource = D1 ('MetaData "UpdateResource" "Amazonka.APIGateway.UpdateResource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "resourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateResource Source #

Arguments

:: Text	`UpdateResource`
-> Text	`$sel:resourceId:UpdateResource'`
-> UpdateResource

Create a value of UpdateResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateResource', updateResource_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateResource, updateResource_restApiId - The string identifier of the associated RestApi.

$sel:resourceId:UpdateResource', updateResource_resourceId - The identifier of the Resource resource.

data Resource Source #

Represents an API resource.

See: newResource smart constructor.

Constructors

Resource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Method))

Instances

Instances details

FromJSON Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods parseJSON :: Value -> Parser Resource # parseJSONList :: Value -> Parser [Resource] #
Generic Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Associated Types type Rep Resource :: Type -> Type # Methods from :: Resource -> Rep Resource x # to :: Rep Resource x -> Resource #
Read Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods readsPrec :: Int -> ReadS Resource # readList :: ReadS [Resource] # readPrec :: ReadPrec Resource # readListPrec :: ReadPrec [Resource] #
Show Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods showsPrec :: Int -> Resource -> ShowS # show :: Resource -> String # showList :: [Resource] -> ShowS #
NFData Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods rnf :: Resource -> () #
Eq Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods (==) :: Resource -> Resource -> Bool # (/=) :: Resource -> Resource -> Bool #
Hashable Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods hashWithSalt :: Int -> Resource -> Int # hash :: Resource -> Int #
type Rep Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource type Rep Resource = D1 ('MetaData "Resource" "Amazonka.APIGateway.Types.Resource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Resource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pathPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceMethods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Method)))))))

newResource :: Resource Source #

Create a value of Resource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:Resource', resource_id - The resource's identifier.

$sel:parentId:Resource', resource_parentId - The parent resource's identifier.

$sel:path:Resource', resource_path - The full path for this resource.

$sel:pathPart:Resource', resource_pathPart - The last path segment for this resource.

$sel:resourceMethods:Resource', resource_resourceMethods - Gets an API resource's method of a given HTTP verb.

UpdateRestApi

data UpdateRestApi Source #

Request to update an existing RestApi resource in your collection.

See: newUpdateRestApi smart constructor.

Constructors

UpdateRestApi' (Maybe [PatchOperation]) Text

Instances

Instances details

ToJSON UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Methods toJSON :: UpdateRestApi -> Value # toEncoding :: UpdateRestApi -> Encoding # toJSONList :: [UpdateRestApi] -> Value # toEncodingList :: [UpdateRestApi] -> Encoding #
ToHeaders UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Methods toHeaders :: UpdateRestApi -> [Header] #
ToPath UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Methods toPath :: UpdateRestApi -> ByteString #
ToQuery UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Methods toQuery :: UpdateRestApi -> QueryString #
AWSRequest UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Associated Types type AWSResponse UpdateRestApi # Methods request :: (Service -> Service) -> UpdateRestApi -> Request UpdateRestApi # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateRestApi -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateRestApi))) #
Generic UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Associated Types type Rep UpdateRestApi :: Type -> Type # Methods from :: UpdateRestApi -> Rep UpdateRestApi x # to :: Rep UpdateRestApi x -> UpdateRestApi #
Read UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Methods readsPrec :: Int -> ReadS UpdateRestApi # readList :: ReadS [UpdateRestApi] # readPrec :: ReadPrec UpdateRestApi # readListPrec :: ReadPrec [UpdateRestApi] #
Show UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Methods showsPrec :: Int -> UpdateRestApi -> ShowS # show :: UpdateRestApi -> String # showList :: [UpdateRestApi] -> ShowS #
NFData UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Methods rnf :: UpdateRestApi -> () #
Eq UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Methods (==) :: UpdateRestApi -> UpdateRestApi -> Bool # (/=) :: UpdateRestApi -> UpdateRestApi -> Bool #
Hashable UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi Methods hashWithSalt :: Int -> UpdateRestApi -> Int # hash :: UpdateRestApi -> Int #
type AWSResponse UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi type AWSResponse UpdateRestApi = RestApi
type Rep UpdateRestApi Source #
Instance details Defined in Amazonka.APIGateway.UpdateRestApi type Rep UpdateRestApi = D1 ('MetaData "UpdateRestApi" "Amazonka.APIGateway.UpdateRestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateRestApi'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateRestApi Source #

Arguments

:: Text	`UpdateRestApi`
-> UpdateRestApi

Create a value of UpdateRestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateRestApi', updateRestApi_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateRestApi, updateRestApi_restApiId - The string identifier of the associated RestApi.

data RestApi Source #

Represents a REST API.

See: newRestApi smart constructor.

Constructors

RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])

Instances

Instances details

FromJSON RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods parseJSON :: Value -> Parser RestApi # parseJSONList :: Value -> Parser [RestApi] #
Generic RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Associated Types type Rep RestApi :: Type -> Type # Methods from :: RestApi -> Rep RestApi x # to :: Rep RestApi x -> RestApi #
Read RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods readsPrec :: Int -> ReadS RestApi # readList :: ReadS [RestApi] # readPrec :: ReadPrec RestApi # readListPrec :: ReadPrec [RestApi] #
Show RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods showsPrec :: Int -> RestApi -> ShowS # show :: RestApi -> String # showList :: [RestApi] -> ShowS #
NFData RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods rnf :: RestApi -> () #
Eq RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods (==) :: RestApi -> RestApi -> Bool # (/=) :: RestApi -> RestApi -> Bool #
Hashable RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods hashWithSalt :: Int -> RestApi -> Int # hash :: RestApi -> Int #
type Rep RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi type Rep RestApi = D1 ('MetaData "RestApi" "Amazonka.APIGateway.Types.RestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RestApi'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiKeySourceType)) :: (S1 ('MetaSel ('Just "binaryMediaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "minimumCompressionSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newRestApi :: RestApi Source #

Create a value of RestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeySource:RestApi', restApi_apiKeySource - The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

$sel:binaryMediaTypes:RestApi', restApi_binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

$sel:createdDate:RestApi', restApi_createdDate - The timestamp when the API was created.

$sel:description:RestApi', restApi_description - The API's description.

$sel:disableExecuteApiEndpoint:RestApi', restApi_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

$sel:endpointConfiguration:RestApi', restApi_endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

$sel:id:RestApi', restApi_id - The API's identifier. This identifier is unique across all of your APIs in API Gateway.

$sel:minimumCompressionSize:RestApi', restApi_minimumCompressionSize - A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

$sel:name:RestApi', restApi_name - The API's name.

$sel:policy:RestApi', restApi_policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

$sel:tags:RestApi', restApi_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:version:RestApi', restApi_version - A version identifier for the API.

$sel:warnings:RestApi', restApi_warnings - The warning messages reported when failonwarnings is turned on during API import.

UpdateStage

data UpdateStage Source #

Requests API Gateway to change information about a Stage resource.

See: newUpdateStage smart constructor.

Constructors

UpdateStage' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Methods toJSON :: UpdateStage -> Value # toEncoding :: UpdateStage -> Encoding # toJSONList :: [UpdateStage] -> Value # toEncodingList :: [UpdateStage] -> Encoding #
ToHeaders UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Methods toHeaders :: UpdateStage -> [Header] #
ToPath UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Methods toPath :: UpdateStage -> ByteString #
ToQuery UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Methods toQuery :: UpdateStage -> QueryString #
AWSRequest UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Associated Types type AWSResponse UpdateStage # Methods request :: (Service -> Service) -> UpdateStage -> Request UpdateStage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateStage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateStage))) #
Generic UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Associated Types type Rep UpdateStage :: Type -> Type # Methods from :: UpdateStage -> Rep UpdateStage x # to :: Rep UpdateStage x -> UpdateStage #
Read UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Methods readsPrec :: Int -> ReadS UpdateStage # readList :: ReadS [UpdateStage] # readPrec :: ReadPrec UpdateStage # readListPrec :: ReadPrec [UpdateStage] #
Show UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Methods showsPrec :: Int -> UpdateStage -> ShowS # show :: UpdateStage -> String # showList :: [UpdateStage] -> ShowS #
NFData UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Methods rnf :: UpdateStage -> () #
Eq UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Methods (==) :: UpdateStage -> UpdateStage -> Bool # (/=) :: UpdateStage -> UpdateStage -> Bool #
Hashable UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage Methods hashWithSalt :: Int -> UpdateStage -> Int # hash :: UpdateStage -> Int #
type AWSResponse UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage type AWSResponse UpdateStage = Stage
type Rep UpdateStage Source #
Instance details Defined in Amazonka.APIGateway.UpdateStage type Rep UpdateStage = D1 ('MetaData "UpdateStage" "Amazonka.APIGateway.UpdateStage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateStage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateStage Source #

Arguments

:: Text	`UpdateStage`
-> Text	`UpdateStage`
-> UpdateStage

Create a value of UpdateStage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateStage', updateStage_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateStage, updateStage_restApiId - The string identifier of the associated RestApi.

UpdateStage, updateStage_stageName - The name of the Stage resource to change information about.

data Stage Source #

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

See: newStage smart constructor.

Constructors

Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe CacheClusterSize) (Maybe CacheClusterStatus) (Maybe CanarySettings) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text MethodSetting)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text)

Instances

Instances details

FromJSON Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods parseJSON :: Value -> Parser Stage # parseJSONList :: Value -> Parser [Stage] #
Generic Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Associated Types type Rep Stage :: Type -> Type # Methods from :: Stage -> Rep Stage x # to :: Rep Stage x -> Stage #
Read Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods readsPrec :: Int -> ReadS Stage # readList :: ReadS [Stage] # readPrec :: ReadPrec Stage # readListPrec :: ReadPrec [Stage] #
Show Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods showsPrec :: Int -> Stage -> ShowS # show :: Stage -> String # showList :: [Stage] -> ShowS #
NFData Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods rnf :: Stage -> () #
Eq Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods (==) :: Stage -> Stage -> Bool # (/=) :: Stage -> Stage -> Bool #
Hashable Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods hashWithSalt :: Int -> Stage -> Int # hash :: Stage -> Int #
type Rep Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage type Rep Stage = D1 ('MetaData "Stage" "Amazonka.APIGateway.Types.Stage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Stage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :: S1 ('MetaSel ('Just "cacheClusterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "cacheClusterSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterSize)) :: S1 ('MetaSel ('Just "cacheClusterStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterStatus)))) :: ((S1 ('MetaSel ('Just "canarySettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanarySettings)) :: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "methodSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MethodSetting))))) :: ((S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "tracingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "webAclArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newStage :: Stage Source #

Create a value of Stage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessLogSettings:Stage', stage_accessLogSettings - Settings for logging access in this stage.

$sel:cacheClusterEnabled:Stage', stage_cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.

$sel:cacheClusterSize:Stage', stage_cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

$sel:cacheClusterStatus:Stage', stage_cacheClusterStatus - The status of the cache cluster for the stage, if enabled.

$sel:canarySettings:Stage', stage_canarySettings - Settings for the canary deployment in this stage.

$sel:clientCertificateId:Stage', stage_clientCertificateId - The identifier of a client certificate for an API stage.

$sel:createdDate:Stage', stage_createdDate - The timestamp when the stage was created.

Stage, stage_deploymentId - The identifier of the Deployment that the stage points to.

$sel:description:Stage', stage_description - The stage's description.

$sel:documentationVersion:Stage', stage_documentationVersion - The version of the associated API documentation.

$sel:lastUpdatedDate:Stage', stage_lastUpdatedDate - The timestamp when the stage last updated.

$sel:methodSettings:Stage', stage_methodSettings - A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

$sel:stageName:Stage', stage_stageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

$sel:tags:Stage', stage_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:tracingEnabled:Stage', stage_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

$sel:variables:Stage', stage_variables - A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

$sel:webAclArn:Stage', stage_webAclArn - The ARN of the WebAcl associated with the Stage.

UpdateUsage

data UpdateUsage Source #

The PATCH request to grant a temporary extension to the remaining quota of a usage plan associated with a specified API key.

See: newUpdateUsage smart constructor.

Constructors

UpdateUsage' (Maybe [PatchOperation]) Text Text

Instances

Instances details

ToJSON UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Methods toJSON :: UpdateUsage -> Value # toEncoding :: UpdateUsage -> Encoding # toJSONList :: [UpdateUsage] -> Value # toEncodingList :: [UpdateUsage] -> Encoding #
ToHeaders UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Methods toHeaders :: UpdateUsage -> [Header] #
ToPath UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Methods toPath :: UpdateUsage -> ByteString #
ToQuery UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Methods toQuery :: UpdateUsage -> QueryString #
AWSRequest UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Associated Types type AWSResponse UpdateUsage # Methods request :: (Service -> Service) -> UpdateUsage -> Request UpdateUsage # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateUsage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateUsage))) #
Generic UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Associated Types type Rep UpdateUsage :: Type -> Type # Methods from :: UpdateUsage -> Rep UpdateUsage x # to :: Rep UpdateUsage x -> UpdateUsage #
Read UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Methods readsPrec :: Int -> ReadS UpdateUsage # readList :: ReadS [UpdateUsage] # readPrec :: ReadPrec UpdateUsage # readListPrec :: ReadPrec [UpdateUsage] #
Show UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Methods showsPrec :: Int -> UpdateUsage -> ShowS # show :: UpdateUsage -> String # showList :: [UpdateUsage] -> ShowS #
NFData UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Methods rnf :: UpdateUsage -> () #
Eq UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Methods (==) :: UpdateUsage -> UpdateUsage -> Bool # (/=) :: UpdateUsage -> UpdateUsage -> Bool #
Hashable UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage Methods hashWithSalt :: Int -> UpdateUsage -> Int # hash :: UpdateUsage -> Int #
type AWSResponse UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage type AWSResponse UpdateUsage = Usage
type Rep UpdateUsage Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsage type Rep UpdateUsage = D1 ('MetaData "UpdateUsage" "Amazonka.APIGateway.UpdateUsage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateUsage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :: (S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newUpdateUsage Source #

Arguments

:: Text	`UpdateUsage`
-> Text	`$sel:keyId:UpdateUsage'`
-> UpdateUsage

Create a value of UpdateUsage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateUsage', updateUsage_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateUsage, updateUsage_usagePlanId - The Id of the usage plan associated with the usage data.

$sel:keyId:UpdateUsage', updateUsage_keyId - The identifier of the API key associated with the usage plan in which a temporary extension is granted to the remaining quota.

data Usage Source #

Represents the usage data of a usage plan.

See: newUsage smart constructor.

Constructors

Usage' (Maybe Text) (Maybe (HashMap Text [[Integer]])) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods parseJSON :: Value -> Parser Usage # parseJSONList :: Value -> Parser [Usage] #
Generic Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Associated Types type Rep Usage :: Type -> Type # Methods from :: Usage -> Rep Usage x # to :: Rep Usage x -> Usage #
Read Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods readsPrec :: Int -> ReadS Usage # readList :: ReadS [Usage] # readPrec :: ReadPrec Usage # readListPrec :: ReadPrec [Usage] #
Show Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods showsPrec :: Int -> Usage -> ShowS # show :: Usage -> String # showList :: [Usage] -> ShowS #
NFData Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods rnf :: Usage -> () #
Eq Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods (==) :: Usage -> Usage -> Bool # (/=) :: Usage -> Usage -> Bool #
Hashable Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods hashWithSalt :: Int -> Usage -> Int # hash :: Usage -> Int #
type Rep Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage type Rep Usage = D1 ('MetaData "Usage" "Amazonka.APIGateway.Types.Usage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Usage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [[Integer]])))) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newUsage :: Usage Source #

Create a value of Usage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endDate:Usage', usage_endDate - The ending date of the usage data.

$sel:items:Usage', usage_items - The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

$sel:position:Usage', usage_position - Undocumented member.

$sel:startDate:Usage', usage_startDate - The starting date of the usage data.

$sel:usagePlanId:Usage', usage_usagePlanId - The plan Id associated with this usage data.

UpdateUsagePlan

data UpdateUsagePlan Source #

The PATCH request to update a usage plan of a given plan Id.

See: newUpdateUsagePlan smart constructor.

Constructors

UpdateUsagePlan' (Maybe [PatchOperation]) Text

Instances

Instances details

ToJSON UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Methods toJSON :: UpdateUsagePlan -> Value # toEncoding :: UpdateUsagePlan -> Encoding # toJSONList :: [UpdateUsagePlan] -> Value # toEncodingList :: [UpdateUsagePlan] -> Encoding #
ToHeaders UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Methods toHeaders :: UpdateUsagePlan -> [Header] #
ToPath UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Methods toPath :: UpdateUsagePlan -> ByteString #
ToQuery UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Methods toQuery :: UpdateUsagePlan -> QueryString #
AWSRequest UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Associated Types type AWSResponse UpdateUsagePlan # Methods request :: (Service -> Service) -> UpdateUsagePlan -> Request UpdateUsagePlan # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateUsagePlan -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateUsagePlan))) #
Generic UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Associated Types type Rep UpdateUsagePlan :: Type -> Type # Methods from :: UpdateUsagePlan -> Rep UpdateUsagePlan x # to :: Rep UpdateUsagePlan x -> UpdateUsagePlan #
Read UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Methods readsPrec :: Int -> ReadS UpdateUsagePlan # readList :: ReadS [UpdateUsagePlan] # readPrec :: ReadPrec UpdateUsagePlan # readListPrec :: ReadPrec [UpdateUsagePlan] #
Show UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Methods showsPrec :: Int -> UpdateUsagePlan -> ShowS # show :: UpdateUsagePlan -> String # showList :: [UpdateUsagePlan] -> ShowS #
NFData UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Methods rnf :: UpdateUsagePlan -> () #
Eq UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Methods (==) :: UpdateUsagePlan -> UpdateUsagePlan -> Bool # (/=) :: UpdateUsagePlan -> UpdateUsagePlan -> Bool #
Hashable UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan Methods hashWithSalt :: Int -> UpdateUsagePlan -> Int # hash :: UpdateUsagePlan -> Int #
type AWSResponse UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan type AWSResponse UpdateUsagePlan = UsagePlan
type Rep UpdateUsagePlan Source #
Instance details Defined in Amazonka.APIGateway.UpdateUsagePlan type Rep UpdateUsagePlan = D1 ('MetaData "UpdateUsagePlan" "Amazonka.APIGateway.UpdateUsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateUsagePlan'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateUsagePlan Source #

Arguments

:: Text	`UpdateUsagePlan`
-> UpdateUsagePlan

Create a value of UpdateUsagePlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateUsagePlan', updateUsagePlan_patchOperations - For more information about supported patch operations, see Patch Operations.

UpdateUsagePlan, updateUsagePlan_usagePlanId - The Id of the to-be-updated usage plan.

data UsagePlan Source #

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.

See: newUsagePlan smart constructor.

Constructors

UsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings)

Instances

Instances details

FromJSON UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods parseJSON :: Value -> Parser UsagePlan # parseJSONList :: Value -> Parser [UsagePlan] #
Generic UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Associated Types type Rep UsagePlan :: Type -> Type # Methods from :: UsagePlan -> Rep UsagePlan x # to :: Rep UsagePlan x -> UsagePlan #
Read UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods readsPrec :: Int -> ReadS UsagePlan # readList :: ReadS [UsagePlan] # readPrec :: ReadPrec UsagePlan # readListPrec :: ReadPrec [UsagePlan] #
Show UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods showsPrec :: Int -> UsagePlan -> ShowS # show :: UsagePlan -> String # showList :: [UsagePlan] -> ShowS #
NFData UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods rnf :: UsagePlan -> () #
Eq UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods (==) :: UsagePlan -> UsagePlan -> Bool # (/=) :: UsagePlan -> UsagePlan -> Bool #
Hashable UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods hashWithSalt :: Int -> UsagePlan -> Int # hash :: UsagePlan -> Int #
type Rep UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan type Rep UsagePlan = D1 ('MetaData "UsagePlan" "Amazonka.APIGateway.Types.UsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UsagePlan'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiStage])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "quota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaSettings))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings))))))

newUsagePlan :: UsagePlan Source #

Create a value of UsagePlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiStages:UsagePlan', usagePlan_apiStages - The associated API stages of a usage plan.

$sel:description:UsagePlan', usagePlan_description - The description of a usage plan.

$sel:id:UsagePlan', usagePlan_id - The identifier of a UsagePlan resource.

$sel:name:UsagePlan', usagePlan_name - The name of a usage plan.

$sel:productCode:UsagePlan', usagePlan_productCode - The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

$sel:quota:UsagePlan', usagePlan_quota - The target maximum number of permitted requests per a given unit time interval.

$sel:tags:UsagePlan', usagePlan_tags - The collection of tags. Each tag element is associated with a given resource.

UsagePlan, usagePlan_throttle - A map containing method level throttling information for API stage in a usage plan.

UpdateVpcLink

data UpdateVpcLink Source #

Updates an existing VpcLink of a specified identifier.

See: newUpdateVpcLink smart constructor.

Constructors

UpdateVpcLink' (Maybe [PatchOperation]) Text

Instances

Instances details

ToJSON UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Methods toJSON :: UpdateVpcLink -> Value # toEncoding :: UpdateVpcLink -> Encoding # toJSONList :: [UpdateVpcLink] -> Value # toEncodingList :: [UpdateVpcLink] -> Encoding #
ToHeaders UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Methods toHeaders :: UpdateVpcLink -> [Header] #
ToPath UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Methods toPath :: UpdateVpcLink -> ByteString #
ToQuery UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Methods toQuery :: UpdateVpcLink -> QueryString #
AWSRequest UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Associated Types type AWSResponse UpdateVpcLink # Methods request :: (Service -> Service) -> UpdateVpcLink -> Request UpdateVpcLink # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateVpcLink -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateVpcLink))) #
Generic UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Associated Types type Rep UpdateVpcLink :: Type -> Type # Methods from :: UpdateVpcLink -> Rep UpdateVpcLink x # to :: Rep UpdateVpcLink x -> UpdateVpcLink #
Read UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Methods readsPrec :: Int -> ReadS UpdateVpcLink # readList :: ReadS [UpdateVpcLink] # readPrec :: ReadPrec UpdateVpcLink # readListPrec :: ReadPrec [UpdateVpcLink] #
Show UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Methods showsPrec :: Int -> UpdateVpcLink -> ShowS # show :: UpdateVpcLink -> String # showList :: [UpdateVpcLink] -> ShowS #
NFData UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Methods rnf :: UpdateVpcLink -> () #
Eq UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Methods (==) :: UpdateVpcLink -> UpdateVpcLink -> Bool # (/=) :: UpdateVpcLink -> UpdateVpcLink -> Bool #
Hashable UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink Methods hashWithSalt :: Int -> UpdateVpcLink -> Int # hash :: UpdateVpcLink -> Int #
type AWSResponse UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink type AWSResponse UpdateVpcLink = VpcLink
type Rep UpdateVpcLink Source #
Instance details Defined in Amazonka.APIGateway.UpdateVpcLink type Rep UpdateVpcLink = D1 ('MetaData "UpdateVpcLink" "Amazonka.APIGateway.UpdateVpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UpdateVpcLink'" 'PrefixI 'True) (S1 ('MetaSel ('Just "patchOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [PatchOperation])) :*: S1 ('MetaSel ('Just "vpcLinkId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newUpdateVpcLink Source #

Arguments

:: Text	`$sel:vpcLinkId:UpdateVpcLink'`
-> UpdateVpcLink

Create a value of UpdateVpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:patchOperations:UpdateVpcLink', updateVpcLink_patchOperations - For more information about supported patch operations, see Patch Operations.

$sel:vpcLinkId:UpdateVpcLink', updateVpcLink_vpcLinkId - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

data VpcLink Source #

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

See: newVpcLink smart constructor.

Constructors

VpcLink' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text])

Instances

Instances details

FromJSON VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods parseJSON :: Value -> Parser VpcLink # parseJSONList :: Value -> Parser [VpcLink] #
Generic VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Associated Types type Rep VpcLink :: Type -> Type # Methods from :: VpcLink -> Rep VpcLink x # to :: Rep VpcLink x -> VpcLink #
Read VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods readsPrec :: Int -> ReadS VpcLink # readList :: ReadS [VpcLink] # readPrec :: ReadPrec VpcLink # readListPrec :: ReadPrec [VpcLink] #
Show VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods showsPrec :: Int -> VpcLink -> ShowS # show :: VpcLink -> String # showList :: [VpcLink] -> ShowS #
NFData VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods rnf :: VpcLink -> () #
Eq VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods (==) :: VpcLink -> VpcLink -> Bool # (/=) :: VpcLink -> VpcLink -> Bool #
Hashable VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods hashWithSalt :: Int -> VpcLink -> Int # hash :: VpcLink -> Int #
type Rep VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink type Rep VpcLink = D1 ('MetaData "VpcLink" "Amazonka.APIGateway.Types.VpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "VpcLink'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcLinkStatus)) :: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "targetArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newVpcLink :: VpcLink Source #

Create a value of VpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:VpcLink', vpcLink_description - The description of the VPC link.

$sel:id:VpcLink', vpcLink_id - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

$sel:name:VpcLink', vpcLink_name - The name used to label and identify the VPC link.

$sel:status:VpcLink', vpcLink_status - The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

$sel:statusMessage:VpcLink', vpcLink_statusMessage - A description about the VPC link status.

$sel:tags:VpcLink', vpcLink_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:targetArns:VpcLink', vpcLink_targetArns - The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.

Types

ApiKeySourceType

newtype ApiKeySourceType Source #

Constructors

ApiKeySourceType'
Fields fromApiKeySourceType :: Text

Bundled Patterns

pattern ApiKeySourceType_AUTHORIZER :: ApiKeySourceType
pattern ApiKeySourceType_HEADER :: ApiKeySourceType

Instances

Instances details

FromJSON ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods parseJSON :: Value -> Parser ApiKeySourceType # parseJSONList :: Value -> Parser [ApiKeySourceType] #
FromJSONKey ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods fromJSONKey :: FromJSONKeyFunction ApiKeySourceType # fromJSONKeyList :: FromJSONKeyFunction [ApiKeySourceType] #
ToJSON ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods toJSON :: ApiKeySourceType -> Value # toEncoding :: ApiKeySourceType -> Encoding # toJSONList :: [ApiKeySourceType] -> Value # toEncodingList :: [ApiKeySourceType] -> Encoding #
ToJSONKey ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods toJSONKey :: ToJSONKeyFunction ApiKeySourceType # toJSONKeyList :: ToJSONKeyFunction [ApiKeySourceType] #
ToByteString ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods toBS :: ApiKeySourceType -> ByteString #
ToHeader ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods toHeader :: HeaderName -> ApiKeySourceType -> [Header] #
ToLog ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods build :: ApiKeySourceType -> ByteStringBuilder #
ToQuery ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods toQuery :: ApiKeySourceType -> QueryString #
FromText ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods fromText :: Text -> Either String ApiKeySourceType #
ToText ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods toText :: ApiKeySourceType -> Text #
FromXML ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods parseXML :: [Node] -> Either String ApiKeySourceType #
ToXML ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods toXML :: ApiKeySourceType -> XML #
Generic ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Associated Types type Rep ApiKeySourceType :: Type -> Type # Methods from :: ApiKeySourceType -> Rep ApiKeySourceType x # to :: Rep ApiKeySourceType x -> ApiKeySourceType #
Read ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods readsPrec :: Int -> ReadS ApiKeySourceType # readList :: ReadS [ApiKeySourceType] # readPrec :: ReadPrec ApiKeySourceType # readListPrec :: ReadPrec [ApiKeySourceType] #
Show ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods showsPrec :: Int -> ApiKeySourceType -> ShowS # show :: ApiKeySourceType -> String # showList :: [ApiKeySourceType] -> ShowS #
NFData ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods rnf :: ApiKeySourceType -> () #
Eq ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods (==) :: ApiKeySourceType -> ApiKeySourceType -> Bool # (/=) :: ApiKeySourceType -> ApiKeySourceType -> Bool #
Ord ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods compare :: ApiKeySourceType -> ApiKeySourceType -> Ordering # (<) :: ApiKeySourceType -> ApiKeySourceType -> Bool # (<=) :: ApiKeySourceType -> ApiKeySourceType -> Bool # (>) :: ApiKeySourceType -> ApiKeySourceType -> Bool # (>=) :: ApiKeySourceType -> ApiKeySourceType -> Bool # max :: ApiKeySourceType -> ApiKeySourceType -> ApiKeySourceType # min :: ApiKeySourceType -> ApiKeySourceType -> ApiKeySourceType #
Hashable ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType Methods hashWithSalt :: Int -> ApiKeySourceType -> Int # hash :: ApiKeySourceType -> Int #
type Rep ApiKeySourceType Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeySourceType type Rep ApiKeySourceType = D1 ('MetaData "ApiKeySourceType" "Amazonka.APIGateway.Types.ApiKeySourceType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "ApiKeySourceType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromApiKeySourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ApiKeysFormat

newtype ApiKeysFormat Source #

Constructors

ApiKeysFormat'
Fields fromApiKeysFormat :: Text

Bundled Patterns

pattern ApiKeysFormat_Csv :: ApiKeysFormat

Instances

Instances details

FromJSON ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods parseJSON :: Value -> Parser ApiKeysFormat # parseJSONList :: Value -> Parser [ApiKeysFormat] #
FromJSONKey ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods fromJSONKey :: FromJSONKeyFunction ApiKeysFormat # fromJSONKeyList :: FromJSONKeyFunction [ApiKeysFormat] #
ToJSON ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods toJSON :: ApiKeysFormat -> Value # toEncoding :: ApiKeysFormat -> Encoding # toJSONList :: [ApiKeysFormat] -> Value # toEncodingList :: [ApiKeysFormat] -> Encoding #
ToJSONKey ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods toJSONKey :: ToJSONKeyFunction ApiKeysFormat # toJSONKeyList :: ToJSONKeyFunction [ApiKeysFormat] #
ToByteString ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods toBS :: ApiKeysFormat -> ByteString #
ToHeader ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods toHeader :: HeaderName -> ApiKeysFormat -> [Header] #
ToLog ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods build :: ApiKeysFormat -> ByteStringBuilder #
ToQuery ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods toQuery :: ApiKeysFormat -> QueryString #
FromText ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods fromText :: Text -> Either String ApiKeysFormat #
ToText ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods toText :: ApiKeysFormat -> Text #
FromXML ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods parseXML :: [Node] -> Either String ApiKeysFormat #
ToXML ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods toXML :: ApiKeysFormat -> XML #
Generic ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Associated Types type Rep ApiKeysFormat :: Type -> Type # Methods from :: ApiKeysFormat -> Rep ApiKeysFormat x # to :: Rep ApiKeysFormat x -> ApiKeysFormat #
Read ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods readsPrec :: Int -> ReadS ApiKeysFormat # readList :: ReadS [ApiKeysFormat] # readPrec :: ReadPrec ApiKeysFormat # readListPrec :: ReadPrec [ApiKeysFormat] #
Show ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods showsPrec :: Int -> ApiKeysFormat -> ShowS # show :: ApiKeysFormat -> String # showList :: [ApiKeysFormat] -> ShowS #
NFData ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods rnf :: ApiKeysFormat -> () #
Eq ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods (==) :: ApiKeysFormat -> ApiKeysFormat -> Bool # (/=) :: ApiKeysFormat -> ApiKeysFormat -> Bool #
Ord ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods compare :: ApiKeysFormat -> ApiKeysFormat -> Ordering # (<) :: ApiKeysFormat -> ApiKeysFormat -> Bool # (<=) :: ApiKeysFormat -> ApiKeysFormat -> Bool # (>) :: ApiKeysFormat -> ApiKeysFormat -> Bool # (>=) :: ApiKeysFormat -> ApiKeysFormat -> Bool # max :: ApiKeysFormat -> ApiKeysFormat -> ApiKeysFormat # min :: ApiKeysFormat -> ApiKeysFormat -> ApiKeysFormat #
Hashable ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat Methods hashWithSalt :: Int -> ApiKeysFormat -> Int # hash :: ApiKeysFormat -> Int #
type Rep ApiKeysFormat Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKeysFormat type Rep ApiKeysFormat = D1 ('MetaData "ApiKeysFormat" "Amazonka.APIGateway.Types.ApiKeysFormat" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "ApiKeysFormat'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromApiKeysFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AuthorizerType

newtype AuthorizerType Source #

The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

Constructors

AuthorizerType'
Fields fromAuthorizerType :: Text

Bundled Patterns

pattern AuthorizerType_COGNITO_USER_POOLS :: AuthorizerType
pattern AuthorizerType_REQUEST :: AuthorizerType
pattern AuthorizerType_TOKEN :: AuthorizerType

Instances

Instances details

FromJSON AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods parseJSON :: Value -> Parser AuthorizerType # parseJSONList :: Value -> Parser [AuthorizerType] #
FromJSONKey AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods fromJSONKey :: FromJSONKeyFunction AuthorizerType # fromJSONKeyList :: FromJSONKeyFunction [AuthorizerType] #
ToJSON AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods toJSON :: AuthorizerType -> Value # toEncoding :: AuthorizerType -> Encoding # toJSONList :: [AuthorizerType] -> Value # toEncodingList :: [AuthorizerType] -> Encoding #
ToJSONKey AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods toJSONKey :: ToJSONKeyFunction AuthorizerType # toJSONKeyList :: ToJSONKeyFunction [AuthorizerType] #
ToByteString AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods toBS :: AuthorizerType -> ByteString #
ToHeader AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods toHeader :: HeaderName -> AuthorizerType -> [Header] #
ToLog AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods build :: AuthorizerType -> ByteStringBuilder #
ToQuery AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods toQuery :: AuthorizerType -> QueryString #
FromText AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods fromText :: Text -> Either String AuthorizerType #
ToText AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods toText :: AuthorizerType -> Text #
FromXML AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods parseXML :: [Node] -> Either String AuthorizerType #
ToXML AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods toXML :: AuthorizerType -> XML #
Generic AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Associated Types type Rep AuthorizerType :: Type -> Type # Methods from :: AuthorizerType -> Rep AuthorizerType x # to :: Rep AuthorizerType x -> AuthorizerType #
Read AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods readsPrec :: Int -> ReadS AuthorizerType # readList :: ReadS [AuthorizerType] # readPrec :: ReadPrec AuthorizerType # readListPrec :: ReadPrec [AuthorizerType] #
Show AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods showsPrec :: Int -> AuthorizerType -> ShowS # show :: AuthorizerType -> String # showList :: [AuthorizerType] -> ShowS #
NFData AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods rnf :: AuthorizerType -> () #
Eq AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods (==) :: AuthorizerType -> AuthorizerType -> Bool # (/=) :: AuthorizerType -> AuthorizerType -> Bool #
Ord AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods compare :: AuthorizerType -> AuthorizerType -> Ordering # (<) :: AuthorizerType -> AuthorizerType -> Bool # (<=) :: AuthorizerType -> AuthorizerType -> Bool # (>) :: AuthorizerType -> AuthorizerType -> Bool # (>=) :: AuthorizerType -> AuthorizerType -> Bool # max :: AuthorizerType -> AuthorizerType -> AuthorizerType # min :: AuthorizerType -> AuthorizerType -> AuthorizerType #
Hashable AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType Methods hashWithSalt :: Int -> AuthorizerType -> Int # hash :: AuthorizerType -> Int #
type Rep AuthorizerType Source #
Instance details Defined in Amazonka.APIGateway.Types.AuthorizerType type Rep AuthorizerType = D1 ('MetaData "AuthorizerType" "Amazonka.APIGateway.Types.AuthorizerType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "AuthorizerType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromAuthorizerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CacheClusterSize

newtype CacheClusterSize Source #

Returns the size of the CacheCluster.

Constructors

CacheClusterSize'
Fields fromCacheClusterSize :: Text

Bundled Patterns

pattern CacheClusterSize_ :: CacheClusterSize

Instances

Instances details

FromJSON CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods parseJSON :: Value -> Parser CacheClusterSize # parseJSONList :: Value -> Parser [CacheClusterSize] #
FromJSONKey CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods fromJSONKey :: FromJSONKeyFunction CacheClusterSize # fromJSONKeyList :: FromJSONKeyFunction [CacheClusterSize] #
ToJSON CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods toJSON :: CacheClusterSize -> Value # toEncoding :: CacheClusterSize -> Encoding # toJSONList :: [CacheClusterSize] -> Value # toEncodingList :: [CacheClusterSize] -> Encoding #
ToJSONKey CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods toJSONKey :: ToJSONKeyFunction CacheClusterSize # toJSONKeyList :: ToJSONKeyFunction [CacheClusterSize] #
ToByteString CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods toBS :: CacheClusterSize -> ByteString #
ToHeader CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods toHeader :: HeaderName -> CacheClusterSize -> [Header] #
ToLog CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods build :: CacheClusterSize -> ByteStringBuilder #
ToQuery CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods toQuery :: CacheClusterSize -> QueryString #
FromText CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods fromText :: Text -> Either String CacheClusterSize #
ToText CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods toText :: CacheClusterSize -> Text #
FromXML CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods parseXML :: [Node] -> Either String CacheClusterSize #
ToXML CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods toXML :: CacheClusterSize -> XML #
Generic CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Associated Types type Rep CacheClusterSize :: Type -> Type # Methods from :: CacheClusterSize -> Rep CacheClusterSize x # to :: Rep CacheClusterSize x -> CacheClusterSize #
Read CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods readsPrec :: Int -> ReadS CacheClusterSize # readList :: ReadS [CacheClusterSize] # readPrec :: ReadPrec CacheClusterSize # readListPrec :: ReadPrec [CacheClusterSize] #
Show CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods showsPrec :: Int -> CacheClusterSize -> ShowS # show :: CacheClusterSize -> String # showList :: [CacheClusterSize] -> ShowS #
NFData CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods rnf :: CacheClusterSize -> () #
Eq CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods (==) :: CacheClusterSize -> CacheClusterSize -> Bool # (/=) :: CacheClusterSize -> CacheClusterSize -> Bool #
Ord CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods compare :: CacheClusterSize -> CacheClusterSize -> Ordering # (<) :: CacheClusterSize -> CacheClusterSize -> Bool # (<=) :: CacheClusterSize -> CacheClusterSize -> Bool # (>) :: CacheClusterSize -> CacheClusterSize -> Bool # (>=) :: CacheClusterSize -> CacheClusterSize -> Bool # max :: CacheClusterSize -> CacheClusterSize -> CacheClusterSize # min :: CacheClusterSize -> CacheClusterSize -> CacheClusterSize #
Hashable CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize Methods hashWithSalt :: Int -> CacheClusterSize -> Int # hash :: CacheClusterSize -> Int #
type Rep CacheClusterSize Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterSize type Rep CacheClusterSize = D1 ('MetaData "CacheClusterSize" "Amazonka.APIGateway.Types.CacheClusterSize" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "CacheClusterSize'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCacheClusterSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

CacheClusterStatus

newtype CacheClusterStatus Source #

Returns the status of the CacheCluster.

Constructors

CacheClusterStatus'
Fields fromCacheClusterStatus :: Text

Bundled Patterns

pattern CacheClusterStatus_AVAILABLE :: CacheClusterStatus
pattern CacheClusterStatus_CREATE_IN_PROGRESS :: CacheClusterStatus
pattern CacheClusterStatus_DELETE_IN_PROGRESS :: CacheClusterStatus
pattern CacheClusterStatus_FLUSH_IN_PROGRESS :: CacheClusterStatus
pattern CacheClusterStatus_NOT_AVAILABLE :: CacheClusterStatus

Instances

Instances details

FromJSON CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods parseJSON :: Value -> Parser CacheClusterStatus # parseJSONList :: Value -> Parser [CacheClusterStatus] #
FromJSONKey CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods fromJSONKey :: FromJSONKeyFunction CacheClusterStatus # fromJSONKeyList :: FromJSONKeyFunction [CacheClusterStatus] #
ToJSON CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods toJSON :: CacheClusterStatus -> Value # toEncoding :: CacheClusterStatus -> Encoding # toJSONList :: [CacheClusterStatus] -> Value # toEncodingList :: [CacheClusterStatus] -> Encoding #
ToJSONKey CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods toJSONKey :: ToJSONKeyFunction CacheClusterStatus # toJSONKeyList :: ToJSONKeyFunction [CacheClusterStatus] #
ToByteString CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods toBS :: CacheClusterStatus -> ByteString #
ToHeader CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods toHeader :: HeaderName -> CacheClusterStatus -> [Header] #
ToLog CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods build :: CacheClusterStatus -> ByteStringBuilder #
ToQuery CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods toQuery :: CacheClusterStatus -> QueryString #
FromText CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods fromText :: Text -> Either String CacheClusterStatus #
ToText CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods toText :: CacheClusterStatus -> Text #
FromXML CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods parseXML :: [Node] -> Either String CacheClusterStatus #
ToXML CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods toXML :: CacheClusterStatus -> XML #
Generic CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Associated Types type Rep CacheClusterStatus :: Type -> Type # Methods from :: CacheClusterStatus -> Rep CacheClusterStatus x # to :: Rep CacheClusterStatus x -> CacheClusterStatus #
Read CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods readsPrec :: Int -> ReadS CacheClusterStatus # readList :: ReadS [CacheClusterStatus] # readPrec :: ReadPrec CacheClusterStatus # readListPrec :: ReadPrec [CacheClusterStatus] #
Show CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods showsPrec :: Int -> CacheClusterStatus -> ShowS # show :: CacheClusterStatus -> String # showList :: [CacheClusterStatus] -> ShowS #
NFData CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods rnf :: CacheClusterStatus -> () #
Eq CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods (==) :: CacheClusterStatus -> CacheClusterStatus -> Bool # (/=) :: CacheClusterStatus -> CacheClusterStatus -> Bool #
Ord CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods compare :: CacheClusterStatus -> CacheClusterStatus -> Ordering # (<) :: CacheClusterStatus -> CacheClusterStatus -> Bool # (<=) :: CacheClusterStatus -> CacheClusterStatus -> Bool # (>) :: CacheClusterStatus -> CacheClusterStatus -> Bool # (>=) :: CacheClusterStatus -> CacheClusterStatus -> Bool # max :: CacheClusterStatus -> CacheClusterStatus -> CacheClusterStatus # min :: CacheClusterStatus -> CacheClusterStatus -> CacheClusterStatus #
Hashable CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus Methods hashWithSalt :: Int -> CacheClusterStatus -> Int # hash :: CacheClusterStatus -> Int #
type Rep CacheClusterStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.CacheClusterStatus type Rep CacheClusterStatus = D1 ('MetaData "CacheClusterStatus" "Amazonka.APIGateway.Types.CacheClusterStatus" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "CacheClusterStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromCacheClusterStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ConnectionType

newtype ConnectionType Source #

Constructors

ConnectionType'
Fields fromConnectionType :: Text

Bundled Patterns

pattern ConnectionType_INTERNET :: ConnectionType
pattern ConnectionType_VPC_LINK :: ConnectionType

Instances

Instances details

FromJSON ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods parseJSON :: Value -> Parser ConnectionType # parseJSONList :: Value -> Parser [ConnectionType] #
FromJSONKey ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods fromJSONKey :: FromJSONKeyFunction ConnectionType # fromJSONKeyList :: FromJSONKeyFunction [ConnectionType] #
ToJSON ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods toJSON :: ConnectionType -> Value # toEncoding :: ConnectionType -> Encoding # toJSONList :: [ConnectionType] -> Value # toEncodingList :: [ConnectionType] -> Encoding #
ToJSONKey ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods toJSONKey :: ToJSONKeyFunction ConnectionType # toJSONKeyList :: ToJSONKeyFunction [ConnectionType] #
ToByteString ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods toBS :: ConnectionType -> ByteString #
ToHeader ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods toHeader :: HeaderName -> ConnectionType -> [Header] #
ToLog ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods build :: ConnectionType -> ByteStringBuilder #
ToQuery ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods toQuery :: ConnectionType -> QueryString #
FromText ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods fromText :: Text -> Either String ConnectionType #
ToText ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods toText :: ConnectionType -> Text #
FromXML ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods parseXML :: [Node] -> Either String ConnectionType #
ToXML ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods toXML :: ConnectionType -> XML #
Generic ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Associated Types type Rep ConnectionType :: Type -> Type # Methods from :: ConnectionType -> Rep ConnectionType x # to :: Rep ConnectionType x -> ConnectionType #
Read ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods readsPrec :: Int -> ReadS ConnectionType # readList :: ReadS [ConnectionType] # readPrec :: ReadPrec ConnectionType # readListPrec :: ReadPrec [ConnectionType] #
Show ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods showsPrec :: Int -> ConnectionType -> ShowS # show :: ConnectionType -> String # showList :: [ConnectionType] -> ShowS #
NFData ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods rnf :: ConnectionType -> () #
Eq ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods (==) :: ConnectionType -> ConnectionType -> Bool # (/=) :: ConnectionType -> ConnectionType -> Bool #
Ord ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods compare :: ConnectionType -> ConnectionType -> Ordering # (<) :: ConnectionType -> ConnectionType -> Bool # (<=) :: ConnectionType -> ConnectionType -> Bool # (>) :: ConnectionType -> ConnectionType -> Bool # (>=) :: ConnectionType -> ConnectionType -> Bool # max :: ConnectionType -> ConnectionType -> ConnectionType # min :: ConnectionType -> ConnectionType -> ConnectionType #
Hashable ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType Methods hashWithSalt :: Int -> ConnectionType -> Int # hash :: ConnectionType -> Int #
type Rep ConnectionType Source #
Instance details Defined in Amazonka.APIGateway.Types.ConnectionType type Rep ConnectionType = D1 ('MetaData "ConnectionType" "Amazonka.APIGateway.Types.ConnectionType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "ConnectionType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromConnectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

ContentHandlingStrategy

newtype ContentHandlingStrategy Source #

Constructors

ContentHandlingStrategy'
Fields fromContentHandlingStrategy :: Text

Bundled Patterns

pattern ContentHandlingStrategy_CONVERT_TO_BINARY :: ContentHandlingStrategy
pattern ContentHandlingStrategy_CONVERT_TO_TEXT :: ContentHandlingStrategy

Instances

Instances details

FromJSON ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods parseJSON :: Value -> Parser ContentHandlingStrategy # parseJSONList :: Value -> Parser [ContentHandlingStrategy] #
FromJSONKey ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods fromJSONKey :: FromJSONKeyFunction ContentHandlingStrategy # fromJSONKeyList :: FromJSONKeyFunction [ContentHandlingStrategy] #
ToJSON ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods toJSON :: ContentHandlingStrategy -> Value # toEncoding :: ContentHandlingStrategy -> Encoding # toJSONList :: [ContentHandlingStrategy] -> Value # toEncodingList :: [ContentHandlingStrategy] -> Encoding #
ToJSONKey ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods toJSONKey :: ToJSONKeyFunction ContentHandlingStrategy # toJSONKeyList :: ToJSONKeyFunction [ContentHandlingStrategy] #
ToByteString ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods toBS :: ContentHandlingStrategy -> ByteString #
ToHeader ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods toHeader :: HeaderName -> ContentHandlingStrategy -> [Header] #
ToLog ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods build :: ContentHandlingStrategy -> ByteStringBuilder #
ToQuery ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods toQuery :: ContentHandlingStrategy -> QueryString #
FromText ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods fromText :: Text -> Either String ContentHandlingStrategy #
ToText ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods toText :: ContentHandlingStrategy -> Text #
FromXML ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods parseXML :: [Node] -> Either String ContentHandlingStrategy #
ToXML ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods toXML :: ContentHandlingStrategy -> XML #
Generic ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Associated Types type Rep ContentHandlingStrategy :: Type -> Type # Methods from :: ContentHandlingStrategy -> Rep ContentHandlingStrategy x # to :: Rep ContentHandlingStrategy x -> ContentHandlingStrategy #
Read ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods readsPrec :: Int -> ReadS ContentHandlingStrategy # readList :: ReadS [ContentHandlingStrategy] # readPrec :: ReadPrec ContentHandlingStrategy # readListPrec :: ReadPrec [ContentHandlingStrategy] #
Show ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods showsPrec :: Int -> ContentHandlingStrategy -> ShowS # show :: ContentHandlingStrategy -> String # showList :: [ContentHandlingStrategy] -> ShowS #
NFData ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods rnf :: ContentHandlingStrategy -> () #
Eq ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods (==) :: ContentHandlingStrategy -> ContentHandlingStrategy -> Bool # (/=) :: ContentHandlingStrategy -> ContentHandlingStrategy -> Bool #
Ord ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods compare :: ContentHandlingStrategy -> ContentHandlingStrategy -> Ordering # (<) :: ContentHandlingStrategy -> ContentHandlingStrategy -> Bool # (<=) :: ContentHandlingStrategy -> ContentHandlingStrategy -> Bool # (>) :: ContentHandlingStrategy -> ContentHandlingStrategy -> Bool # (>=) :: ContentHandlingStrategy -> ContentHandlingStrategy -> Bool # max :: ContentHandlingStrategy -> ContentHandlingStrategy -> ContentHandlingStrategy # min :: ContentHandlingStrategy -> ContentHandlingStrategy -> ContentHandlingStrategy #
Hashable ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy Methods hashWithSalt :: Int -> ContentHandlingStrategy -> Int # hash :: ContentHandlingStrategy -> Int #
type Rep ContentHandlingStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.ContentHandlingStrategy type Rep ContentHandlingStrategy = D1 ('MetaData "ContentHandlingStrategy" "Amazonka.APIGateway.Types.ContentHandlingStrategy" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "ContentHandlingStrategy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromContentHandlingStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DocumentationPartType

newtype DocumentationPartType Source #

Constructors

DocumentationPartType'
Fields fromDocumentationPartType :: Text

Bundled Patterns

pattern DocumentationPartType_API :: DocumentationPartType
pattern DocumentationPartType_AUTHORIZER :: DocumentationPartType
pattern DocumentationPartType_METHOD :: DocumentationPartType
pattern DocumentationPartType_MODEL :: DocumentationPartType
pattern DocumentationPartType_PATH_PARAMETER :: DocumentationPartType
pattern DocumentationPartType_QUERY_PARAMETER :: DocumentationPartType
pattern DocumentationPartType_REQUEST_BODY :: DocumentationPartType
pattern DocumentationPartType_REQUEST_HEADER :: DocumentationPartType
pattern DocumentationPartType_RESOURCE :: DocumentationPartType
pattern DocumentationPartType_RESPONSE :: DocumentationPartType
pattern DocumentationPartType_RESPONSE_BODY :: DocumentationPartType
pattern DocumentationPartType_RESPONSE_HEADER :: DocumentationPartType

Instances

Instances details

FromJSON DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods parseJSON :: Value -> Parser DocumentationPartType # parseJSONList :: Value -> Parser [DocumentationPartType] #
FromJSONKey DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods fromJSONKey :: FromJSONKeyFunction DocumentationPartType # fromJSONKeyList :: FromJSONKeyFunction [DocumentationPartType] #
ToJSON DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods toJSON :: DocumentationPartType -> Value # toEncoding :: DocumentationPartType -> Encoding # toJSONList :: [DocumentationPartType] -> Value # toEncodingList :: [DocumentationPartType] -> Encoding #
ToJSONKey DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods toJSONKey :: ToJSONKeyFunction DocumentationPartType # toJSONKeyList :: ToJSONKeyFunction [DocumentationPartType] #
ToByteString DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods toBS :: DocumentationPartType -> ByteString #
ToHeader DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods toHeader :: HeaderName -> DocumentationPartType -> [Header] #
ToLog DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods build :: DocumentationPartType -> ByteStringBuilder #
ToQuery DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods toQuery :: DocumentationPartType -> QueryString #
FromText DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods fromText :: Text -> Either String DocumentationPartType #
ToText DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods toText :: DocumentationPartType -> Text #
FromXML DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods parseXML :: [Node] -> Either String DocumentationPartType #
ToXML DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods toXML :: DocumentationPartType -> XML #
Generic DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Associated Types type Rep DocumentationPartType :: Type -> Type # Methods from :: DocumentationPartType -> Rep DocumentationPartType x # to :: Rep DocumentationPartType x -> DocumentationPartType #
Read DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods readsPrec :: Int -> ReadS DocumentationPartType # readList :: ReadS [DocumentationPartType] # readPrec :: ReadPrec DocumentationPartType # readListPrec :: ReadPrec [DocumentationPartType] #
Show DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods showsPrec :: Int -> DocumentationPartType -> ShowS # show :: DocumentationPartType -> String # showList :: [DocumentationPartType] -> ShowS #
NFData DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods rnf :: DocumentationPartType -> () #
Eq DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods (==) :: DocumentationPartType -> DocumentationPartType -> Bool # (/=) :: DocumentationPartType -> DocumentationPartType -> Bool #
Ord DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods compare :: DocumentationPartType -> DocumentationPartType -> Ordering # (<) :: DocumentationPartType -> DocumentationPartType -> Bool # (<=) :: DocumentationPartType -> DocumentationPartType -> Bool # (>) :: DocumentationPartType -> DocumentationPartType -> Bool # (>=) :: DocumentationPartType -> DocumentationPartType -> Bool # max :: DocumentationPartType -> DocumentationPartType -> DocumentationPartType # min :: DocumentationPartType -> DocumentationPartType -> DocumentationPartType #
Hashable DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType Methods hashWithSalt :: Int -> DocumentationPartType -> Int # hash :: DocumentationPartType -> Int #
type Rep DocumentationPartType Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartType type Rep DocumentationPartType = D1 ('MetaData "DocumentationPartType" "Amazonka.APIGateway.Types.DocumentationPartType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "DocumentationPartType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDocumentationPartType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

DomainNameStatus

newtype DomainNameStatus Source #

Constructors

DomainNameStatus'
Fields fromDomainNameStatus :: Text

Bundled Patterns

pattern DomainNameStatus_AVAILABLE :: DomainNameStatus
pattern DomainNameStatus_PENDING :: DomainNameStatus
pattern DomainNameStatus_PENDING_CERTIFICATE_REIMPORT :: DomainNameStatus
pattern DomainNameStatus_PENDING_OWNERSHIP_VERIFICATION :: DomainNameStatus
pattern DomainNameStatus_UPDATING :: DomainNameStatus

Instances

Instances details

FromJSON DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods parseJSON :: Value -> Parser DomainNameStatus # parseJSONList :: Value -> Parser [DomainNameStatus] #
FromJSONKey DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods fromJSONKey :: FromJSONKeyFunction DomainNameStatus # fromJSONKeyList :: FromJSONKeyFunction [DomainNameStatus] #
ToJSON DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods toJSON :: DomainNameStatus -> Value # toEncoding :: DomainNameStatus -> Encoding # toJSONList :: [DomainNameStatus] -> Value # toEncodingList :: [DomainNameStatus] -> Encoding #
ToJSONKey DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods toJSONKey :: ToJSONKeyFunction DomainNameStatus # toJSONKeyList :: ToJSONKeyFunction [DomainNameStatus] #
ToByteString DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods toBS :: DomainNameStatus -> ByteString #
ToHeader DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods toHeader :: HeaderName -> DomainNameStatus -> [Header] #
ToLog DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods build :: DomainNameStatus -> ByteStringBuilder #
ToQuery DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods toQuery :: DomainNameStatus -> QueryString #
FromText DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods fromText :: Text -> Either String DomainNameStatus #
ToText DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods toText :: DomainNameStatus -> Text #
FromXML DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods parseXML :: [Node] -> Either String DomainNameStatus #
ToXML DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods toXML :: DomainNameStatus -> XML #
Generic DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Associated Types type Rep DomainNameStatus :: Type -> Type # Methods from :: DomainNameStatus -> Rep DomainNameStatus x # to :: Rep DomainNameStatus x -> DomainNameStatus #
Read DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods readsPrec :: Int -> ReadS DomainNameStatus # readList :: ReadS [DomainNameStatus] # readPrec :: ReadPrec DomainNameStatus # readListPrec :: ReadPrec [DomainNameStatus] #
Show DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods showsPrec :: Int -> DomainNameStatus -> ShowS # show :: DomainNameStatus -> String # showList :: [DomainNameStatus] -> ShowS #
NFData DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods rnf :: DomainNameStatus -> () #
Eq DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods (==) :: DomainNameStatus -> DomainNameStatus -> Bool # (/=) :: DomainNameStatus -> DomainNameStatus -> Bool #
Ord DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods compare :: DomainNameStatus -> DomainNameStatus -> Ordering # (<) :: DomainNameStatus -> DomainNameStatus -> Bool # (<=) :: DomainNameStatus -> DomainNameStatus -> Bool # (>) :: DomainNameStatus -> DomainNameStatus -> Bool # (>=) :: DomainNameStatus -> DomainNameStatus -> Bool # max :: DomainNameStatus -> DomainNameStatus -> DomainNameStatus # min :: DomainNameStatus -> DomainNameStatus -> DomainNameStatus #
Hashable DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus Methods hashWithSalt :: Int -> DomainNameStatus -> Int # hash :: DomainNameStatus -> Int #
type Rep DomainNameStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainNameStatus type Rep DomainNameStatus = D1 ('MetaData "DomainNameStatus" "Amazonka.APIGateway.Types.DomainNameStatus" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "DomainNameStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromDomainNameStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

EndpointType

newtype EndpointType Source #

The endpoint type. The valid values are EDGE for edge-optimized API setup, most suitable for mobile applications; REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region; and PRIVATE for private APIs.

Constructors

EndpointType'
Fields fromEndpointType :: Text

Bundled Patterns

pattern EndpointType_EDGE :: EndpointType
pattern EndpointType_PRIVATE :: EndpointType
pattern EndpointType_REGIONAL :: EndpointType

Instances

Instances details

FromJSON EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods parseJSON :: Value -> Parser EndpointType # parseJSONList :: Value -> Parser [EndpointType] #
FromJSONKey EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods fromJSONKey :: FromJSONKeyFunction EndpointType # fromJSONKeyList :: FromJSONKeyFunction [EndpointType] #
ToJSON EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods toJSON :: EndpointType -> Value # toEncoding :: EndpointType -> Encoding # toJSONList :: [EndpointType] -> Value # toEncodingList :: [EndpointType] -> Encoding #
ToJSONKey EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods toJSONKey :: ToJSONKeyFunction EndpointType # toJSONKeyList :: ToJSONKeyFunction [EndpointType] #
ToByteString EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods toBS :: EndpointType -> ByteString #
ToHeader EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods toHeader :: HeaderName -> EndpointType -> [Header] #
ToLog EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods build :: EndpointType -> ByteStringBuilder #
ToQuery EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods toQuery :: EndpointType -> QueryString #
FromText EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods fromText :: Text -> Either String EndpointType #
ToText EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods toText :: EndpointType -> Text #
FromXML EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods parseXML :: [Node] -> Either String EndpointType #
ToXML EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods toXML :: EndpointType -> XML #
Generic EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Associated Types type Rep EndpointType :: Type -> Type # Methods from :: EndpointType -> Rep EndpointType x # to :: Rep EndpointType x -> EndpointType #
Read EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods readsPrec :: Int -> ReadS EndpointType # readList :: ReadS [EndpointType] # readPrec :: ReadPrec EndpointType # readListPrec :: ReadPrec [EndpointType] #
Show EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods showsPrec :: Int -> EndpointType -> ShowS # show :: EndpointType -> String # showList :: [EndpointType] -> ShowS #
NFData EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods rnf :: EndpointType -> () #
Eq EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods (==) :: EndpointType -> EndpointType -> Bool # (/=) :: EndpointType -> EndpointType -> Bool #
Ord EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods compare :: EndpointType -> EndpointType -> Ordering # (<) :: EndpointType -> EndpointType -> Bool # (<=) :: EndpointType -> EndpointType -> Bool # (>) :: EndpointType -> EndpointType -> Bool # (>=) :: EndpointType -> EndpointType -> Bool # max :: EndpointType -> EndpointType -> EndpointType # min :: EndpointType -> EndpointType -> EndpointType #
Hashable EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType Methods hashWithSalt :: Int -> EndpointType -> Int # hash :: EndpointType -> Int #
type Rep EndpointType Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointType type Rep EndpointType = D1 ('MetaData "EndpointType" "Amazonka.APIGateway.Types.EndpointType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "EndpointType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromEndpointType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

GatewayResponseType

newtype GatewayResponseType Source #

Constructors

GatewayResponseType'
Fields fromGatewayResponseType :: Text

Bundled Patterns

pattern GatewayResponseType_ACCESS_DENIED :: GatewayResponseType
pattern GatewayResponseType_API_CONFIGURATION_ERROR :: GatewayResponseType
pattern GatewayResponseType_AUTHORIZER_CONFIGURATION_ERROR :: GatewayResponseType
pattern GatewayResponseType_AUTHORIZER_FAILURE :: GatewayResponseType
pattern GatewayResponseType_BAD_REQUEST_BODY :: GatewayResponseType
pattern GatewayResponseType_BAD_REQUEST_PARAMETERS :: GatewayResponseType
pattern GatewayResponseType_DEFAULT_4XX :: GatewayResponseType
pattern GatewayResponseType_DEFAULT_5XX :: GatewayResponseType
pattern GatewayResponseType_EXPIRED_TOKEN :: GatewayResponseType
pattern GatewayResponseType_INTEGRATION_FAILURE :: GatewayResponseType
pattern GatewayResponseType_INTEGRATION_TIMEOUT :: GatewayResponseType
pattern GatewayResponseType_INVALID_API_KEY :: GatewayResponseType
pattern GatewayResponseType_INVALID_SIGNATURE :: GatewayResponseType
pattern GatewayResponseType_MISSING_AUTHENTICATION_TOKEN :: GatewayResponseType
pattern GatewayResponseType_QUOTA_EXCEEDED :: GatewayResponseType
pattern GatewayResponseType_REQUEST_TOO_LARGE :: GatewayResponseType
pattern GatewayResponseType_RESOURCE_NOT_FOUND :: GatewayResponseType
pattern GatewayResponseType_THROTTLED :: GatewayResponseType
pattern GatewayResponseType_UNAUTHORIZED :: GatewayResponseType
pattern GatewayResponseType_UNSUPPORTED_MEDIA_TYPE :: GatewayResponseType
pattern GatewayResponseType_WAF_FILTERED :: GatewayResponseType

Instances

Instances details

FromJSON GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods parseJSON :: Value -> Parser GatewayResponseType # parseJSONList :: Value -> Parser [GatewayResponseType] #
FromJSONKey GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods fromJSONKey :: FromJSONKeyFunction GatewayResponseType # fromJSONKeyList :: FromJSONKeyFunction [GatewayResponseType] #
ToJSON GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods toJSON :: GatewayResponseType -> Value # toEncoding :: GatewayResponseType -> Encoding # toJSONList :: [GatewayResponseType] -> Value # toEncodingList :: [GatewayResponseType] -> Encoding #
ToJSONKey GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods toJSONKey :: ToJSONKeyFunction GatewayResponseType # toJSONKeyList :: ToJSONKeyFunction [GatewayResponseType] #
ToByteString GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods toBS :: GatewayResponseType -> ByteString #
ToHeader GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods toHeader :: HeaderName -> GatewayResponseType -> [Header] #
ToLog GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods build :: GatewayResponseType -> ByteStringBuilder #
ToQuery GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods toQuery :: GatewayResponseType -> QueryString #
FromText GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods fromText :: Text -> Either String GatewayResponseType #
ToText GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods toText :: GatewayResponseType -> Text #
FromXML GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods parseXML :: [Node] -> Either String GatewayResponseType #
ToXML GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods toXML :: GatewayResponseType -> XML #
Generic GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Associated Types type Rep GatewayResponseType :: Type -> Type # Methods from :: GatewayResponseType -> Rep GatewayResponseType x # to :: Rep GatewayResponseType x -> GatewayResponseType #
Read GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods readsPrec :: Int -> ReadS GatewayResponseType # readList :: ReadS [GatewayResponseType] # readPrec :: ReadPrec GatewayResponseType # readListPrec :: ReadPrec [GatewayResponseType] #
Show GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods showsPrec :: Int -> GatewayResponseType -> ShowS # show :: GatewayResponseType -> String # showList :: [GatewayResponseType] -> ShowS #
NFData GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods rnf :: GatewayResponseType -> () #
Eq GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods (==) :: GatewayResponseType -> GatewayResponseType -> Bool # (/=) :: GatewayResponseType -> GatewayResponseType -> Bool #
Ord GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods compare :: GatewayResponseType -> GatewayResponseType -> Ordering # (<) :: GatewayResponseType -> GatewayResponseType -> Bool # (<=) :: GatewayResponseType -> GatewayResponseType -> Bool # (>) :: GatewayResponseType -> GatewayResponseType -> Bool # (>=) :: GatewayResponseType -> GatewayResponseType -> Bool # max :: GatewayResponseType -> GatewayResponseType -> GatewayResponseType # min :: GatewayResponseType -> GatewayResponseType -> GatewayResponseType #
Hashable GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType Methods hashWithSalt :: Int -> GatewayResponseType -> Int # hash :: GatewayResponseType -> Int #
type Rep GatewayResponseType Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponseType type Rep GatewayResponseType = D1 ('MetaData "GatewayResponseType" "Amazonka.APIGateway.Types.GatewayResponseType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "GatewayResponseType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromGatewayResponseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

IntegrationType

newtype IntegrationType Source #

The integration type. The valid value is HTTP for integrating an API method with an HTTP backend; AWS with any AWS service endpoints; MOCK for testing without actually invoking the backend; HTTP_PROXY for integrating with the HTTP proxy integration; AWS_PROXY for integrating with the Lambda proxy integration.

Constructors

IntegrationType'
Fields fromIntegrationType :: Text

Bundled Patterns

pattern IntegrationType_AWS :: IntegrationType
pattern IntegrationType_AWS_PROXY :: IntegrationType
pattern IntegrationType_HTTP :: IntegrationType
pattern IntegrationType_HTTP_PROXY :: IntegrationType
pattern IntegrationType_MOCK :: IntegrationType

Instances

Instances details

FromJSON IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods parseJSON :: Value -> Parser IntegrationType # parseJSONList :: Value -> Parser [IntegrationType] #
FromJSONKey IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods fromJSONKey :: FromJSONKeyFunction IntegrationType # fromJSONKeyList :: FromJSONKeyFunction [IntegrationType] #
ToJSON IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods toJSON :: IntegrationType -> Value # toEncoding :: IntegrationType -> Encoding # toJSONList :: [IntegrationType] -> Value # toEncodingList :: [IntegrationType] -> Encoding #
ToJSONKey IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods toJSONKey :: ToJSONKeyFunction IntegrationType # toJSONKeyList :: ToJSONKeyFunction [IntegrationType] #
ToByteString IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods toBS :: IntegrationType -> ByteString #
ToHeader IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods toHeader :: HeaderName -> IntegrationType -> [Header] #
ToLog IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods build :: IntegrationType -> ByteStringBuilder #
ToQuery IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods toQuery :: IntegrationType -> QueryString #
FromText IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods fromText :: Text -> Either String IntegrationType #
ToText IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods toText :: IntegrationType -> Text #
FromXML IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods parseXML :: [Node] -> Either String IntegrationType #
ToXML IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods toXML :: IntegrationType -> XML #
Generic IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Associated Types type Rep IntegrationType :: Type -> Type # Methods from :: IntegrationType -> Rep IntegrationType x # to :: Rep IntegrationType x -> IntegrationType #
Read IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods readsPrec :: Int -> ReadS IntegrationType # readList :: ReadS [IntegrationType] # readPrec :: ReadPrec IntegrationType # readListPrec :: ReadPrec [IntegrationType] #
Show IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods showsPrec :: Int -> IntegrationType -> ShowS # show :: IntegrationType -> String # showList :: [IntegrationType] -> ShowS #
NFData IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods rnf :: IntegrationType -> () #
Eq IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods (==) :: IntegrationType -> IntegrationType -> Bool # (/=) :: IntegrationType -> IntegrationType -> Bool #
Ord IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods compare :: IntegrationType -> IntegrationType -> Ordering # (<) :: IntegrationType -> IntegrationType -> Bool # (<=) :: IntegrationType -> IntegrationType -> Bool # (>) :: IntegrationType -> IntegrationType -> Bool # (>=) :: IntegrationType -> IntegrationType -> Bool # max :: IntegrationType -> IntegrationType -> IntegrationType # min :: IntegrationType -> IntegrationType -> IntegrationType #
Hashable IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType Methods hashWithSalt :: Int -> IntegrationType -> Int # hash :: IntegrationType -> Int #
type Rep IntegrationType Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationType type Rep IntegrationType = D1 ('MetaData "IntegrationType" "Amazonka.APIGateway.Types.IntegrationType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "IntegrationType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromIntegrationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

LocationStatusType

newtype LocationStatusType Source #

Constructors

LocationStatusType'
Fields fromLocationStatusType :: Text

Bundled Patterns

pattern LocationStatusType_DOCUMENTED :: LocationStatusType
pattern LocationStatusType_UNDOCUMENTED :: LocationStatusType

Instances

Instances details

FromJSON LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods parseJSON :: Value -> Parser LocationStatusType # parseJSONList :: Value -> Parser [LocationStatusType] #
FromJSONKey LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods fromJSONKey :: FromJSONKeyFunction LocationStatusType # fromJSONKeyList :: FromJSONKeyFunction [LocationStatusType] #
ToJSON LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods toJSON :: LocationStatusType -> Value # toEncoding :: LocationStatusType -> Encoding # toJSONList :: [LocationStatusType] -> Value # toEncodingList :: [LocationStatusType] -> Encoding #
ToJSONKey LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods toJSONKey :: ToJSONKeyFunction LocationStatusType # toJSONKeyList :: ToJSONKeyFunction [LocationStatusType] #
ToByteString LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods toBS :: LocationStatusType -> ByteString #
ToHeader LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods toHeader :: HeaderName -> LocationStatusType -> [Header] #
ToLog LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods build :: LocationStatusType -> ByteStringBuilder #
ToQuery LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods toQuery :: LocationStatusType -> QueryString #
FromText LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods fromText :: Text -> Either String LocationStatusType #
ToText LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods toText :: LocationStatusType -> Text #
FromXML LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods parseXML :: [Node] -> Either String LocationStatusType #
ToXML LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods toXML :: LocationStatusType -> XML #
Generic LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Associated Types type Rep LocationStatusType :: Type -> Type # Methods from :: LocationStatusType -> Rep LocationStatusType x # to :: Rep LocationStatusType x -> LocationStatusType #
Read LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods readsPrec :: Int -> ReadS LocationStatusType # readList :: ReadS [LocationStatusType] # readPrec :: ReadPrec LocationStatusType # readListPrec :: ReadPrec [LocationStatusType] #
Show LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods showsPrec :: Int -> LocationStatusType -> ShowS # show :: LocationStatusType -> String # showList :: [LocationStatusType] -> ShowS #
NFData LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods rnf :: LocationStatusType -> () #
Eq LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods (==) :: LocationStatusType -> LocationStatusType -> Bool # (/=) :: LocationStatusType -> LocationStatusType -> Bool #
Ord LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods compare :: LocationStatusType -> LocationStatusType -> Ordering # (<) :: LocationStatusType -> LocationStatusType -> Bool # (<=) :: LocationStatusType -> LocationStatusType -> Bool # (>) :: LocationStatusType -> LocationStatusType -> Bool # (>=) :: LocationStatusType -> LocationStatusType -> Bool # max :: LocationStatusType -> LocationStatusType -> LocationStatusType # min :: LocationStatusType -> LocationStatusType -> LocationStatusType #
Hashable LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType Methods hashWithSalt :: Int -> LocationStatusType -> Int # hash :: LocationStatusType -> Int #
type Rep LocationStatusType Source #
Instance details Defined in Amazonka.APIGateway.Types.LocationStatusType type Rep LocationStatusType = D1 ('MetaData "LocationStatusType" "Amazonka.APIGateway.Types.LocationStatusType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "LocationStatusType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromLocationStatusType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

Op

newtype Op Source #

Constructors

Op'
Fields fromOp :: Text

Bundled Patterns

pattern Op_Add :: Op
pattern Op_Copy :: Op
pattern Op_Move :: Op
pattern Op_Remove :: Op
pattern Op_Replace :: Op
pattern Op_Test :: Op

Instances

Instances details

FromJSON Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods parseJSON :: Value -> Parser Op # parseJSONList :: Value -> Parser [Op] #
FromJSONKey Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods fromJSONKey :: FromJSONKeyFunction Op # fromJSONKeyList :: FromJSONKeyFunction [Op] #
ToJSON Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods toJSON :: Op -> Value # toEncoding :: Op -> Encoding # toJSONList :: [Op] -> Value # toEncodingList :: [Op] -> Encoding #
ToJSONKey Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods toJSONKey :: ToJSONKeyFunction Op # toJSONKeyList :: ToJSONKeyFunction [Op] #
ToByteString Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods toBS :: Op -> ByteString #
ToHeader Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods toHeader :: HeaderName -> Op -> [Header] #
ToLog Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods build :: Op -> ByteStringBuilder #
ToQuery Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods toQuery :: Op -> QueryString #
FromText Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods fromText :: Text -> Either String Op #
ToText Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods toText :: Op -> Text #
FromXML Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods parseXML :: [Node] -> Either String Op #
ToXML Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods toXML :: Op -> XML #
Generic Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Associated Types type Rep Op :: Type -> Type # Methods from :: Op -> Rep Op x # to :: Rep Op x -> Op #
Read Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods readsPrec :: Int -> ReadS Op # readList :: ReadS [Op] # readPrec :: ReadPrec Op # readListPrec :: ReadPrec [Op] #
Show Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods showsPrec :: Int -> Op -> ShowS # show :: Op -> String # showList :: [Op] -> ShowS #
NFData Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods rnf :: Op -> () #
Eq Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods (==) :: Op -> Op -> Bool # (/=) :: Op -> Op -> Bool #
Ord Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods compare :: Op -> Op -> Ordering # (<) :: Op -> Op -> Bool # (<=) :: Op -> Op -> Bool # (>) :: Op -> Op -> Bool # (>=) :: Op -> Op -> Bool # max :: Op -> Op -> Op # min :: Op -> Op -> Op #
Hashable Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op Methods hashWithSalt :: Int -> Op -> Int # hash :: Op -> Int #
type Rep Op Source #
Instance details Defined in Amazonka.APIGateway.Types.Op type Rep Op = D1 ('MetaData "Op" "Amazonka.APIGateway.Types.Op" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "Op'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromOp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

PutMode

newtype PutMode Source #

Constructors

PutMode'
Fields fromPutMode :: Text

Bundled Patterns

pattern PutMode_Merge :: PutMode
pattern PutMode_Overwrite :: PutMode

Instances

Instances details

FromJSON PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods parseJSON :: Value -> Parser PutMode # parseJSONList :: Value -> Parser [PutMode] #
FromJSONKey PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods fromJSONKey :: FromJSONKeyFunction PutMode # fromJSONKeyList :: FromJSONKeyFunction [PutMode] #
ToJSON PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods toJSON :: PutMode -> Value # toEncoding :: PutMode -> Encoding # toJSONList :: [PutMode] -> Value # toEncodingList :: [PutMode] -> Encoding #
ToJSONKey PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods toJSONKey :: ToJSONKeyFunction PutMode # toJSONKeyList :: ToJSONKeyFunction [PutMode] #
ToByteString PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods toBS :: PutMode -> ByteString #
ToHeader PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods toHeader :: HeaderName -> PutMode -> [Header] #
ToLog PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods build :: PutMode -> ByteStringBuilder #
ToQuery PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods toQuery :: PutMode -> QueryString #
FromText PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods fromText :: Text -> Either String PutMode #
ToText PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods toText :: PutMode -> Text #
FromXML PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods parseXML :: [Node] -> Either String PutMode #
ToXML PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods toXML :: PutMode -> XML #
Generic PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Associated Types type Rep PutMode :: Type -> Type # Methods from :: PutMode -> Rep PutMode x # to :: Rep PutMode x -> PutMode #
Read PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods readsPrec :: Int -> ReadS PutMode # readList :: ReadS [PutMode] # readPrec :: ReadPrec PutMode # readListPrec :: ReadPrec [PutMode] #
Show PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods showsPrec :: Int -> PutMode -> ShowS # show :: PutMode -> String # showList :: [PutMode] -> ShowS #
NFData PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods rnf :: PutMode -> () #
Eq PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods (==) :: PutMode -> PutMode -> Bool # (/=) :: PutMode -> PutMode -> Bool #
Ord PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods compare :: PutMode -> PutMode -> Ordering # (<) :: PutMode -> PutMode -> Bool # (<=) :: PutMode -> PutMode -> Bool # (>) :: PutMode -> PutMode -> Bool # (>=) :: PutMode -> PutMode -> Bool # max :: PutMode -> PutMode -> PutMode # min :: PutMode -> PutMode -> PutMode #
Hashable PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode Methods hashWithSalt :: Int -> PutMode -> Int # hash :: PutMode -> Int #
type Rep PutMode Source #
Instance details Defined in Amazonka.APIGateway.Types.PutMode type Rep PutMode = D1 ('MetaData "PutMode" "Amazonka.APIGateway.Types.PutMode" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "PutMode'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromPutMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

QuotaPeriodType

newtype QuotaPeriodType Source #

Constructors

QuotaPeriodType'
Fields fromQuotaPeriodType :: Text

Bundled Patterns

pattern QuotaPeriodType_DAY :: QuotaPeriodType
pattern QuotaPeriodType_MONTH :: QuotaPeriodType
pattern QuotaPeriodType_WEEK :: QuotaPeriodType

Instances

Instances details

FromJSON QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods parseJSON :: Value -> Parser QuotaPeriodType # parseJSONList :: Value -> Parser [QuotaPeriodType] #
FromJSONKey QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods fromJSONKey :: FromJSONKeyFunction QuotaPeriodType # fromJSONKeyList :: FromJSONKeyFunction [QuotaPeriodType] #
ToJSON QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods toJSON :: QuotaPeriodType -> Value # toEncoding :: QuotaPeriodType -> Encoding # toJSONList :: [QuotaPeriodType] -> Value # toEncodingList :: [QuotaPeriodType] -> Encoding #
ToJSONKey QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods toJSONKey :: ToJSONKeyFunction QuotaPeriodType # toJSONKeyList :: ToJSONKeyFunction [QuotaPeriodType] #
ToByteString QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods toBS :: QuotaPeriodType -> ByteString #
ToHeader QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods toHeader :: HeaderName -> QuotaPeriodType -> [Header] #
ToLog QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods build :: QuotaPeriodType -> ByteStringBuilder #
ToQuery QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods toQuery :: QuotaPeriodType -> QueryString #
FromText QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods fromText :: Text -> Either String QuotaPeriodType #
ToText QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods toText :: QuotaPeriodType -> Text #
FromXML QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods parseXML :: [Node] -> Either String QuotaPeriodType #
ToXML QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods toXML :: QuotaPeriodType -> XML #
Generic QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Associated Types type Rep QuotaPeriodType :: Type -> Type # Methods from :: QuotaPeriodType -> Rep QuotaPeriodType x # to :: Rep QuotaPeriodType x -> QuotaPeriodType #
Read QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods readsPrec :: Int -> ReadS QuotaPeriodType # readList :: ReadS [QuotaPeriodType] # readPrec :: ReadPrec QuotaPeriodType # readListPrec :: ReadPrec [QuotaPeriodType] #
Show QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods showsPrec :: Int -> QuotaPeriodType -> ShowS # show :: QuotaPeriodType -> String # showList :: [QuotaPeriodType] -> ShowS #
NFData QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods rnf :: QuotaPeriodType -> () #
Eq QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods (==) :: QuotaPeriodType -> QuotaPeriodType -> Bool # (/=) :: QuotaPeriodType -> QuotaPeriodType -> Bool #
Ord QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods compare :: QuotaPeriodType -> QuotaPeriodType -> Ordering # (<) :: QuotaPeriodType -> QuotaPeriodType -> Bool # (<=) :: QuotaPeriodType -> QuotaPeriodType -> Bool # (>) :: QuotaPeriodType -> QuotaPeriodType -> Bool # (>=) :: QuotaPeriodType -> QuotaPeriodType -> Bool # max :: QuotaPeriodType -> QuotaPeriodType -> QuotaPeriodType # min :: QuotaPeriodType -> QuotaPeriodType -> QuotaPeriodType #
Hashable QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType Methods hashWithSalt :: Int -> QuotaPeriodType -> Int # hash :: QuotaPeriodType -> Int #
type Rep QuotaPeriodType Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaPeriodType type Rep QuotaPeriodType = D1 ('MetaData "QuotaPeriodType" "Amazonka.APIGateway.Types.QuotaPeriodType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "QuotaPeriodType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromQuotaPeriodType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

SecurityPolicy

newtype SecurityPolicy Source #

Constructors

SecurityPolicy'
Fields fromSecurityPolicy :: Text

Bundled Patterns

pattern SecurityPolicy_TLS_1_0 :: SecurityPolicy
pattern SecurityPolicy_TLS_1_2 :: SecurityPolicy

Instances

Instances details

FromJSON SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods parseJSON :: Value -> Parser SecurityPolicy # parseJSONList :: Value -> Parser [SecurityPolicy] #
FromJSONKey SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods fromJSONKey :: FromJSONKeyFunction SecurityPolicy # fromJSONKeyList :: FromJSONKeyFunction [SecurityPolicy] #
ToJSON SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods toJSON :: SecurityPolicy -> Value # toEncoding :: SecurityPolicy -> Encoding # toJSONList :: [SecurityPolicy] -> Value # toEncodingList :: [SecurityPolicy] -> Encoding #
ToJSONKey SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods toJSONKey :: ToJSONKeyFunction SecurityPolicy # toJSONKeyList :: ToJSONKeyFunction [SecurityPolicy] #
ToByteString SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods toBS :: SecurityPolicy -> ByteString #
ToHeader SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods toHeader :: HeaderName -> SecurityPolicy -> [Header] #
ToLog SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods build :: SecurityPolicy -> ByteStringBuilder #
ToQuery SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods toQuery :: SecurityPolicy -> QueryString #
FromText SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods fromText :: Text -> Either String SecurityPolicy #
ToText SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods toText :: SecurityPolicy -> Text #
FromXML SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods parseXML :: [Node] -> Either String SecurityPolicy #
ToXML SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods toXML :: SecurityPolicy -> XML #
Generic SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Associated Types type Rep SecurityPolicy :: Type -> Type # Methods from :: SecurityPolicy -> Rep SecurityPolicy x # to :: Rep SecurityPolicy x -> SecurityPolicy #
Read SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods readsPrec :: Int -> ReadS SecurityPolicy # readList :: ReadS [SecurityPolicy] # readPrec :: ReadPrec SecurityPolicy # readListPrec :: ReadPrec [SecurityPolicy] #
Show SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods showsPrec :: Int -> SecurityPolicy -> ShowS # show :: SecurityPolicy -> String # showList :: [SecurityPolicy] -> ShowS #
NFData SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods rnf :: SecurityPolicy -> () #
Eq SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods (==) :: SecurityPolicy -> SecurityPolicy -> Bool # (/=) :: SecurityPolicy -> SecurityPolicy -> Bool #
Ord SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods compare :: SecurityPolicy -> SecurityPolicy -> Ordering # (<) :: SecurityPolicy -> SecurityPolicy -> Bool # (<=) :: SecurityPolicy -> SecurityPolicy -> Bool # (>) :: SecurityPolicy -> SecurityPolicy -> Bool # (>=) :: SecurityPolicy -> SecurityPolicy -> Bool # max :: SecurityPolicy -> SecurityPolicy -> SecurityPolicy # min :: SecurityPolicy -> SecurityPolicy -> SecurityPolicy #
Hashable SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy Methods hashWithSalt :: Int -> SecurityPolicy -> Int # hash :: SecurityPolicy -> Int #
type Rep SecurityPolicy Source #
Instance details Defined in Amazonka.APIGateway.Types.SecurityPolicy type Rep SecurityPolicy = D1 ('MetaData "SecurityPolicy" "Amazonka.APIGateway.Types.SecurityPolicy" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "SecurityPolicy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromSecurityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

UnauthorizedCacheControlHeaderStrategy

newtype UnauthorizedCacheControlHeaderStrategy Source #

Constructors

UnauthorizedCacheControlHeaderStrategy'
Fields fromUnauthorizedCacheControlHeaderStrategy :: Text

Bundled Patterns

pattern UnauthorizedCacheControlHeaderStrategy_FAIL_WITH_403 :: UnauthorizedCacheControlHeaderStrategy
pattern UnauthorizedCacheControlHeaderStrategy_SUCCEED_WITHOUT_RESPONSE_HEADER :: UnauthorizedCacheControlHeaderStrategy
pattern UnauthorizedCacheControlHeaderStrategy_SUCCEED_WITH_RESPONSE_HEADER :: UnauthorizedCacheControlHeaderStrategy

Instances

Instances details

FromJSON UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods parseJSON :: Value -> Parser UnauthorizedCacheControlHeaderStrategy # parseJSONList :: Value -> Parser [UnauthorizedCacheControlHeaderStrategy] #
FromJSONKey UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods fromJSONKey :: FromJSONKeyFunction UnauthorizedCacheControlHeaderStrategy # fromJSONKeyList :: FromJSONKeyFunction [UnauthorizedCacheControlHeaderStrategy] #
ToJSON UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods toJSON :: UnauthorizedCacheControlHeaderStrategy -> Value # toEncoding :: UnauthorizedCacheControlHeaderStrategy -> Encoding # toJSONList :: [UnauthorizedCacheControlHeaderStrategy] -> Value # toEncodingList :: [UnauthorizedCacheControlHeaderStrategy] -> Encoding #
ToJSONKey UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods toJSONKey :: ToJSONKeyFunction UnauthorizedCacheControlHeaderStrategy # toJSONKeyList :: ToJSONKeyFunction [UnauthorizedCacheControlHeaderStrategy] #
ToByteString UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods toBS :: UnauthorizedCacheControlHeaderStrategy -> ByteString #
ToHeader UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods toHeader :: HeaderName -> UnauthorizedCacheControlHeaderStrategy -> [Header] #
ToLog UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods build :: UnauthorizedCacheControlHeaderStrategy -> ByteStringBuilder #
ToQuery UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods toQuery :: UnauthorizedCacheControlHeaderStrategy -> QueryString #
FromText UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods fromText :: Text -> Either String UnauthorizedCacheControlHeaderStrategy #
ToText UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods toText :: UnauthorizedCacheControlHeaderStrategy -> Text #
FromXML UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods parseXML :: [Node] -> Either String UnauthorizedCacheControlHeaderStrategy #
ToXML UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods toXML :: UnauthorizedCacheControlHeaderStrategy -> XML #
Generic UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Associated Types type Rep UnauthorizedCacheControlHeaderStrategy :: Type -> Type # Methods from :: UnauthorizedCacheControlHeaderStrategy -> Rep UnauthorizedCacheControlHeaderStrategy x # to :: Rep UnauthorizedCacheControlHeaderStrategy x -> UnauthorizedCacheControlHeaderStrategy #
Read UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods readsPrec :: Int -> ReadS UnauthorizedCacheControlHeaderStrategy # readList :: ReadS [UnauthorizedCacheControlHeaderStrategy] # readPrec :: ReadPrec UnauthorizedCacheControlHeaderStrategy # readListPrec :: ReadPrec [UnauthorizedCacheControlHeaderStrategy] #
Show UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods showsPrec :: Int -> UnauthorizedCacheControlHeaderStrategy -> ShowS # show :: UnauthorizedCacheControlHeaderStrategy -> String # showList :: [UnauthorizedCacheControlHeaderStrategy] -> ShowS #
NFData UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods rnf :: UnauthorizedCacheControlHeaderStrategy -> () #
Eq UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods (==) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool # (/=) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool #
Ord UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods compare :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Ordering # (<) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool # (<=) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool # (>) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool # (>=) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool # max :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy # min :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy #
Hashable UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy Methods hashWithSalt :: Int -> UnauthorizedCacheControlHeaderStrategy -> Int # hash :: UnauthorizedCacheControlHeaderStrategy -> Int #
type Rep UnauthorizedCacheControlHeaderStrategy Source #
Instance details Defined in Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy type Rep UnauthorizedCacheControlHeaderStrategy = D1 ('MetaData "UnauthorizedCacheControlHeaderStrategy" "Amazonka.APIGateway.Types.UnauthorizedCacheControlHeaderStrategy" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "UnauthorizedCacheControlHeaderStrategy'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromUnauthorizedCacheControlHeaderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

VpcLinkStatus

newtype VpcLinkStatus Source #

Constructors

VpcLinkStatus'
Fields fromVpcLinkStatus :: Text

Bundled Patterns

pattern VpcLinkStatus_AVAILABLE :: VpcLinkStatus
pattern VpcLinkStatus_DELETING :: VpcLinkStatus
pattern VpcLinkStatus_FAILED :: VpcLinkStatus
pattern VpcLinkStatus_PENDING :: VpcLinkStatus

Instances

Instances details

FromJSON VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods parseJSON :: Value -> Parser VpcLinkStatus # parseJSONList :: Value -> Parser [VpcLinkStatus] #
FromJSONKey VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods fromJSONKey :: FromJSONKeyFunction VpcLinkStatus # fromJSONKeyList :: FromJSONKeyFunction [VpcLinkStatus] #
ToJSON VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods toJSON :: VpcLinkStatus -> Value # toEncoding :: VpcLinkStatus -> Encoding # toJSONList :: [VpcLinkStatus] -> Value # toEncodingList :: [VpcLinkStatus] -> Encoding #
ToJSONKey VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods toJSONKey :: ToJSONKeyFunction VpcLinkStatus # toJSONKeyList :: ToJSONKeyFunction [VpcLinkStatus] #
ToByteString VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods toBS :: VpcLinkStatus -> ByteString #
ToHeader VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods toHeader :: HeaderName -> VpcLinkStatus -> [Header] #
ToLog VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods build :: VpcLinkStatus -> ByteStringBuilder #
ToQuery VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods toQuery :: VpcLinkStatus -> QueryString #
FromText VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods fromText :: Text -> Either String VpcLinkStatus #
ToText VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods toText :: VpcLinkStatus -> Text #
FromXML VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods parseXML :: [Node] -> Either String VpcLinkStatus #
ToXML VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods toXML :: VpcLinkStatus -> XML #
Generic VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Associated Types type Rep VpcLinkStatus :: Type -> Type # Methods from :: VpcLinkStatus -> Rep VpcLinkStatus x # to :: Rep VpcLinkStatus x -> VpcLinkStatus #
Read VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods readsPrec :: Int -> ReadS VpcLinkStatus # readList :: ReadS [VpcLinkStatus] # readPrec :: ReadPrec VpcLinkStatus # readListPrec :: ReadPrec [VpcLinkStatus] #
Show VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods showsPrec :: Int -> VpcLinkStatus -> ShowS # show :: VpcLinkStatus -> String # showList :: [VpcLinkStatus] -> ShowS #
NFData VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods rnf :: VpcLinkStatus -> () #
Eq VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods (==) :: VpcLinkStatus -> VpcLinkStatus -> Bool # (/=) :: VpcLinkStatus -> VpcLinkStatus -> Bool #
Ord VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods compare :: VpcLinkStatus -> VpcLinkStatus -> Ordering # (<) :: VpcLinkStatus -> VpcLinkStatus -> Bool # (<=) :: VpcLinkStatus -> VpcLinkStatus -> Bool # (>) :: VpcLinkStatus -> VpcLinkStatus -> Bool # (>=) :: VpcLinkStatus -> VpcLinkStatus -> Bool # max :: VpcLinkStatus -> VpcLinkStatus -> VpcLinkStatus # min :: VpcLinkStatus -> VpcLinkStatus -> VpcLinkStatus #
Hashable VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus Methods hashWithSalt :: Int -> VpcLinkStatus -> Int # hash :: VpcLinkStatus -> Int #
type Rep VpcLinkStatus Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLinkStatus type Rep VpcLinkStatus = D1 ('MetaData "VpcLinkStatus" "Amazonka.APIGateway.Types.VpcLinkStatus" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'True) (C1 ('MetaCons "VpcLinkStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "fromVpcLinkStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

AccessLogSettings

data AccessLogSettings Source #

Access log settings, including the access log format and access log destination ARN.

See: newAccessLogSettings smart constructor.

Constructors

AccessLogSettings' (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON AccessLogSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.AccessLogSettings Methods parseJSON :: Value -> Parser AccessLogSettings # parseJSONList :: Value -> Parser [AccessLogSettings] #
Generic AccessLogSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.AccessLogSettings Associated Types type Rep AccessLogSettings :: Type -> Type # Methods from :: AccessLogSettings -> Rep AccessLogSettings x # to :: Rep AccessLogSettings x -> AccessLogSettings #
Read AccessLogSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.AccessLogSettings Methods readsPrec :: Int -> ReadS AccessLogSettings # readList :: ReadS [AccessLogSettings] # readPrec :: ReadPrec AccessLogSettings # readListPrec :: ReadPrec [AccessLogSettings] #
Show AccessLogSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.AccessLogSettings Methods showsPrec :: Int -> AccessLogSettings -> ShowS # show :: AccessLogSettings -> String # showList :: [AccessLogSettings] -> ShowS #
NFData AccessLogSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.AccessLogSettings Methods rnf :: AccessLogSettings -> () #
Eq AccessLogSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.AccessLogSettings Methods (==) :: AccessLogSettings -> AccessLogSettings -> Bool # (/=) :: AccessLogSettings -> AccessLogSettings -> Bool #
Hashable AccessLogSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.AccessLogSettings Methods hashWithSalt :: Int -> AccessLogSettings -> Int # hash :: AccessLogSettings -> Int #
type Rep AccessLogSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.AccessLogSettings type Rep AccessLogSettings = D1 ('MetaData "AccessLogSettings" "Amazonka.APIGateway.Types.AccessLogSettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "AccessLogSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "destinationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "format") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newAccessLogSettings :: AccessLogSettings Source #

Create a value of AccessLogSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:destinationArn:AccessLogSettings', accessLogSettings_destinationArn - The Amazon Resource Name (ARN) of the CloudWatch Logs log group or Kinesis Data Firehose delivery stream to receive access logs. If you specify a Kinesis Data Firehose delivery stream, the stream name must begin with amazon-apigateway-.

$sel:format:AccessLogSettings', accessLogSettings_format - A single line format of the access logs of data, as specified by selected $context variables. The format must include at least $context.requestId.

Account

data Account Source #

Represents an AWS account that is associated with API Gateway.

See: newAccount smart constructor.

Constructors

Account' (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe ThrottleSettings)

Instances

Instances details

FromJSON Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods parseJSON :: Value -> Parser Account # parseJSONList :: Value -> Parser [Account] #
Generic Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Associated Types type Rep Account :: Type -> Type # Methods from :: Account -> Rep Account x # to :: Rep Account x -> Account #
Read Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods readsPrec :: Int -> ReadS Account # readList :: ReadS [Account] # readPrec :: ReadPrec Account # readListPrec :: ReadPrec [Account] #
Show Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods showsPrec :: Int -> Account -> ShowS # show :: Account -> String # showList :: [Account] -> ShowS #
NFData Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods rnf :: Account -> () #
Eq Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods (==) :: Account -> Account -> Bool # (/=) :: Account -> Account -> Bool #
Hashable Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account Methods hashWithSalt :: Int -> Account -> Int # hash :: Account -> Int #
type Rep Account Source #
Instance details Defined in Amazonka.APIGateway.Types.Account type Rep Account = D1 ('MetaData "Account" "Amazonka.APIGateway.Types.Account" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Account'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiKeyVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "cloudwatchRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "features") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "throttleSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings)))))

newAccount :: Account Source #

Create a value of Account with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyVersion:Account', account_apiKeyVersion - The version of the API keys used for the account.

$sel:cloudwatchRoleArn:Account', account_cloudwatchRoleArn - The ARN of an Amazon CloudWatch role for the current Account.

$sel:features:Account', account_features - A list of features supported for the account. When usage plans are enabled, the features list will include an entry of "UsagePlans".

$sel:throttleSettings:Account', account_throttleSettings - Specifies the API request limits configured for the current Account.

ApiKey

data ApiKey Source #

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

See: newApiKey smart constructor.

Constructors

ApiKey' (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe [Text]) (Maybe (HashMap Text Text)) (Maybe Text)

Instances

Instances details

FromJSON ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods parseJSON :: Value -> Parser ApiKey # parseJSONList :: Value -> Parser [ApiKey] #
Generic ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Associated Types type Rep ApiKey :: Type -> Type # Methods from :: ApiKey -> Rep ApiKey x # to :: Rep ApiKey x -> ApiKey #
Read ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods readsPrec :: Int -> ReadS ApiKey # readList :: ReadS [ApiKey] # readPrec :: ReadPrec ApiKey # readListPrec :: ReadPrec [ApiKey] #
Show ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods showsPrec :: Int -> ApiKey -> ShowS # show :: ApiKey -> String # showList :: [ApiKey] -> ShowS #
NFData ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods rnf :: ApiKey -> () #
Eq ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods (==) :: ApiKey -> ApiKey -> Bool # (/=) :: ApiKey -> ApiKey -> Bool #
Hashable ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey Methods hashWithSalt :: Int -> ApiKey -> Int # hash :: ApiKey -> Int #
type Rep ApiKey Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiKey type Rep ApiKey = D1 ('MetaData "ApiKey" "Amazonka.APIGateway.Types.ApiKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ApiKey'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "customerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stageKeys") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newApiKey :: ApiKey Source #

Create a value of ApiKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdDate:ApiKey', apiKey_createdDate - The timestamp when the API Key was created.

$sel:customerId:ApiKey', apiKey_customerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

$sel:description:ApiKey', apiKey_description - The description of the API Key.

$sel:enabled:ApiKey', apiKey_enabled - Specifies whether the API Key can be used by callers.

$sel:id:ApiKey', apiKey_id - The identifier of the API Key.

$sel:lastUpdatedDate:ApiKey', apiKey_lastUpdatedDate - The timestamp when the API Key was last updated.

$sel:name:ApiKey', apiKey_name - The name of the API Key.

$sel:stageKeys:ApiKey', apiKey_stageKeys - A list of Stage resources that are associated with the ApiKey resource.

$sel:tags:ApiKey', apiKey_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:value:ApiKey', apiKey_value - The value of the API Key.

ApiStage

data ApiStage Source #

API stage name of the associated API stage in a usage plan.

See: newApiStage smart constructor.

Constructors

ApiStage' (Maybe Text) (Maybe Text) (Maybe (HashMap Text ThrottleSettings))

Instances

Instances details

FromJSON ApiStage Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiStage Methods parseJSON :: Value -> Parser ApiStage # parseJSONList :: Value -> Parser [ApiStage] #
ToJSON ApiStage Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiStage Methods toJSON :: ApiStage -> Value # toEncoding :: ApiStage -> Encoding # toJSONList :: [ApiStage] -> Value # toEncodingList :: [ApiStage] -> Encoding #
Generic ApiStage Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiStage Associated Types type Rep ApiStage :: Type -> Type # Methods from :: ApiStage -> Rep ApiStage x # to :: Rep ApiStage x -> ApiStage #
Read ApiStage Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiStage Methods readsPrec :: Int -> ReadS ApiStage # readList :: ReadS [ApiStage] # readPrec :: ReadPrec ApiStage # readListPrec :: ReadPrec [ApiStage] #
Show ApiStage Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiStage Methods showsPrec :: Int -> ApiStage -> ShowS # show :: ApiStage -> String # showList :: [ApiStage] -> ShowS #
NFData ApiStage Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiStage Methods rnf :: ApiStage -> () #
Eq ApiStage Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiStage Methods (==) :: ApiStage -> ApiStage -> Bool # (/=) :: ApiStage -> ApiStage -> Bool #
Hashable ApiStage Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiStage Methods hashWithSalt :: Int -> ApiStage -> Int # hash :: ApiStage -> Int #
type Rep ApiStage Source #
Instance details Defined in Amazonka.APIGateway.Types.ApiStage type Rep ApiStage = D1 ('MetaData "ApiStage" "Amazonka.APIGateway.Types.ApiStage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ApiStage'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text ThrottleSettings))))))

newApiStage :: ApiStage Source #

Create a value of ApiStage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiId:ApiStage', apiStage_apiId - API Id of the associated API stage in a usage plan.

$sel:stage:ApiStage', apiStage_stage - API stage name of the associated API stage in a usage plan.

$sel:throttle:ApiStage', apiStage_throttle - Map containing method level throttling information for API stage in a usage plan.

Authorizer

data Authorizer Source #

Represents an authorization layer for methods. If enabled on a method, API Gateway will activate the authorizer when a client calls the method.

See: newAuthorizer smart constructor.

Constructors

Authorizer' (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe AuthorizerType)

Instances

Instances details

FromJSON Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods parseJSON :: Value -> Parser Authorizer # parseJSONList :: Value -> Parser [Authorizer] #
Generic Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Associated Types type Rep Authorizer :: Type -> Type # Methods from :: Authorizer -> Rep Authorizer x # to :: Rep Authorizer x -> Authorizer #
Read Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods readsPrec :: Int -> ReadS Authorizer # readList :: ReadS [Authorizer] # readPrec :: ReadPrec Authorizer # readListPrec :: ReadPrec [Authorizer] #
Show Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods showsPrec :: Int -> Authorizer -> ShowS # show :: Authorizer -> String # showList :: [Authorizer] -> ShowS #
NFData Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods rnf :: Authorizer -> () #
Eq Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods (==) :: Authorizer -> Authorizer -> Bool # (/=) :: Authorizer -> Authorizer -> Bool #
Hashable Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer Methods hashWithSalt :: Int -> Authorizer -> Int # hash :: Authorizer -> Int #
type Rep Authorizer Source #
Instance details Defined in Amazonka.APIGateway.Types.Authorizer type Rep Authorizer = D1 ('MetaData "Authorizer" "Amazonka.APIGateway.Types.Authorizer" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Authorizer'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "authorizerCredentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "authorizerResultTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "authorizerUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "identitySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "identityValidationExpression") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "providerARNs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerType)))))))

newAuthorizer :: Authorizer Source #

Create a value of Authorizer with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authType:Authorizer', authorizer_authType - Optional customer-defined field, used in OpenAPI imports and exports without functional impact.

$sel:authorizerCredentials:Authorizer', authorizer_authorizerCredentials - Specifies the required credentials as an IAM role for API Gateway to invoke the authorizer. To specify an IAM role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

$sel:authorizerResultTtlInSeconds:Authorizer', authorizer_authorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.

$sel:authorizerUri:Authorizer', authorizer_authorizerUri - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api}, where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations.

$sel:id:Authorizer', authorizer_id - The identifier for the authorizer resource.

$sel:identitySource:Authorizer', authorizer_identitySource - The identity source for which authorization is requested. For a TOKEN or COGNITO_USER_POOLS authorizer, this is required and specifies the request header mapping expression for the custom header holding the authorization token submitted by the client. For example, if the token header name is Auth, the header mapping expression is method.request.header.Auth. For the REQUEST authorizer, this is required when authorization caching is enabled. The value is a comma-separated string of one or more mapping expressions of the specified request parameters. For example, if an Auth header, a Name query string parameter are defined as identity sources, this value is method.request.header.Auth, method.request.querystring.Name. These parameters will be used to derive the authorization caching key and to perform runtime validation of the REQUEST authorizer by verifying all of the identity-related request parameters are present, not null and non-empty. Only when this is true does the authorizer invoke the authorizer Lambda function, otherwise, it returns a 401 Unauthorized response without calling the Lambda function. The valid value is a string of comma-separated mapping expressions of the specified request parameters. When the authorization caching is not enabled, this property is optional.

$sel:identityValidationExpression:Authorizer', authorizer_identityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. For COGNITO_USER_POOLS authorizers, API Gateway will match the aud field of the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function when there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.

$sel:name:Authorizer', authorizer_name - The name of the authorizer.

$sel:providerARNs:Authorizer', authorizer_providerARNs - A list of the Amazon Cognito user pool ARNs for the COGNITO_USER_POOLS authorizer. Each element is of this format: arn:aws:cognito-idp:{region}:{account_id}:userpool/{user_pool_id}. For a TOKEN or REQUEST authorizer, this is not defined.

$sel:type':Authorizer', authorizer_type - The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.

BasePathMapping

data BasePathMapping Source #

Represents the base path that callers of the API must provide as part of the URL after the domain name.

See: newBasePathMapping smart constructor.

Constructors

BasePathMapping' (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods parseJSON :: Value -> Parser BasePathMapping # parseJSONList :: Value -> Parser [BasePathMapping] #
Generic BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Associated Types type Rep BasePathMapping :: Type -> Type # Methods from :: BasePathMapping -> Rep BasePathMapping x # to :: Rep BasePathMapping x -> BasePathMapping #
Read BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods readsPrec :: Int -> ReadS BasePathMapping # readList :: ReadS [BasePathMapping] # readPrec :: ReadPrec BasePathMapping # readListPrec :: ReadPrec [BasePathMapping] #
Show BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods showsPrec :: Int -> BasePathMapping -> ShowS # show :: BasePathMapping -> String # showList :: [BasePathMapping] -> ShowS #
NFData BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods rnf :: BasePathMapping -> () #
Eq BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods (==) :: BasePathMapping -> BasePathMapping -> Bool # (/=) :: BasePathMapping -> BasePathMapping -> Bool #
Hashable BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping Methods hashWithSalt :: Int -> BasePathMapping -> Int # hash :: BasePathMapping -> Int #
type Rep BasePathMapping Source #
Instance details Defined in Amazonka.APIGateway.Types.BasePathMapping type Rep BasePathMapping = D1 ('MetaData "BasePathMapping" "Amazonka.APIGateway.Types.BasePathMapping" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "BasePathMapping'" 'PrefixI 'True) (S1 ('MetaSel ('Just "basePath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newBasePathMapping :: BasePathMapping Source #

Create a value of BasePathMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:basePath:BasePathMapping', basePathMapping_basePath - The base path name that callers of the API must provide as part of the URL after the domain name.

$sel:restApiId:BasePathMapping', basePathMapping_restApiId - The string identifier of the associated RestApi.

$sel:stage:BasePathMapping', basePathMapping_stage - The name of the associated stage.

CanarySettings

data CanarySettings Source #

Configuration settings of a canary deployment.

See: newCanarySettings smart constructor.

Constructors

CanarySettings' (Maybe Text) (Maybe Double) (Maybe (HashMap Text Text)) (Maybe Bool)

Instances

Instances details

FromJSON CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods parseJSON :: Value -> Parser CanarySettings # parseJSONList :: Value -> Parser [CanarySettings] #
ToJSON CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods toJSON :: CanarySettings -> Value # toEncoding :: CanarySettings -> Encoding # toJSONList :: [CanarySettings] -> Value # toEncodingList :: [CanarySettings] -> Encoding #
Generic CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Associated Types type Rep CanarySettings :: Type -> Type # Methods from :: CanarySettings -> Rep CanarySettings x # to :: Rep CanarySettings x -> CanarySettings #
Read CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods readsPrec :: Int -> ReadS CanarySettings # readList :: ReadS [CanarySettings] # readPrec :: ReadPrec CanarySettings # readListPrec :: ReadPrec [CanarySettings] #
Show CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods showsPrec :: Int -> CanarySettings -> ShowS # show :: CanarySettings -> String # showList :: [CanarySettings] -> ShowS #
NFData CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods rnf :: CanarySettings -> () #
Eq CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods (==) :: CanarySettings -> CanarySettings -> Bool # (/=) :: CanarySettings -> CanarySettings -> Bool #
Hashable CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings Methods hashWithSalt :: Int -> CanarySettings -> Int # hash :: CanarySettings -> Int #
type Rep CanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.CanarySettings type Rep CanarySettings = D1 ('MetaData "CanarySettings" "Amazonka.APIGateway.Types.CanarySettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "CanarySettings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "percentTraffic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))) :: (S1 ('MetaSel ('Just "stageVariableOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "useStageCache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newCanarySettings :: CanarySettings Source #

Create a value of CanarySettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:deploymentId:CanarySettings', canarySettings_deploymentId - The ID of the canary deployment.

$sel:percentTraffic:CanarySettings', canarySettings_percentTraffic - The percent (0-100) of traffic diverted to a canary deployment.

$sel:stageVariableOverrides:CanarySettings', canarySettings_stageVariableOverrides - Stage variables overridden for a canary release deployment, including new stage variables introduced in the canary. These stage variables are represented as a string-to-string map between stage variable names and their values.

$sel:useStageCache:CanarySettings', canarySettings_useStageCache - A Boolean flag to indicate whether the canary deployment uses the stage cache or not.

ClientCertificate

data ClientCertificate Source #

Represents a client certificate used to configure client-side SSL authentication while sending requests to the integration endpoint.

See: newClientCertificate smart constructor.

Constructors

ClientCertificate' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe (HashMap Text Text))

Instances

Instances details

FromJSON ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods parseJSON :: Value -> Parser ClientCertificate # parseJSONList :: Value -> Parser [ClientCertificate] #
Generic ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Associated Types type Rep ClientCertificate :: Type -> Type # Methods from :: ClientCertificate -> Rep ClientCertificate x # to :: Rep ClientCertificate x -> ClientCertificate #
Read ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods readsPrec :: Int -> ReadS ClientCertificate # readList :: ReadS [ClientCertificate] # readPrec :: ReadPrec ClientCertificate # readListPrec :: ReadPrec [ClientCertificate] #
Show ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods showsPrec :: Int -> ClientCertificate -> ShowS # show :: ClientCertificate -> String # showList :: [ClientCertificate] -> ShowS #
NFData ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods rnf :: ClientCertificate -> () #
Eq ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods (==) :: ClientCertificate -> ClientCertificate -> Bool # (/=) :: ClientCertificate -> ClientCertificate -> Bool #
Hashable ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate Methods hashWithSalt :: Int -> ClientCertificate -> Int # hash :: ClientCertificate -> Int #
type Rep ClientCertificate Source #
Instance details Defined in Amazonka.APIGateway.Types.ClientCertificate type Rep ClientCertificate = D1 ('MetaData "ClientCertificate" "Amazonka.APIGateway.Types.ClientCertificate" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ClientCertificate'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "expirationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "pemEncodedCertificate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))

newClientCertificate :: ClientCertificate Source #

Create a value of ClientCertificate with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:clientCertificateId:ClientCertificate', clientCertificate_clientCertificateId - The identifier of the client certificate.

$sel:createdDate:ClientCertificate', clientCertificate_createdDate - The timestamp when the client certificate was created.

$sel:description:ClientCertificate', clientCertificate_description - The description of the client certificate.

$sel:expirationDate:ClientCertificate', clientCertificate_expirationDate - The timestamp when the client certificate will expire.

$sel:pemEncodedCertificate:ClientCertificate', clientCertificate_pemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

$sel:tags:ClientCertificate', clientCertificate_tags - The collection of tags. Each tag element is associated with a given resource.

Deployment

data Deployment Source #

An immutable representation of a RestApi resource that can be called by users using Stages. A deployment must be associated with a Stage for it to be callable over the Internet.

See: newDeployment smart constructor.

Constructors

Deployment' (Maybe (HashMap Text (HashMap Text MethodSnapshot))) (Maybe POSIX) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods parseJSON :: Value -> Parser Deployment # parseJSONList :: Value -> Parser [Deployment] #
Generic Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Associated Types type Rep Deployment :: Type -> Type # Methods from :: Deployment -> Rep Deployment x # to :: Rep Deployment x -> Deployment #
Read Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods readsPrec :: Int -> ReadS Deployment # readList :: ReadS [Deployment] # readPrec :: ReadPrec Deployment # readListPrec :: ReadPrec [Deployment] #
Show Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods showsPrec :: Int -> Deployment -> ShowS # show :: Deployment -> String # showList :: [Deployment] -> ShowS #
NFData Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods rnf :: Deployment -> () #
Eq Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods (==) :: Deployment -> Deployment -> Bool # (/=) :: Deployment -> Deployment -> Bool #
Hashable Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment Methods hashWithSalt :: Int -> Deployment -> Int # hash :: Deployment -> Int #
type Rep Deployment Source #
Instance details Defined in Amazonka.APIGateway.Types.Deployment type Rep Deployment = D1 ('MetaData "Deployment" "Amazonka.APIGateway.Types.Deployment" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Deployment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "apiSummary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text (HashMap Text MethodSnapshot)))) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDeployment :: Deployment Source #

Create a value of Deployment with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiSummary:Deployment', deployment_apiSummary - A summary of the RestApi at the date and time that the deployment resource was created.

$sel:createdDate:Deployment', deployment_createdDate - The date and time that the deployment resource was created.

$sel:description:Deployment', deployment_description - The description for the deployment resource.

$sel:id:Deployment', deployment_id - The identifier for the deployment resource.

DeploymentCanarySettings

data DeploymentCanarySettings Source #

The input configuration for a canary deployment.

See: newDeploymentCanarySettings smart constructor.

Constructors

DeploymentCanarySettings' (Maybe Double) (Maybe (HashMap Text Text)) (Maybe Bool)

Instances

Instances details

ToJSON DeploymentCanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings Methods toJSON :: DeploymentCanarySettings -> Value # toEncoding :: DeploymentCanarySettings -> Encoding # toJSONList :: [DeploymentCanarySettings] -> Value # toEncodingList :: [DeploymentCanarySettings] -> Encoding #
Generic DeploymentCanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings Associated Types type Rep DeploymentCanarySettings :: Type -> Type # Methods from :: DeploymentCanarySettings -> Rep DeploymentCanarySettings x # to :: Rep DeploymentCanarySettings x -> DeploymentCanarySettings #
Read DeploymentCanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings Methods readsPrec :: Int -> ReadS DeploymentCanarySettings # readList :: ReadS [DeploymentCanarySettings] # readPrec :: ReadPrec DeploymentCanarySettings # readListPrec :: ReadPrec [DeploymentCanarySettings] #
Show DeploymentCanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings Methods showsPrec :: Int -> DeploymentCanarySettings -> ShowS # show :: DeploymentCanarySettings -> String # showList :: [DeploymentCanarySettings] -> ShowS #
NFData DeploymentCanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings Methods rnf :: DeploymentCanarySettings -> () #
Eq DeploymentCanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings Methods (==) :: DeploymentCanarySettings -> DeploymentCanarySettings -> Bool # (/=) :: DeploymentCanarySettings -> DeploymentCanarySettings -> Bool #
Hashable DeploymentCanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings Methods hashWithSalt :: Int -> DeploymentCanarySettings -> Int # hash :: DeploymentCanarySettings -> Int #
type Rep DeploymentCanarySettings Source #
Instance details Defined in Amazonka.APIGateway.Types.DeploymentCanarySettings type Rep DeploymentCanarySettings = D1 ('MetaData "DeploymentCanarySettings" "Amazonka.APIGateway.Types.DeploymentCanarySettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DeploymentCanarySettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "percentTraffic") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :: (S1 ('MetaSel ('Just "stageVariableOverrides") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "useStageCache") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newDeploymentCanarySettings :: DeploymentCanarySettings Source #

Create a value of DeploymentCanarySettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:percentTraffic:DeploymentCanarySettings', deploymentCanarySettings_percentTraffic - The percentage (0.0-100.0) of traffic routed to the canary deployment.

$sel:stageVariableOverrides:DeploymentCanarySettings', deploymentCanarySettings_stageVariableOverrides - A stage variable overrides used for the canary release deployment. They can override existing stage variables or add new stage variables for the canary release deployment. These stage variables are represented as a string-to-string map between stage variable names and their values.

$sel:useStageCache:DeploymentCanarySettings', deploymentCanarySettings_useStageCache - A Boolean flag to indicate whether the canary release deployment uses the stage cache or not.

DocumentationPart

data DocumentationPart Source #

A documentation part for a targeted API entity.

See: newDocumentationPart smart constructor.

Constructors

DocumentationPart' (Maybe Text) (Maybe DocumentationPartLocation) (Maybe Text)

Instances

Instances details

FromJSON DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods parseJSON :: Value -> Parser DocumentationPart # parseJSONList :: Value -> Parser [DocumentationPart] #
Generic DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Associated Types type Rep DocumentationPart :: Type -> Type # Methods from :: DocumentationPart -> Rep DocumentationPart x # to :: Rep DocumentationPart x -> DocumentationPart #
Read DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods readsPrec :: Int -> ReadS DocumentationPart # readList :: ReadS [DocumentationPart] # readPrec :: ReadPrec DocumentationPart # readListPrec :: ReadPrec [DocumentationPart] #
Show DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods showsPrec :: Int -> DocumentationPart -> ShowS # show :: DocumentationPart -> String # showList :: [DocumentationPart] -> ShowS #
NFData DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods rnf :: DocumentationPart -> () #
Eq DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods (==) :: DocumentationPart -> DocumentationPart -> Bool # (/=) :: DocumentationPart -> DocumentationPart -> Bool #
Hashable DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart Methods hashWithSalt :: Int -> DocumentationPart -> Int # hash :: DocumentationPart -> Int #
type Rep DocumentationPart Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPart type Rep DocumentationPart = D1 ('MetaData "DocumentationPart" "Amazonka.APIGateway.Types.DocumentationPart" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationPart'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "location") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DocumentationPartLocation)) :: S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationPart :: DocumentationPart Source #

Create a value of DocumentationPart with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:DocumentationPart', documentationPart_id - The DocumentationPart identifier, generated by API Gateway when the DocumentationPart is created.

$sel:location:DocumentationPart', documentationPart_location - The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.

$sel:properties:DocumentationPart', documentationPart_properties - A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ \"description\": \"The API does ...\" }". Only OpenAPI-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a OpenAPI extension of x-amazon-apigateway-documentation.

DocumentationPartLocation

data DocumentationPartLocation Source #

Specifies the target API entity to which the documentation applies.

See: newDocumentationPartLocation smart constructor.

Constructors

DocumentationPartLocation' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) DocumentationPartType

Instances

Instances details

FromJSON DocumentationPartLocation Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartLocation Methods parseJSON :: Value -> Parser DocumentationPartLocation # parseJSONList :: Value -> Parser [DocumentationPartLocation] #
ToJSON DocumentationPartLocation Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartLocation Methods toJSON :: DocumentationPartLocation -> Value # toEncoding :: DocumentationPartLocation -> Encoding # toJSONList :: [DocumentationPartLocation] -> Value # toEncodingList :: [DocumentationPartLocation] -> Encoding #
Generic DocumentationPartLocation Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartLocation Associated Types type Rep DocumentationPartLocation :: Type -> Type # Methods from :: DocumentationPartLocation -> Rep DocumentationPartLocation x # to :: Rep DocumentationPartLocation x -> DocumentationPartLocation #
Read DocumentationPartLocation Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartLocation Methods readsPrec :: Int -> ReadS DocumentationPartLocation # readList :: ReadS [DocumentationPartLocation] # readPrec :: ReadPrec DocumentationPartLocation # readListPrec :: ReadPrec [DocumentationPartLocation] #
Show DocumentationPartLocation Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartLocation Methods showsPrec :: Int -> DocumentationPartLocation -> ShowS # show :: DocumentationPartLocation -> String # showList :: [DocumentationPartLocation] -> ShowS #
NFData DocumentationPartLocation Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartLocation Methods rnf :: DocumentationPartLocation -> () #
Eq DocumentationPartLocation Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartLocation Methods (==) :: DocumentationPartLocation -> DocumentationPartLocation -> Bool # (/=) :: DocumentationPartLocation -> DocumentationPartLocation -> Bool #
Hashable DocumentationPartLocation Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartLocation Methods hashWithSalt :: Int -> DocumentationPartLocation -> Int # hash :: DocumentationPartLocation -> Int #
type Rep DocumentationPartLocation Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationPartLocation type Rep DocumentationPartLocation = D1 ('MetaData "DocumentationPartLocation" "Amazonka.APIGateway.Types.DocumentationPartLocation" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationPartLocation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DocumentationPartType)))))

newDocumentationPartLocation Source #

Arguments

:: DocumentationPartType	`$sel:type':DocumentationPartLocation'`
-> DocumentationPartLocation

Create a value of DocumentationPartLocation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:method:DocumentationPartLocation', documentationPartLocation_method - The HTTP verb of a method. It is a valid field for the API entity types of METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.

$sel:name:DocumentationPartLocation', documentationPartLocation_name - The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER, MODEL, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY and RESPONSE_HEADER. It is an invalid field for any other entity type.

$sel:path:DocumentationPartLocation', documentationPartLocation_path - The URL path of the target. It is a valid field for the API entity types of RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.

$sel:statusCode:DocumentationPartLocation', documentationPartLocation_statusCode - The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.

$sel:type':DocumentationPartLocation', documentationPartLocation_type - The type of API entity to which the documentation content applies. Valid values are API, AUTHORIZER, MODEL, RESOURCE, METHOD, PATH_PARAMETER, QUERY_PARAMETER, REQUEST_HEADER, REQUEST_BODY, RESPONSE, RESPONSE_HEADER, and RESPONSE_BODY. Content inheritance does not apply to any entity of the API, AUTHORIZER, METHOD, MODEL, REQUEST_BODY, or RESOURCE type.

DocumentationVersion

data DocumentationVersion Source #

A snapshot of the documentation of an API.

See: newDocumentationVersion smart constructor.

Constructors

DocumentationVersion' (Maybe POSIX) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods parseJSON :: Value -> Parser DocumentationVersion # parseJSONList :: Value -> Parser [DocumentationVersion] #
Generic DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Associated Types type Rep DocumentationVersion :: Type -> Type # Methods from :: DocumentationVersion -> Rep DocumentationVersion x # to :: Rep DocumentationVersion x -> DocumentationVersion #
Read DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods readsPrec :: Int -> ReadS DocumentationVersion # readList :: ReadS [DocumentationVersion] # readPrec :: ReadPrec DocumentationVersion # readListPrec :: ReadPrec [DocumentationVersion] #
Show DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods showsPrec :: Int -> DocumentationVersion -> ShowS # show :: DocumentationVersion -> String # showList :: [DocumentationVersion] -> ShowS #
NFData DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods rnf :: DocumentationVersion -> () #
Eq DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods (==) :: DocumentationVersion -> DocumentationVersion -> Bool # (/=) :: DocumentationVersion -> DocumentationVersion -> Bool #
Hashable DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion Methods hashWithSalt :: Int -> DocumentationVersion -> Int # hash :: DocumentationVersion -> Int #
type Rep DocumentationVersion Source #
Instance details Defined in Amazonka.APIGateway.Types.DocumentationVersion type Rep DocumentationVersion = D1 ('MetaData "DocumentationVersion" "Amazonka.APIGateway.Types.DocumentationVersion" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DocumentationVersion'" 'PrefixI 'True) (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newDocumentationVersion :: DocumentationVersion Source #

Create a value of DocumentationVersion with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:createdDate:DocumentationVersion', documentationVersion_createdDate - The date when the API documentation snapshot is created.

$sel:description:DocumentationVersion', documentationVersion_description - The description of the API documentation snapshot.

$sel:version:DocumentationVersion', documentationVersion_version - The version identifier of the API documentation snapshot.

DomainName

data DomainName Source #

Represents a custom domain name as a user-friendly host name of an API (RestApi).

See: newDomainName smart constructor.

Constructors

DomainName' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DomainNameStatus) (Maybe Text) (Maybe EndpointConfiguration) (Maybe MutualTlsAuthentication) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SecurityPolicy) (Maybe (HashMap Text Text))

Instances

Instances details

FromJSON DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods parseJSON :: Value -> Parser DomainName # parseJSONList :: Value -> Parser [DomainName] #
Generic DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Associated Types type Rep DomainName :: Type -> Type # Methods from :: DomainName -> Rep DomainName x # to :: Rep DomainName x -> DomainName #
Read DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods readsPrec :: Int -> ReadS DomainName # readList :: ReadS [DomainName] # readPrec :: ReadPrec DomainName # readListPrec :: ReadPrec [DomainName] #
Show DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods showsPrec :: Int -> DomainName -> ShowS # show :: DomainName -> String # showList :: [DomainName] -> ShowS #
NFData DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods rnf :: DomainName -> () #
Eq DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods (==) :: DomainName -> DomainName -> Bool # (/=) :: DomainName -> DomainName -> Bool #
Hashable DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName Methods hashWithSalt :: Int -> DomainName -> Int # hash :: DomainName -> Int #
type Rep DomainName Source #
Instance details Defined in Amazonka.APIGateway.Types.DomainName type Rep DomainName = D1 ('MetaData "DomainName" "Amazonka.APIGateway.Types.DomainName" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "DomainName'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "certificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "certificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "certificateUploadDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "distributionDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "distributionHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domainNameStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DomainNameStatus)) :: S1 ('MetaSel ('Just "domainNameStatusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration)) :: S1 ('MetaSel ('Just "mutualTlsAuthentication") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MutualTlsAuthentication))) :: (S1 ('MetaSel ('Just "ownershipVerificationCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "regionalCertificateName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "regionalDomainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "regionalHostedZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "securityPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SecurityPolicy)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))))))))

newDomainName :: DomainName Source #

Create a value of DomainName with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:certificateArn:DomainName', domainName_certificateArn - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.

$sel:certificateName:DomainName', domainName_certificateName - The name of the certificate that will be used by edge-optimized endpoint for this domain name.

$sel:certificateUploadDate:DomainName', domainName_certificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

$sel:distributionDomainName:DomainName', domainName_distributionDomainName - The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation.

$sel:distributionHostedZoneId:DomainName', domainName_distributionHostedZoneId - The region-agnostic Amazon Route 53 Hosted Zone ID of the edge-optimized endpoint. The valid value is Z2FDTNDATAQYW2 for all the regions. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:domainName:DomainName', domainName_domainName - The custom domain name as an API host name, for example, my-api.example.com.

$sel:domainNameStatus:DomainName', domainName_domainNameStatus - The status of the DomainName migration. The valid values are AVAILABLE and UPDATING. If the status is UPDATING, the domain cannot be modified further until the existing operation is complete. If it is AVAILABLE, the domain can be updated.

$sel:domainNameStatusMessage:DomainName', domainName_domainNameStatusMessage - An optional text message containing detailed information about status of the DomainName migration.

$sel:endpointConfiguration:DomainName', domainName_endpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

$sel:mutualTlsAuthentication:DomainName', domainName_mutualTlsAuthentication - The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

$sel:ownershipVerificationCertificateArn:DomainName', domainName_ownershipVerificationCertificateArn - The ARN of the public certificate issued by ACM to validate ownership of your custom domain. Only required when configuring mutual TLS and using an ACM imported or private CA certificate ARN as the regionalCertificateArn.

$sel:regionalCertificateArn:DomainName', domainName_regionalCertificateArn - The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

$sel:regionalCertificateName:DomainName', domainName_regionalCertificateName - The name of the certificate that will be used for validating the regional domain name.

$sel:regionalDomainName:DomainName', domainName_regionalDomainName - The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by API Gateway when you create a regional endpoint.

$sel:regionalHostedZoneId:DomainName', domainName_regionalHostedZoneId - The region-specific Amazon Route 53 Hosted Zone ID of the regional endpoint. For more information, see Set up a Regional Custom Domain Name and AWS Regions and Endpoints for API Gateway.

$sel:securityPolicy:DomainName', domainName_securityPolicy - The Transport Layer Security (TLS) version + cipher suite for this DomainName. The valid values are TLS_1_0 and TLS_1_2.

$sel:tags:DomainName', domainName_tags - The collection of tags. Each tag element is associated with a given resource.

EndpointConfiguration

data EndpointConfiguration Source #

The endpoint configuration to indicate the types of endpoints an API (RestApi) or its custom domain name (DomainName) has.

See: newEndpointConfiguration smart constructor.

Constructors

EndpointConfiguration' (Maybe [EndpointType]) (Maybe [Text])

Instances

Instances details

FromJSON EndpointConfiguration Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointConfiguration Methods parseJSON :: Value -> Parser EndpointConfiguration # parseJSONList :: Value -> Parser [EndpointConfiguration] #
ToJSON EndpointConfiguration Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointConfiguration Methods toJSON :: EndpointConfiguration -> Value # toEncoding :: EndpointConfiguration -> Encoding # toJSONList :: [EndpointConfiguration] -> Value # toEncodingList :: [EndpointConfiguration] -> Encoding #
Generic EndpointConfiguration Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointConfiguration Associated Types type Rep EndpointConfiguration :: Type -> Type # Methods from :: EndpointConfiguration -> Rep EndpointConfiguration x # to :: Rep EndpointConfiguration x -> EndpointConfiguration #
Read EndpointConfiguration Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointConfiguration Methods readsPrec :: Int -> ReadS EndpointConfiguration # readList :: ReadS [EndpointConfiguration] # readPrec :: ReadPrec EndpointConfiguration # readListPrec :: ReadPrec [EndpointConfiguration] #
Show EndpointConfiguration Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointConfiguration Methods showsPrec :: Int -> EndpointConfiguration -> ShowS # show :: EndpointConfiguration -> String # showList :: [EndpointConfiguration] -> ShowS #
NFData EndpointConfiguration Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointConfiguration Methods rnf :: EndpointConfiguration -> () #
Eq EndpointConfiguration Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointConfiguration Methods (==) :: EndpointConfiguration -> EndpointConfiguration -> Bool # (/=) :: EndpointConfiguration -> EndpointConfiguration -> Bool #
Hashable EndpointConfiguration Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointConfiguration Methods hashWithSalt :: Int -> EndpointConfiguration -> Int # hash :: EndpointConfiguration -> Int #
type Rep EndpointConfiguration Source #
Instance details Defined in Amazonka.APIGateway.Types.EndpointConfiguration type Rep EndpointConfiguration = D1 ('MetaData "EndpointConfiguration" "Amazonka.APIGateway.Types.EndpointConfiguration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "EndpointConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "types") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [EndpointType])) :*: S1 ('MetaSel ('Just "vpcEndpointIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))

newEndpointConfiguration :: EndpointConfiguration Source #

Create a value of EndpointConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:types:EndpointConfiguration', endpointConfiguration_types - A list of endpoint types of an API (RestApi) or its custom domain name (DomainName). For an edge-optimized API and its custom domain name, the endpoint type is "EDGE". For a regional API and its custom domain name, the endpoint type is REGIONAL. For a private API, the endpoint type is PRIVATE.

$sel:vpcEndpointIds:EndpointConfiguration', endpointConfiguration_vpcEndpointIds - A list of VpcEndpointIds of an API (RestApi) against which to create Route53 ALIASes. It is only supported for PRIVATE endpoint type.

GatewayResponse

data GatewayResponse Source #

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

See: newGatewayResponse smart constructor.

Constructors

GatewayResponse' (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe GatewayResponseType) (Maybe Text)

Instances

Instances details

FromJSON GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods parseJSON :: Value -> Parser GatewayResponse # parseJSONList :: Value -> Parser [GatewayResponse] #
Generic GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Associated Types type Rep GatewayResponse :: Type -> Type # Methods from :: GatewayResponse -> Rep GatewayResponse x # to :: Rep GatewayResponse x -> GatewayResponse #
Read GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods readsPrec :: Int -> ReadS GatewayResponse # readList :: ReadS [GatewayResponse] # readPrec :: ReadPrec GatewayResponse # readListPrec :: ReadPrec [GatewayResponse] #
Show GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods showsPrec :: Int -> GatewayResponse -> ShowS # show :: GatewayResponse -> String # showList :: [GatewayResponse] -> ShowS #
NFData GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods rnf :: GatewayResponse -> () #
Eq GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods (==) :: GatewayResponse -> GatewayResponse -> Bool # (/=) :: GatewayResponse -> GatewayResponse -> Bool #
Hashable GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse Methods hashWithSalt :: Int -> GatewayResponse -> Int # hash :: GatewayResponse -> Int #
type Rep GatewayResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.GatewayResponse type Rep GatewayResponse = D1 ('MetaData "GatewayResponse" "Amazonka.APIGateway.Types.GatewayResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GatewayResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultResponse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GatewayResponseType)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newGatewayResponse :: GatewayResponse Source #

Create a value of GatewayResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultResponse:GatewayResponse', gatewayResponse_defaultResponse - A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

$sel:responseParameters:GatewayResponse', gatewayResponse_responseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseTemplates:GatewayResponse', gatewayResponse_responseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

$sel:responseType:GatewayResponse', gatewayResponse_responseType - The response type of the associated GatewayResponse.

$sel:statusCode:GatewayResponse', gatewayResponse_statusCode - The HTTP status code for this GatewayResponse.

Integration

data Integration Source #

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

See: newIntegration smart constructor.

Constructors

Integration' (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe ConnectionType) (Maybe ContentHandlingStrategy) (Maybe Text) (Maybe Text) (Maybe (HashMap Text IntegrationResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Int) (Maybe TlsConfig) (Maybe IntegrationType) (Maybe Text)

Instances

Instances details

FromJSON Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods parseJSON :: Value -> Parser Integration # parseJSONList :: Value -> Parser [Integration] #
Generic Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Associated Types type Rep Integration :: Type -> Type # Methods from :: Integration -> Rep Integration x # to :: Rep Integration x -> Integration #
Read Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods readsPrec :: Int -> ReadS Integration # readList :: ReadS [Integration] # readPrec :: ReadPrec Integration # readListPrec :: ReadPrec [Integration] #
Show Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods showsPrec :: Int -> Integration -> ShowS # show :: Integration -> String # showList :: [Integration] -> ShowS #
NFData Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods rnf :: Integration -> () #
Eq Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods (==) :: Integration -> Integration -> Bool # (/=) :: Integration -> Integration -> Bool #
Hashable Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration Methods hashWithSalt :: Int -> Integration -> Int # hash :: Integration -> Int #
type Rep Integration Source #
Instance details Defined in Amazonka.APIGateway.Types.Integration type Rep Integration = D1 ('MetaData "Integration" "Amazonka.APIGateway.Types.Integration" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Integration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheKeyParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "cacheNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "connectionId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "connectionType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConnectionType)) :: S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy))) :: (S1 ('MetaSel ('Just "credentials") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "integrationResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text IntegrationResponse))) :: S1 ('MetaSel ('Just "passthroughBehavior") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "requestTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))) :: ((S1 ('MetaSel ('Just "timeoutInMillis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "tlsConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TlsConfig))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IntegrationType)) :: S1 ('MetaSel ('Just "uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newIntegration :: Integration Source #

Create a value of Integration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheKeyParameters:Integration', integration_cacheKeyParameters - A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

$sel:cacheNamespace:Integration', integration_cacheNamespace - Specifies a group of related cached parameters. By default, API Gateway uses the resource ID as the cacheNamespace. You can specify the same cacheNamespace across resources to return the same cached data for requests to different resources.

$sel:connectionId:Integration', integration_connectionId - The ID of the VpcLink used for the integration when connectionType=VPC_LINK and undefined, otherwise.

$sel:connectionType:Integration', integration_connectionType - The type of the network connection to the integration endpoint. The valid value is INTERNET for connections through the public routable internet or VPC_LINK for private connections between API Gateway and a network load balancer in a VPC. The default value is INTERNET.

Integration, integration_contentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehavior is configured to support payload pass-through.

$sel:credentials:Integration', integration_credentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for API Gateway to assume, use the role's Amazon Resource Name (ARN). To require that the caller's identity be passed through from the request, specify the string arn:aws:iam::\*:user/\*. To use resource-based permissions on supported AWS services, specify null.

$sel:httpMethod:Integration', integration_httpMethod - Specifies the integration's HTTP method type.

$sel:integrationResponses:Integration', integration_integrationResponses - Specifies the integration's responses.

$sel:passthroughBehavior:Integration', integration_passthroughBehavior - Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. The valid value is one of the following: WHEN_NO_MATCH: passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. WHEN_NO_TEMPLATES: passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. NEVER: rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

$sel:requestParameters:Integration', integration_requestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name must be a valid and unique method request parameter name.

$sel:requestTemplates:Integration', integration_requestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

$sel:timeoutInMillis:Integration', integration_timeoutInMillis - Custom timeout between 50 and 29,000 milliseconds. The default value is 29,000 milliseconds or 29 seconds.

$sel:tlsConfig:Integration', integration_tlsConfig - Specifies the TLS configuration for an integration.

$sel:type':Integration', integration_type - Specifies an API method integration type. The valid value is one of the following:

For the HTTP and HTTP proxy integrations, each integration can specify a protocol (http/https), port and path. Standard 80 and 443 ports are supported as well as custom ports above 1024. An HTTP or HTTP proxy integration with a connectionType of VPC_LINK is referred to as a private integration and uses a VpcLink to connect API Gateway to a network load balancer of a VPC.

$sel:uri:Integration', integration_uri - Specifies Uniform Resource Identifier (URI) of the integration endpoint.

For HTTP or HTTP_PROXY integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification, for either standard integration, where connectionType is not VPC_LINK, or private integration, where connectionType is VPC_LINK. For a private HTTP integration, the URI is not used for routing. For AWS or AWS_PROXY integrations, the URI is of the form arn:aws:apigateway:{region}:{subdomain.service|service}:path|action/{service_api}. Here, {Region} is the API Gateway region (e.g., us-east-1); {service} is the name of the integrated Amazon Web Services service (e.g., s3); and {subdomain} is a designated subdomain supported by certain Amazon Web Services service for fast host-name lookup. action can be used for an Amazon Web Services service action-based API, using an Action={name}&{p1}={v1}&p2={v2}... query string. The ensuing {service_api} refers to a supported action {name} plus any required input parameters. Alternatively, path can be used for an AWS service path-based API. The ensuing service_api refers to the path to an Amazon Web Services service resource, including the region of the integrated Amazon Web Services service, if applicable. For example, for integration with the S3 API of GetObject, the uri can be either arn:aws:apigateway:us-west-2:s3:action/GetObject&Bucket={bucket}&Key={key} or arn:aws:apigateway:us-west-2:s3:path/{bucket}/{key}

IntegrationResponse

data IntegrationResponse Source #

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the back-end response.

See: newIntegrationResponse smart constructor.

Constructors

IntegrationResponse' (Maybe ContentHandlingStrategy) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods parseJSON :: Value -> Parser IntegrationResponse # parseJSONList :: Value -> Parser [IntegrationResponse] #
Generic IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Associated Types type Rep IntegrationResponse :: Type -> Type # Methods from :: IntegrationResponse -> Rep IntegrationResponse x # to :: Rep IntegrationResponse x -> IntegrationResponse #
Read IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods readsPrec :: Int -> ReadS IntegrationResponse # readList :: ReadS [IntegrationResponse] # readPrec :: ReadPrec IntegrationResponse # readListPrec :: ReadPrec [IntegrationResponse] #
Show IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods showsPrec :: Int -> IntegrationResponse -> ShowS # show :: IntegrationResponse -> String # showList :: [IntegrationResponse] -> ShowS #
NFData IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods rnf :: IntegrationResponse -> () #
Eq IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods (==) :: IntegrationResponse -> IntegrationResponse -> Bool # (/=) :: IntegrationResponse -> IntegrationResponse -> Bool #
Hashable IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse Methods hashWithSalt :: Int -> IntegrationResponse -> Int # hash :: IntegrationResponse -> Int #
type Rep IntegrationResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.IntegrationResponse type Rep IntegrationResponse = D1 ('MetaData "IntegrationResponse" "Amazonka.APIGateway.Types.IntegrationResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "IntegrationResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentHandling") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)) :: S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "responseTemplates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "selectionPattern") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newIntegrationResponse :: IntegrationResponse Source #

Create a value of IntegrationResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentHandling:IntegrationResponse', integrationResponse_contentHandling - Specifies how to handle response payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT, with the following behaviors:

If this property is not defined, the response payload will be passed through from the integration response to the method response without modification.

$sel:responseParameters:IntegrationResponse', integrationResponse_responseParameters - A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of method.response.header.{name}, where name is a valid and unique header name. The mapped non-static value must match the pattern of integration.response.header.{name} or integration.response.body.{JSON-expression}, where name is a valid and unique response header name and JSON-expression is a valid JSON expression without the $ prefix.

$sel:responseTemplates:IntegrationResponse', integrationResponse_responseTemplates - Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

$sel:selectionPattern:IntegrationResponse', integrationResponse_selectionPattern - Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline (\n) character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

$sel:statusCode:IntegrationResponse', integrationResponse_statusCode - Specifies the status code that is used to map the integration response to an existing MethodResponse.

Method

data Method Source #

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

See: newMethod smart constructor.

Constructors

Method' (Maybe Bool) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Integration) (Maybe (HashMap Text MethodResponse)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)

Instances

Instances details

FromJSON Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods parseJSON :: Value -> Parser Method # parseJSONList :: Value -> Parser [Method] #
Generic Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Associated Types type Rep Method :: Type -> Type # Methods from :: Method -> Rep Method x # to :: Rep Method x -> Method #
Read Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods readsPrec :: Int -> ReadS Method # readList :: ReadS [Method] # readPrec :: ReadPrec Method # readListPrec :: ReadPrec [Method] #
Show Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods showsPrec :: Int -> Method -> ShowS # show :: Method -> String # showList :: [Method] -> ShowS #
NFData Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods rnf :: Method -> () #
Eq Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods (==) :: Method -> Method -> Bool # (/=) :: Method -> Method -> Bool #
Hashable Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method Methods hashWithSalt :: Int -> Method -> Int # hash :: Method -> Int #
type Rep Method Source #
Instance details Defined in Amazonka.APIGateway.Types.Method type Rep Method = D1 ('MetaData "Method" "Amazonka.APIGateway.Types.Method" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Method'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "authorizationScopes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :: (S1 ('MetaSel ('Just "authorizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "authorizerId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpMethod") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "methodIntegration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integration)) :: (S1 ('MetaSel ('Just "methodResponses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MethodResponse))) :: S1 ('MetaSel ('Just "operationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "requestModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "requestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: S1 ('MetaSel ('Just "requestValidatorId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newMethod :: Method Source #

Create a value of Method with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyRequired:Method', method_apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke this method.

$sel:authorizationScopes:Method', method_authorizationScopes - A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

$sel:authorizationType:Method', method_authorizationType - The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

$sel:authorizerId:Method', method_authorizerId - The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Method, method_httpMethod - The method's HTTP verb.

$sel:methodIntegration:Method', method_methodIntegration - Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

$sel:methodResponses:Method', method_methodResponses - Gets a method response associated with a given HTTP status code.

$sel:operationName:Method', method_operationName - A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

$sel:requestModels:Method', method_requestModels - A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

Method, method_requestParameters - A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key is a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

$sel:requestValidatorId:Method', method_requestValidatorId - The identifier of a RequestValidator for request validation.

MethodResponse

data MethodResponse Source #

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

See: newMethodResponse smart constructor.

Constructors

MethodResponse' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Bool)) (Maybe Text)

Instances

Instances details

FromJSON MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods parseJSON :: Value -> Parser MethodResponse # parseJSONList :: Value -> Parser [MethodResponse] #
Generic MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Associated Types type Rep MethodResponse :: Type -> Type # Methods from :: MethodResponse -> Rep MethodResponse x # to :: Rep MethodResponse x -> MethodResponse #
Read MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods readsPrec :: Int -> ReadS MethodResponse # readList :: ReadS [MethodResponse] # readPrec :: ReadPrec MethodResponse # readListPrec :: ReadPrec [MethodResponse] #
Show MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods showsPrec :: Int -> MethodResponse -> ShowS # show :: MethodResponse -> String # showList :: [MethodResponse] -> ShowS #
NFData MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods rnf :: MethodResponse -> () #
Eq MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods (==) :: MethodResponse -> MethodResponse -> Bool # (/=) :: MethodResponse -> MethodResponse -> Bool #
Hashable MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse Methods hashWithSalt :: Int -> MethodResponse -> Int # hash :: MethodResponse -> Int #
type Rep MethodResponse Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodResponse type Rep MethodResponse = D1 ('MetaData "MethodResponse" "Amazonka.APIGateway.Types.MethodResponse" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MethodResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "responseModels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "responseParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Bool))) :: S1 ('MetaSel ('Just "statusCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newMethodResponse :: MethodResponse Source #

Create a value of MethodResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:responseModels:MethodResponse', methodResponse_responseModels - Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

$sel:responseParameters:MethodResponse', methodResponse_responseParameters - A key-value map specifying required or optional response parameters that API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern method.response.header.{name}, where name is a valid and unique header name. API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in integration.response.header.{name}, a static value enclosed within a pair of single quotes (e.g., 'application/json'), or a JSON expression from the back-end response payload in the form of integration.response.body.{JSON-expression}, where JSON-expression is a valid JSON expression without the $ prefix.)

$sel:statusCode:MethodResponse', methodResponse_statusCode - The method response's status code.

MethodSetting

data MethodSetting Source #

Specifies the method setting properties.

See: newMethodSetting smart constructor.

Constructors

MethodSetting' (Maybe Bool) (Maybe Int) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Int) (Maybe Double) (Maybe UnauthorizedCacheControlHeaderStrategy)

Instances

Instances details

FromJSON MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods parseJSON :: Value -> Parser MethodSetting # parseJSONList :: Value -> Parser [MethodSetting] #
Generic MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Associated Types type Rep MethodSetting :: Type -> Type # Methods from :: MethodSetting -> Rep MethodSetting x # to :: Rep MethodSetting x -> MethodSetting #
Read MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods readsPrec :: Int -> ReadS MethodSetting # readList :: ReadS [MethodSetting] # readPrec :: ReadPrec MethodSetting # readListPrec :: ReadPrec [MethodSetting] #
Show MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods showsPrec :: Int -> MethodSetting -> ShowS # show :: MethodSetting -> String # showList :: [MethodSetting] -> ShowS #
NFData MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods rnf :: MethodSetting -> () #
Eq MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods (==) :: MethodSetting -> MethodSetting -> Bool # (/=) :: MethodSetting -> MethodSetting -> Bool #
Hashable MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting Methods hashWithSalt :: Int -> MethodSetting -> Int # hash :: MethodSetting -> Int #
type Rep MethodSetting Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSetting type Rep MethodSetting = D1 ('MetaData "MethodSetting" "Amazonka.APIGateway.Types.MethodSetting" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MethodSetting'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "cacheDataEncrypted") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "cacheTtlInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "cachingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "dataTraceEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "loggingLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "metricsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "requireAuthorizationForCacheControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "throttlingBurstLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "throttlingRateLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double)) :*: S1 ('MetaSel ('Just "unauthorizedCacheControlHeaderStrategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UnauthorizedCacheControlHeaderStrategy)))))))

newMethodSetting :: MethodSetting Source #

Create a value of MethodSetting with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cacheDataEncrypted:MethodSetting', methodSetting_cacheDataEncrypted - Specifies whether the cached responses are encrypted. The PATCH path for this setting is /{method_setting_key}/caching/dataEncrypted, and the value is a Boolean.

$sel:cacheTtlInSeconds:MethodSetting', methodSetting_cacheTtlInSeconds - Specifies the time to live (TTL), in seconds, for cached responses. The higher the TTL, the longer the response will be cached. The PATCH path for this setting is /{method_setting_key}/caching/ttlInSeconds, and the value is an integer.

$sel:cachingEnabled:MethodSetting', methodSetting_cachingEnabled - Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is /{method_setting_key}/caching/enabled, and the value is a Boolean.

$sel:dataTraceEnabled:MethodSetting', methodSetting_dataTraceEnabled - Specifies whether data trace logging is enabled for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/dataTrace, and the value is a Boolean.

$sel:loggingLevel:MethodSetting', methodSetting_loggingLevel - Specifies the logging level for this method, which affects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is /{method_setting_key}/logging/loglevel, and the available levels are OFF, ERROR, and INFO. Choose ERROR to write only error-level entries to CloudWatch Logs, or choose INFO to include all ERROR events as well as extra informational events.

$sel:metricsEnabled:MethodSetting', methodSetting_metricsEnabled - Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is /{method_setting_key}/metrics/enabled, and the value is a Boolean.

$sel:requireAuthorizationForCacheControl:MethodSetting', methodSetting_requireAuthorizationForCacheControl - Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is /{method_setting_key}/caching/requireAuthorizationForCacheControl, and the value is a Boolean.

$sel:throttlingBurstLimit:MethodSetting', methodSetting_throttlingBurstLimit - Specifies the throttling burst limit. The PATCH path for this setting is /{method_setting_key}/throttling/burstLimit, and the value is an integer.

$sel:throttlingRateLimit:MethodSetting', methodSetting_throttlingRateLimit - Specifies the throttling rate limit. The PATCH path for this setting is /{method_setting_key}/throttling/rateLimit, and the value is a double.

$sel:unauthorizedCacheControlHeaderStrategy:MethodSetting', methodSetting_unauthorizedCacheControlHeaderStrategy - Specifies how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is /{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy, and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

MethodSnapshot

data MethodSnapshot Source #

Represents a summary of a Method resource, given a particular date and time.

See: newMethodSnapshot smart constructor.

Constructors

MethodSnapshot' (Maybe Bool) (Maybe Text)

Instances

Instances details

FromJSON MethodSnapshot Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSnapshot Methods parseJSON :: Value -> Parser MethodSnapshot # parseJSONList :: Value -> Parser [MethodSnapshot] #
Generic MethodSnapshot Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSnapshot Associated Types type Rep MethodSnapshot :: Type -> Type # Methods from :: MethodSnapshot -> Rep MethodSnapshot x # to :: Rep MethodSnapshot x -> MethodSnapshot #
Read MethodSnapshot Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSnapshot Methods readsPrec :: Int -> ReadS MethodSnapshot # readList :: ReadS [MethodSnapshot] # readPrec :: ReadPrec MethodSnapshot # readListPrec :: ReadPrec [MethodSnapshot] #
Show MethodSnapshot Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSnapshot Methods showsPrec :: Int -> MethodSnapshot -> ShowS # show :: MethodSnapshot -> String # showList :: [MethodSnapshot] -> ShowS #
NFData MethodSnapshot Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSnapshot Methods rnf :: MethodSnapshot -> () #
Eq MethodSnapshot Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSnapshot Methods (==) :: MethodSnapshot -> MethodSnapshot -> Bool # (/=) :: MethodSnapshot -> MethodSnapshot -> Bool #
Hashable MethodSnapshot Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSnapshot Methods hashWithSalt :: Int -> MethodSnapshot -> Int # hash :: MethodSnapshot -> Int #
type Rep MethodSnapshot Source #
Instance details Defined in Amazonka.APIGateway.Types.MethodSnapshot type Rep MethodSnapshot = D1 ('MetaData "MethodSnapshot" "Amazonka.APIGateway.Types.MethodSnapshot" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MethodSnapshot'" 'PrefixI 'True) (S1 ('MetaSel ('Just "apiKeyRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "authorizationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newMethodSnapshot :: MethodSnapshot Source #

Create a value of MethodSnapshot with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeyRequired:MethodSnapshot', methodSnapshot_apiKeyRequired - Specifies whether the method requires a valid ApiKey.

$sel:authorizationType:MethodSnapshot', methodSnapshot_authorizationType - The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Model

data Model Source #

Represents the data structure of a method's request or response payload.

See: newModel smart constructor.

Constructors

Model' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods parseJSON :: Value -> Parser Model # parseJSONList :: Value -> Parser [Model] #
Generic Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Associated Types type Rep Model :: Type -> Type # Methods from :: Model -> Rep Model x # to :: Rep Model x -> Model #
Read Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods readsPrec :: Int -> ReadS Model # readList :: ReadS [Model] # readPrec :: ReadPrec Model # readListPrec :: ReadPrec [Model] #
Show Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods showsPrec :: Int -> Model -> ShowS # show :: Model -> String # showList :: [Model] -> ShowS #
NFData Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods rnf :: Model -> () #
Eq Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods (==) :: Model -> Model -> Bool # (/=) :: Model -> Model -> Bool #
Hashable Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model Methods hashWithSalt :: Int -> Model -> Int # hash :: Model -> Int #
type Rep Model Source #
Instance details Defined in Amazonka.APIGateway.Types.Model type Rep Model = D1 ('MetaData "Model" "Amazonka.APIGateway.Types.Model" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Model'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newModel :: Model Source #

Create a value of Model with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:contentType:Model', model_contentType - The content-type for the model.

$sel:description:Model', model_description - The description of the model.

$sel:id:Model', model_id - The identifier for the model resource.

$sel:name:Model', model_name - The name of the model. Must be an alphanumeric string.

$sel:schema:Model', model_schema - The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

MutualTlsAuthentication

data MutualTlsAuthentication Source #

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

See: newMutualTlsAuthentication smart constructor.

Constructors

MutualTlsAuthentication' (Maybe Text) (Maybe Text) (Maybe [Text])

Instances

Instances details

FromJSON MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods parseJSON :: Value -> Parser MutualTlsAuthentication # parseJSONList :: Value -> Parser [MutualTlsAuthentication] #
Generic MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Associated Types type Rep MutualTlsAuthentication :: Type -> Type # Methods from :: MutualTlsAuthentication -> Rep MutualTlsAuthentication x # to :: Rep MutualTlsAuthentication x -> MutualTlsAuthentication #
Read MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods readsPrec :: Int -> ReadS MutualTlsAuthentication # readList :: ReadS [MutualTlsAuthentication] # readPrec :: ReadPrec MutualTlsAuthentication # readListPrec :: ReadPrec [MutualTlsAuthentication] #
Show MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods showsPrec :: Int -> MutualTlsAuthentication -> ShowS # show :: MutualTlsAuthentication -> String # showList :: [MutualTlsAuthentication] -> ShowS #
NFData MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods rnf :: MutualTlsAuthentication -> () #
Eq MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods (==) :: MutualTlsAuthentication -> MutualTlsAuthentication -> Bool # (/=) :: MutualTlsAuthentication -> MutualTlsAuthentication -> Bool #
Hashable MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication Methods hashWithSalt :: Int -> MutualTlsAuthentication -> Int # hash :: MutualTlsAuthentication -> Int #
type Rep MutualTlsAuthentication Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthentication type Rep MutualTlsAuthentication = D1 ('MetaData "MutualTlsAuthentication" "Amazonka.APIGateway.Types.MutualTlsAuthentication" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MutualTlsAuthentication'" 'PrefixI 'True) (S1 ('MetaSel ('Just "truststoreUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "truststoreVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "truststoreWarnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))

newMutualTlsAuthentication :: MutualTlsAuthentication Source #

Create a value of MutualTlsAuthentication with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:truststoreUri:MutualTlsAuthentication', mutualTlsAuthentication_truststoreUri - An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

$sel:truststoreVersion:MutualTlsAuthentication', mutualTlsAuthentication_truststoreVersion - The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

$sel:truststoreWarnings:MutualTlsAuthentication', mutualTlsAuthentication_truststoreWarnings - A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

MutualTlsAuthenticationInput

data MutualTlsAuthenticationInput Source #

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

See: newMutualTlsAuthenticationInput smart constructor.

Constructors

MutualTlsAuthenticationInput' (Maybe Text) (Maybe Text)

Instances

Instances details

ToJSON MutualTlsAuthenticationInput Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput Methods toJSON :: MutualTlsAuthenticationInput -> Value # toEncoding :: MutualTlsAuthenticationInput -> Encoding # toJSONList :: [MutualTlsAuthenticationInput] -> Value # toEncodingList :: [MutualTlsAuthenticationInput] -> Encoding #
Generic MutualTlsAuthenticationInput Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput Associated Types type Rep MutualTlsAuthenticationInput :: Type -> Type # Methods from :: MutualTlsAuthenticationInput -> Rep MutualTlsAuthenticationInput x # to :: Rep MutualTlsAuthenticationInput x -> MutualTlsAuthenticationInput #
Read MutualTlsAuthenticationInput Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput Methods readsPrec :: Int -> ReadS MutualTlsAuthenticationInput # readList :: ReadS [MutualTlsAuthenticationInput] # readPrec :: ReadPrec MutualTlsAuthenticationInput # readListPrec :: ReadPrec [MutualTlsAuthenticationInput] #
Show MutualTlsAuthenticationInput Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput Methods showsPrec :: Int -> MutualTlsAuthenticationInput -> ShowS # show :: MutualTlsAuthenticationInput -> String # showList :: [MutualTlsAuthenticationInput] -> ShowS #
NFData MutualTlsAuthenticationInput Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput Methods rnf :: MutualTlsAuthenticationInput -> () #
Eq MutualTlsAuthenticationInput Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput Methods (==) :: MutualTlsAuthenticationInput -> MutualTlsAuthenticationInput -> Bool # (/=) :: MutualTlsAuthenticationInput -> MutualTlsAuthenticationInput -> Bool #
Hashable MutualTlsAuthenticationInput Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput Methods hashWithSalt :: Int -> MutualTlsAuthenticationInput -> Int # hash :: MutualTlsAuthenticationInput -> Int #
type Rep MutualTlsAuthenticationInput Source #
Instance details Defined in Amazonka.APIGateway.Types.MutualTlsAuthenticationInput type Rep MutualTlsAuthenticationInput = D1 ('MetaData "MutualTlsAuthenticationInput" "Amazonka.APIGateway.Types.MutualTlsAuthenticationInput" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "MutualTlsAuthenticationInput'" 'PrefixI 'True) (S1 ('MetaSel ('Just "truststoreUri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "truststoreVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newMutualTlsAuthenticationInput :: MutualTlsAuthenticationInput Source #

Create a value of MutualTlsAuthenticationInput with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:truststoreUri:MutualTlsAuthenticationInput', mutualTlsAuthenticationInput_truststoreUri - An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

$sel:truststoreVersion:MutualTlsAuthenticationInput', mutualTlsAuthenticationInput_truststoreVersion - The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket

PatchOperation

data PatchOperation Source #

For more information about supported patch operations, see Patch Operations.

See: newPatchOperation smart constructor.

Constructors

PatchOperation' (Maybe Text) (Maybe Op) (Maybe Text) (Maybe Text)

Instances

Instances details

ToJSON PatchOperation Source #
Instance details Defined in Amazonka.APIGateway.Types.PatchOperation Methods toJSON :: PatchOperation -> Value # toEncoding :: PatchOperation -> Encoding # toJSONList :: [PatchOperation] -> Value # toEncodingList :: [PatchOperation] -> Encoding #
Generic PatchOperation Source #
Instance details Defined in Amazonka.APIGateway.Types.PatchOperation Associated Types type Rep PatchOperation :: Type -> Type # Methods from :: PatchOperation -> Rep PatchOperation x # to :: Rep PatchOperation x -> PatchOperation #
Read PatchOperation Source #
Instance details Defined in Amazonka.APIGateway.Types.PatchOperation Methods readsPrec :: Int -> ReadS PatchOperation # readList :: ReadS [PatchOperation] # readPrec :: ReadPrec PatchOperation # readListPrec :: ReadPrec [PatchOperation] #
Show PatchOperation Source #
Instance details Defined in Amazonka.APIGateway.Types.PatchOperation Methods showsPrec :: Int -> PatchOperation -> ShowS # show :: PatchOperation -> String # showList :: [PatchOperation] -> ShowS #
NFData PatchOperation Source #
Instance details Defined in Amazonka.APIGateway.Types.PatchOperation Methods rnf :: PatchOperation -> () #
Eq PatchOperation Source #
Instance details Defined in Amazonka.APIGateway.Types.PatchOperation Methods (==) :: PatchOperation -> PatchOperation -> Bool # (/=) :: PatchOperation -> PatchOperation -> Bool #
Hashable PatchOperation Source #
Instance details Defined in Amazonka.APIGateway.Types.PatchOperation Methods hashWithSalt :: Int -> PatchOperation -> Int # hash :: PatchOperation -> Int #
type Rep PatchOperation Source #
Instance details Defined in Amazonka.APIGateway.Types.PatchOperation type Rep PatchOperation = D1 ('MetaData "PatchOperation" "Amazonka.APIGateway.Types.PatchOperation" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "PatchOperation'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "from") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "op") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Op))) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newPatchOperation :: PatchOperation Source #

Create a value of PatchOperation with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:from:PatchOperation', patchOperation_from - The copy update operation's source as identified by a JSON-Pointer value referencing the location within the targeted resource to copy the value from. For example, to promote a canary deployment, you copy the canary deployment ID to the affiliated deployment ID by calling a PATCH request on a Stage resource with "op":"copy", "from":"/canarySettings/deploymentId" and "path":"/deploymentId".

$sel:op:PatchOperation', patchOperation_op - An update operation to be performed with this PATCH request. The valid value can be add, remove, replace or copy. Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message..

$sel:path:PatchOperation', patchOperation_path - The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {"name":"value"}, the path for this property is /name. If the name property value is a JSON object (e.g., {"name": {"child/name": "child-value"}}), the path for the child/name property will be /name/child~1name. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.

$sel:value:PatchOperation', patchOperation_value - The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{"a": ...}'.

QuotaSettings

data QuotaSettings Source #

Quotas configured for a usage plan.

See: newQuotaSettings smart constructor.

Constructors

QuotaSettings' (Maybe Int) (Maybe Int) (Maybe QuotaPeriodType)

Instances

Instances details

FromJSON QuotaSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaSettings Methods parseJSON :: Value -> Parser QuotaSettings # parseJSONList :: Value -> Parser [QuotaSettings] #
ToJSON QuotaSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaSettings Methods toJSON :: QuotaSettings -> Value # toEncoding :: QuotaSettings -> Encoding # toJSONList :: [QuotaSettings] -> Value # toEncodingList :: [QuotaSettings] -> Encoding #
Generic QuotaSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaSettings Associated Types type Rep QuotaSettings :: Type -> Type # Methods from :: QuotaSettings -> Rep QuotaSettings x # to :: Rep QuotaSettings x -> QuotaSettings #
Read QuotaSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaSettings Methods readsPrec :: Int -> ReadS QuotaSettings # readList :: ReadS [QuotaSettings] # readPrec :: ReadPrec QuotaSettings # readListPrec :: ReadPrec [QuotaSettings] #
Show QuotaSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaSettings Methods showsPrec :: Int -> QuotaSettings -> ShowS # show :: QuotaSettings -> String # showList :: [QuotaSettings] -> ShowS #
NFData QuotaSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaSettings Methods rnf :: QuotaSettings -> () #
Eq QuotaSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaSettings Methods (==) :: QuotaSettings -> QuotaSettings -> Bool # (/=) :: QuotaSettings -> QuotaSettings -> Bool #
Hashable QuotaSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaSettings Methods hashWithSalt :: Int -> QuotaSettings -> Int # hash :: QuotaSettings -> Int #
type Rep QuotaSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.QuotaSettings type Rep QuotaSettings = D1 ('MetaData "QuotaSettings" "Amazonka.APIGateway.Types.QuotaSettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "QuotaSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "limit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "offset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "period") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaPeriodType)))))

newQuotaSettings :: QuotaSettings Source #

Create a value of QuotaSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:limit:QuotaSettings', quotaSettings_limit - The target maximum number of requests that can be made in a given time period.

$sel:offset:QuotaSettings', quotaSettings_offset - The number of requests subtracted from the given limit in the initial time period.

$sel:period:QuotaSettings', quotaSettings_period - The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

RequestValidator

data RequestValidator Source #

A set of validation rules for incoming Method requests.

See: newRequestValidator smart constructor.

Constructors

RequestValidator' (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool)

Instances

Instances details

FromJSON RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods parseJSON :: Value -> Parser RequestValidator # parseJSONList :: Value -> Parser [RequestValidator] #
Generic RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Associated Types type Rep RequestValidator :: Type -> Type # Methods from :: RequestValidator -> Rep RequestValidator x # to :: Rep RequestValidator x -> RequestValidator #
Read RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods readsPrec :: Int -> ReadS RequestValidator # readList :: ReadS [RequestValidator] # readPrec :: ReadPrec RequestValidator # readListPrec :: ReadPrec [RequestValidator] #
Show RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods showsPrec :: Int -> RequestValidator -> ShowS # show :: RequestValidator -> String # showList :: [RequestValidator] -> ShowS #
NFData RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods rnf :: RequestValidator -> () #
Eq RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods (==) :: RequestValidator -> RequestValidator -> Bool # (/=) :: RequestValidator -> RequestValidator -> Bool #
Hashable RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator Methods hashWithSalt :: Int -> RequestValidator -> Int # hash :: RequestValidator -> Int #
type Rep RequestValidator Source #
Instance details Defined in Amazonka.APIGateway.Types.RequestValidator type Rep RequestValidator = D1 ('MetaData "RequestValidator" "Amazonka.APIGateway.Types.RequestValidator" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RequestValidator'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "validateRequestBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "validateRequestParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))))

newRequestValidator :: RequestValidator Source #

Create a value of RequestValidator with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:RequestValidator', requestValidator_id - The identifier of this RequestValidator.

$sel:name:RequestValidator', requestValidator_name - The name of this RequestValidator

$sel:validateRequestBody:RequestValidator', requestValidator_validateRequestBody - A Boolean flag to indicate whether to validate a request body according to the configured Model schema.

$sel:validateRequestParameters:RequestValidator', requestValidator_validateRequestParameters - A Boolean flag to indicate whether to validate request parameters (true) or not (false).

Resource

data Resource Source #

Represents an API resource.

See: newResource smart constructor.

Constructors

Resource' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Method))

Instances

Instances details

FromJSON Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods parseJSON :: Value -> Parser Resource # parseJSONList :: Value -> Parser [Resource] #
Generic Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Associated Types type Rep Resource :: Type -> Type # Methods from :: Resource -> Rep Resource x # to :: Rep Resource x -> Resource #
Read Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods readsPrec :: Int -> ReadS Resource # readList :: ReadS [Resource] # readPrec :: ReadPrec Resource # readListPrec :: ReadPrec [Resource] #
Show Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods showsPrec :: Int -> Resource -> ShowS # show :: Resource -> String # showList :: [Resource] -> ShowS #
NFData Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods rnf :: Resource -> () #
Eq Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods (==) :: Resource -> Resource -> Bool # (/=) :: Resource -> Resource -> Bool #
Hashable Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource Methods hashWithSalt :: Int -> Resource -> Int # hash :: Resource -> Int #
type Rep Resource Source #
Instance details Defined in Amazonka.APIGateway.Types.Resource type Rep Resource = D1 ('MetaData "Resource" "Amazonka.APIGateway.Types.Resource" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Resource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "parentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "pathPart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resourceMethods") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Method)))))))

newResource :: Resource Source #

Create a value of Resource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:Resource', resource_id - The resource's identifier.

$sel:parentId:Resource', resource_parentId - The parent resource's identifier.

$sel:path:Resource', resource_path - The full path for this resource.

$sel:pathPart:Resource', resource_pathPart - The last path segment for this resource.

$sel:resourceMethods:Resource', resource_resourceMethods - Gets an API resource's method of a given HTTP verb.

RestApi

data RestApi Source #

Represents a REST API.

See: newRestApi smart constructor.

Constructors

RestApi' (Maybe ApiKeySourceType) (Maybe [Text]) (Maybe POSIX) (Maybe Text) (Maybe Bool) (Maybe EndpointConfiguration) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe [Text])

Instances

Instances details

FromJSON RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods parseJSON :: Value -> Parser RestApi # parseJSONList :: Value -> Parser [RestApi] #
Generic RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Associated Types type Rep RestApi :: Type -> Type # Methods from :: RestApi -> Rep RestApi x # to :: Rep RestApi x -> RestApi #
Read RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods readsPrec :: Int -> ReadS RestApi # readList :: ReadS [RestApi] # readPrec :: ReadPrec RestApi # readListPrec :: ReadPrec [RestApi] #
Show RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods showsPrec :: Int -> RestApi -> ShowS # show :: RestApi -> String # showList :: [RestApi] -> ShowS #
NFData RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods rnf :: RestApi -> () #
Eq RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods (==) :: RestApi -> RestApi -> Bool # (/=) :: RestApi -> RestApi -> Bool #
Hashable RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi Methods hashWithSalt :: Int -> RestApi -> Int # hash :: RestApi -> Int #
type Rep RestApi Source #
Instance details Defined in Amazonka.APIGateway.Types.RestApi type Rep RestApi = D1 ('MetaData "RestApi" "Amazonka.APIGateway.Types.RestApi" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "RestApi'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiKeySource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ApiKeySourceType)) :: (S1 ('MetaSel ('Just "binaryMediaTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "disableExecuteApiEndpoint") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "endpointConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EndpointConfiguration))))) :: ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "minimumCompressionSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "warnings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

newRestApi :: RestApi Source #

Create a value of RestApi with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiKeySource:RestApi', restApi_apiKeySource - The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

$sel:binaryMediaTypes:RestApi', restApi_binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

$sel:createdDate:RestApi', restApi_createdDate - The timestamp when the API was created.

$sel:description:RestApi', restApi_description - The API's description.

$sel:disableExecuteApiEndpoint:RestApi', restApi_disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

$sel:endpointConfiguration:RestApi', restApi_endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

$sel:id:RestApi', restApi_id - The API's identifier. This identifier is unique across all of your APIs in API Gateway.

$sel:minimumCompressionSize:RestApi', restApi_minimumCompressionSize - A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

$sel:name:RestApi', restApi_name - The API's name.

$sel:policy:RestApi', restApi_policy - A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

$sel:tags:RestApi', restApi_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:version:RestApi', restApi_version - A version identifier for the API.

$sel:warnings:RestApi', restApi_warnings - The warning messages reported when failonwarnings is turned on during API import.

SdkConfigurationProperty

data SdkConfigurationProperty Source #

A configuration property of an SDK type.

See: newSdkConfigurationProperty smart constructor.

Constructors

SdkConfigurationProperty' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool)

Instances

Instances details

FromJSON SdkConfigurationProperty Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkConfigurationProperty Methods parseJSON :: Value -> Parser SdkConfigurationProperty # parseJSONList :: Value -> Parser [SdkConfigurationProperty] #
Generic SdkConfigurationProperty Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkConfigurationProperty Associated Types type Rep SdkConfigurationProperty :: Type -> Type # Methods from :: SdkConfigurationProperty -> Rep SdkConfigurationProperty x # to :: Rep SdkConfigurationProperty x -> SdkConfigurationProperty #
Read SdkConfigurationProperty Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkConfigurationProperty Methods readsPrec :: Int -> ReadS SdkConfigurationProperty # readList :: ReadS [SdkConfigurationProperty] # readPrec :: ReadPrec SdkConfigurationProperty # readListPrec :: ReadPrec [SdkConfigurationProperty] #
Show SdkConfigurationProperty Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkConfigurationProperty Methods showsPrec :: Int -> SdkConfigurationProperty -> ShowS # show :: SdkConfigurationProperty -> String # showList :: [SdkConfigurationProperty] -> ShowS #
NFData SdkConfigurationProperty Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkConfigurationProperty Methods rnf :: SdkConfigurationProperty -> () #
Eq SdkConfigurationProperty Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkConfigurationProperty Methods (==) :: SdkConfigurationProperty -> SdkConfigurationProperty -> Bool # (/=) :: SdkConfigurationProperty -> SdkConfigurationProperty -> Bool #
Hashable SdkConfigurationProperty Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkConfigurationProperty Methods hashWithSalt :: Int -> SdkConfigurationProperty -> Int # hash :: SdkConfigurationProperty -> Int #
type Rep SdkConfigurationProperty Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkConfigurationProperty type Rep SdkConfigurationProperty = D1 ('MetaData "SdkConfigurationProperty" "Amazonka.APIGateway.Types.SdkConfigurationProperty" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "SdkConfigurationProperty'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "friendlyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "required") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))))

newSdkConfigurationProperty :: SdkConfigurationProperty Source #

Create a value of SdkConfigurationProperty with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultValue:SdkConfigurationProperty', sdkConfigurationProperty_defaultValue - The default value of an SdkType configuration property.

$sel:description:SdkConfigurationProperty', sdkConfigurationProperty_description - The description of an SdkType configuration property.

$sel:friendlyName:SdkConfigurationProperty', sdkConfigurationProperty_friendlyName - The user-friendly name of an SdkType configuration property.

$sel:name:SdkConfigurationProperty', sdkConfigurationProperty_name - The name of a an SdkType configuration property.

$sel:required:SdkConfigurationProperty', sdkConfigurationProperty_required - A boolean flag of an SdkType configuration property to indicate if the associated SDK configuration property is required (true) or not (false).

SdkType

data SdkType Source #

A type of SDK that API Gateway can generate.

See: newSdkType smart constructor.

Constructors

SdkType' (Maybe [SdkConfigurationProperty]) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods parseJSON :: Value -> Parser SdkType # parseJSONList :: Value -> Parser [SdkType] #
Generic SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Associated Types type Rep SdkType :: Type -> Type # Methods from :: SdkType -> Rep SdkType x # to :: Rep SdkType x -> SdkType #
Read SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods readsPrec :: Int -> ReadS SdkType # readList :: ReadS [SdkType] # readPrec :: ReadPrec SdkType # readListPrec :: ReadPrec [SdkType] #
Show SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods showsPrec :: Int -> SdkType -> ShowS # show :: SdkType -> String # showList :: [SdkType] -> ShowS #
NFData SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods rnf :: SdkType -> () #
Eq SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods (==) :: SdkType -> SdkType -> Bool # (/=) :: SdkType -> SdkType -> Bool #
Hashable SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType Methods hashWithSalt :: Int -> SdkType -> Int # hash :: SdkType -> Int #
type Rep SdkType Source #
Instance details Defined in Amazonka.APIGateway.Types.SdkType type Rep SdkType = D1 ('MetaData "SdkType" "Amazonka.APIGateway.Types.SdkType" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "SdkType'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configurationProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SdkConfigurationProperty])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "friendlyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSdkType :: SdkType Source #

Create a value of SdkType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:configurationProperties:SdkType', sdkType_configurationProperties - A list of configuration properties of an SdkType.

SdkType, sdkType_description - The description of an SdkType.

SdkType, sdkType_friendlyName - The user-friendly name of an SdkType instance.

$sel:id:SdkType', sdkType_id - The identifier of an SdkType instance.

Stage

data Stage Source #

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

See: newStage smart constructor.

Constructors

Stage' (Maybe AccessLogSettings) (Maybe Bool) (Maybe CacheClusterSize) (Maybe CacheClusterStatus) (Maybe CanarySettings) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe (HashMap Text MethodSetting)) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text)

Instances

Instances details

FromJSON Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods parseJSON :: Value -> Parser Stage # parseJSONList :: Value -> Parser [Stage] #
Generic Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Associated Types type Rep Stage :: Type -> Type # Methods from :: Stage -> Rep Stage x # to :: Rep Stage x -> Stage #
Read Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods readsPrec :: Int -> ReadS Stage # readList :: ReadS [Stage] # readPrec :: ReadPrec Stage # readListPrec :: ReadPrec [Stage] #
Show Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods showsPrec :: Int -> Stage -> ShowS # show :: Stage -> String # showList :: [Stage] -> ShowS #
NFData Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods rnf :: Stage -> () #
Eq Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods (==) :: Stage -> Stage -> Bool # (/=) :: Stage -> Stage -> Bool #
Hashable Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage Methods hashWithSalt :: Int -> Stage -> Int # hash :: Stage -> Int #
type Rep Stage Source #
Instance details Defined in Amazonka.APIGateway.Types.Stage type Rep Stage = D1 ('MetaData "Stage" "Amazonka.APIGateway.Types.Stage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Stage'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "accessLogSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccessLogSettings)) :: S1 ('MetaSel ('Just "cacheClusterEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "cacheClusterSize") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterSize)) :: S1 ('MetaSel ('Just "cacheClusterStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CacheClusterStatus)))) :: ((S1 ('MetaSel ('Just "canarySettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CanarySettings)) :: S1 ('MetaSel ('Just "clientCertificateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "deploymentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "documentationVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastUpdatedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "methodSettings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text MethodSetting))))) :: ((S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "tracingEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "webAclArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))))

newStage :: Stage Source #

Create a value of Stage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:accessLogSettings:Stage', stage_accessLogSettings - Settings for logging access in this stage.

$sel:cacheClusterEnabled:Stage', stage_cacheClusterEnabled - Specifies whether a cache cluster is enabled for the stage.

$sel:cacheClusterSize:Stage', stage_cacheClusterSize - The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

$sel:cacheClusterStatus:Stage', stage_cacheClusterStatus - The status of the cache cluster for the stage, if enabled.

$sel:canarySettings:Stage', stage_canarySettings - Settings for the canary deployment in this stage.

$sel:clientCertificateId:Stage', stage_clientCertificateId - The identifier of a client certificate for an API stage.

$sel:createdDate:Stage', stage_createdDate - The timestamp when the stage was created.

Stage, stage_deploymentId - The identifier of the Deployment that the stage points to.

$sel:description:Stage', stage_description - The stage's description.

$sel:documentationVersion:Stage', stage_documentationVersion - The version of the associated API documentation.

$sel:lastUpdatedDate:Stage', stage_lastUpdatedDate - The timestamp when the stage last updated.

$sel:methodSettings:Stage', stage_methodSettings - A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.

$sel:stageName:Stage', stage_stageName - The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

$sel:tags:Stage', stage_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:tracingEnabled:Stage', stage_tracingEnabled - Specifies whether active tracing with X-ray is enabled for the Stage.

$sel:variables:Stage', stage_variables - A map that defines the stage variables for a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

$sel:webAclArn:Stage', stage_webAclArn - The ARN of the WebAcl associated with the Stage.

StageKey

data StageKey Source #

A reference to a unique stage identified in the format {restApiId}/{stage}.

See: newStageKey smart constructor.

Constructors

StageKey' (Maybe Text) (Maybe Text)

Instances

Instances details

ToJSON StageKey Source #
Instance details Defined in Amazonka.APIGateway.Types.StageKey Methods toJSON :: StageKey -> Value # toEncoding :: StageKey -> Encoding # toJSONList :: [StageKey] -> Value # toEncodingList :: [StageKey] -> Encoding #
Generic StageKey Source #
Instance details Defined in Amazonka.APIGateway.Types.StageKey Associated Types type Rep StageKey :: Type -> Type # Methods from :: StageKey -> Rep StageKey x # to :: Rep StageKey x -> StageKey #
Read StageKey Source #
Instance details Defined in Amazonka.APIGateway.Types.StageKey Methods readsPrec :: Int -> ReadS StageKey # readList :: ReadS [StageKey] # readPrec :: ReadPrec StageKey # readListPrec :: ReadPrec [StageKey] #
Show StageKey Source #
Instance details Defined in Amazonka.APIGateway.Types.StageKey Methods showsPrec :: Int -> StageKey -> ShowS # show :: StageKey -> String # showList :: [StageKey] -> ShowS #
NFData StageKey Source #
Instance details Defined in Amazonka.APIGateway.Types.StageKey Methods rnf :: StageKey -> () #
Eq StageKey Source #
Instance details Defined in Amazonka.APIGateway.Types.StageKey Methods (==) :: StageKey -> StageKey -> Bool # (/=) :: StageKey -> StageKey -> Bool #
Hashable StageKey Source #
Instance details Defined in Amazonka.APIGateway.Types.StageKey Methods hashWithSalt :: Int -> StageKey -> Int # hash :: StageKey -> Int #
type Rep StageKey Source #
Instance details Defined in Amazonka.APIGateway.Types.StageKey type Rep StageKey = D1 ('MetaData "StageKey" "Amazonka.APIGateway.Types.StageKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "StageKey'" 'PrefixI 'True) (S1 ('MetaSel ('Just "restApiId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stageName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

newStageKey :: StageKey Source #

Create a value of StageKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:restApiId:StageKey', stageKey_restApiId - The string identifier of the associated RestApi.

$sel:stageName:StageKey', stageKey_stageName - The stage name associated with the stage key.

ThrottleSettings

data ThrottleSettings Source #

The API request rate limits.

See: newThrottleSettings smart constructor.

Constructors

ThrottleSettings' (Maybe Int) (Maybe Double)

Instances

Instances details

FromJSON ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods parseJSON :: Value -> Parser ThrottleSettings # parseJSONList :: Value -> Parser [ThrottleSettings] #
ToJSON ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods toJSON :: ThrottleSettings -> Value # toEncoding :: ThrottleSettings -> Encoding # toJSONList :: [ThrottleSettings] -> Value # toEncodingList :: [ThrottleSettings] -> Encoding #
Generic ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Associated Types type Rep ThrottleSettings :: Type -> Type # Methods from :: ThrottleSettings -> Rep ThrottleSettings x # to :: Rep ThrottleSettings x -> ThrottleSettings #
Read ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods readsPrec :: Int -> ReadS ThrottleSettings # readList :: ReadS [ThrottleSettings] # readPrec :: ReadPrec ThrottleSettings # readListPrec :: ReadPrec [ThrottleSettings] #
Show ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods showsPrec :: Int -> ThrottleSettings -> ShowS # show :: ThrottleSettings -> String # showList :: [ThrottleSettings] -> ShowS #
NFData ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods rnf :: ThrottleSettings -> () #
Eq ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods (==) :: ThrottleSettings -> ThrottleSettings -> Bool # (/=) :: ThrottleSettings -> ThrottleSettings -> Bool #
Hashable ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings Methods hashWithSalt :: Int -> ThrottleSettings -> Int # hash :: ThrottleSettings -> Int #
type Rep ThrottleSettings Source #
Instance details Defined in Amazonka.APIGateway.Types.ThrottleSettings type Rep ThrottleSettings = D1 ('MetaData "ThrottleSettings" "Amazonka.APIGateway.Types.ThrottleSettings" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ThrottleSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "burstLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "rateLimit") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Double))))

newThrottleSettings :: ThrottleSettings Source #

Create a value of ThrottleSettings with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:burstLimit:ThrottleSettings', throttleSettings_burstLimit - The API target request burst rate limit. This allows more requests through for a period of time than the target rate limit.

$sel:rateLimit:ThrottleSettings', throttleSettings_rateLimit - The API target request rate limit.

TlsConfig

data TlsConfig Source #

Specifies the TLS configuration for an integration.

See: newTlsConfig smart constructor.

Constructors

TlsConfig' (Maybe Bool)

Instances

Instances details

FromJSON TlsConfig Source #
Instance details Defined in Amazonka.APIGateway.Types.TlsConfig Methods parseJSON :: Value -> Parser TlsConfig # parseJSONList :: Value -> Parser [TlsConfig] #
ToJSON TlsConfig Source #
Instance details Defined in Amazonka.APIGateway.Types.TlsConfig Methods toJSON :: TlsConfig -> Value # toEncoding :: TlsConfig -> Encoding # toJSONList :: [TlsConfig] -> Value # toEncodingList :: [TlsConfig] -> Encoding #
Generic TlsConfig Source #
Instance details Defined in Amazonka.APIGateway.Types.TlsConfig Associated Types type Rep TlsConfig :: Type -> Type # Methods from :: TlsConfig -> Rep TlsConfig x # to :: Rep TlsConfig x -> TlsConfig #
Read TlsConfig Source #
Instance details Defined in Amazonka.APIGateway.Types.TlsConfig Methods readsPrec :: Int -> ReadS TlsConfig # readList :: ReadS [TlsConfig] # readPrec :: ReadPrec TlsConfig # readListPrec :: ReadPrec [TlsConfig] #
Show TlsConfig Source #
Instance details Defined in Amazonka.APIGateway.Types.TlsConfig Methods showsPrec :: Int -> TlsConfig -> ShowS # show :: TlsConfig -> String # showList :: [TlsConfig] -> ShowS #
NFData TlsConfig Source #
Instance details Defined in Amazonka.APIGateway.Types.TlsConfig Methods rnf :: TlsConfig -> () #
Eq TlsConfig Source #
Instance details Defined in Amazonka.APIGateway.Types.TlsConfig Methods (==) :: TlsConfig -> TlsConfig -> Bool # (/=) :: TlsConfig -> TlsConfig -> Bool #
Hashable TlsConfig Source #
Instance details Defined in Amazonka.APIGateway.Types.TlsConfig Methods hashWithSalt :: Int -> TlsConfig -> Int # hash :: TlsConfig -> Int #
type Rep TlsConfig Source #
Instance details Defined in Amazonka.APIGateway.Types.TlsConfig type Rep TlsConfig = D1 ('MetaData "TlsConfig" "Amazonka.APIGateway.Types.TlsConfig" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "TlsConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "insecureSkipVerification") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newTlsConfig :: TlsConfig Source #

Create a value of TlsConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:insecureSkipVerification:TlsConfig', tlsConfig_insecureSkipVerification - Specifies whether or not API Gateway skips verification that the certificate for an integration endpoint is issued by a supported certificate authority. This isn’t recommended, but it enables you to use certificates that are signed by private certificate authorities, or certificates that are self-signed. If enabled, API Gateway still performs basic certificate validation, which includes checking the certificate's expiration date, hostname, and presence of a root certificate authority. Supported only for HTTP and HTTP_PROXY integrations.

Enabling insecureSkipVerification isn't recommended, especially for integrations with public HTTPS endpoints. If you enable insecureSkipVerification, you increase the risk of man-in-the-middle attacks.

Usage

data Usage Source #

Represents the usage data of a usage plan.

See: newUsage smart constructor.

Constructors

Usage' (Maybe Text) (Maybe (HashMap Text [[Integer]])) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods parseJSON :: Value -> Parser Usage # parseJSONList :: Value -> Parser [Usage] #
Generic Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Associated Types type Rep Usage :: Type -> Type # Methods from :: Usage -> Rep Usage x # to :: Rep Usage x -> Usage #
Read Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods readsPrec :: Int -> ReadS Usage # readList :: ReadS [Usage] # readPrec :: ReadPrec Usage # readListPrec :: ReadPrec [Usage] #
Show Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods showsPrec :: Int -> Usage -> ShowS # show :: Usage -> String # showList :: [Usage] -> ShowS #
NFData Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods rnf :: Usage -> () #
Eq Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods (==) :: Usage -> Usage -> Bool # (/=) :: Usage -> Usage -> Bool #
Hashable Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage Methods hashWithSalt :: Int -> Usage -> Int # hash :: Usage -> Int #
type Rep Usage Source #
Instance details Defined in Amazonka.APIGateway.Types.Usage type Rep Usage = D1 ('MetaData "Usage" "Amazonka.APIGateway.Types.Usage" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "Usage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "endDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "items") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text [[Integer]])))) :: (S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "usagePlanId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newUsage :: Usage Source #

Create a value of Usage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:endDate:Usage', usage_endDate - The ending date of the usage data.

$sel:items:Usage', usage_items - The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

$sel:position:Usage', usage_position - Undocumented member.

$sel:startDate:Usage', usage_startDate - The starting date of the usage data.

$sel:usagePlanId:Usage', usage_usagePlanId - The plan Id associated with this usage data.

UsagePlan

data UsagePlan Source #

Represents a usage plan used to specify who can assess associated API stages. Optionally, target request rate and quota limits can be set. In some cases clients can exceed the targets that you set. Don’t rely on usage plans to control costs. Consider using Amazon Web Services Budgets to monitor costs and WAF to manage API requests.

See: newUsagePlan smart constructor.

Constructors

UsagePlan' (Maybe [ApiStage]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe QuotaSettings) (Maybe (HashMap Text Text)) (Maybe ThrottleSettings)

Instances

Instances details

FromJSON UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods parseJSON :: Value -> Parser UsagePlan # parseJSONList :: Value -> Parser [UsagePlan] #
Generic UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Associated Types type Rep UsagePlan :: Type -> Type # Methods from :: UsagePlan -> Rep UsagePlan x # to :: Rep UsagePlan x -> UsagePlan #
Read UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods readsPrec :: Int -> ReadS UsagePlan # readList :: ReadS [UsagePlan] # readPrec :: ReadPrec UsagePlan # readListPrec :: ReadPrec [UsagePlan] #
Show UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods showsPrec :: Int -> UsagePlan -> ShowS # show :: UsagePlan -> String # showList :: [UsagePlan] -> ShowS #
NFData UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods rnf :: UsagePlan -> () #
Eq UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods (==) :: UsagePlan -> UsagePlan -> Bool # (/=) :: UsagePlan -> UsagePlan -> Bool #
Hashable UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan Methods hashWithSalt :: Int -> UsagePlan -> Int # hash :: UsagePlan -> Int #
type Rep UsagePlan Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlan type Rep UsagePlan = D1 ('MetaData "UsagePlan" "Amazonka.APIGateway.Types.UsagePlan" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UsagePlan'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "apiStages") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ApiStage])) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "productCode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "quota") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuotaSettings))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "throttle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThrottleSettings))))))

newUsagePlan :: UsagePlan Source #

Create a value of UsagePlan with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:apiStages:UsagePlan', usagePlan_apiStages - The associated API stages of a usage plan.

$sel:description:UsagePlan', usagePlan_description - The description of a usage plan.

$sel:id:UsagePlan', usagePlan_id - The identifier of a UsagePlan resource.

$sel:name:UsagePlan', usagePlan_name - The name of a usage plan.

$sel:productCode:UsagePlan', usagePlan_productCode - The AWS Markeplace product identifier to associate with the usage plan as a SaaS product on AWS Marketplace.

$sel:quota:UsagePlan', usagePlan_quota - The target maximum number of permitted requests per a given unit time interval.

$sel:tags:UsagePlan', usagePlan_tags - The collection of tags. Each tag element is associated with a given resource.

UsagePlan, usagePlan_throttle - A map containing method level throttling information for API stage in a usage plan.

UsagePlanKey

data UsagePlanKey Source #

Represents a usage plan key to identify a plan customer.

See: newUsagePlanKey smart constructor.

Constructors

UsagePlanKey' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)

Instances

Instances details

FromJSON UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods parseJSON :: Value -> Parser UsagePlanKey # parseJSONList :: Value -> Parser [UsagePlanKey] #
Generic UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Associated Types type Rep UsagePlanKey :: Type -> Type # Methods from :: UsagePlanKey -> Rep UsagePlanKey x # to :: Rep UsagePlanKey x -> UsagePlanKey #
Read UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods readsPrec :: Int -> ReadS UsagePlanKey # readList :: ReadS [UsagePlanKey] # readPrec :: ReadPrec UsagePlanKey # readListPrec :: ReadPrec [UsagePlanKey] #
Show UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods showsPrec :: Int -> UsagePlanKey -> ShowS # show :: UsagePlanKey -> String # showList :: [UsagePlanKey] -> ShowS #
NFData UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods rnf :: UsagePlanKey -> () #
Eq UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods (==) :: UsagePlanKey -> UsagePlanKey -> Bool # (/=) :: UsagePlanKey -> UsagePlanKey -> Bool #
Hashable UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey Methods hashWithSalt :: Int -> UsagePlanKey -> Int # hash :: UsagePlanKey -> Int #
type Rep UsagePlanKey Source #
Instance details Defined in Amazonka.APIGateway.Types.UsagePlanKey type Rep UsagePlanKey = D1 ('MetaData "UsagePlanKey" "Amazonka.APIGateway.Types.UsagePlanKey" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "UsagePlanKey'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newUsagePlanKey :: UsagePlanKey Source #

Create a value of UsagePlanKey with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:id:UsagePlanKey', usagePlanKey_id - The Id of a usage plan key.

$sel:name:UsagePlanKey', usagePlanKey_name - The name of a usage plan key.

$sel:type':UsagePlanKey', usagePlanKey_type - The type of a usage plan key. Currently, the valid key type is API_KEY.

$sel:value:UsagePlanKey', usagePlanKey_value - The value of a usage plan key.

VpcLink

data VpcLink Source #

An API Gateway VPC link for a RestApi to access resources in an Amazon Virtual Private Cloud (VPC).

See: newVpcLink smart constructor.

Constructors

VpcLink' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VpcLinkStatus) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe [Text])

Instances

Instances details

FromJSON VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods parseJSON :: Value -> Parser VpcLink # parseJSONList :: Value -> Parser [VpcLink] #
Generic VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Associated Types type Rep VpcLink :: Type -> Type # Methods from :: VpcLink -> Rep VpcLink x # to :: Rep VpcLink x -> VpcLink #
Read VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods readsPrec :: Int -> ReadS VpcLink # readList :: ReadS [VpcLink] # readPrec :: ReadPrec VpcLink # readListPrec :: ReadPrec [VpcLink] #
Show VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods showsPrec :: Int -> VpcLink -> ShowS # show :: VpcLink -> String # showList :: [VpcLink] -> ShowS #
NFData VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods rnf :: VpcLink -> () #
Eq VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods (==) :: VpcLink -> VpcLink -> Bool # (/=) :: VpcLink -> VpcLink -> Bool #
Hashable VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink Methods hashWithSalt :: Int -> VpcLink -> Int # hash :: VpcLink -> Int #
type Rep VpcLink Source #
Instance details Defined in Amazonka.APIGateway.Types.VpcLink type Rep VpcLink = D1 ('MetaData "VpcLink" "Amazonka.APIGateway.Types.VpcLink" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "VpcLink'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VpcLinkStatus)) :: S1 ('MetaSel ('Just "statusMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "targetArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newVpcLink :: VpcLink Source #

Create a value of VpcLink with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:VpcLink', vpcLink_description - The description of the VPC link.

$sel:id:VpcLink', vpcLink_id - The identifier of the VpcLink. It is used in an Integration to reference this VpcLink.

$sel:name:VpcLink', vpcLink_name - The name used to label and identify the VPC link.

$sel:status:VpcLink', vpcLink_status - The status of the VPC link. The valid values are AVAILABLE, PENDING, DELETING, or FAILED. Deploying an API will wait if the status is PENDING and will fail if the status is DELETING.

$sel:statusMessage:VpcLink', vpcLink_statusMessage - A description about the VPC link status.

$sel:tags:VpcLink', vpcLink_tags - The collection of tags. Each tag element is associated with a given resource.

$sel:targetArns:VpcLink', vpcLink_targetArns - The ARN of the network load balancer of the VPC targeted by the VPC link. The network load balancer must be owned by the same AWS account of the API owner.