amazonka-apigateway-1.5.0: Amazon API Gateway SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.APIGateway

Contents

Description

Amazon API Gateway

Amazon API Gateway helps developers deliver robust, secure, and scalable mobile and web application back ends. Amazon 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

Service Configuration

apiGateway :: 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.

ConflictException

_ConflictException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

NotFoundException

_NotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

TooManyRequestsException

_TooManyRequestsException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

ServiceUnavailableException

_ServiceUnavailableException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

UnauthorizedException

_UnauthorizedException :: AsError a => Getting (First ServiceError) a ServiceError Source #

The request is denied because the caller has insufficient permissions.

BadRequestException

_BadRequestException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #

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

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.

GetResource

GetDeployments (Paginated)

GetDeployment

DeleteGatewayResponse

UpdateGatewayResponse

CreateUsagePlan

GetDomainNames (Paginated)

GetClientCertificate

PutGatewayResponse

GetSDKType

GetMethodResponse

GetModels (Paginated)

GetBasePathMapping

GetRequestValidators

PutMethodResponse

ImportRestAPI

DeleteMethodResponse

UpdateMethodResponse

DeleteStage

UpdateStage

GetRestAPIs (Paginated)

GetDocumentationVersions

CreateDeployment

CreateBasePathMapping

GetIntegration

GetDocumentationParts

UpdateAccount

GetUsagePlan

DeleteDeployment

UpdateDeployment

GetDocumentationPart

DeleteResource

UpdateResource

CreateRequestValidator

ImportDocumentationParts

GetUsage (Paginated)

CreateModel

GetIntegrationResponse

CreateDomainName

FlushStageAuthorizersCache

GetGatewayResponses

DeleteModel

UpdateModel

GetDocumentationVersion

DeleteAPIKey

UpdateAPIKey

GetRestAPI

GetStages

PutRestAPI

GetMethod

GetModel

UpdateRestAPI

DeleteRestAPI

ImportAPIKeys

CreateDocumentationPart

TestInvokeMethod

GetRequestValidator

GetDomainName

DeleteDocumentationPart

UpdateDocumentationPart

GetAuthorizers

CreateDocumentationVersion

PutIntegrationResponse

GetUsagePlanKeys (Paginated)

FlushStageCache

CreateRestAPI

DeleteIntegrationResponse

UpdateIntegrationResponse

UpdateUsage

DeleteIntegration

UpdateIntegration

TestInvokeAuthorizer

GenerateClientCertificate

GetResources (Paginated)

GetUsagePlanKey

GetAccount

PutIntegration

GetAuthorizer

DeleteUsagePlan

UpdateUsagePlan

GetStage

GetExport

GetSDK

GetAPIKeys (Paginated)

DeleteBasePathMapping

UpdateBasePathMapping

DeleteClientCertificate

UpdateClientCertificate

GetGatewayResponse

CreateUsagePlanKey

CreateAuthorizer

UpdateAuthorizer

DeleteAuthorizer

CreateStage

DeleteUsagePlanKey

CreateAPIKey

GetUsagePlans (Paginated)

PutMethod

UpdateDomainName

DeleteDomainName

CreateResource

DeleteMethod

UpdateMethod

UpdateRequestValidator

DeleteRequestValidator

GetSDKTypes

GetClientCertificates (Paginated)

GetModelTemplate

UpdateDocumentationVersion

DeleteDocumentationVersion

GetBasePathMappings (Paginated)

GetAPIKey

Types

APIKeysFormat

data APIKeysFormat Source #

Constructors

CSV 

Instances

Bounded APIKeysFormat Source # 
Enum APIKeysFormat Source # 
Eq APIKeysFormat Source # 
Data APIKeysFormat Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APIKeysFormat -> c APIKeysFormat #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APIKeysFormat #

toConstr :: APIKeysFormat -> Constr #

dataTypeOf :: APIKeysFormat -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APIKeysFormat) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APIKeysFormat) #

gmapT :: (forall b. Data b => b -> b) -> APIKeysFormat -> APIKeysFormat #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APIKeysFormat -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APIKeysFormat -> r #

gmapQ :: (forall d. Data d => d -> u) -> APIKeysFormat -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APIKeysFormat -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APIKeysFormat -> m APIKeysFormat #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APIKeysFormat -> m APIKeysFormat #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APIKeysFormat -> m APIKeysFormat #

Ord APIKeysFormat Source # 
Read APIKeysFormat Source # 
Show APIKeysFormat Source # 
Generic APIKeysFormat Source # 

Associated Types

type Rep APIKeysFormat :: * -> * #

Hashable APIKeysFormat Source # 
ToJSON APIKeysFormat Source # 
NFData APIKeysFormat Source # 

Methods

rnf :: APIKeysFormat -> () #

ToQuery APIKeysFormat Source # 
ToHeader APIKeysFormat Source # 
ToByteString APIKeysFormat Source # 
FromText APIKeysFormat Source # 
ToText APIKeysFormat Source # 

Methods

toText :: APIKeysFormat -> Text #

type Rep APIKeysFormat Source # 
type Rep APIKeysFormat = D1 (MetaData "APIKeysFormat" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "CSV" PrefixI False) U1)

AuthorizerType

data AuthorizerType Source #

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

Instances

Bounded AuthorizerType Source # 
Enum AuthorizerType Source # 
Eq AuthorizerType Source # 
Data AuthorizerType Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> AuthorizerType -> c AuthorizerType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c AuthorizerType #

toConstr :: AuthorizerType -> Constr #

dataTypeOf :: AuthorizerType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c AuthorizerType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c AuthorizerType) #

gmapT :: (forall b. Data b => b -> b) -> AuthorizerType -> AuthorizerType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> AuthorizerType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> AuthorizerType -> r #

gmapQ :: (forall d. Data d => d -> u) -> AuthorizerType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> AuthorizerType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> AuthorizerType -> m AuthorizerType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> AuthorizerType -> m AuthorizerType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> AuthorizerType -> m AuthorizerType #

Ord AuthorizerType Source # 
Read AuthorizerType Source # 
Show AuthorizerType Source # 
Generic AuthorizerType Source # 

Associated Types

type Rep AuthorizerType :: * -> * #

Hashable AuthorizerType Source # 
FromJSON AuthorizerType Source # 
ToJSON AuthorizerType Source # 
NFData AuthorizerType Source # 

Methods

rnf :: AuthorizerType -> () #

ToQuery AuthorizerType Source # 
ToHeader AuthorizerType Source # 
ToByteString AuthorizerType Source # 
FromText AuthorizerType Source # 
ToText AuthorizerType Source # 
type Rep AuthorizerType Source # 
type Rep AuthorizerType = D1 (MetaData "AuthorizerType" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) (C1 (MetaCons "AuthorizerCognitoUserPools" PrefixI False) U1) ((:+:) (C1 (MetaCons "AuthorizerRequest" PrefixI False) U1) (C1 (MetaCons "AuthorizerToken" PrefixI False) U1)))

CacheClusterSize

data CacheClusterSize Source #

Returns the size of the CacheCluster .

Constructors

D0_5 
D118 
D13_5 
D1_6 
D237 
D28_4 
D58_2 
D6_1 

Instances

Bounded CacheClusterSize Source # 
Enum CacheClusterSize Source # 
Eq CacheClusterSize Source # 
Data CacheClusterSize Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CacheClusterSize -> c CacheClusterSize #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CacheClusterSize #

toConstr :: CacheClusterSize -> Constr #

dataTypeOf :: CacheClusterSize -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CacheClusterSize) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CacheClusterSize) #

gmapT :: (forall b. Data b => b -> b) -> CacheClusterSize -> CacheClusterSize #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CacheClusterSize -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CacheClusterSize -> r #

gmapQ :: (forall d. Data d => d -> u) -> CacheClusterSize -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CacheClusterSize -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CacheClusterSize -> m CacheClusterSize #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CacheClusterSize -> m CacheClusterSize #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CacheClusterSize -> m CacheClusterSize #

Ord CacheClusterSize Source # 
Read CacheClusterSize Source # 
Show CacheClusterSize Source # 
Generic CacheClusterSize Source # 
Hashable CacheClusterSize Source # 
FromJSON CacheClusterSize Source # 
ToJSON CacheClusterSize Source # 
NFData CacheClusterSize Source # 

Methods

rnf :: CacheClusterSize -> () #

ToQuery CacheClusterSize Source # 
ToHeader CacheClusterSize Source # 
ToByteString CacheClusterSize Source # 
FromText CacheClusterSize Source # 
ToText CacheClusterSize Source # 
type Rep CacheClusterSize Source # 
type Rep CacheClusterSize = D1 (MetaData "CacheClusterSize" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "D0_5" PrefixI False) U1) (C1 (MetaCons "D118" PrefixI False) U1)) ((:+:) (C1 (MetaCons "D13_5" PrefixI False) U1) (C1 (MetaCons "D1_6" PrefixI False) U1))) ((:+:) ((:+:) (C1 (MetaCons "D237" PrefixI False) U1) (C1 (MetaCons "D28_4" PrefixI False) U1)) ((:+:) (C1 (MetaCons "D58_2" PrefixI False) U1) (C1 (MetaCons "D6_1" PrefixI False) U1))))

CacheClusterStatus

data CacheClusterStatus Source #

Returns the status of the CacheCluster .

Instances

Bounded CacheClusterStatus Source # 
Enum CacheClusterStatus Source # 
Eq CacheClusterStatus Source # 
Data CacheClusterStatus Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CacheClusterStatus -> c CacheClusterStatus #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CacheClusterStatus #

toConstr :: CacheClusterStatus -> Constr #

dataTypeOf :: CacheClusterStatus -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CacheClusterStatus) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CacheClusterStatus) #

gmapT :: (forall b. Data b => b -> b) -> CacheClusterStatus -> CacheClusterStatus #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CacheClusterStatus -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CacheClusterStatus -> r #

gmapQ :: (forall d. Data d => d -> u) -> CacheClusterStatus -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> CacheClusterStatus -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CacheClusterStatus -> m CacheClusterStatus #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CacheClusterStatus -> m CacheClusterStatus #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CacheClusterStatus -> m CacheClusterStatus #

Ord CacheClusterStatus Source # 
Read CacheClusterStatus Source # 
Show CacheClusterStatus Source # 
Generic CacheClusterStatus Source # 
Hashable CacheClusterStatus Source # 
FromJSON CacheClusterStatus Source # 
NFData CacheClusterStatus Source # 

Methods

rnf :: CacheClusterStatus -> () #

ToQuery CacheClusterStatus Source # 
ToHeader CacheClusterStatus Source # 
ToByteString CacheClusterStatus Source # 
FromText CacheClusterStatus Source # 
ToText CacheClusterStatus Source # 
type Rep CacheClusterStatus Source # 
type Rep CacheClusterStatus = D1 (MetaData "CacheClusterStatus" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) ((:+:) (C1 (MetaCons "Available" PrefixI False) U1) (C1 (MetaCons "CreateInProgress" PrefixI False) U1)) ((:+:) (C1 (MetaCons "DeleteInProgress" PrefixI False) U1) ((:+:) (C1 (MetaCons "FlushInProgress" PrefixI False) U1) (C1 (MetaCons "NotAvailable" PrefixI False) U1))))

ContentHandlingStrategy

data ContentHandlingStrategy Source #

Instances

Bounded ContentHandlingStrategy Source # 
Enum ContentHandlingStrategy Source # 
Eq ContentHandlingStrategy Source # 
Data ContentHandlingStrategy Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ContentHandlingStrategy -> c ContentHandlingStrategy #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ContentHandlingStrategy #

toConstr :: ContentHandlingStrategy -> Constr #

dataTypeOf :: ContentHandlingStrategy -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ContentHandlingStrategy) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ContentHandlingStrategy) #

gmapT :: (forall b. Data b => b -> b) -> ContentHandlingStrategy -> ContentHandlingStrategy #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ContentHandlingStrategy -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ContentHandlingStrategy -> r #

gmapQ :: (forall d. Data d => d -> u) -> ContentHandlingStrategy -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ContentHandlingStrategy -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ContentHandlingStrategy -> m ContentHandlingStrategy #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ContentHandlingStrategy -> m ContentHandlingStrategy #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ContentHandlingStrategy -> m ContentHandlingStrategy #

Ord ContentHandlingStrategy Source # 
Read ContentHandlingStrategy Source # 
Show ContentHandlingStrategy Source # 
Generic ContentHandlingStrategy Source # 
Hashable ContentHandlingStrategy Source # 
FromJSON ContentHandlingStrategy Source # 
ToJSON ContentHandlingStrategy Source # 
NFData ContentHandlingStrategy Source # 

Methods

rnf :: ContentHandlingStrategy -> () #

ToQuery ContentHandlingStrategy Source # 
ToHeader ContentHandlingStrategy Source # 
ToByteString ContentHandlingStrategy Source # 
FromText ContentHandlingStrategy Source # 
ToText ContentHandlingStrategy Source # 
type Rep ContentHandlingStrategy Source # 
type Rep ContentHandlingStrategy = D1 (MetaData "ContentHandlingStrategy" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) (C1 (MetaCons "ConvertToBinary" PrefixI False) U1) (C1 (MetaCons "ConvertToText" PrefixI False) U1))

DocumentationPartType

data DocumentationPartType Source #

Instances

Bounded DocumentationPartType Source # 
Enum DocumentationPartType Source # 
Eq DocumentationPartType Source # 
Data DocumentationPartType Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DocumentationPartType -> c DocumentationPartType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DocumentationPartType #

toConstr :: DocumentationPartType -> Constr #

dataTypeOf :: DocumentationPartType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DocumentationPartType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocumentationPartType) #

gmapT :: (forall b. Data b => b -> b) -> DocumentationPartType -> DocumentationPartType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationPartType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationPartType -> r #

gmapQ :: (forall d. Data d => d -> u) -> DocumentationPartType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DocumentationPartType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DocumentationPartType -> m DocumentationPartType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationPartType -> m DocumentationPartType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationPartType -> m DocumentationPartType #

Ord DocumentationPartType Source # 
Read DocumentationPartType Source # 
Show DocumentationPartType Source # 
Generic DocumentationPartType Source # 
Hashable DocumentationPartType Source # 
FromJSON DocumentationPartType Source # 
ToJSON DocumentationPartType Source # 
NFData DocumentationPartType Source # 

Methods

rnf :: DocumentationPartType -> () #

ToQuery DocumentationPartType Source # 
ToHeader DocumentationPartType Source # 
ToByteString DocumentationPartType Source # 
FromText DocumentationPartType Source # 
ToText DocumentationPartType Source # 
type Rep DocumentationPartType Source # 
type Rep DocumentationPartType = D1 (MetaData "DocumentationPartType" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "API" PrefixI False) U1) ((:+:) (C1 (MetaCons "Authorizer" PrefixI False) U1) (C1 (MetaCons "Method" PrefixI False) U1))) ((:+:) (C1 (MetaCons "Model" PrefixI False) U1) ((:+:) (C1 (MetaCons "PathParameter" PrefixI False) U1) (C1 (MetaCons "QueryParameter" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "RequestBody" PrefixI False) U1) ((:+:) (C1 (MetaCons "RequestHeader" PrefixI False) U1) (C1 (MetaCons "Resource" PrefixI False) U1))) ((:+:) (C1 (MetaCons "Response" PrefixI False) U1) ((:+:) (C1 (MetaCons "ResponseBody" PrefixI False) U1) (C1 (MetaCons "ResponseHeader" PrefixI False) U1)))))

EndpointType

data EndpointType Source #

The endpoint type. The valid value is EDGE for edge-optimized API setup, most suitable for mobile applications, REGIONAL for regional API endpoint setup, most suitable for calling from AWS Region

Constructors

Edge 
Regional 

Instances

Bounded EndpointType Source # 
Enum EndpointType Source # 
Eq EndpointType Source # 
Data EndpointType Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointType -> c EndpointType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointType #

toConstr :: EndpointType -> Constr #

dataTypeOf :: EndpointType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointType) #

gmapT :: (forall b. Data b => b -> b) -> EndpointType -> EndpointType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointType -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointType -> m EndpointType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointType -> m EndpointType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointType -> m EndpointType #

Ord EndpointType Source # 
Read EndpointType Source # 
Show EndpointType Source # 
Generic EndpointType Source # 

Associated Types

type Rep EndpointType :: * -> * #

Hashable EndpointType Source # 
FromJSON EndpointType Source # 
ToJSON EndpointType Source # 
NFData EndpointType Source # 

Methods

rnf :: EndpointType -> () #

ToQuery EndpointType Source # 
ToHeader EndpointType Source # 
ToByteString EndpointType Source # 
FromText EndpointType Source # 
ToText EndpointType Source # 

Methods

toText :: EndpointType -> Text #

type Rep EndpointType Source # 
type Rep EndpointType = D1 (MetaData "EndpointType" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) (C1 (MetaCons "Edge" PrefixI False) U1) (C1 (MetaCons "Regional" PrefixI False) U1))

GatewayResponseType

data GatewayResponseType Source #

Instances

Bounded GatewayResponseType Source # 
Enum GatewayResponseType Source # 
Eq GatewayResponseType Source # 
Data GatewayResponseType Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GatewayResponseType -> c GatewayResponseType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GatewayResponseType #

toConstr :: GatewayResponseType -> Constr #

dataTypeOf :: GatewayResponseType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GatewayResponseType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GatewayResponseType) #

gmapT :: (forall b. Data b => b -> b) -> GatewayResponseType -> GatewayResponseType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GatewayResponseType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GatewayResponseType -> r #

gmapQ :: (forall d. Data d => d -> u) -> GatewayResponseType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GatewayResponseType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GatewayResponseType -> m GatewayResponseType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GatewayResponseType -> m GatewayResponseType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GatewayResponseType -> m GatewayResponseType #

Ord GatewayResponseType Source # 
Read GatewayResponseType Source # 
Show GatewayResponseType Source # 
Generic GatewayResponseType Source # 
Hashable GatewayResponseType Source # 
FromJSON GatewayResponseType Source # 
ToJSON GatewayResponseType Source # 
NFData GatewayResponseType Source # 

Methods

rnf :: GatewayResponseType -> () #

ToQuery GatewayResponseType Source # 
ToHeader GatewayResponseType Source # 
ToByteString GatewayResponseType Source # 
FromText GatewayResponseType Source # 
ToText GatewayResponseType Source # 
type Rep GatewayResponseType Source # 
type Rep GatewayResponseType = D1 (MetaData "GatewayResponseType" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "APIConfigurationError" PrefixI False) U1) (C1 (MetaCons "AccessDenied" PrefixI False) U1)) ((:+:) (C1 (MetaCons "AuthorizerConfigurationError" PrefixI False) U1) ((:+:) (C1 (MetaCons "AuthorizerFailure" PrefixI False) U1) (C1 (MetaCons "BadRequestBody" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "BadRequestParameters" PrefixI False) U1) (C1 (MetaCons "Default4XX" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Default5XX" PrefixI False) U1) ((:+:) (C1 (MetaCons "ExpiredToken" PrefixI False) U1) (C1 (MetaCons "IntegrationFailure" PrefixI False) U1))))) ((:+:) ((:+:) ((:+:) (C1 (MetaCons "IntegrationTimeout" PrefixI False) U1) (C1 (MetaCons "InvalidAPIKey" PrefixI False) U1)) ((:+:) (C1 (MetaCons "InvalidSignature" PrefixI False) U1) ((:+:) (C1 (MetaCons "MissingAuthenticationToken" PrefixI False) U1) (C1 (MetaCons "QuotaExceeded" PrefixI False) U1)))) ((:+:) ((:+:) (C1 (MetaCons "RequestTooLarge" PrefixI False) U1) (C1 (MetaCons "ResourceNotFound" PrefixI False) U1)) ((:+:) (C1 (MetaCons "Throttled" PrefixI False) U1) ((:+:) (C1 (MetaCons "Unauthorized" PrefixI False) U1) (C1 (MetaCons "UnsupportedMediaType" PrefixI False) U1))))))

IntegrationType

data IntegrationType Source #

The integration type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.

Constructors

AWS 
AWSProxy 
HTTP 
HTTPProxy 
Mock 

Instances

Bounded IntegrationType Source # 
Enum IntegrationType Source # 
Eq IntegrationType Source # 
Data IntegrationType Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> IntegrationType -> c IntegrationType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c IntegrationType #

toConstr :: IntegrationType -> Constr #

dataTypeOf :: IntegrationType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c IntegrationType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c IntegrationType) #

gmapT :: (forall b. Data b => b -> b) -> IntegrationType -> IntegrationType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> IntegrationType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> IntegrationType -> r #

gmapQ :: (forall d. Data d => d -> u) -> IntegrationType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> IntegrationType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> IntegrationType -> m IntegrationType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> IntegrationType -> m IntegrationType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> IntegrationType -> m IntegrationType #

Ord IntegrationType Source # 
Read IntegrationType Source # 
Show IntegrationType Source # 
Generic IntegrationType Source # 
Hashable IntegrationType Source # 
FromJSON IntegrationType Source # 
ToJSON IntegrationType Source # 
NFData IntegrationType Source # 

Methods

rnf :: IntegrationType -> () #

ToQuery IntegrationType Source # 
ToHeader IntegrationType Source # 
ToByteString IntegrationType Source # 
FromText IntegrationType Source # 
ToText IntegrationType Source # 
type Rep IntegrationType Source # 
type Rep IntegrationType = D1 (MetaData "IntegrationType" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) ((:+:) (C1 (MetaCons "AWS" PrefixI False) U1) (C1 (MetaCons "AWSProxy" PrefixI False) U1)) ((:+:) (C1 (MetaCons "HTTP" PrefixI False) U1) ((:+:) (C1 (MetaCons "HTTPProxy" PrefixI False) U1) (C1 (MetaCons "Mock" PrefixI False) U1))))

Op

data Op Source #

Constructors

Add 
Copy 
Move 
Remove 
Replace 
Test 

Instances

Bounded Op Source # 

Methods

minBound :: Op #

maxBound :: Op #

Enum Op Source # 

Methods

succ :: Op -> Op #

pred :: Op -> Op #

toEnum :: Int -> Op #

fromEnum :: Op -> Int #

enumFrom :: Op -> [Op] #

enumFromThen :: Op -> Op -> [Op] #

enumFromTo :: Op -> Op -> [Op] #

enumFromThenTo :: Op -> Op -> Op -> [Op] #

Eq Op Source # 

Methods

(==) :: Op -> Op -> Bool #

(/=) :: Op -> Op -> Bool #

Data Op Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Op -> c Op #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Op #

toConstr :: Op -> Constr #

dataTypeOf :: Op -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Op) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Op) #

gmapT :: (forall b. Data b => b -> b) -> Op -> Op #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Op -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Op -> r #

gmapQ :: (forall d. Data d => d -> u) -> Op -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Op -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Op -> m Op #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Op -> m Op #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Op -> m Op #

Ord Op Source # 

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 #

Read Op Source # 
Show Op Source # 

Methods

showsPrec :: Int -> Op -> ShowS #

show :: Op -> String #

showList :: [Op] -> ShowS #

Generic Op Source # 

Associated Types

type Rep Op :: * -> * #

Methods

from :: Op -> Rep Op x #

to :: Rep Op x -> Op #

Hashable Op Source # 

Methods

hashWithSalt :: Int -> Op -> Int #

hash :: Op -> Int #

ToJSON Op Source # 
NFData Op Source # 

Methods

rnf :: Op -> () #

ToQuery Op Source # 

Methods

toQuery :: Op -> QueryString #

ToHeader Op Source # 

Methods

toHeader :: HeaderName -> Op -> [Header] #

ToByteString Op Source # 

Methods

toBS :: Op -> ByteString #

FromText Op Source # 

Methods

parser :: Parser Op #

ToText Op Source # 

Methods

toText :: Op -> Text #

type Rep Op Source # 
type Rep Op = D1 (MetaData "Op" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) ((:+:) (C1 (MetaCons "Add" PrefixI False) U1) ((:+:) (C1 (MetaCons "Copy" PrefixI False) U1) (C1 (MetaCons "Move" PrefixI False) U1))) ((:+:) (C1 (MetaCons "Remove" PrefixI False) U1) ((:+:) (C1 (MetaCons "Replace" PrefixI False) U1) (C1 (MetaCons "Test" PrefixI False) U1))))

PutMode

data PutMode Source #

Constructors

Merge 
Overwrite 

Instances

Bounded PutMode Source # 
Enum PutMode Source # 
Eq PutMode Source # 

Methods

(==) :: PutMode -> PutMode -> Bool #

(/=) :: PutMode -> PutMode -> Bool #

Data PutMode Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PutMode -> c PutMode #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PutMode #

toConstr :: PutMode -> Constr #

dataTypeOf :: PutMode -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c PutMode) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PutMode) #

gmapT :: (forall b. Data b => b -> b) -> PutMode -> PutMode #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PutMode -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PutMode -> r #

gmapQ :: (forall d. Data d => d -> u) -> PutMode -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> PutMode -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> PutMode -> m PutMode #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PutMode -> m PutMode #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PutMode -> m PutMode #

Ord PutMode Source # 
Read PutMode Source # 
Show PutMode Source # 
Generic PutMode Source # 

Associated Types

type Rep PutMode :: * -> * #

Methods

from :: PutMode -> Rep PutMode x #

to :: Rep PutMode x -> PutMode #

Hashable PutMode Source # 

Methods

hashWithSalt :: Int -> PutMode -> Int #

hash :: PutMode -> Int #

ToJSON PutMode Source # 
NFData PutMode Source # 

Methods

rnf :: PutMode -> () #

ToQuery PutMode Source # 
ToHeader PutMode Source # 

Methods

toHeader :: HeaderName -> PutMode -> [Header] #

ToByteString PutMode Source # 

Methods

toBS :: PutMode -> ByteString #

FromText PutMode Source # 
ToText PutMode Source # 

Methods

toText :: PutMode -> Text #

type Rep PutMode Source # 
type Rep PutMode = D1 (MetaData "PutMode" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) (C1 (MetaCons "Merge" PrefixI False) U1) (C1 (MetaCons "Overwrite" PrefixI False) U1))

QuotaPeriodType

data QuotaPeriodType Source #

Constructors

Day 
Month 
Week 

Instances

Bounded QuotaPeriodType Source # 
Enum QuotaPeriodType Source # 
Eq QuotaPeriodType Source # 
Data QuotaPeriodType Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QuotaPeriodType -> c QuotaPeriodType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c QuotaPeriodType #

toConstr :: QuotaPeriodType -> Constr #

dataTypeOf :: QuotaPeriodType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c QuotaPeriodType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c QuotaPeriodType) #

gmapT :: (forall b. Data b => b -> b) -> QuotaPeriodType -> QuotaPeriodType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QuotaPeriodType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QuotaPeriodType -> r #

gmapQ :: (forall d. Data d => d -> u) -> QuotaPeriodType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> QuotaPeriodType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> QuotaPeriodType -> m QuotaPeriodType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QuotaPeriodType -> m QuotaPeriodType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QuotaPeriodType -> m QuotaPeriodType #

Ord QuotaPeriodType Source # 
Read QuotaPeriodType Source # 
Show QuotaPeriodType Source # 
Generic QuotaPeriodType Source # 
Hashable QuotaPeriodType Source # 
FromJSON QuotaPeriodType Source # 
ToJSON QuotaPeriodType Source # 
NFData QuotaPeriodType Source # 

Methods

rnf :: QuotaPeriodType -> () #

ToQuery QuotaPeriodType Source # 
ToHeader QuotaPeriodType Source # 
ToByteString QuotaPeriodType Source # 
FromText QuotaPeriodType Source # 
ToText QuotaPeriodType Source # 
type Rep QuotaPeriodType Source # 
type Rep QuotaPeriodType = D1 (MetaData "QuotaPeriodType" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) (C1 (MetaCons "Day" PrefixI False) U1) ((:+:) (C1 (MetaCons "Month" PrefixI False) U1) (C1 (MetaCons "Week" PrefixI False) U1)))

UnauthorizedCacheControlHeaderStrategy

data UnauthorizedCacheControlHeaderStrategy Source #

Instances

Bounded UnauthorizedCacheControlHeaderStrategy Source # 
Enum UnauthorizedCacheControlHeaderStrategy Source # 
Eq UnauthorizedCacheControlHeaderStrategy Source # 
Data UnauthorizedCacheControlHeaderStrategy Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UnauthorizedCacheControlHeaderStrategy -> c UnauthorizedCacheControlHeaderStrategy #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UnauthorizedCacheControlHeaderStrategy #

toConstr :: UnauthorizedCacheControlHeaderStrategy -> Constr #

dataTypeOf :: UnauthorizedCacheControlHeaderStrategy -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UnauthorizedCacheControlHeaderStrategy) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UnauthorizedCacheControlHeaderStrategy) #

gmapT :: (forall b. Data b => b -> b) -> UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UnauthorizedCacheControlHeaderStrategy -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UnauthorizedCacheControlHeaderStrategy -> r #

gmapQ :: (forall d. Data d => d -> u) -> UnauthorizedCacheControlHeaderStrategy -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UnauthorizedCacheControlHeaderStrategy -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UnauthorizedCacheControlHeaderStrategy -> m UnauthorizedCacheControlHeaderStrategy #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UnauthorizedCacheControlHeaderStrategy -> m UnauthorizedCacheControlHeaderStrategy #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UnauthorizedCacheControlHeaderStrategy -> m UnauthorizedCacheControlHeaderStrategy #

Ord UnauthorizedCacheControlHeaderStrategy Source # 
Read UnauthorizedCacheControlHeaderStrategy Source # 
Show UnauthorizedCacheControlHeaderStrategy Source # 
Generic UnauthorizedCacheControlHeaderStrategy Source # 
Hashable UnauthorizedCacheControlHeaderStrategy Source # 
FromJSON UnauthorizedCacheControlHeaderStrategy Source # 
NFData UnauthorizedCacheControlHeaderStrategy Source # 
ToQuery UnauthorizedCacheControlHeaderStrategy Source # 
ToHeader UnauthorizedCacheControlHeaderStrategy Source # 
ToByteString UnauthorizedCacheControlHeaderStrategy Source # 
FromText UnauthorizedCacheControlHeaderStrategy Source # 
ToText UnauthorizedCacheControlHeaderStrategy Source # 
type Rep UnauthorizedCacheControlHeaderStrategy Source # 
type Rep UnauthorizedCacheControlHeaderStrategy = D1 (MetaData "UnauthorizedCacheControlHeaderStrategy" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) ((:+:) (C1 (MetaCons "FailWith403" PrefixI False) U1) ((:+:) (C1 (MetaCons "SucceedWithResponseHeader" PrefixI False) U1) (C1 (MetaCons "SucceedWithoutResponseHeader" PrefixI False) U1)))

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.

Use API Keys

See: apiKey smart constructor.

Instances

Eq APIKey Source # 

Methods

(==) :: APIKey -> APIKey -> Bool #

(/=) :: APIKey -> APIKey -> Bool #

Data APIKey Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APIKey -> c APIKey #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APIKey #

toConstr :: APIKey -> Constr #

dataTypeOf :: APIKey -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APIKey) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APIKey) #

gmapT :: (forall b. Data b => b -> b) -> APIKey -> APIKey #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APIKey -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APIKey -> r #

gmapQ :: (forall d. Data d => d -> u) -> APIKey -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APIKey -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APIKey -> m APIKey #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APIKey -> m APIKey #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APIKey -> m APIKey #

Read APIKey Source # 
Show APIKey Source # 
Generic APIKey Source # 

Associated Types

type Rep APIKey :: * -> * #

Methods

from :: APIKey -> Rep APIKey x #

to :: Rep APIKey x -> APIKey #

Hashable APIKey Source # 

Methods

hashWithSalt :: Int -> APIKey -> Int #

hash :: APIKey -> Int #

FromJSON APIKey Source # 
NFData APIKey Source # 

Methods

rnf :: APIKey -> () #

type Rep APIKey Source # 

apiKey :: APIKey Source #

Creates a value of APIKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • akEnabled - Specifies whether the API Key can be used by callers.
  • akValue - The value of the API Key.
  • akCustomerId - An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
  • akCreatedDate - The timestamp when the API Key was created.
  • akName - The name of the API Key.
  • akId - The identifier of the API Key.
  • akStageKeys - A list of Stage resources that are associated with the ApiKey resource.
  • akLastUpdatedDate - The timestamp when the API Key was last updated.
  • akDescription - The description of the API Key.

akEnabled :: Lens' APIKey (Maybe Bool) Source #

Specifies whether the API Key can be used by callers.

akValue :: Lens' APIKey (Maybe Text) Source #

The value of the API Key.

akCustomerId :: Lens' APIKey (Maybe Text) Source #

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

akCreatedDate :: Lens' APIKey (Maybe UTCTime) Source #

The timestamp when the API Key was created.

akName :: Lens' APIKey (Maybe Text) Source #

The name of the API Key.

akId :: Lens' APIKey (Maybe Text) Source #

The identifier of the API Key.

akStageKeys :: Lens' APIKey [Text] Source #

A list of Stage resources that are associated with the ApiKey resource.

akLastUpdatedDate :: Lens' APIKey (Maybe UTCTime) Source #

The timestamp when the API Key was last updated.

akDescription :: Lens' APIKey (Maybe Text) Source #

The description of the API Key.

APIStage

data APIStage Source #

API stage name of the associated API stage in a usage plan.

See: apiStage smart constructor.

Instances

Eq APIStage Source # 
Data APIStage Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> APIStage -> c APIStage #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c APIStage #

toConstr :: APIStage -> Constr #

dataTypeOf :: APIStage -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c APIStage) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c APIStage) #

gmapT :: (forall b. Data b => b -> b) -> APIStage -> APIStage #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> APIStage -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> APIStage -> r #

gmapQ :: (forall d. Data d => d -> u) -> APIStage -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> APIStage -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> APIStage -> m APIStage #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> APIStage -> m APIStage #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> APIStage -> m APIStage #

Read APIStage Source # 
Show APIStage Source # 
Generic APIStage Source # 

Associated Types

type Rep APIStage :: * -> * #

Methods

from :: APIStage -> Rep APIStage x #

to :: Rep APIStage x -> APIStage #

Hashable APIStage Source # 

Methods

hashWithSalt :: Int -> APIStage -> Int #

hash :: APIStage -> Int #

FromJSON APIStage Source # 
ToJSON APIStage Source # 
NFData APIStage Source # 

Methods

rnf :: APIStage -> () #

type Rep APIStage Source # 
type Rep APIStage = D1 (MetaData "APIStage" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "APIStage'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_asStage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_asApiId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

apiStage :: APIStage Source #

Creates a value of APIStage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • asStage - API stage name of the associated API stage in a usage plan.
  • asApiId - API Id of the associated API stage in a usage plan.

asStage :: Lens' APIStage (Maybe Text) Source #

API stage name of the associated API stage in a usage plan.

asApiId :: Lens' APIStage (Maybe Text) Source #

API Id of the associated API stage in a usage plan.

Account

data Account Source #

Represents an AWS account that is associated with Amazon API Gateway.

To view the account info, call GET on this resource.

Error Codes The following exception may be thrown when the request fails.

  • UnauthorizedException * NotFoundException * TooManyRequestsException

For detailed error code information, including the corresponding HTTP Status Codes, see API Gateway Error Codes

Example: Get the information about an account. Request @GET account HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns a 200 OK@ status code and a payload similar to the following:

@{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "account" }, "account:update": { "href": "account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } } @ In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.

API Gateway Limits Developer Guide , AWS CLI

See: account smart constructor.

Instances

Eq Account Source # 

Methods

(==) :: Account -> Account -> Bool #

(/=) :: Account -> Account -> Bool #

Data Account Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Account -> c Account #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Account #

toConstr :: Account -> Constr #

dataTypeOf :: Account -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Account) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Account) #

gmapT :: (forall b. Data b => b -> b) -> Account -> Account #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Account -> r #

gmapQ :: (forall d. Data d => d -> u) -> Account -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Account -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Account -> m Account #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Account -> m Account #

Read Account Source # 
Show Account Source # 
Generic Account Source # 

Associated Types

type Rep Account :: * -> * #

Methods

from :: Account -> Rep Account x #

to :: Rep Account x -> Account #

Hashable Account Source # 

Methods

hashWithSalt :: Int -> Account -> Int #

hash :: Account -> Int #

FromJSON Account Source # 
NFData Account Source # 

Methods

rnf :: Account -> () #

type Rep Account Source # 
type Rep Account = D1 (MetaData "Account" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "Account'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aApiKeyVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aCloudwatchRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aFeatures") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_aThrottleSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ThrottleSettings))))))

account :: Account Source #

Creates a value of Account with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

aApiKeyVersion :: Lens' Account (Maybe Text) Source #

The version of the API keys used for the account.

aCloudwatchRoleARN :: Lens' Account (Maybe Text) Source #

The ARN of an Amazon CloudWatch role for the current Account .

aFeatures :: Lens' Account [Text] Source #

A list of features supported for the account. When usage plans are enabled, the features list will include an entry of UsagePlans .

aThrottleSettings :: Lens' Account (Maybe ThrottleSettings) Source #

Specifies the API request limits configured for the current Account .

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.

Enable custom authorization

See: authorizer smart constructor.

Instances

Eq Authorizer Source # 
Data Authorizer Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Authorizer -> c Authorizer #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Authorizer #

toConstr :: Authorizer -> Constr #

dataTypeOf :: Authorizer -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Authorizer) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Authorizer) #

gmapT :: (forall b. Data b => b -> b) -> Authorizer -> Authorizer #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Authorizer -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Authorizer -> r #

gmapQ :: (forall d. Data d => d -> u) -> Authorizer -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Authorizer -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Authorizer -> m Authorizer #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Authorizer -> m Authorizer #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Authorizer -> m Authorizer #

Read Authorizer Source # 
Show Authorizer Source # 
Generic Authorizer Source # 

Associated Types

type Rep Authorizer :: * -> * #

Hashable Authorizer Source # 
FromJSON Authorizer Source # 
NFData Authorizer Source # 

Methods

rnf :: Authorizer -> () #

type Rep Authorizer Source # 

authorizer :: Authorizer Source #

Creates a value of Authorizer with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • aAuthorizerURI - Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN or REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path2015-03-31functionsarn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}invocations . In general, the URI has this form arn:aws:apigateway:{region}:lambda:path/{service_api} , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial / . For Lambda functions, this is usually of the form 2015-03-31functions[FunctionARN]invocations .
  • aIdentityValidationExpression - A validation expression for the incoming identity token. For TOKEN authorizers, this value is a regular expression. Amazon API Gateway will match the incoming token from the client against the specified regular expression. It will invoke the authorizer's Lambda function there is a match. Otherwise, it will return a 401 Unauthorized response without calling the Lambda function. The validation expression does not apply to the REQUEST authorizer.
  • aProviderARNs - 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.
  • aName - [Required] The name of the authorizer.
  • aId - The identifier for the authorizer resource.
  • aAuthorizerResultTtlInSeconds - The TTL in seconds of cached authorizer results. If it equals 0, authorization caching is disabled. If it is greater than 0, API Gateway will cache authorizer responses. If this field is not set, the default value is 300. The maximum value is 3600, or 1 hour.
  • aAuthType - Optional customer-defined field, used in Swagger imports and exports without functional impact.
  • aType - [Required] The authorizer type. Valid values are TOKEN for a Lambda function using a single authorization token submitted in a custom header, REQUEST for a Lambda function using incoming request parameters, and COGNITO_USER_POOLS for using an Amazon Cognito user pool.
  • aIdentitySource - The identity source for which authorization is requested. * For a TOKEN 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. * For a COGNITO_USER_POOLS authorizer, this property is not used.
  • aAuthorizerCredentials - Specifies the required credentials as an IAM role for Amazon API Gateway to invoke the authorizer. To specify an IAM role for Amazon API Gateway to assume, use the role's Amazon Resource Name (ARN). To use resource-based permissions on the Lambda function, specify null.

aAuthorizerURI :: Lens' Authorizer (Maybe Text) Source #

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

aIdentityValidationExpression :: Lens' Authorizer (Maybe Text) Source #

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

aProviderARNs :: Lens' Authorizer [Text] Source #

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

aName :: Lens' Authorizer (Maybe Text) Source #

Required
The name of the authorizer.

aId :: Lens' Authorizer (Maybe Text) Source #

The identifier for the authorizer resource.

aAuthorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int) Source #

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

aAuthType :: Lens' Authorizer (Maybe Text) Source #

Optional customer-defined field, used in Swagger imports and exports without functional impact.

aType :: Lens' Authorizer (Maybe AuthorizerType) Source #

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

aIdentitySource :: Lens' Authorizer (Maybe Text) Source #

The identity source for which authorization is requested. * For a TOKEN 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. * For a COGNITO_USER_POOLS authorizer, this property is not used.

aAuthorizerCredentials :: Lens' Authorizer (Maybe Text) Source #

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

BasePathMapping

data BasePathMapping Source #

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

A custom domain name plus a BasePathMapping specification identifies a deployed RestApi in a given stage of the owner Account .Use Custom Domain Names

See: basePathMapping smart constructor.

Instances

Eq BasePathMapping Source # 
Data BasePathMapping Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> BasePathMapping -> c BasePathMapping #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c BasePathMapping #

toConstr :: BasePathMapping -> Constr #

dataTypeOf :: BasePathMapping -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c BasePathMapping) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c BasePathMapping) #

gmapT :: (forall b. Data b => b -> b) -> BasePathMapping -> BasePathMapping #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> BasePathMapping -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> BasePathMapping -> r #

gmapQ :: (forall d. Data d => d -> u) -> BasePathMapping -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> BasePathMapping -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> BasePathMapping -> m BasePathMapping #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> BasePathMapping -> m BasePathMapping #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> BasePathMapping -> m BasePathMapping #

Read BasePathMapping Source # 
Show BasePathMapping Source # 
Generic BasePathMapping Source # 
Hashable BasePathMapping Source # 
FromJSON BasePathMapping Source # 
NFData BasePathMapping Source # 

Methods

rnf :: BasePathMapping -> () #

type Rep BasePathMapping Source # 
type Rep BasePathMapping = D1 (MetaData "BasePathMapping" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "BasePathMapping'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_bpmStage") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_bpmBasePath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_bpmRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

basePathMapping :: BasePathMapping Source #

Creates a value of BasePathMapping with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • bpmStage - The name of the associated stage.
  • bpmBasePath - The base path name that callers of the API must provide as part of the URL after the domain name.
  • bpmRestAPIId - The string identifier of the associated RestApi .

bpmStage :: Lens' BasePathMapping (Maybe Text) Source #

The name of the associated stage.

bpmBasePath :: Lens' BasePathMapping (Maybe Text) Source #

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

bpmRestAPIId :: Lens' BasePathMapping (Maybe Text) Source #

The string identifier of the associated RestApi .

ClientCertificate

data ClientCertificate Source #

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

Client certificates are used to authenticate an API by the backend server. To authenticate an API client (or user), use IAM roles and policies, a custom Authorizer or an Amazon Cognito user pool.Use Client-Side Certificate

See: clientCertificate smart constructor.

Instances

Eq ClientCertificate Source # 
Data ClientCertificate Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ClientCertificate -> c ClientCertificate #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ClientCertificate #

toConstr :: ClientCertificate -> Constr #

dataTypeOf :: ClientCertificate -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c ClientCertificate) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ClientCertificate) #

gmapT :: (forall b. Data b => b -> b) -> ClientCertificate -> ClientCertificate #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ClientCertificate -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ClientCertificate -> r #

gmapQ :: (forall d. Data d => d -> u) -> ClientCertificate -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ClientCertificate -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ClientCertificate -> m ClientCertificate #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ClientCertificate -> m ClientCertificate #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ClientCertificate -> m ClientCertificate #

Read ClientCertificate Source # 
Show ClientCertificate Source # 
Generic ClientCertificate Source # 
Hashable ClientCertificate Source # 
FromJSON ClientCertificate Source # 
NFData ClientCertificate Source # 

Methods

rnf :: ClientCertificate -> () #

type Rep ClientCertificate Source # 
type Rep ClientCertificate = D1 (MetaData "ClientCertificate" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "ClientCertificate'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_ccPemEncodedCertificate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_ccClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_ccCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_ccExpirationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (S1 (MetaSel (Just Symbol "_ccDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

clientCertificate :: ClientCertificate Source #

Creates a value of ClientCertificate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ccPemEncodedCertificate - The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .
  • ccClientCertificateId - The identifier of the client certificate.
  • ccCreatedDate - The timestamp when the client certificate was created.
  • ccExpirationDate - The timestamp when the client certificate will expire.
  • ccDescription - The description of the client certificate.

ccPemEncodedCertificate :: Lens' ClientCertificate (Maybe Text) Source #

The PEM-encoded public key of the client certificate, which can be used to configure certificate authentication in the integration endpoint .

ccClientCertificateId :: Lens' ClientCertificate (Maybe Text) Source #

The identifier of the client certificate.

ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate was created.

ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime) Source #

The timestamp when the client certificate will expire.

ccDescription :: Lens' ClientCertificate (Maybe Text) Source #

The description of the client certificate.

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.

To create a deployment, call POST on the Deployments resource of a RestApi . To view, update, or delete a deployment, call GET , PATCH , or DELETE on the specified deployment resource (restapis{restapi_id}deployments{deployment_id} ).RestApi , Deployments , Stage , AWS CLI , AWS SDKs

See: deployment smart constructor.

Instances

Eq Deployment Source # 
Data Deployment Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Deployment -> c Deployment #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Deployment #

toConstr :: Deployment -> Constr #

dataTypeOf :: Deployment -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Deployment) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Deployment) #

gmapT :: (forall b. Data b => b -> b) -> Deployment -> Deployment #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Deployment -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Deployment -> r #

gmapQ :: (forall d. Data d => d -> u) -> Deployment -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Deployment -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Deployment -> m Deployment #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Deployment -> m Deployment #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Deployment -> m Deployment #

Read Deployment Source # 
Show Deployment Source # 
Generic Deployment Source # 

Associated Types

type Rep Deployment :: * -> * #

Hashable Deployment Source # 
FromJSON Deployment Source # 
NFData Deployment Source # 

Methods

rnf :: Deployment -> () #

type Rep Deployment Source # 
type Rep Deployment = D1 (MetaData "Deployment" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "Deployment'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dApiSummary") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text (Map Text MethodSnapshot))))) (S1 (MetaSel (Just Symbol "_dCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX)))) ((:*:) (S1 (MetaSel (Just Symbol "_dId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

deployment :: Deployment Source #

Creates a value of Deployment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dApiSummary - A summary of the RestApi at the date and time that the deployment resource was created.
  • dCreatedDate - The date and time that the deployment resource was created.
  • dId - The identifier for the deployment resource.
  • dDescription - The description for the deployment resource.

dApiSummary :: Lens' Deployment (HashMap Text (HashMap Text MethodSnapshot)) Source #

A summary of the RestApi at the date and time that the deployment resource was created.

dCreatedDate :: Lens' Deployment (Maybe UTCTime) Source #

The date and time that the deployment resource was created.

dId :: Lens' Deployment (Maybe Text) Source #

The identifier for the deployment resource.

dDescription :: Lens' Deployment (Maybe Text) Source #

The description for the deployment resource.

DocumentationPart

data DocumentationPart Source #

A documentation part for a targeted API entity.

A documentation part consists of a content map (properties ) and a target (location ). The target specifies an API entity to which the documentation content applies. The supported API entity types are API , AUTHORIZER , MODEL , RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . Valid location fields depend on the API entity type. All valid fields are not required.

The content map is a JSON string of API-specific key-value pairs. Although an API can use any shape for the content map, only the Swagger-compliant documentation fields will be injected into the associated API entity definition in the exported Swagger definition file.

Documenting an API , DocumentationParts

See: documentationPart smart constructor.

Instances

Eq DocumentationPart Source # 
Data DocumentationPart Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DocumentationPart -> c DocumentationPart #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DocumentationPart #

toConstr :: DocumentationPart -> Constr #

dataTypeOf :: DocumentationPart -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DocumentationPart) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocumentationPart) #

gmapT :: (forall b. Data b => b -> b) -> DocumentationPart -> DocumentationPart #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationPart -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationPart -> r #

gmapQ :: (forall d. Data d => d -> u) -> DocumentationPart -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DocumentationPart -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DocumentationPart -> m DocumentationPart #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationPart -> m DocumentationPart #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationPart -> m DocumentationPart #

Read DocumentationPart Source # 
Show DocumentationPart Source # 
Generic DocumentationPart Source # 
Hashable DocumentationPart Source # 
FromJSON DocumentationPart Source # 
NFData DocumentationPart Source # 

Methods

rnf :: DocumentationPart -> () #

type Rep DocumentationPart Source # 
type Rep DocumentationPart = D1 (MetaData "DocumentationPart" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "DocumentationPart'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dpLocation") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DocumentationPartLocation))) ((:*:) (S1 (MetaSel (Just Symbol "_dpId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dpProperties") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

documentationPart :: DocumentationPart Source #

Creates a value of DocumentationPart with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dpLocation - The location of the API entity to which the documentation applies. Valid fields depend on the targeted API entity type. All the valid location fields are not required. If not explicitly specified, a valid location field is treated as a wildcard and associated documentation content may be inherited by matching entities, unless overridden.
  • dpId - The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.
  • dpProperties - A content map of API-specific key-value pairs describing the targeted API entity. The map must be encoded as a JSON string, e.g., "{ "description": "The API does ..." }" . Only Swagger-compliant documentation-related fields from the properties map are exported and, hence, published as part of the API entity definitions, while the original documentation parts are exported in a Swagger extension of x-amazon-apigateway-documentation .

dpLocation :: Lens' DocumentationPart (Maybe DocumentationPartLocation) Source #

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

dpId :: Lens' DocumentationPart (Maybe Text) Source #

The DocumentationPart identifier, generated by Amazon API Gateway when the DocumentationPart is created.

dpProperties :: Lens' DocumentationPart (Maybe Text) Source #

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

DocumentationPartLocation

data DocumentationPartLocation Source #

Specifies the target API entity to which the documentation applies.

See: documentationPartLocation smart constructor.

Instances

Eq DocumentationPartLocation Source # 
Data DocumentationPartLocation Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DocumentationPartLocation -> c DocumentationPartLocation #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DocumentationPartLocation #

toConstr :: DocumentationPartLocation -> Constr #

dataTypeOf :: DocumentationPartLocation -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DocumentationPartLocation) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocumentationPartLocation) #

gmapT :: (forall b. Data b => b -> b) -> DocumentationPartLocation -> DocumentationPartLocation #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationPartLocation -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationPartLocation -> r #

gmapQ :: (forall d. Data d => d -> u) -> DocumentationPartLocation -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DocumentationPartLocation -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DocumentationPartLocation -> m DocumentationPartLocation #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationPartLocation -> m DocumentationPartLocation #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationPartLocation -> m DocumentationPartLocation #

Read DocumentationPartLocation Source # 
Show DocumentationPartLocation Source # 
Generic DocumentationPartLocation Source # 
Hashable DocumentationPartLocation Source # 
FromJSON DocumentationPartLocation Source # 
ToJSON DocumentationPartLocation Source # 
NFData DocumentationPartLocation Source # 
type Rep DocumentationPartLocation Source # 
type Rep DocumentationPartLocation = D1 (MetaData "DocumentationPartLocation" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "DocumentationPartLocation'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dplPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dplName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dplMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_dplStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dplType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 DocumentationPartType))))))

documentationPartLocation Source #

Creates a value of DocumentationPartLocation with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dplPath - The URL path of the target. It is a valid field for the API entity types of RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.
  • dplName - The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER , MODEL , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY and RESPONSE_HEADER . It is an invalid field for any other entity type.
  • dplMethod - The HTTP verb of a method. It is a valid field for the API entity types of METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.
  • dplStatusCode - The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.
  • dplType - The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of 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.

dplPath :: Lens' DocumentationPartLocation (Maybe Text) Source #

The URL path of the target. It is a valid field for the API entity types of RESOURCE , METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is / for the root resource. When an applicable child entity inherits the content of another entity of the same type with more general specifications of the other location attributes, the child entity's path attribute must match that of the parent entity as a prefix.

dplName :: Lens' DocumentationPartLocation (Maybe Text) Source #

The name of the targeted API entity. It is a valid and required field for the API entity types of AUTHORIZER , MODEL , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY and RESPONSE_HEADER . It is an invalid field for any other entity type.

dplMethod :: Lens' DocumentationPartLocation (Maybe Text) Source #

The HTTP verb of a method. It is a valid field for the API entity types of METHOD , PATH_PARAMETER , QUERY_PARAMETER , REQUEST_HEADER , REQUEST_BODY , RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any method. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's method attribute must match that of the parent entity exactly.

dplStatusCode :: Lens' DocumentationPartLocation (Maybe Text) Source #

The HTTP status code of a response. It is a valid field for the API entity types of RESPONSE , RESPONSE_HEADER , and RESPONSE_BODY . The default value is * for any status code. When an applicable child entity inherits the content of an entity of the same type with more general specifications of the other location attributes, the child entity's statusCode attribute must match that of the parent entity exactly.

dplType :: Lens' DocumentationPartLocation DocumentationPartType Source #

The type of API entity to which the documentation content applies. It is a valid and required field for API entity types of 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.

Publishing API documentation involves creating a documentation version associated with an API stage and exporting the versioned documentation to an external (e.g., Swagger) file.

Documenting an API , DocumentationPart , DocumentationVersions

See: documentationVersion smart constructor.

Instances

Eq DocumentationVersion Source # 
Data DocumentationVersion Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DocumentationVersion -> c DocumentationVersion #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DocumentationVersion #

toConstr :: DocumentationVersion -> Constr #

dataTypeOf :: DocumentationVersion -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DocumentationVersion) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocumentationVersion) #

gmapT :: (forall b. Data b => b -> b) -> DocumentationVersion -> DocumentationVersion #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationVersion -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DocumentationVersion -> r #

gmapQ :: (forall d. Data d => d -> u) -> DocumentationVersion -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DocumentationVersion -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DocumentationVersion -> m DocumentationVersion #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationVersion -> m DocumentationVersion #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentationVersion -> m DocumentationVersion #

Read DocumentationVersion Source # 
Show DocumentationVersion Source # 
Generic DocumentationVersion Source # 
Hashable DocumentationVersion Source # 
FromJSON DocumentationVersion Source # 
NFData DocumentationVersion Source # 

Methods

rnf :: DocumentationVersion -> () #

type Rep DocumentationVersion Source # 
type Rep DocumentationVersion = D1 (MetaData "DocumentationVersion" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "DocumentationVersion'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dvCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_dvVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dvDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

documentationVersion :: DocumentationVersion Source #

Creates a value of DocumentationVersion with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dvCreatedDate - The date when the API documentation snapshot is created.
  • dvVersion - The version identifier of the API documentation snapshot.
  • dvDescription - The description of the API documentation snapshot.

dvCreatedDate :: Lens' DocumentationVersion (Maybe UTCTime) Source #

The date when the API documentation snapshot is created.

dvVersion :: Lens' DocumentationVersion (Maybe Text) Source #

The version identifier of the API documentation snapshot.

dvDescription :: Lens' DocumentationVersion (Maybe Text) Source #

The description of the API documentation snapshot.

DomainName

data DomainName Source #

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

When you deploy an API, Amazon API Gateway creates a default host name for the API. This default API host name is of the {restapi-id}.execute-api.{region}.amazonaws.com format. With the default host name, you can access the API's root resource with the URL of https://{restapi-id}.execute-api.{region}.amazonaws.com/{stage}/ . When you set up a custom domain name of apis.example.com for this API, you can then access the same resource using the URL of the https://apis.examples.com/myApi , where myApi is the base path mapping (BasePathMapping ) of your API under the custom domain name.

Set a Custom Host Name for an API

See: domainName smart constructor.

Instances

Eq DomainName Source # 
Data DomainName Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DomainName -> c DomainName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DomainName #

toConstr :: DomainName -> Constr #

dataTypeOf :: DomainName -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DomainName) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DomainName) #

gmapT :: (forall b. Data b => b -> b) -> DomainName -> DomainName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DomainName -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DomainName -> r #

gmapQ :: (forall d. Data d => d -> u) -> DomainName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DomainName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DomainName -> m DomainName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DomainName -> m DomainName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DomainName -> m DomainName #

Read DomainName Source # 
Show DomainName Source # 
Generic DomainName Source # 

Associated Types

type Rep DomainName :: * -> * #

Hashable DomainName Source # 
FromJSON DomainName Source # 
NFData DomainName Source # 

Methods

rnf :: DomainName -> () #

type Rep DomainName Source # 
type Rep DomainName = D1 (MetaData "DomainName" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "DomainName'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dnCertificateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dnRegionalCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dnCertificateARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dnDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dnRegionalCertificateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dnRegionalDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dnCertificateUploadDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) ((:*:) (S1 (MetaSel (Just Symbol "_dnDistributionDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dnEndpointConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe EndpointConfiguration))))))))

domainName :: DomainName Source #

Creates a value of DomainName with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • dnCertificateName - The name of the certificate that will be used by edge-optimized endpoint for this domain name.
  • dnRegionalCertificateARN - The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.
  • dnCertificateARN - The reference to an AWS-managed certificate that will be used by edge-optimized endpoint for this domain name. AWS Certificate Manager is the only supported source.
  • dnDomainName - The name of the DomainName resource.
  • dnRegionalCertificateName - The name of the certificate that will be used for validating the regional domain name.
  • dnRegionalDomainName - The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by Amazon API Gateway when you create a regional endpoint.
  • dnCertificateUploadDate - The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.
  • dnDistributionDomainName - The domain name of the Amazon CloudFront distribution associated with this custom domain name for an edge-optimized endpoint. You set up this association when adding a DNS record pointing the custom domain name to this distribution name. For more information about CloudFront distributions, see the Amazon CloudFront documentation .
  • dnEndpointConfiguration - The endpoint configuration of this DomainName showing the endpoint types of the domain name.

dnCertificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used by edge-optimized endpoint for this domain name.

dnRegionalCertificateARN :: Lens' DomainName (Maybe Text) Source #

The reference to an AWS-managed certificate that will be used for validating the regional domain name. AWS Certificate Manager is the only supported source.

dnCertificateARN :: Lens' DomainName (Maybe Text) Source #

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

dnDomainName :: Lens' DomainName (Maybe Text) Source #

The name of the DomainName resource.

dnRegionalCertificateName :: Lens' DomainName (Maybe Text) Source #

The name of the certificate that will be used for validating the regional domain name.

dnRegionalDomainName :: Lens' DomainName (Maybe Text) Source #

The domain name associated with the regional endpoint for this custom domain name. You set up this association by adding a DNS record that points the custom domain name to this regional domain name. The regional domain name is returned by Amazon API Gateway when you create a regional endpoint.

dnCertificateUploadDate :: Lens' DomainName (Maybe UTCTime) Source #

The timestamp when the certificate that was used by edge-optimized endpoint for this domain name was uploaded.

dnDistributionDomainName :: Lens' DomainName (Maybe Text) Source #

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

dnEndpointConfiguration :: Lens' DomainName (Maybe EndpointConfiguration) Source #

The endpoint configuration of this DomainName showing the endpoint types of the domain name.

EndpointConfiguration

data EndpointConfiguration Source #

The endpoint configuration to indicate the types of endpoints an API (RestApi ) or its custom domain name (DomainName ) has.

See: endpointConfiguration smart constructor.

Instances

Eq EndpointConfiguration Source # 
Data EndpointConfiguration Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> EndpointConfiguration -> c EndpointConfiguration #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c EndpointConfiguration #

toConstr :: EndpointConfiguration -> Constr #

dataTypeOf :: EndpointConfiguration -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c EndpointConfiguration) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c EndpointConfiguration) #

gmapT :: (forall b. Data b => b -> b) -> EndpointConfiguration -> EndpointConfiguration #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> EndpointConfiguration -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> EndpointConfiguration -> r #

gmapQ :: (forall d. Data d => d -> u) -> EndpointConfiguration -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> EndpointConfiguration -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> EndpointConfiguration -> m EndpointConfiguration #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointConfiguration -> m EndpointConfiguration #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> EndpointConfiguration -> m EndpointConfiguration #

Read EndpointConfiguration Source # 
Show EndpointConfiguration Source # 
Generic EndpointConfiguration Source # 
Hashable EndpointConfiguration Source # 
FromJSON EndpointConfiguration Source # 
ToJSON EndpointConfiguration Source # 
NFData EndpointConfiguration Source # 

Methods

rnf :: EndpointConfiguration -> () #

type Rep EndpointConfiguration Source # 
type Rep EndpointConfiguration = D1 (MetaData "EndpointConfiguration" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" True) (C1 (MetaCons "EndpointConfiguration'" PrefixI True) (S1 (MetaSel (Just Symbol "_ecTypes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe [EndpointType]))))

endpointConfiguration :: EndpointConfiguration Source #

Creates a value of EndpointConfiguration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • ecTypes - A list of endpoint types of an API (RestApi ) or its custom domain name (DomainName ). For an edge-optimized API and its custom domain name, the endpoint type is EDGE . For a regional API and its custom domain name, the endpoint type is REGIONAL .

ecTypes :: Lens' EndpointConfiguration [EndpointType] Source #

A list of endpoint types of an API (RestApi ) or its custom domain name (DomainName ). For an edge-optimized API and its custom domain name, the endpoint type is EDGE . For a regional API and its custom domain name, the endpoint type is REGIONAL .

GatewayResponse

data GatewayResponse Source #

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

For more information about valid gateway response types, see Gateway Response Types Supported by Amazon API Gateway Example: Get a Gateway Response of a given response type Request This example shows how to get a gateway response of the MISSING_AUTHNETICATION_TOKEN type.

@GET restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN HTTP1.1 Host: beta-apigateway.us-east-1.amazonaws.com Content-Type: applicationjson X-Amz-Date: 20170503T202516Z Authorization: AWS4-HMAC-SHA256 Credential={access-key-id}20170503us-east-1apigatewayaws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=1b52460e3159c1a26cff29093855d50ea141c1c5b937528fecaf60f51129697a Cache-Control: no-cache Postman-Token: 3b2a1ce9-c848-2e26-2e2f-9c2caefbed45 @ The response type is specified as a URL path.

Response The successful operation returns the 200 OK status code and a payload similar to the following:

@{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-gatewayresponse-{rel}.html", "name": "gatewayresponse", "templated": true }, "self": { "href": "restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:delete": { "href": "restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN" }, "gatewayresponse:put": { "href": "restapiso81lxiseflgatewayresponses{response_type}", "templated": true }, "gatewayresponse:update": { "href": "restapiso81lxiseflgatewayresponsesMISSING_AUTHENTICATION_TOKEN" } }, "defaultResponse": false, "responseParameters": { "gatewayresponse.header.x-request-path": "method.request.path.petId", "gatewayresponse.header.Access-Control-Allow-Origin": "'a.b.c'", "gatewayresponse.header.x-request-query": "method.request.querystring.q", "gatewayresponse.header.x-request-header": "method.request.header.Accept" }, "responseTemplates": { "application/json": "{n "message": $context.error.messageString,n "type": "$context.error.responseType",n "stage": "$context.stage",n "resourcePath": "$context.resourcePath",n "stageVariables.a": "$stageVariables.a",n "statusCode": "'404'"n}" }, "responseType": MISSING_AUTHENTICATION_TOKEN, "statusCode": "404" } @

Customize Gateway Responses

See: gatewayResponse smart constructor.

Instances

Eq GatewayResponse Source # 
Data GatewayResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GatewayResponse -> c GatewayResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GatewayResponse #

toConstr :: GatewayResponse -> Constr #

dataTypeOf :: GatewayResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GatewayResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GatewayResponse) #

gmapT :: (forall b. Data b => b -> b) -> GatewayResponse -> GatewayResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GatewayResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GatewayResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> GatewayResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> GatewayResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GatewayResponse -> m GatewayResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GatewayResponse -> m GatewayResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GatewayResponse -> m GatewayResponse #

Read GatewayResponse Source # 
Show GatewayResponse Source # 
Generic GatewayResponse Source # 
Hashable GatewayResponse Source # 
FromJSON GatewayResponse Source # 
NFData GatewayResponse Source # 

Methods

rnf :: GatewayResponse -> () #

type Rep GatewayResponse Source # 
type Rep GatewayResponse = D1 (MetaData "GatewayResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "GatewayResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_gDefaultResponse") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gResponseTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_gResponseType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GatewayResponseType))) ((:*:) (S1 (MetaSel (Just Symbol "_gStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_gResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))))))

gatewayResponse :: GatewayResponse Source #

Creates a value of GatewayResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • gDefaultResponse - A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true ) or not (false ). A default gateway response is one generated by Amazon API Gateway without any customization by an API developer.
  • gResponseTemplates - Response templates of the GatewayResponse as a string-to-string map of key-value pairs.
  • gResponseType - The response type of the associated GatewayResponse . Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPES
  • gStatusCode - The HTTP status code for this GatewayResponse .
  • gResponseParameters - Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

gDefaultResponse :: Lens' GatewayResponse (Maybe Bool) Source #

A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true ) or not (false ). A default gateway response is one generated by Amazon API Gateway without any customization by an API developer.

gResponseTemplates :: Lens' GatewayResponse (HashMap Text Text) Source #

Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

gResponseType :: Lens' GatewayResponse (Maybe GatewayResponseType) Source #

The response type of the associated GatewayResponse . Valid values are * ACCESS_DENIED * API_CONFIGURATION_ERROR * AUTHORIZER_FAILURE * AUTHORIZER_CONFIGURATION_ERROR * BAD_REQUEST_PARAMETERS * BAD_REQUEST_BODY * DEFAULT_4XX * DEFAULT_5XX * EXPIRED_TOKEN * INVALID_SIGNATURE * INTEGRATION_FAILURE * INTEGRATION_TIMEOUT * INVALID_API_KEY * MISSING_AUTHENTICATION_TOKEN * QUOTA_EXCEEDED * REQUEST_TOO_LARGE * RESOURCE_NOT_FOUND * THROTTLED * UNAUTHORIZED * UNSUPPORTED_MEDIA_TYPES

gStatusCode :: Lens' GatewayResponse (Maybe Text) Source #

The HTTP status code for this GatewayResponse .

gResponseParameters :: Lens' GatewayResponse (HashMap Text Text) Source #

Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

Integration

data Integration Source #

Represents an HTTP, HTTP_PROXY, AWS, AWS_PROXY, or Mock integration.

In the API Gateway console, the built-in Lambda integration is an AWS integration.Creating an API

See: integration smart constructor.

Instances

Eq Integration Source # 
Data Integration Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Integration -> c Integration #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Integration #

toConstr :: Integration -> Constr #

dataTypeOf :: Integration -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Integration) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Integration) #

gmapT :: (forall b. Data b => b -> b) -> Integration -> Integration #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Integration -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Integration -> r #

gmapQ :: (forall d. Data d => d -> u) -> Integration -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> Integration -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Integration -> m Integration #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Integration -> m Integration #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Integration -> m Integration #

Read Integration Source # 
Show Integration Source # 
Generic Integration Source # 

Associated Types

type Rep Integration :: * -> * #

Hashable Integration Source # 
FromJSON Integration Source # 
NFData Integration Source # 

Methods

rnf :: Integration -> () #

type Rep Integration Source # 
type Rep Integration = D1 (MetaData "Integration" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.5.0-3jDq4KKltGt78uikPpOCEJ" False) (C1 (MetaCons "Integration'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iRequestTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_iCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_iRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_iContentHandling") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ContentHandlingStrategy)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iPassthroughBehavior") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_iUri") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iIntegrationResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text IntegrationResponse)))))) ((:*:) (S1 (MetaSel (Just Symbol "_iCacheNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_iType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe IntegrationType))) (S1 (MetaSel (Just Symbol "_iCacheKeyParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))))))

integration :: Integration Source #

Creates a value of Integration with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

  • iHttpMethod - Specifies the integration's HTTP method type.
  • iRequestTemplates - Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.
  • iCredentials - Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon 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.
  • iRequestParameters - A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name must be a valid and unique method request parameter name.
  • iContentHandling - Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a request payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.
  • iPassthroughBehavior - 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 . There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . * WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. * WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. * NEVER rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.
  • iUri - Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification . For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api} . Region , subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial / .
  • iIntegrationResponses - Specifies the integration's responses. Example: Get integration responses of a method Request @GET restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200 HTTP1.1 Content-Type: applicationjson Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}20160607us-east-1apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash} Response The successful response returns 200 OK status and a payload as follows: { "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200", "title": "200" }, "integrationresponse:delete": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" }, "integrationresponse:update": { "href": "restapisfugvjdxtriresources3kzxbg5sa2methodsGETintegrationresponses200" } }, "responseParameters": { "method.response.header.Content-Type": "'applicationxml'" }, "responseTemplates": { "applicationjson": "$util.urlDecode("%3CkinesisStreams%3E#foreach($stream in $input.path('$.StreamNames'))%3Cstream%3E%3Cname%3E$stream%3Cname%3E%3Cstream%3E#end%3CkinesisStreams%3E")n" }, "statusCode": "200" } @ Creating an API
  • iCacheNamespace - Specifies the integration's cache namespace.
  • iType - Specifies the integration's type. The valid value is HTTP for integrating with an HTTP back end, AWS for any AWS service endpoints, MOCK for testing without actually invoking the back end, HTTP_PROXY for integrating with the HTTP proxy integration, or AWS_PROXY for integrating with the Lambda proxy integration type.
  • iCacheKeyParameters - Specifies the integration's cache key parameters.

iHttpMethod :: Lens' Integration (Maybe Text) Source #

Specifies the integration's HTTP method type.

iRequestTemplates :: Lens' Integration (HashMap Text Text) Source #

Represents a map of Velocity templates that are applied on the request payload based on the value of the Content-Type header sent by the client. The content type value is the key in this map, and the template (as a String) is the value.

iCredentials :: Lens' Integration (Maybe Text) Source #

Specifies the credentials required for the integration, if any. For AWS integrations, three options are available. To specify an IAM Role for Amazon 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.

iRequestParameters :: Lens' Integration (HashMap Text Text) Source #

A key-value map specifying request parameters that are passed from the method request to the back end. The key is an integration request parameter name and the associated value is a method request parameter value or static value that must be enclosed within single quotes and pre-encoded as required by the back end. The method request parameter value must match the pattern of method.request.{location}.{name} , where location is querystring , path , or header and name must be a valid and unique method request parameter name.

iContentHandling :: Lens' Integration (Maybe ContentHandlingStrategy) Source #

Specifies how to handle request payload content type conversions. Supported values are CONVERT_TO_BINARY and CONVERT_TO_TEXT , with the following behaviors: * CONVERT_TO_BINARY : Converts a request payload from a Base64-encoded string to the corresponding binary blob. * CONVERT_TO_TEXT : Converts a request payload from a binary blob to a Base64-encoded string. If this property is not defined, the request payload will be passed through from the method request to integration request without modification, provided that the passthroughBehaviors is configured to support payload pass-through.

iPassthroughBehavior :: Lens' Integration (Maybe Text) Source #

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates . There are three valid values: WHEN_NO_MATCH , WHEN_NO_TEMPLATES , and NEVER . * WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request. * WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP 415 Unsupported Media Type response. * NEVER rejects the method request with an HTTP 415 Unsupported Media Type response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

iUri :: Lens' Integration (Maybe Text) Source #

Specifies the integration's Uniform Resource Identifier (URI). For HTTP integrations, the URI must be a fully formed, encoded HTTP(S) URL according to the RFC-3986 specification . For AWS integrations, the URI should be of the form arn:aws:apigateway:{region}:{subdomain.service|service}:{path|action}/{service_api} . Region , subdomain and service are used to determine the right endpoint. For AWS services that use the Action= query string parameter, service_api should be a valid action for the desired service. For RESTful AWS service APIs, path is used