Network.AWS.APIGateway.Types

Service Configuration

apiGateway :: Service

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

Errors

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

Prism for ConflictException' errors.

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

Prism for NotFoundException' errors.

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

Prism for TooManyRequestsException' errors.

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

Prism for ServiceUnavailableException' errors.

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

Prism for UnauthorizedException' errors.

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

Prism for BadRequestException' errors.

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

Prism for LimitExceededException' errors.

AuthorizerType

data AuthorizerType

The authorizer type. Only current value is TOKEN.

Constructors

Token

Instances

Bounded AuthorizerType

Methods

minBound :: AuthorizerType

maxBound :: AuthorizerType

Enum AuthorizerType

Methods

succ :: AuthorizerType -> AuthorizerType

pred :: AuthorizerType -> AuthorizerType

toEnum :: Int -> AuthorizerType

fromEnum :: AuthorizerType -> Int

enumFrom :: AuthorizerType -> [AuthorizerType]

enumFromThen :: AuthorizerType -> AuthorizerType -> [AuthorizerType]

enumFromTo :: AuthorizerType -> AuthorizerType -> [AuthorizerType]

enumFromThenTo :: AuthorizerType -> AuthorizerType -> AuthorizerType -> [AuthorizerType]

Eq AuthorizerType

Methods

(==) :: AuthorizerType -> AuthorizerType -> Bool

(/=) :: AuthorizerType -> AuthorizerType -> Bool

Data AuthorizerType

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

Methods

compare :: AuthorizerType -> AuthorizerType -> Ordering

(<) :: AuthorizerType -> AuthorizerType -> Bool

(<=) :: AuthorizerType -> AuthorizerType -> Bool

(>) :: AuthorizerType -> AuthorizerType -> Bool

(>=) :: AuthorizerType -> AuthorizerType -> Bool

max :: AuthorizerType -> AuthorizerType -> AuthorizerType

min :: AuthorizerType -> AuthorizerType -> AuthorizerType

Read AuthorizerType

Methods

readsPrec :: Int -> ReadS AuthorizerType

readList :: ReadS [AuthorizerType]

readPrec :: ReadPrec AuthorizerType

readListPrec :: ReadPrec [AuthorizerType]

Show AuthorizerType

Methods

showsPrec :: Int -> AuthorizerType -> ShowS

show :: AuthorizerType -> String

showList :: [AuthorizerType] -> ShowS

Generic AuthorizerType

Associated Types

type Rep AuthorizerType :: * -> *

Methods

from :: AuthorizerType -> Rep AuthorizerType x

to :: Rep AuthorizerType x -> AuthorizerType

ToJSON AuthorizerType

Methods

toJSON :: AuthorizerType -> Value

toEncoding :: AuthorizerType -> Encoding

FromJSON AuthorizerType

Methods

parseJSON :: Value -> Parser AuthorizerType

Hashable AuthorizerType

Methods

hashWithSalt :: Int -> AuthorizerType -> Int

hash :: AuthorizerType -> Int

NFData AuthorizerType

Methods

rnf :: AuthorizerType -> ()

ToHeader AuthorizerType

Methods

toHeader :: HeaderName -> AuthorizerType -> [Header]

ToQuery AuthorizerType

Methods

toQuery :: AuthorizerType -> QueryString

ToByteString AuthorizerType

Methods

toBS :: AuthorizerType -> ByteString

FromText AuthorizerType

Methods

parser :: Parser AuthorizerType

ToText AuthorizerType

Methods

toText :: AuthorizerType -> Text

type Rep AuthorizerType

type Rep AuthorizerType = D1 (MetaData "AuthorizerType" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Token" PrefixI False) U1)

CacheClusterSize

data CacheClusterSize

Returns the size of the CacheCluster.

Constructors

D0_5

D118

D13_5

D1_6

D237

D28_4

D58_2

D6_1

Instances

Bounded CacheClusterSize

Methods

minBound :: CacheClusterSize

maxBound :: CacheClusterSize

Enum CacheClusterSize

Methods

succ :: CacheClusterSize -> CacheClusterSize

pred :: CacheClusterSize -> CacheClusterSize

toEnum :: Int -> CacheClusterSize

fromEnum :: CacheClusterSize -> Int

enumFrom :: CacheClusterSize -> [CacheClusterSize]

enumFromThen :: CacheClusterSize -> CacheClusterSize -> [CacheClusterSize]

enumFromTo :: CacheClusterSize -> CacheClusterSize -> [CacheClusterSize]

enumFromThenTo :: CacheClusterSize -> CacheClusterSize -> CacheClusterSize -> [CacheClusterSize]

Eq CacheClusterSize

Methods

(==) :: CacheClusterSize -> CacheClusterSize -> Bool

(/=) :: CacheClusterSize -> CacheClusterSize -> Bool

Data CacheClusterSize

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

Methods

compare :: CacheClusterSize -> CacheClusterSize -> Ordering

(<) :: CacheClusterSize -> CacheClusterSize -> Bool

(<=) :: CacheClusterSize -> CacheClusterSize -> Bool

(>) :: CacheClusterSize -> CacheClusterSize -> Bool

(>=) :: CacheClusterSize -> CacheClusterSize -> Bool

max :: CacheClusterSize -> CacheClusterSize -> CacheClusterSize

min :: CacheClusterSize -> CacheClusterSize -> CacheClusterSize

Read CacheClusterSize

Methods

readsPrec :: Int -> ReadS CacheClusterSize

readList :: ReadS [CacheClusterSize]

readPrec :: ReadPrec CacheClusterSize

readListPrec :: ReadPrec [CacheClusterSize]

Show CacheClusterSize

Methods

showsPrec :: Int -> CacheClusterSize -> ShowS

show :: CacheClusterSize -> String

showList :: [CacheClusterSize] -> ShowS

Generic CacheClusterSize

Associated Types

type Rep CacheClusterSize :: * -> *

Methods

from :: CacheClusterSize -> Rep CacheClusterSize x

to :: Rep CacheClusterSize x -> CacheClusterSize

ToJSON CacheClusterSize

Methods

toJSON :: CacheClusterSize -> Value

toEncoding :: CacheClusterSize -> Encoding

FromJSON CacheClusterSize

Methods

parseJSON :: Value -> Parser CacheClusterSize

Hashable CacheClusterSize

Methods

hashWithSalt :: Int -> CacheClusterSize -> Int

hash :: CacheClusterSize -> Int

NFData CacheClusterSize

Methods

rnf :: CacheClusterSize -> ()

ToHeader CacheClusterSize

Methods

toHeader :: HeaderName -> CacheClusterSize -> [Header]

ToQuery CacheClusterSize

Methods

toQuery :: CacheClusterSize -> QueryString

ToByteString CacheClusterSize

Methods

toBS :: CacheClusterSize -> ByteString

FromText CacheClusterSize

Methods

parser :: Parser CacheClusterSize

ToText CacheClusterSize

Methods

toText :: CacheClusterSize -> Text

type Rep CacheClusterSize

type Rep CacheClusterSize = D1 (MetaData "CacheClusterSize" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" 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

Returns the status of the CacheCluster.

Constructors

Available

CreateInProgress

DeleteInProgress

FlushInProgress

NotAvailable

Instances

Bounded CacheClusterStatus

Methods

minBound :: CacheClusterStatus

maxBound :: CacheClusterStatus

Enum CacheClusterStatus

Methods

succ :: CacheClusterStatus -> CacheClusterStatus

pred :: CacheClusterStatus -> CacheClusterStatus

toEnum :: Int -> CacheClusterStatus

fromEnum :: CacheClusterStatus -> Int

enumFrom :: CacheClusterStatus -> [CacheClusterStatus]

enumFromThen :: CacheClusterStatus -> CacheClusterStatus -> [CacheClusterStatus]

enumFromTo :: CacheClusterStatus -> CacheClusterStatus -> [CacheClusterStatus]

enumFromThenTo :: CacheClusterStatus -> CacheClusterStatus -> CacheClusterStatus -> [CacheClusterStatus]

Eq CacheClusterStatus

Methods

(==) :: CacheClusterStatus -> CacheClusterStatus -> Bool

(/=) :: CacheClusterStatus -> CacheClusterStatus -> Bool

Data CacheClusterStatus

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

Methods

compare :: CacheClusterStatus -> CacheClusterStatus -> Ordering

(<) :: CacheClusterStatus -> CacheClusterStatus -> Bool

(<=) :: CacheClusterStatus -> CacheClusterStatus -> Bool

(>) :: CacheClusterStatus -> CacheClusterStatus -> Bool

(>=) :: CacheClusterStatus -> CacheClusterStatus -> Bool

max :: CacheClusterStatus -> CacheClusterStatus -> CacheClusterStatus

min :: CacheClusterStatus -> CacheClusterStatus -> CacheClusterStatus

Read CacheClusterStatus

Methods

readsPrec :: Int -> ReadS CacheClusterStatus

readList :: ReadS [CacheClusterStatus]

readPrec :: ReadPrec CacheClusterStatus

readListPrec :: ReadPrec [CacheClusterStatus]

Show CacheClusterStatus

Methods

showsPrec :: Int -> CacheClusterStatus -> ShowS

show :: CacheClusterStatus -> String

showList :: [CacheClusterStatus] -> ShowS

Generic CacheClusterStatus

Associated Types

type Rep CacheClusterStatus :: * -> *

Methods

from :: CacheClusterStatus -> Rep CacheClusterStatus x

to :: Rep CacheClusterStatus x -> CacheClusterStatus

FromJSON CacheClusterStatus

Methods

parseJSON :: Value -> Parser CacheClusterStatus

Hashable CacheClusterStatus

Methods

hashWithSalt :: Int -> CacheClusterStatus -> Int

hash :: CacheClusterStatus -> Int

NFData CacheClusterStatus

Methods

rnf :: CacheClusterStatus -> ()

ToHeader CacheClusterStatus

Methods

toHeader :: HeaderName -> CacheClusterStatus -> [Header]

ToQuery CacheClusterStatus

Methods

toQuery :: CacheClusterStatus -> QueryString

ToByteString CacheClusterStatus

Methods

toBS :: CacheClusterStatus -> ByteString

FromText CacheClusterStatus

Methods

parser :: Parser CacheClusterStatus

ToText CacheClusterStatus

Methods

toText :: CacheClusterStatus -> Text

type Rep CacheClusterStatus

type Rep CacheClusterStatus = D1 (MetaData "CacheClusterStatus" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" 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))))

IntegrationType

data IntegrationType

The integration type. The valid value is HTTP, AWS, or MOCK.

Constructors

AWS

HTTP

Mock

Instances

Bounded IntegrationType

Methods

minBound :: IntegrationType

maxBound :: IntegrationType

Enum IntegrationType

Methods

succ :: IntegrationType -> IntegrationType

pred :: IntegrationType -> IntegrationType

toEnum :: Int -> IntegrationType

fromEnum :: IntegrationType -> Int

enumFrom :: IntegrationType -> [IntegrationType]

enumFromThen :: IntegrationType -> IntegrationType -> [IntegrationType]

enumFromTo :: IntegrationType -> IntegrationType -> [IntegrationType]

enumFromThenTo :: IntegrationType -> IntegrationType -> IntegrationType -> [IntegrationType]

Eq IntegrationType

Methods

(==) :: IntegrationType -> IntegrationType -> Bool

(/=) :: IntegrationType -> IntegrationType -> Bool

Data IntegrationType

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

Methods

compare :: IntegrationType -> IntegrationType -> Ordering

(<) :: IntegrationType -> IntegrationType -> Bool

(<=) :: IntegrationType -> IntegrationType -> Bool

(>) :: IntegrationType -> IntegrationType -> Bool

(>=) :: IntegrationType -> IntegrationType -> Bool

max :: IntegrationType -> IntegrationType -> IntegrationType

min :: IntegrationType -> IntegrationType -> IntegrationType

Read IntegrationType

Methods

readsPrec :: Int -> ReadS IntegrationType

readList :: ReadS [IntegrationType]

readPrec :: ReadPrec IntegrationType

readListPrec :: ReadPrec [IntegrationType]

Show IntegrationType

Methods

showsPrec :: Int -> IntegrationType -> ShowS

show :: IntegrationType -> String

showList :: [IntegrationType] -> ShowS

Generic IntegrationType

Associated Types

type Rep IntegrationType :: * -> *

Methods

from :: IntegrationType -> Rep IntegrationType x

to :: Rep IntegrationType x -> IntegrationType

ToJSON IntegrationType

Methods

toJSON :: IntegrationType -> Value

toEncoding :: IntegrationType -> Encoding

FromJSON IntegrationType

Methods

parseJSON :: Value -> Parser IntegrationType

Hashable IntegrationType

Methods

hashWithSalt :: Int -> IntegrationType -> Int

hash :: IntegrationType -> Int

NFData IntegrationType

Methods

rnf :: IntegrationType -> ()

ToHeader IntegrationType

Methods

toHeader :: HeaderName -> IntegrationType -> [Header]

ToQuery IntegrationType

Methods

toQuery :: IntegrationType -> QueryString

ToByteString IntegrationType

Methods

toBS :: IntegrationType -> ByteString

FromText IntegrationType

Methods

parser :: Parser IntegrationType

ToText IntegrationType

Methods

toText :: IntegrationType -> Text

type Rep IntegrationType

type Rep IntegrationType = D1 (MetaData "IntegrationType" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) ((:+:) (C1 (MetaCons "AWS" PrefixI False) U1) ((:+:) (C1 (MetaCons "HTTP" PrefixI False) U1) (C1 (MetaCons "Mock" PrefixI False) U1)))

Op

data Op

Constructors

Add

Copy

Move

Remove

Replace

Test

Instances

Bounded Op

Methods

minBound :: Op

maxBound :: Op

Enum Op

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

Methods

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

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

Data Op

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

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

Methods

readsPrec :: Int -> ReadS Op

readList :: ReadS [Op]

readPrec :: ReadPrec Op

readListPrec :: ReadPrec [Op]

Show Op

Methods

showsPrec :: Int -> Op -> ShowS

show :: Op -> String

showList :: [Op] -> ShowS

Generic Op

Associated Types

type Rep Op :: * -> *

Methods

from :: Op -> Rep Op x

to :: Rep Op x -> Op

ToJSON Op

Methods

toJSON :: Op -> Value

toEncoding :: Op -> Encoding

Hashable Op

Methods

hashWithSalt :: Int -> Op -> Int

hash :: Op -> Int

NFData Op

Methods

rnf :: Op -> ()

ToHeader Op

Methods

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

ToQuery Op

Methods

toQuery :: Op -> QueryString

ToByteString Op

Methods

toBS :: Op -> ByteString

FromText Op

Methods

parser :: Parser Op

ToText Op

Methods

toText :: Op -> Text

type Rep Op

type Rep Op = D1 (MetaData "Op" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" 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

Constructors

Merge

Overwrite

Instances

Bounded PutMode

Methods

minBound :: PutMode

maxBound :: PutMode

Enum PutMode

Methods

succ :: PutMode -> PutMode

pred :: PutMode -> PutMode

toEnum :: Int -> PutMode

fromEnum :: PutMode -> Int

enumFrom :: PutMode -> [PutMode]

enumFromThen :: PutMode -> PutMode -> [PutMode]

enumFromTo :: PutMode -> PutMode -> [PutMode]

enumFromThenTo :: PutMode -> PutMode -> PutMode -> [PutMode]

Eq PutMode

Methods

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

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

Data PutMode

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

Methods

compare :: PutMode -> PutMode -> Ordering

(<) :: PutMode -> PutMode -> Bool

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

(>) :: PutMode -> PutMode -> Bool

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

max :: PutMode -> PutMode -> PutMode

min :: PutMode -> PutMode -> PutMode

Read PutMode

Methods

readsPrec :: Int -> ReadS PutMode

readList :: ReadS [PutMode]

readPrec :: ReadPrec PutMode

readListPrec :: ReadPrec [PutMode]

Show PutMode

Methods

showsPrec :: Int -> PutMode -> ShowS

show :: PutMode -> String

showList :: [PutMode] -> ShowS

Generic PutMode

Associated Types

type Rep PutMode :: * -> *

Methods

from :: PutMode -> Rep PutMode x

to :: Rep PutMode x -> PutMode

ToJSON PutMode

Methods

toJSON :: PutMode -> Value

toEncoding :: PutMode -> Encoding

Hashable PutMode

Methods

hashWithSalt :: Int -> PutMode -> Int

hash :: PutMode -> Int

NFData PutMode

Methods

rnf :: PutMode -> ()

ToHeader PutMode

Methods

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

ToQuery PutMode

Methods

toQuery :: PutMode -> QueryString

ToByteString PutMode

Methods

toBS :: PutMode -> ByteString

FromText PutMode

Methods

parser :: Parser PutMode

ToText PutMode

Methods

toText :: PutMode -> Text

type Rep PutMode

type Rep PutMode = D1 (MetaData "PutMode" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) ((:+:) (C1 (MetaCons "Merge" PrefixI False) U1) (C1 (MetaCons "Overwrite" PrefixI False) U1))

UnauthorizedCacheControlHeaderStrategy

data UnauthorizedCacheControlHeaderStrategy

Constructors

FailWith403

SucceedWithResponseHeader

SucceedWithoutResponseHeader

Instances

Bounded UnauthorizedCacheControlHeaderStrategy

Methods

minBound :: UnauthorizedCacheControlHeaderStrategy

maxBound :: UnauthorizedCacheControlHeaderStrategy

Enum UnauthorizedCacheControlHeaderStrategy

Methods

succ :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy

pred :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy

toEnum :: Int -> UnauthorizedCacheControlHeaderStrategy

fromEnum :: UnauthorizedCacheControlHeaderStrategy -> Int

enumFrom :: UnauthorizedCacheControlHeaderStrategy -> [UnauthorizedCacheControlHeaderStrategy]

enumFromThen :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> [UnauthorizedCacheControlHeaderStrategy]

enumFromTo :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> [UnauthorizedCacheControlHeaderStrategy]

enumFromThenTo :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> [UnauthorizedCacheControlHeaderStrategy]

Eq UnauthorizedCacheControlHeaderStrategy

Methods

(==) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool

(/=) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool

Data UnauthorizedCacheControlHeaderStrategy

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

Methods

compare :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Ordering

(<) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool

(<=) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool

(>) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool

(>=) :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> Bool

max :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy

min :: UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy -> UnauthorizedCacheControlHeaderStrategy

Read UnauthorizedCacheControlHeaderStrategy

Methods

readsPrec :: Int -> ReadS UnauthorizedCacheControlHeaderStrategy

readList :: ReadS [UnauthorizedCacheControlHeaderStrategy]

readPrec :: ReadPrec UnauthorizedCacheControlHeaderStrategy

readListPrec :: ReadPrec [UnauthorizedCacheControlHeaderStrategy]

Show UnauthorizedCacheControlHeaderStrategy

Methods

showsPrec :: Int -> UnauthorizedCacheControlHeaderStrategy -> ShowS

show :: UnauthorizedCacheControlHeaderStrategy -> String

showList :: [UnauthorizedCacheControlHeaderStrategy] -> ShowS

Generic UnauthorizedCacheControlHeaderStrategy

Associated Types

type Rep UnauthorizedCacheControlHeaderStrategy :: * -> *

Methods

from :: UnauthorizedCacheControlHeaderStrategy -> Rep UnauthorizedCacheControlHeaderStrategy x

to :: Rep UnauthorizedCacheControlHeaderStrategy x -> UnauthorizedCacheControlHeaderStrategy

FromJSON UnauthorizedCacheControlHeaderStrategy

Methods

parseJSON :: Value -> Parser UnauthorizedCacheControlHeaderStrategy

Hashable UnauthorizedCacheControlHeaderStrategy

Methods

hashWithSalt :: Int -> UnauthorizedCacheControlHeaderStrategy -> Int

hash :: UnauthorizedCacheControlHeaderStrategy -> Int

NFData UnauthorizedCacheControlHeaderStrategy

Methods

rnf :: UnauthorizedCacheControlHeaderStrategy -> ()

ToHeader UnauthorizedCacheControlHeaderStrategy

Methods

toHeader :: HeaderName -> UnauthorizedCacheControlHeaderStrategy -> [Header]

ToQuery UnauthorizedCacheControlHeaderStrategy

Methods

toQuery :: UnauthorizedCacheControlHeaderStrategy -> QueryString

ToByteString UnauthorizedCacheControlHeaderStrategy

Methods

toBS :: UnauthorizedCacheControlHeaderStrategy -> ByteString

FromText UnauthorizedCacheControlHeaderStrategy

Methods

parser :: Parser UnauthorizedCacheControlHeaderStrategy

ToText UnauthorizedCacheControlHeaderStrategy

Methods

toText :: UnauthorizedCacheControlHeaderStrategy -> Text

type Rep UnauthorizedCacheControlHeaderStrategy

type Rep UnauthorizedCacheControlHeaderStrategy = D1 (MetaData "UnauthorizedCacheControlHeaderStrategy" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) ((:+:) (C1 (MetaCons "FailWith403" PrefixI False) U1) ((:+:) (C1 (MetaCons "SucceedWithResponseHeader" PrefixI False) U1) (C1 (MetaCons "SucceedWithoutResponseHeader" PrefixI False) U1)))

APIKey

data APIKey

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

See: apiKey smart constructor.

Instances

Eq APIKey

Methods

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

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

Data APIKey

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

Methods

readsPrec :: Int -> ReadS APIKey

readList :: ReadS [APIKey]

readPrec :: ReadPrec APIKey

readListPrec :: ReadPrec [APIKey]

Show APIKey

Methods

showsPrec :: Int -> APIKey -> ShowS

show :: APIKey -> String

showList :: [APIKey] -> ShowS

Generic APIKey

Associated Types

type Rep APIKey :: * -> *

Methods

from :: APIKey -> Rep APIKey x

to :: Rep APIKey x -> APIKey

FromJSON APIKey

Methods

parseJSON :: Value -> Parser APIKey

Hashable APIKey

Methods

hashWithSalt :: Int -> APIKey -> Int

hash :: APIKey -> Int

NFData APIKey

Methods

rnf :: APIKey -> ()

type Rep APIKey

type Rep APIKey = D1 (MetaData "APIKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "APIKey'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_akEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_akCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_akName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_akId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_akStageKeys") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_akLastUpdatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_akDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

apiKey :: APIKey

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
• akCreatedDate
• akName
• akId
• akStageKeys
• akLastUpdatedDate
• akDescription

akEnabled :: Lens' APIKey (Maybe Bool)

Specifies whether the API Key can be used by callers.

akCreatedDate :: Lens' APIKey (Maybe UTCTime)

The date when the API Key was created, in ISO 8601 format.

akName :: Lens' APIKey (Maybe Text)

The name of the API Key.

akId :: Lens' APIKey (Maybe Text)

The identifier of the API Key.

akStageKeys :: Lens' APIKey [Text]

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

akLastUpdatedDate :: Lens' APIKey (Maybe UTCTime)

When the API Key was last updated, in ISO 8601 format.

akDescription :: Lens' APIKey (Maybe Text)

The description of the API Key.

Account

data Account

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

See: account smart constructor.

Instances

Eq Account

Methods

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

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

Data Account

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

Methods

readsPrec :: Int -> ReadS Account

readList :: ReadS [Account]

readPrec :: ReadPrec Account

readListPrec :: ReadPrec [Account]

Show Account

Methods

showsPrec :: Int -> Account -> ShowS

show :: Account -> String

showList :: [Account] -> ShowS

Generic Account

Associated Types

type Rep Account :: * -> *

Methods

from :: Account -> Rep Account x

to :: Rep Account x -> Account

FromJSON Account

Methods

parseJSON :: Value -> Parser Account

Hashable Account

Methods

hashWithSalt :: Int -> Account -> Int

hash :: Account -> Int

NFData Account

Methods

rnf :: Account -> ()

type Rep Account

type Rep Account = D1 (MetaData "Account" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Account'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_aCloudwatchRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aThrottleSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ThrottleSettings)))))

account :: Account

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:

• aCloudwatchRoleARN
• aThrottleSettings

aCloudwatchRoleARN :: Lens' Account (Maybe Text)

Specifies the Amazon resource name (ARN) of an Amazon CloudWatch role for the current Account resource.

aThrottleSettings :: Lens' Account (Maybe ThrottleSettings)

Specifies the application programming interface (API) throttle settings for the current Account resource.

Authorizer

data Authorizer

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

See: authorizer smart constructor.

Instances

Eq Authorizer

Methods

(==) :: Authorizer -> Authorizer -> Bool

(/=) :: Authorizer -> Authorizer -> Bool

Data Authorizer

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

Methods

readsPrec :: Int -> ReadS Authorizer

readList :: ReadS [Authorizer]

readPrec :: ReadPrec Authorizer

readListPrec :: ReadPrec [Authorizer]

Show Authorizer

Methods

showsPrec :: Int -> Authorizer -> ShowS

show :: Authorizer -> String

showList :: [Authorizer] -> ShowS

Generic Authorizer

Associated Types

type Rep Authorizer :: * -> *

Methods

from :: Authorizer -> Rep Authorizer x

to :: Rep Authorizer x -> Authorizer

FromJSON Authorizer

Methods

parseJSON :: Value -> Parser Authorizer

Hashable Authorizer

Methods

hashWithSalt :: Int -> Authorizer -> Int

hash :: Authorizer -> Int

NFData Authorizer

Methods

rnf :: Authorizer -> ()

type Rep Authorizer

type Rep Authorizer = D1 (MetaData "Authorizer" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Authorizer'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aAuthorizerURI") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aIdentityValidationExpression") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_aAuthorizerResultTtlInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_aAuthType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_aType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe AuthorizerType))) ((:*:) (S1 (MetaSel (Just Symbol "_aIdentitySource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_aAuthorizerCredentials") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

authorizer :: Authorizer

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
• aIdentityValidationExpression
• aName
• aId
• aAuthorizerResultTtlInSeconds
• aAuthType
• aType
• aIdentitySource
• aAuthorizerCredentials

aAuthorizerURI :: Lens' Authorizer (Maybe Text)

Required

Specifies the authorizer's Uniform Resource Identifier (URI). For TOKEN authorizers, this must be a well-formed Lambda function URI. The URI should be of the form 'arn:aws:apigateway:{region}:lambda:path/{service_api}'. Region is used to determine the right endpoint. In this case, path is used to indicate that the remaining substring in the URI should be treated as the path to the resource, including the initial \/. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations

aIdentityValidationExpression :: Lens' Authorizer (Maybe Text)

A validation expression for the incoming identity. For TOKEN authorizers, this value should be a regular expression. The incoming token from the client is matched against this expression, and will proceed if the token matches. If the token doesn't match, the client receives a 401 Unauthorized response.

aName :: Lens' Authorizer (Maybe Text)

Required

The name of the authorizer.

aId :: Lens' Authorizer (Maybe Text)

The identifier for the authorizer resource.

aAuthorizerResultTtlInSeconds :: Lens' Authorizer (Maybe Int)

The TTL in seconds of cached authorizer results. If 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)

Optional customer-defined field, used in Swagger imports/exports. Has no functional impact.

aType :: Lens' Authorizer (Maybe AuthorizerType)

Required

The type of the authorizer. Currently, the only valid type is TOKEN.

aIdentitySource :: Lens' Authorizer (Maybe Text)

Required

The source of the identity in an incoming request. For TOKEN authorizers, this value is a mapping expression with the same syntax as integration parameter mappings. The only valid source for tokens is 'header', so the expression should match 'method.request.header.[headerName]'. The value of the header '[headerName]' will be interpreted as the incoming token.

aAuthorizerCredentials :: Lens' Authorizer (Maybe Text)

Specifies the credentials required for the authorizer, if any. Two options are available. 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

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

See: basePathMapping smart constructor.

Instances

Eq BasePathMapping

Methods

(==) :: BasePathMapping -> BasePathMapping -> Bool

(/=) :: BasePathMapping -> BasePathMapping -> Bool

Data BasePathMapping

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

Methods

readsPrec :: Int -> ReadS BasePathMapping

readList :: ReadS [BasePathMapping]

readPrec :: ReadPrec BasePathMapping

readListPrec :: ReadPrec [BasePathMapping]

Show BasePathMapping

Methods

showsPrec :: Int -> BasePathMapping -> ShowS

show :: BasePathMapping -> String

showList :: [BasePathMapping] -> ShowS

Generic BasePathMapping

Associated Types

type Rep BasePathMapping :: * -> *

Methods

from :: BasePathMapping -> Rep BasePathMapping x

to :: Rep BasePathMapping x -> BasePathMapping

FromJSON BasePathMapping

Methods

parseJSON :: Value -> Parser BasePathMapping

Hashable BasePathMapping

Methods

hashWithSalt :: Int -> BasePathMapping -> Int

hash :: BasePathMapping -> Int

NFData BasePathMapping

Methods

rnf :: BasePathMapping -> ()

type Rep BasePathMapping

type Rep BasePathMapping = D1 (MetaData "BasePathMapping" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" 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

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
• bpmBasePath
• bpmRestAPIId

bpmStage :: Lens' BasePathMapping (Maybe Text)

The name of the API's stage.

bpmBasePath :: Lens' BasePathMapping (Maybe Text)

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)

The name of the API.

ClientCertificate

data ClientCertificate

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

See: clientCertificate smart constructor.

Instances

Eq ClientCertificate

Methods

(==) :: ClientCertificate -> ClientCertificate -> Bool

(/=) :: ClientCertificate -> ClientCertificate -> Bool

Data ClientCertificate

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

Methods

readsPrec :: Int -> ReadS ClientCertificate

readList :: ReadS [ClientCertificate]

readPrec :: ReadPrec ClientCertificate

readListPrec :: ReadPrec [ClientCertificate]

Show ClientCertificate

Methods

showsPrec :: Int -> ClientCertificate -> ShowS

show :: ClientCertificate -> String

showList :: [ClientCertificate] -> ShowS

Generic ClientCertificate

Associated Types

type Rep ClientCertificate :: * -> *

Methods

from :: ClientCertificate -> Rep ClientCertificate x

to :: Rep ClientCertificate x -> ClientCertificate

FromJSON ClientCertificate

Methods

parseJSON :: Value -> Parser ClientCertificate

Hashable ClientCertificate

Methods

hashWithSalt :: Int -> ClientCertificate -> Int

hash :: ClientCertificate -> Int

NFData ClientCertificate

Methods

rnf :: ClientCertificate -> ()

type Rep ClientCertificate

type Rep ClientCertificate = D1 (MetaData "ClientCertificate" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" 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 ISO8601))) ((:*:) (S1 (MetaSel (Just Symbol "_ccExpirationDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_ccDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

clientCertificate :: ClientCertificate

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
• ccClientCertificateId
• ccCreatedDate
• ccExpirationDate
• ccDescription

ccPemEncodedCertificate :: Lens' ClientCertificate (Maybe Text)

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

ccClientCertificateId :: Lens' ClientCertificate (Maybe Text)

The identifier of the Client Certificate.

ccCreatedDate :: Lens' ClientCertificate (Maybe UTCTime)

The date when the Client Certificate was created, in ISO 8601 format.

ccExpirationDate :: Lens' ClientCertificate (Maybe UTCTime)

The date when the Client Certificate will expire, in ISO 8601 format.

ccDescription :: Lens' ClientCertificate (Maybe Text)

The description of the Client Certificate.

Deployment

data Deployment

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

See: deployment smart constructor.

Instances

Eq Deployment

Methods

(==) :: Deployment -> Deployment -> Bool

(/=) :: Deployment -> Deployment -> Bool

Data Deployment

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

Methods

readsPrec :: Int -> ReadS Deployment

readList :: ReadS [Deployment]

readPrec :: ReadPrec Deployment

readListPrec :: ReadPrec [Deployment]

Show Deployment

Methods

showsPrec :: Int -> Deployment -> ShowS

show :: Deployment -> String

showList :: [Deployment] -> ShowS

Generic Deployment

Associated Types

type Rep Deployment :: * -> *

Methods

from :: Deployment -> Rep Deployment x

to :: Rep Deployment x -> Deployment

FromJSON Deployment

Methods

parseJSON :: Value -> Parser Deployment

Hashable Deployment

Methods

hashWithSalt :: Int -> Deployment -> Int

hash :: Deployment -> Int

NFData Deployment

Methods

rnf :: Deployment -> ()

type Rep Deployment

type Rep Deployment = D1 (MetaData "Deployment" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" 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 ISO8601)))) ((:*:) (S1 (MetaSel (Just Symbol "_dId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

deployment :: Deployment

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
• dCreatedDate
• dId
• dDescription

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

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

dCreatedDate :: Lens' Deployment (Maybe UTCTime)

The date and time that the deployment resource was created.

dId :: Lens' Deployment (Maybe Text)

The identifier for the deployment resource.

dDescription :: Lens' Deployment (Maybe Text)

The description for the deployment resource.

DomainName

data DomainName

Represents a domain name that is contained in a simpler, more intuitive URL that can be called.

See: domainName smart constructor.

Instances

Eq DomainName

Methods

(==) :: DomainName -> DomainName -> Bool

(/=) :: DomainName -> DomainName -> Bool

Data DomainName

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

Methods

readsPrec :: Int -> ReadS DomainName

readList :: ReadS [DomainName]

readPrec :: ReadPrec DomainName

readListPrec :: ReadPrec [DomainName]

Show DomainName

Methods

showsPrec :: Int -> DomainName -> ShowS

show :: DomainName -> String

showList :: [DomainName] -> ShowS

Generic DomainName

Associated Types

type Rep DomainName :: * -> *

Methods

from :: DomainName -> Rep DomainName x

to :: Rep DomainName x -> DomainName

FromJSON DomainName

Methods

parseJSON :: Value -> Parser DomainName

Hashable DomainName

Methods

hashWithSalt :: Int -> DomainName -> Int

hash :: DomainName -> Int

NFData DomainName

Methods

rnf :: DomainName -> ()

type Rep DomainName

type Rep DomainName = D1 (MetaData "DomainName" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "DomainName'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_dnCertificateName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_dnDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_dnCertificateUploadDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_dnDistributionDomainName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

domainName :: DomainName

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
• dnDomainName
• dnCertificateUploadDate
• dnDistributionDomainName

dnCertificateName :: Lens' DomainName (Maybe Text)

The name of the certificate.

dnDomainName :: Lens' DomainName (Maybe Text)

The name of the DomainName resource.

dnCertificateUploadDate :: Lens' DomainName (Maybe UTCTime)

The date when the certificate was uploaded, in ISO 8601 format.

dnDistributionDomainName :: Lens' DomainName (Maybe Text)

The domain name of the Amazon CloudFront distribution. For more information, see the Amazon CloudFront documentation.

Integration

data Integration

Represents a HTTP, AWS, or Mock integration.

See: integration smart constructor.

Instances

Eq Integration

Methods

(==) :: Integration -> Integration -> Bool

(/=) :: Integration -> Integration -> Bool

Data Integration

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

Methods

readsPrec :: Int -> ReadS Integration

readList :: ReadS [Integration]

readPrec :: ReadPrec Integration

readListPrec :: ReadPrec [Integration]

Show Integration

Methods

showsPrec :: Int -> Integration -> ShowS

show :: Integration -> String

showList :: [Integration] -> ShowS

Generic Integration

Associated Types

type Rep Integration :: * -> *

Methods

from :: Integration -> Rep Integration x

to :: Rep Integration x -> Integration

FromJSON Integration

Methods

parseJSON :: Value -> Parser Integration

Hashable Integration

Methods

hashWithSalt :: Int -> Integration -> Int

hash :: Integration -> Int

NFData Integration

Methods

rnf :: Integration -> ()

type Rep Integration

type Rep Integration = D1 (MetaData "Integration" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" 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 "_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

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
• iRequestTemplates
• iCredentials
• iRequestParameters
• iUri
• iIntegrationResponses
• iCacheNamespace
• iType
• iCacheKeyParameters

iHttpMethod :: Lens' Integration (Maybe Text)

Specifies the integration's HTTP method type.

iRequestTemplates :: Lens' Integration (HashMap Text Text)

Specifies the integration's request templates.

iCredentials :: Lens' Integration (Maybe Text)

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)

Represents requests parameters that are sent with the backend request. Request parameters are represented as a key/value map, with a destination as the key and a source as the value. A source must match an existing method request parameter, or a static value. Static values must be enclosed with single quotes, and be pre-encoded based on their destination in the request. The destination must match the pattern 'integration.request.{location}.{name}', where location is either querystring, path, or header. name must be a valid, unique parameter name.

iUri :: Lens' Integration (Maybe Text)

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 :: Lens' Integration (HashMap Text IntegrationResponse)

Specifies the integration's responses.

iCacheNamespace :: Lens' Integration (Maybe Text)

Specifies the integration's cache namespace.

iType :: Lens' Integration (Maybe IntegrationType)

Specifies the integration's type. The valid value is HTTP, AWS, or MOCK.

iCacheKeyParameters :: Lens' Integration [Text]

Specifies the integration's cache key parameters.

IntegrationResponse

data IntegrationResponse

Represents an integration response. The status code must map to an existing MethodResponse, and parameters and templates can be used to transform the backend response.

See: integrationResponse smart constructor.

Instances

Eq IntegrationResponse

Methods

(==) :: IntegrationResponse -> IntegrationResponse -> Bool

(/=) :: IntegrationResponse -> IntegrationResponse -> Bool

Data IntegrationResponse

Methods

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

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

toConstr :: IntegrationResponse -> Constr

dataTypeOf :: IntegrationResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> IntegrationResponse -> IntegrationResponse

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

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

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

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

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

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

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

Read IntegrationResponse

Methods

readsPrec :: Int -> ReadS IntegrationResponse

readList :: ReadS [IntegrationResponse]

readPrec :: ReadPrec IntegrationResponse

readListPrec :: ReadPrec [IntegrationResponse]

Show IntegrationResponse

Methods

showsPrec :: Int -> IntegrationResponse -> ShowS

show :: IntegrationResponse -> String

showList :: [IntegrationResponse] -> ShowS

Generic IntegrationResponse

Associated Types

type Rep IntegrationResponse :: * -> *

Methods

from :: IntegrationResponse -> Rep IntegrationResponse x

to :: Rep IntegrationResponse x -> IntegrationResponse

FromJSON IntegrationResponse

Methods

parseJSON :: Value -> Parser IntegrationResponse

Hashable IntegrationResponse

Methods

hashWithSalt :: Int -> IntegrationResponse -> Int

hash :: IntegrationResponse -> Int

NFData IntegrationResponse

Methods

rnf :: IntegrationResponse -> ()

type Rep IntegrationResponse

type Rep IntegrationResponse = D1 (MetaData "IntegrationResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "IntegrationResponse'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iResponseTemplates") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_iSelectionPattern") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_iStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))))))

integrationResponse :: IntegrationResponse

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

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

• iResponseTemplates
• iSelectionPattern
• iStatusCode
• iResponseParameters

iResponseTemplates :: Lens' IntegrationResponse (HashMap Text Text)

Specifies the templates used to transform the integration response body. Response templates are represented as a key/value map, with a content-type as the key and a template as the value.

iSelectionPattern :: Lens' IntegrationResponse (Maybe Text)

Specifies the regular expression (regex) pattern used to choose an integration response based on the response from the backend. If the backend is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS backends, the HTTP status code is matched.

iStatusCode :: Lens' IntegrationResponse (Maybe Text)

Specifies the status code that is used to map the integration response to an existing MethodResponse.

iResponseParameters :: Lens' IntegrationResponse (HashMap Text Text)

Represents response parameters that can be read from the backend response. Response parameters are represented as a key/value map, with a destination as the key and a source as the value. A destination must match an existing response parameter in the MethodResponse. The source can be a header from the backend response, or a static value. Static values are specified using enclosing single quotes, and backend response headers can be read using the pattern 'integration.response.header.{name}'.

Method

data Method

Represents a method.

See: method smart constructor.

Instances

Eq Method

Methods

(==) :: Method -> Method -> Bool

(/=) :: Method -> Method -> Bool

Data Method

Methods

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

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

toConstr :: Method -> Constr

dataTypeOf :: Method -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Method -> Method

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

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

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

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

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

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

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

Read Method

Methods

readsPrec :: Int -> ReadS Method

readList :: ReadS [Method]

readPrec :: ReadPrec Method

readListPrec :: ReadPrec [Method]

Show Method

Methods

showsPrec :: Int -> Method -> ShowS

show :: Method -> String

showList :: [Method] -> ShowS

Generic Method

Associated Types

type Rep Method :: * -> *

Methods

from :: Method -> Rep Method x

to :: Rep Method x -> Method

FromJSON Method

Methods

parseJSON :: Value -> Parser Method

Hashable Method

Methods

hashWithSalt :: Int -> Method -> Int

hash :: Method -> Int

NFData Method

Methods

rnf :: Method -> ()

type Rep Method

type Rep Method = D1 (MetaData "Method" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Method'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mMethodResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text MethodResponse)))) (S1 (MetaSel (Just Symbol "_mHttpMethod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_mRequestModels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) (S1 (MetaSel (Just Symbol "_mRequestParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Bool)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mAuthorizerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mAuthorizationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_mApiKeyRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_mMethodIntegration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Integration)))))))

method :: Method

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

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

• mMethodResponses
• mHttpMethod
• mRequestModels
• mRequestParameters
• mAuthorizerId
• mAuthorizationType
• mApiKeyRequired
• mMethodIntegration

mMethodResponses :: Lens' Method (HashMap Text MethodResponse)

Represents available responses that can be sent to the caller. Method responses are represented as a key/value map, with an HTTP status code as the key and a MethodResponse as the value. The status codes are available for the Integration responses to map to.

mHttpMethod :: Lens' Method (Maybe Text)

The HTTP method.

mRequestModels :: Lens' Method (HashMap Text Text)

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

mRequestParameters :: Lens' Method (HashMap Text Bool)

Represents request parameters that can be accepted by Amazon API Gateway. Request parameters are represented as a key/value map, with a source as the key and a Boolean flag as the value. The Boolean flag is used to specify whether the parameter is required. A source must match the pattern 'method.request.{location}.{name}', where location is either querystring, path, or header. name is a valid, unique parameter name. Sources specified here are available to the integration for mapping to integration request parameters or templates.

mAuthorizerId :: Lens' Method (Maybe Text)

Specifies the identifier of an Authorizer to use on this Method. The authorizationType must be CUSTOM.

mAuthorizationType :: Lens' Method (Maybe Text)

The method's authorization type.

mApiKeyRequired :: Lens' Method (Maybe Bool)

Specifies whether the method requires a valid ApiKey.

mMethodIntegration :: Lens' Method (Maybe Integration)

The method's integration.

MethodResponse

data MethodResponse

Represents a method response. Amazon API Gateway sends back the status code to the caller as the HTTP status code. Parameters and models can be used to transform the response from the method's integration.

See: methodResponse smart constructor.

Instances

Eq MethodResponse

Methods

(==) :: MethodResponse -> MethodResponse -> Bool

(/=) :: MethodResponse -> MethodResponse -> Bool

Data MethodResponse

Methods

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

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

toConstr :: MethodResponse -> Constr

dataTypeOf :: MethodResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> MethodResponse -> MethodResponse

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

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

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

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

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

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

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

Read MethodResponse

Methods

readsPrec :: Int -> ReadS MethodResponse

readList :: ReadS [MethodResponse]

readPrec :: ReadPrec MethodResponse

readListPrec :: ReadPrec [MethodResponse]

Show MethodResponse

Methods

showsPrec :: Int -> MethodResponse -> ShowS

show :: MethodResponse -> String

showList :: [MethodResponse] -> ShowS

Generic MethodResponse

Associated Types

type Rep MethodResponse :: * -> *

Methods

from :: MethodResponse -> Rep MethodResponse x

to :: Rep MethodResponse x -> MethodResponse

FromJSON MethodResponse

Methods

parseJSON :: Value -> Parser MethodResponse

Hashable MethodResponse

Methods

hashWithSalt :: Int -> MethodResponse -> Int

hash :: MethodResponse -> Int

NFData MethodResponse

Methods

rnf :: MethodResponse -> ()

type Rep MethodResponse

type Rep MethodResponse = D1 (MetaData "MethodResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "MethodResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_mResponseModels") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_mStatusCode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mResponseParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Bool)))))))

methodResponse :: MethodResponse

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

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

• mResponseModels
• mStatusCode
• mResponseParameters

mResponseModels :: Lens' MethodResponse (HashMap Text Text)

Specifies the Model resources used for the response's content-type. Response models are represented as a key/value map, with a content-type as the key and a Model name as the value.

mStatusCode :: Lens' MethodResponse (Maybe Text)

The method response's status code.

mResponseParameters :: Lens' MethodResponse (HashMap Text Bool)

Represents response parameters that can be sent back to the caller by Amazon API Gateway. Response parameters are represented as a key/value map, with a destination as the key and a boolean flag as the value, which is used to specify whether the parameter is required. A destination must match the pattern 'method.response.header.{name}', where name is a valid, unique header name. Destinations specified here are available to the integration for mapping from integration response parameters.

MethodSetting

data MethodSetting

Specifies the method setting properties.

See: methodSetting smart constructor.

Instances

Eq MethodSetting

Methods

(==) :: MethodSetting -> MethodSetting -> Bool

(/=) :: MethodSetting -> MethodSetting -> Bool

Data MethodSetting

Methods

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

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

toConstr :: MethodSetting -> Constr

dataTypeOf :: MethodSetting -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> MethodSetting -> MethodSetting

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

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

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

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

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

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

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

Read MethodSetting

Methods

readsPrec :: Int -> ReadS MethodSetting

readList :: ReadS [MethodSetting]

readPrec :: ReadPrec MethodSetting

readListPrec :: ReadPrec [MethodSetting]

Show MethodSetting

Methods

showsPrec :: Int -> MethodSetting -> ShowS

show :: MethodSetting -> String

showList :: [MethodSetting] -> ShowS

Generic MethodSetting

Associated Types

type Rep MethodSetting :: * -> *

Methods

from :: MethodSetting -> Rep MethodSetting x

to :: Rep MethodSetting x -> MethodSetting

FromJSON MethodSetting

Methods

parseJSON :: Value -> Parser MethodSetting

Hashable MethodSetting

Methods

hashWithSalt :: Int -> MethodSetting -> Int

hash :: MethodSetting -> Int

NFData MethodSetting

Methods

rnf :: MethodSetting -> ()

type Rep MethodSetting

type Rep MethodSetting = D1 (MetaData "MethodSetting" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "MethodSetting'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_msCacheTtlInSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_msDataTraceEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_msThrottlingBurstLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_msCacheDataEncrypted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_msLoggingLevel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_msRequireAuthorizationForCacheControl") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_msCachingEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_msMetricsEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_msThrottlingRateLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double))) (S1 (MetaSel (Just Symbol "_msUnauthorizedCacheControlHeaderStrategy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe UnauthorizedCacheControlHeaderStrategy))))))))

methodSetting :: MethodSetting

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

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

• msCacheTtlInSeconds
• msDataTraceEnabled
• msThrottlingBurstLimit
• msCacheDataEncrypted
• msLoggingLevel
• msRequireAuthorizationForCacheControl
• msCachingEnabled
• msMetricsEnabled
• msThrottlingRateLimit
• msUnauthorizedCacheControlHeaderStrategy

msCacheTtlInSeconds :: Lens' MethodSetting (Maybe Int)

Specifies the time to live (TTL) in seconds, for cached responses. The higher a the TTL, the longer the response will be cached. The PATCH path for this setting is '/{method_setting_key}/caching/ttlInSeconds', and the value is an integer.

msDataTraceEnabled :: Lens' MethodSetting (Maybe Bool)

Specifies the whether data trace logging is enabled for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is '/{method_setting_key}/logging/dataTrace', and the value is a Boolean.

msThrottlingBurstLimit :: Lens' MethodSetting (Maybe Int)

Specifies the throttling burst limit. The PATCH path for this setting is '/{method_setting_key}/throttling/burstLimit', and the value is an integer.

msCacheDataEncrypted :: Lens' MethodSetting (Maybe Bool)

Specifies whether the cached responses are encrypted. The PATCH path for this setting is '/{method_setting_key}/caching/dataEncrypted', and the value is a Boolean.

msLoggingLevel :: Lens' MethodSetting (Maybe Text)

Specifies the logging level for this method, which effects the log entries pushed to Amazon CloudWatch Logs. The PATCH path for this setting is '/{method_setting_key}/logging/loglevel', and the available levels are OFF, ERROR, and INFO.

msRequireAuthorizationForCacheControl :: Lens' MethodSetting (Maybe Bool)

Specifies whether authorization is required for a cache invalidation request. The PATCH path for this setting is '/{method_setting_key}/caching/requireAuthorizationForCacheControl', and the value is a Boolean.

msCachingEnabled :: Lens' MethodSetting (Maybe Bool)

Specifies whether responses should be cached and returned for requests. A cache cluster must be enabled on the stage for responses to be cached. The PATCH path for this setting is '/{method_setting_key}/caching/enabled', and the value is a Boolean.

msMetricsEnabled :: Lens' MethodSetting (Maybe Bool)

Specifies whether Amazon CloudWatch metrics are enabled for this method. The PATCH path for this setting is '/{method_setting_key}/metrics/enabled', and the value is a Boolean.

msThrottlingRateLimit :: Lens' MethodSetting (Maybe Double)

Specifies the throttling rate limit. The PATCH path for this setting is '/{method_setting_key}/throttling/rateLimit', and the value is a double.

msUnauthorizedCacheControlHeaderStrategy :: Lens' MethodSetting (Maybe UnauthorizedCacheControlHeaderStrategy)

Specifies the strategy on how to handle the unauthorized requests for cache invalidation. The PATCH path for this setting is '/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy', and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

MethodSnapshot

data MethodSnapshot

Represents a summary of a Method resource, given a particular date and time.

See: methodSnapshot smart constructor.

Instances

Eq MethodSnapshot

Methods

(==) :: MethodSnapshot -> MethodSnapshot -> Bool

(/=) :: MethodSnapshot -> MethodSnapshot -> Bool

Data MethodSnapshot

Methods

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

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

toConstr :: MethodSnapshot -> Constr

dataTypeOf :: MethodSnapshot -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> MethodSnapshot -> MethodSnapshot

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

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

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

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

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

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

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

Read MethodSnapshot

Methods

readsPrec :: Int -> ReadS MethodSnapshot

readList :: ReadS [MethodSnapshot]

readPrec :: ReadPrec MethodSnapshot

readListPrec :: ReadPrec [MethodSnapshot]

Show MethodSnapshot

Methods

showsPrec :: Int -> MethodSnapshot -> ShowS

show :: MethodSnapshot -> String

showList :: [MethodSnapshot] -> ShowS

Generic MethodSnapshot

Associated Types

type Rep MethodSnapshot :: * -> *

Methods

from :: MethodSnapshot -> Rep MethodSnapshot x

to :: Rep MethodSnapshot x -> MethodSnapshot

FromJSON MethodSnapshot

Methods

parseJSON :: Value -> Parser MethodSnapshot

Hashable MethodSnapshot

Methods

hashWithSalt :: Int -> MethodSnapshot -> Int

hash :: MethodSnapshot -> Int

NFData MethodSnapshot

Methods

rnf :: MethodSnapshot -> ()

type Rep MethodSnapshot

type Rep MethodSnapshot = D1 (MetaData "MethodSnapshot" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "MethodSnapshot'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_msAuthorizationType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_msApiKeyRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))))

methodSnapshot :: MethodSnapshot

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

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

• msAuthorizationType
• msApiKeyRequired

msAuthorizationType :: Lens' MethodSnapshot (Maybe Text)

Specifies the type of authorization used for the method.

msApiKeyRequired :: Lens' MethodSnapshot (Maybe Bool)

Specifies whether the method requires a valid ApiKey.

Model

data Model

Represents the structure of a request or response payload for a method.

See: model smart constructor.

Instances

Eq Model

Methods

(==) :: Model -> Model -> Bool

(/=) :: Model -> Model -> Bool

Data Model

Methods

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

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

toConstr :: Model -> Constr

dataTypeOf :: Model -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Model -> Model

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

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

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

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

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

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

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

Read Model

Methods

readsPrec :: Int -> ReadS Model

readList :: ReadS [Model]

readPrec :: ReadPrec Model

readListPrec :: ReadPrec [Model]

Show Model

Methods

showsPrec :: Int -> Model -> ShowS

show :: Model -> String

showList :: [Model] -> ShowS

Generic Model

Associated Types

type Rep Model :: * -> *

Methods

from :: Model -> Rep Model x

to :: Rep Model x -> Model

FromJSON Model

Methods

parseJSON :: Value -> Parser Model

Hashable Model

Methods

hashWithSalt :: Int -> Model -> Int

hash :: Model -> Int

NFData Model

Methods

rnf :: Model -> ()

type Rep Model

type Rep Model = D1 (MetaData "Model" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Model'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_mSchema") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_mId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_mDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_mContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

model :: Model

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

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

• mSchema
• mName
• mId
• mDescription
• mContentType

mSchema :: Lens' Model (Maybe Text)

The schema for the model. For 'application\/json' models, this should be JSON-schema draft v4 model.

mName :: Lens' Model (Maybe Text)

The name of the model.

mId :: Lens' Model (Maybe Text)

The identifier for the model resource.

mDescription :: Lens' Model (Maybe Text)

The description of the model.

mContentType :: Lens' Model (Maybe Text)

The content-type for the model.

PatchOperation

data PatchOperation

A single patch operation to apply to the specified resource. Please refer to http://tools.ietf.org/html/rfc6902#section-4 for an explanation of how each operation is used.

See: patchOperation smart constructor.

Instances

Eq PatchOperation

Methods

(==) :: PatchOperation -> PatchOperation -> Bool

(/=) :: PatchOperation -> PatchOperation -> Bool

Data PatchOperation

Methods

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

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

toConstr :: PatchOperation -> Constr

dataTypeOf :: PatchOperation -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> PatchOperation -> PatchOperation

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

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

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

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

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

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

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

Read PatchOperation

Methods

readsPrec :: Int -> ReadS PatchOperation

readList :: ReadS [PatchOperation]

readPrec :: ReadPrec PatchOperation

readListPrec :: ReadPrec [PatchOperation]

Show PatchOperation

Methods

showsPrec :: Int -> PatchOperation -> ShowS

show :: PatchOperation -> String

showList :: [PatchOperation] -> ShowS

Generic PatchOperation

Associated Types

type Rep PatchOperation :: * -> *

Methods

from :: PatchOperation -> Rep PatchOperation x

to :: Rep PatchOperation x -> PatchOperation

ToJSON PatchOperation

Methods

toJSON :: PatchOperation -> Value

toEncoding :: PatchOperation -> Encoding

Hashable PatchOperation

Methods

hashWithSalt :: Int -> PatchOperation -> Int

hash :: PatchOperation -> Int

NFData PatchOperation

Methods

rnf :: PatchOperation -> ()

type Rep PatchOperation

type Rep PatchOperation = D1 (MetaData "PatchOperation" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "PatchOperation'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_poOp") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Op))) (S1 (MetaSel (Just Symbol "_poPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_poValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_poFrom") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

patchOperation :: PatchOperation

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

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

• poOp
• poPath
• poValue
• poFrom

poOp :: Lens' PatchOperation (Maybe Op)

A patch operation whose value indicates the operation to perform. Its value MUST be one of "add", "remove", "replace", "move", "copy", or "test"; other values are errors.

poPath :: Lens' PatchOperation (Maybe Text)

Operation objects MUST have exactly one "path" member. That member's value is a string containing a `JSON-Pointer` value that references a location within the target document (the "target location") where the operation is performed.

poValue :: Lens' PatchOperation (Maybe Text)

The actual value content.

poFrom :: Lens' PatchOperation (Maybe Text)

The "move" and "copy" operation object MUST contain a "from" member, which is a string containing a 'JSON Pointer' value that references the location in the target document to move the value from.

Resource

data Resource

Represents a resource.

See: resource smart constructor.

Instances

Eq Resource

Methods

(==) :: Resource -> Resource -> Bool

(/=) :: Resource -> Resource -> Bool

Data Resource

Methods

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

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

toConstr :: Resource -> Constr

dataTypeOf :: Resource -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Resource -> Resource

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

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

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

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

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

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

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

Read Resource

Methods

readsPrec :: Int -> ReadS Resource

readList :: ReadS [Resource]

readPrec :: ReadPrec Resource

readListPrec :: ReadPrec [Resource]

Show Resource

Methods

showsPrec :: Int -> Resource -> ShowS

show :: Resource -> String

showList :: [Resource] -> ShowS

Generic Resource

Associated Types

type Rep Resource :: * -> *

Methods

from :: Resource -> Rep Resource x

to :: Rep Resource x -> Resource

FromJSON Resource

Methods

parseJSON :: Value -> Parser Resource

Hashable Resource

Methods

hashWithSalt :: Int -> Resource -> Int

hash :: Resource -> Int

NFData Resource

Methods

rnf :: Resource -> ()

type Rep Resource

type Rep Resource = D1 (MetaData "Resource" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Resource'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_rPathPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_rPath") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_rId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_rResourceMethods") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Method)))) (S1 (MetaSel (Just Symbol "_rParentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

resource :: Resource

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

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

• rPathPart
• rPath
• rId
• rResourceMethods
• rParentId

rPathPart :: Lens' Resource (Maybe Text)

The last path segment for this resource.

rPath :: Lens' Resource (Maybe Text)

The full path for this resource.

rId :: Lens' Resource (Maybe Text)

The resource's identifier.

rResourceMethods :: Lens' Resource (HashMap Text Method)

Map of methods for this resource, which is included only if the request uses the embed query option.

rParentId :: Lens' Resource (Maybe Text)

The parent resource's identifier.

RestAPI

data RestAPI

Represents a REST API.

See: restAPI smart constructor.

Instances

Eq RestAPI

Methods

(==) :: RestAPI -> RestAPI -> Bool

(/=) :: RestAPI -> RestAPI -> Bool

Data RestAPI

Methods

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

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

toConstr :: RestAPI -> Constr

dataTypeOf :: RestAPI -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> RestAPI -> RestAPI

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

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

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

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

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

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

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

Read RestAPI

Methods

readsPrec :: Int -> ReadS RestAPI

readList :: ReadS [RestAPI]

readPrec :: ReadPrec RestAPI

readListPrec :: ReadPrec [RestAPI]

Show RestAPI

Methods

showsPrec :: Int -> RestAPI -> ShowS

show :: RestAPI -> String

showList :: [RestAPI] -> ShowS

Generic RestAPI

Associated Types

type Rep RestAPI :: * -> *

Methods

from :: RestAPI -> Rep RestAPI x

to :: Rep RestAPI x -> RestAPI

FromJSON RestAPI

Methods

parseJSON :: Value -> Parser RestAPI

Hashable RestAPI

Methods

hashWithSalt :: Int -> RestAPI -> Int

hash :: RestAPI -> Int

NFData RestAPI

Methods

rnf :: RestAPI -> ()

type Rep RestAPI

type Rep RestAPI = D1 (MetaData "RestAPI" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "RestAPI'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_raWarnings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_raCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601)))) ((:*:) (S1 (MetaSel (Just Symbol "_raName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_raId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_raDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

restAPI :: RestAPI

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

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

• raWarnings
• raCreatedDate
• raName
• raId
• raDescription

raWarnings :: Lens' RestAPI [Text]

Undocumented member.

raCreatedDate :: Lens' RestAPI (Maybe UTCTime)

The date when the API was created, in ISO 8601 format.

raName :: Lens' RestAPI (Maybe Text)

The API's name.

raId :: Lens' RestAPI (Maybe Text)

The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

raDescription :: Lens' RestAPI (Maybe Text)

The API's description.

Stage

data Stage

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

See: stage smart constructor.

Instances

Eq Stage

Methods

(==) :: Stage -> Stage -> Bool

(/=) :: Stage -> Stage -> Bool

Data Stage

Methods

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

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

toConstr :: Stage -> Constr

dataTypeOf :: Stage -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> Stage -> Stage

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

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

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

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

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

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

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

Read Stage

Methods

readsPrec :: Int -> ReadS Stage

readList :: ReadS [Stage]

readPrec :: ReadPrec Stage

readListPrec :: ReadPrec [Stage]

Show Stage

Methods

showsPrec :: Int -> Stage -> ShowS

show :: Stage -> String

showList :: [Stage] -> ShowS

Generic Stage

Associated Types

type Rep Stage :: * -> *

Methods

from :: Stage -> Rep Stage x

to :: Rep Stage x -> Stage

FromJSON Stage

Methods

parseJSON :: Value -> Parser Stage

Hashable Stage

Methods

hashWithSalt :: Int -> Stage -> Int

hash :: Stage -> Int

NFData Stage

Methods

rnf :: Stage -> ()

type Rep Stage

type Rep Stage = D1 (MetaData "Stage" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "Stage'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sDeploymentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sVariables") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_sClientCertificateId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_sCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_sCacheClusterStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterStatus)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_sMethodSettings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text MethodSetting)))) ((:*:) (S1 (MetaSel (Just Symbol "_sLastUpdatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ISO8601))) (S1 (MetaSel (Just Symbol "_sCacheClusterSize") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe CacheClusterSize))))) ((:*:) (S1 (MetaSel (Just Symbol "_sCacheClusterEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_sStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_sDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))))

stage :: Stage

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

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

• sDeploymentId
• sVariables
• sClientCertificateId
• sCreatedDate
• sCacheClusterStatus
• sMethodSettings
• sLastUpdatedDate
• sCacheClusterSize
• sCacheClusterEnabled
• sStageName
• sDescription

sDeploymentId :: Lens' Stage (Maybe Text)

The identifier of the Deployment that the stage points to.

sVariables :: Lens' Stage (HashMap Text Text)

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

sClientCertificateId :: Lens' Stage (Maybe Text)

Undocumented member.

sCreatedDate :: Lens' Stage (Maybe UTCTime)

The date and time that the stage was created, in ISO 8601 format.

sCacheClusterStatus :: Lens' Stage (Maybe CacheClusterStatus)

The status of the cache cluster for the stage, if enabled.

sMethodSettings :: Lens' Stage (HashMap Text MethodSetting)

A map that defines the method settings for a Stage resource. Keys are defined as '{resource_path}/{http_method}' for an individual method override, or \\*\/\\* for the settings applied to all methods in the stage.

sLastUpdatedDate :: Lens' Stage (Maybe UTCTime)

The date and time that information about the stage was last updated, in ISO 8601 format.

sCacheClusterSize :: Lens' Stage (Maybe CacheClusterSize)

The size of the cache cluster for the stage, if enabled.

sCacheClusterEnabled :: Lens' Stage (Maybe Bool)

Specifies whether a cache cluster is enabled for the stage.

sStageName :: Lens' Stage (Maybe Text)

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.

sDescription :: Lens' Stage (Maybe Text)

The stage's description.

StageKey

data StageKey

A reference to a unique stage identified in the format '{restApiId}/{stage}'.

See: stageKey smart constructor.

Instances

Eq StageKey

Methods

(==) :: StageKey -> StageKey -> Bool

(/=) :: StageKey -> StageKey -> Bool

Data StageKey

Methods

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

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

toConstr :: StageKey -> Constr

dataTypeOf :: StageKey -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> StageKey -> StageKey

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

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

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

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

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

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

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

Read StageKey

Methods

readsPrec :: Int -> ReadS StageKey

readList :: ReadS [StageKey]

readPrec :: ReadPrec StageKey

readListPrec :: ReadPrec [StageKey]

Show StageKey

Methods

showsPrec :: Int -> StageKey -> ShowS

show :: StageKey -> String

showList :: [StageKey] -> ShowS

Generic StageKey

Associated Types

type Rep StageKey :: * -> *

Methods

from :: StageKey -> Rep StageKey x

to :: Rep StageKey x -> StageKey

ToJSON StageKey

Methods

toJSON :: StageKey -> Value

toEncoding :: StageKey -> Encoding

Hashable StageKey

Methods

hashWithSalt :: Int -> StageKey -> Int

hash :: StageKey -> Int

NFData StageKey

Methods

rnf :: StageKey -> ()

type Rep StageKey

type Rep StageKey = D1 (MetaData "StageKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "StageKey'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_skRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_skStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

stageKey :: StageKey

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

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

• skRestAPIId
• skStageName

skRestAPIId :: Lens' StageKey (Maybe Text)

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

skStageName :: Lens' StageKey (Maybe Text)

The stage name in the RestApi that the stage key references.

ThrottleSettings

data ThrottleSettings

Returns the throttle settings.

See: throttleSettings smart constructor.

Instances

Eq ThrottleSettings

Methods

(==) :: ThrottleSettings -> ThrottleSettings -> Bool

(/=) :: ThrottleSettings -> ThrottleSettings -> Bool

Data ThrottleSettings

Methods

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

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

toConstr :: ThrottleSettings -> Constr

dataTypeOf :: ThrottleSettings -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ThrottleSettings -> ThrottleSettings

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

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

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

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

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

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

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

Read ThrottleSettings

Methods

readsPrec :: Int -> ReadS ThrottleSettings

readList :: ReadS [ThrottleSettings]

readPrec :: ReadPrec ThrottleSettings

readListPrec :: ReadPrec [ThrottleSettings]

Show ThrottleSettings

Methods

showsPrec :: Int -> ThrottleSettings -> ShowS

show :: ThrottleSettings -> String

showList :: [ThrottleSettings] -> ShowS

Generic ThrottleSettings

Associated Types

type Rep ThrottleSettings :: * -> *

Methods

from :: ThrottleSettings -> Rep ThrottleSettings x

to :: Rep ThrottleSettings x -> ThrottleSettings

FromJSON ThrottleSettings

Methods

parseJSON :: Value -> Parser ThrottleSettings

Hashable ThrottleSettings

Methods

hashWithSalt :: Int -> ThrottleSettings -> Int

hash :: ThrottleSettings -> Int

NFData ThrottleSettings

Methods

rnf :: ThrottleSettings -> ()

type Rep ThrottleSettings

type Rep ThrottleSettings = D1 (MetaData "ThrottleSettings" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.2-1ZfIGe0X9Tw3KKubfE7kqg" False) (C1 (MetaCons "ThrottleSettings'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_tsBurstLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) (S1 (MetaSel (Just Symbol "_tsRateLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Double)))))

throttleSettings :: ThrottleSettings

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

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

• tsBurstLimit
• tsRateLimit

tsBurstLimit :: Lens' ThrottleSettings (Maybe Int)

Returns the burstLimit when ThrottleSettings is called.

tsRateLimit :: Lens' ThrottleSettings (Maybe Double)

Returns the rateLimit when ThrottleSettings is called.