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.

APIKeysFormat

data APIKeysFormat

Constructors

CSV

Instances

Bounded APIKeysFormat

Methods

minBound :: APIKeysFormat

maxBound :: APIKeysFormat

Enum APIKeysFormat

Methods

succ :: APIKeysFormat -> APIKeysFormat

pred :: APIKeysFormat -> APIKeysFormat

toEnum :: Int -> APIKeysFormat

fromEnum :: APIKeysFormat -> Int

enumFrom :: APIKeysFormat -> [APIKeysFormat]

enumFromThen :: APIKeysFormat -> APIKeysFormat -> [APIKeysFormat]

enumFromTo :: APIKeysFormat -> APIKeysFormat -> [APIKeysFormat]

enumFromThenTo :: APIKeysFormat -> APIKeysFormat -> APIKeysFormat -> [APIKeysFormat]

Eq APIKeysFormat

Methods

(==) :: APIKeysFormat -> APIKeysFormat -> Bool

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

Data APIKeysFormat

Methods

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

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

toConstr :: APIKeysFormat -> Constr

dataTypeOf :: APIKeysFormat -> DataType

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

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

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

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

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

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

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

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

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

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

Ord APIKeysFormat

Methods

compare :: APIKeysFormat -> APIKeysFormat -> Ordering

(<) :: APIKeysFormat -> APIKeysFormat -> Bool

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

(>) :: APIKeysFormat -> APIKeysFormat -> Bool

(>=) :: APIKeysFormat -> APIKeysFormat -> Bool

max :: APIKeysFormat -> APIKeysFormat -> APIKeysFormat

min :: APIKeysFormat -> APIKeysFormat -> APIKeysFormat

Read APIKeysFormat

Methods

readsPrec :: Int -> ReadS APIKeysFormat

readList :: ReadS [APIKeysFormat]

readPrec :: ReadPrec APIKeysFormat

readListPrec :: ReadPrec [APIKeysFormat]

Show APIKeysFormat

Methods

showsPrec :: Int -> APIKeysFormat -> ShowS

show :: APIKeysFormat -> String

showList :: [APIKeysFormat] -> ShowS

Generic APIKeysFormat

Associated Types

type Rep APIKeysFormat :: * -> *

Methods

from :: APIKeysFormat -> Rep APIKeysFormat x

to :: Rep APIKeysFormat x -> APIKeysFormat

Hashable APIKeysFormat

Methods

hashWithSalt :: Int -> APIKeysFormat -> Int

hash :: APIKeysFormat -> Int

NFData APIKeysFormat

Methods

rnf :: APIKeysFormat -> ()

ToHeader APIKeysFormat

Methods

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

ToQuery APIKeysFormat

Methods

toQuery :: APIKeysFormat -> QueryString

ToByteString APIKeysFormat

Methods

toBS :: APIKeysFormat -> ByteString

ToJSON APIKeysFormat

Methods

toJSON :: APIKeysFormat -> Value

toEncoding :: APIKeysFormat -> Encoding

FromText APIKeysFormat

Methods

parser :: Parser APIKeysFormat

ToText APIKeysFormat

Methods

toText :: APIKeysFormat -> Text

type Rep APIKeysFormat

type Rep APIKeysFormat = D1 (MetaData "APIKeysFormat" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" False) (C1 (MetaCons "CSV" PrefixI False) U1)

AuthorizerType

data AuthorizerType

The authorizer type. the only current value is TOKEN.

Constructors

CognitoUserPools

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

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

FromJSON AuthorizerType

Methods

parseJSON :: Value -> Parser AuthorizerType

ToJSON AuthorizerType

Methods

toJSON :: AuthorizerType -> Value

toEncoding :: AuthorizerType -> Encoding

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.4-IZnuIXoXoORFOGBhN7tIo9" False) ((:+:) (C1 (MetaCons "CognitoUserPools" PrefixI False) U1) (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

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

FromJSON CacheClusterSize

Methods

parseJSON :: Value -> Parser CacheClusterSize

ToJSON CacheClusterSize

Methods

toJSON :: CacheClusterSize -> Value

toEncoding :: CacheClusterSize -> Encoding

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.4-IZnuIXoXoORFOGBhN7tIo9" 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

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

FromJSON CacheClusterStatus

Methods

parseJSON :: Value -> Parser CacheClusterStatus

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.4-IZnuIXoXoORFOGBhN7tIo9" 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

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

FromJSON IntegrationType

Methods

parseJSON :: Value -> Parser IntegrationType

ToJSON IntegrationType

Methods

toJSON :: IntegrationType -> Value

toEncoding :: IntegrationType -> Encoding

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.4-IZnuIXoXoORFOGBhN7tIo9" 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

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

ToJSON Op

Methods

toJSON :: Op -> Value

toEncoding :: Op -> Encoding

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.4-IZnuIXoXoORFOGBhN7tIo9" 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

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

ToJSON PutMode

Methods

toJSON :: PutMode -> Value

toEncoding :: PutMode -> Encoding

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.4-IZnuIXoXoORFOGBhN7tIo9" False) ((:+:) (C1 (MetaCons "Merge" PrefixI False) U1) (C1 (MetaCons "Overwrite" PrefixI False) U1))

QuotaPeriodType

data QuotaPeriodType

Constructors

Day

Month

Week

Instances

Bounded QuotaPeriodType

Methods

minBound :: QuotaPeriodType

maxBound :: QuotaPeriodType

Enum QuotaPeriodType

Methods

succ :: QuotaPeriodType -> QuotaPeriodType

pred :: QuotaPeriodType -> QuotaPeriodType

toEnum :: Int -> QuotaPeriodType

fromEnum :: QuotaPeriodType -> Int

enumFrom :: QuotaPeriodType -> [QuotaPeriodType]

enumFromThen :: QuotaPeriodType -> QuotaPeriodType -> [QuotaPeriodType]

enumFromTo :: QuotaPeriodType -> QuotaPeriodType -> [QuotaPeriodType]

enumFromThenTo :: QuotaPeriodType -> QuotaPeriodType -> QuotaPeriodType -> [QuotaPeriodType]

Eq QuotaPeriodType

Methods

(==) :: QuotaPeriodType -> QuotaPeriodType -> Bool

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

Data QuotaPeriodType

Methods

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

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

toConstr :: QuotaPeriodType -> Constr

dataTypeOf :: QuotaPeriodType -> DataType

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

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

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

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

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

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

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

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

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

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

Ord QuotaPeriodType

Methods

compare :: QuotaPeriodType -> QuotaPeriodType -> Ordering

(<) :: QuotaPeriodType -> QuotaPeriodType -> Bool

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

(>) :: QuotaPeriodType -> QuotaPeriodType -> Bool

(>=) :: QuotaPeriodType -> QuotaPeriodType -> Bool

max :: QuotaPeriodType -> QuotaPeriodType -> QuotaPeriodType

min :: QuotaPeriodType -> QuotaPeriodType -> QuotaPeriodType

Read QuotaPeriodType

Methods

readsPrec :: Int -> ReadS QuotaPeriodType

readList :: ReadS [QuotaPeriodType]

readPrec :: ReadPrec QuotaPeriodType

readListPrec :: ReadPrec [QuotaPeriodType]

Show QuotaPeriodType

Methods

showsPrec :: Int -> QuotaPeriodType -> ShowS

show :: QuotaPeriodType -> String

showList :: [QuotaPeriodType] -> ShowS

Generic QuotaPeriodType

Associated Types

type Rep QuotaPeriodType :: * -> *

Methods

from :: QuotaPeriodType -> Rep QuotaPeriodType x

to :: Rep QuotaPeriodType x -> QuotaPeriodType

Hashable QuotaPeriodType

Methods

hashWithSalt :: Int -> QuotaPeriodType -> Int

hash :: QuotaPeriodType -> Int

NFData QuotaPeriodType

Methods

rnf :: QuotaPeriodType -> ()

ToHeader QuotaPeriodType

Methods

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

ToQuery QuotaPeriodType

Methods

toQuery :: QuotaPeriodType -> QueryString

ToByteString QuotaPeriodType

Methods

toBS :: QuotaPeriodType -> ByteString

FromJSON QuotaPeriodType

Methods

parseJSON :: Value -> Parser QuotaPeriodType

ToJSON QuotaPeriodType

Methods

toJSON :: QuotaPeriodType -> Value

toEncoding :: QuotaPeriodType -> Encoding

FromText QuotaPeriodType

Methods

parser :: Parser QuotaPeriodType

ToText QuotaPeriodType

Methods

toText :: QuotaPeriodType -> Text

type Rep QuotaPeriodType

type Rep QuotaPeriodType = D1 (MetaData "QuotaPeriodType" "Network.AWS.APIGateway.Types.Sum" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" False) ((:+:) (C1 (MetaCons "Day" PrefixI False) U1) ((:+:) (C1 (MetaCons "Month" PrefixI False) U1) (C1 (MetaCons "Week" 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

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

FromJSON UnauthorizedCacheControlHeaderStrategy

Methods

parseJSON :: Value -> Parser UnauthorizedCacheControlHeaderStrategy

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.4-IZnuIXoXoORFOGBhN7tIo9" 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.

Use API Keys

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

Hashable APIKey

Methods

hashWithSalt :: Int -> APIKey -> Int

hash :: APIKey -> Int

NFData APIKey

Methods

rnf :: APIKey -> ()

FromJSON APIKey

Methods

parseJSON :: Value -> Parser APIKey

type Rep APIKey

type Rep APIKey = D1 (MetaData "APIKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" False) (C1 (MetaCons "APIKey'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_akEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_akValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_akCreatedDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe POSIX))) (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 POSIX))) (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
• akValue
• akCreatedDate
• akName
• akId
• akStageKeys
• akLastUpdatedDate
• akDescription

akEnabled :: Lens' APIKey (Maybe Bool)

Specifies whether the API Key can be used by callers.

akValue :: Lens' APIKey (Maybe Text)

The value of the API Key.

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.

APIStage

data APIStage

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

See: apiStage smart constructor.

Instances

Eq APIStage

Methods

(==) :: APIStage -> APIStage -> Bool

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

Data APIStage

Methods

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

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

toConstr :: APIStage -> Constr

dataTypeOf :: APIStage -> DataType

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

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

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

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

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

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

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

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

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

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

Read APIStage

Methods

readsPrec :: Int -> ReadS APIStage

readList :: ReadS [APIStage]

readPrec :: ReadPrec APIStage

readListPrec :: ReadPrec [APIStage]

Show APIStage

Methods

showsPrec :: Int -> APIStage -> ShowS

show :: APIStage -> String

showList :: [APIStage] -> ShowS

Generic APIStage

Associated Types

type Rep APIStage :: * -> *

Methods

from :: APIStage -> Rep APIStage x

to :: Rep APIStage x -> APIStage

Hashable APIStage

Methods

hashWithSalt :: Int -> APIStage -> Int

hash :: APIStage -> Int

NFData APIStage

Methods

rnf :: APIStage -> ()

FromJSON APIStage

Methods

parseJSON :: Value -> Parser APIStage

ToJSON APIStage

Methods

toJSON :: APIStage -> Value

toEncoding :: APIStage -> Encoding

type Rep APIStage

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

apiStage :: APIStage

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

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

• asStage
• asApiId

asStage :: Lens' APIStage (Maybe Text)

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

asApiId :: Lens' APIStage (Maybe Text)

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

Account

data Account

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

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

Error Codes

The following exception may be thrown when the request fails.

• UnauthorizedException
• NotFoundException
• TooManyRequestsException

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

Example: Get the information about an account.

Request

GET /account HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160531T184618Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns a '200 OK' status code and a payload similar to the following:

{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/account-apigateway-{rel}.html", "name": "account", "templated": true }, "self": { "href": "/account" }, "account:update": { "href": "/account" } }, "cloudwatchRoleArn": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "throttleSettings": { "rateLimit": 500, "burstLimit": 1000 } }

In addition to making the REST API call directly, you can use the AWS CLI and an AWS SDK to access this resource.

API Gateway Limits Developer Guide, AWS CLI

See: account smart constructor.

Instances

Eq Account

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

Hashable Account

Methods

hashWithSalt :: Int -> Account -> Int

hash :: Account -> Int

NFData Account

Methods

rnf :: Account -> ()

FromJSON Account

Methods

parseJSON :: Value -> Parser Account

type Rep Account

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

account :: Account

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

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

• aApiKeyVersion
• aCloudwatchRoleARN
• aFeatures
• aThrottleSettings

aApiKeyVersion :: Lens' Account (Maybe Text)

The version of the API keys used for the account.

aCloudwatchRoleARN :: Lens' Account (Maybe Text)

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

aFeatures :: Lens' Account [Text]

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

aThrottleSettings :: Lens' Account (Maybe ThrottleSettings)

Specifies the API request limits configured for the current Account.

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.

Enable custom authorization

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

Hashable Authorizer

Methods

hashWithSalt :: Int -> Authorizer -> Int

hash :: Authorizer -> Int

NFData Authorizer

Methods

rnf :: Authorizer -> ()

FromJSON Authorizer

Methods

parseJSON :: Value -> Parser Authorizer

type Rep Authorizer

type Rep Authorizer = D1 (MetaData "Authorizer" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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 "_aProviderARNs") 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
• aProviderARNs
• 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.

aProviderARNs :: Lens' Authorizer [Text]

A list of the provider ARNs of the authorizer.

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 must provide as part of the URL after the domain name.

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

Use Custom Domain Names

See: basePathMapping smart constructor.

Instances

Eq BasePathMapping

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

Hashable BasePathMapping

Methods

hashWithSalt :: Int -> BasePathMapping -> Int

hash :: BasePathMapping -> Int

NFData BasePathMapping

Methods

rnf :: BasePathMapping -> ()

FromJSON BasePathMapping

Methods

parseJSON :: Value -> Parser BasePathMapping

type Rep BasePathMapping

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

Client certificates are used authenticate an API by the back-end server. To authenticate an API client (or user), use a custom Authorizer.

Use Client-Side Certificate

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

Hashable ClientCertificate

Methods

hashWithSalt :: Int -> ClientCertificate -> Int

hash :: ClientCertificate -> Int

NFData ClientCertificate

Methods

rnf :: ClientCertificate -> ()

FromJSON ClientCertificate

Methods

parseJSON :: Value -> Parser ClientCertificate

type Rep ClientCertificate

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

clientCertificate :: ClientCertificate

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, which 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.

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

RestApi, Deployments, Stage, AWS CLI, AWS SDKs

See: deployment smart constructor.

Instances

Eq Deployment

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

Hashable Deployment

Methods

hashWithSalt :: Int -> Deployment -> Int

hash :: Deployment -> Int

NFData Deployment

Methods

rnf :: Deployment -> ()

FromJSON Deployment

Methods

parseJSON :: Value -> Parser Deployment

type Rep Deployment

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

deployment :: Deployment

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))

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.

Use Client-Side Certificate

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

Hashable DomainName

Methods

hashWithSalt :: Int -> DomainName -> Int

hash :: DomainName -> Int

NFData DomainName

Methods

rnf :: DomainName -> ()

FromJSON DomainName

Methods

parseJSON :: Value -> Parser DomainName

type Rep DomainName

type Rep DomainName = D1 (MetaData "DomainName" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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 POSIX))) (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 an HTTP, AWS, or Mock integration.

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

Creating an API

See: integration smart constructor.

Instances

Eq Integration

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

Hashable Integration

Methods

hashWithSalt :: Int -> Integration -> Int

hash :: Integration -> Int

NFData Integration

Methods

rnf :: Integration -> ()

FromJSON Integration

Methods

parseJSON :: Value -> Parser Integration

type Rep Integration

type Rep Integration = D1 (MetaData "Integration" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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 "_iPassthroughBehavior") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_iUri") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_iIntegrationResponses") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text IntegrationResponse))))) ((:*:) (S1 (MetaSel (Just Symbol "_iCacheNamespace") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_iType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe IntegrationType))) (S1 (MetaSel (Just Symbol "_iCacheKeyParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))))))

integration :: Integration

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
• iPassthroughBehavior
• iUri
• iIntegrationResponses
• iCacheNamespace
• iType
• iCacheKeyParameters

iHttpMethod :: Lens' Integration (Maybe Text)

Specifies the integration's HTTP method type.

iRequestTemplates :: Lens' Integration (HashMap Text Text)

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

iCredentials :: Lens' Integration (Maybe Text)

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)

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

iPassthroughBehavior :: Lens' Integration (Maybe Text)

Specifies how the method request body of an unmapped content type will be passed through the integration request to the back end without transformation. A content type is unmapped if no mapping template is defined in the integration or the content type does not match any of the mapped content types, as specified in requestTemplates. There are three valid values: WHEN_NO_MATCH, WHEN_NO_TEMPLATES, and NEVER.

• WHEN_NO_MATCH passes the method request body through the integration request to the back end without transformation when the method request content type does not match any content type associated with the mapping templates defined in the integration request.
• WHEN_NO_TEMPLATES passes the method request body through the integration request to the back end without transformation when no mapping template is defined in the integration request. If a template is defined when this option is selected, the method request of an unmapped content-type will be rejected with an HTTP '415 Unsupported Media Type' response.
• NEVER rejects the method request with an HTTP '415 Unsupported Media Type' response when either the method request content type does not match any content type associated with the mapping templates defined in the integration request or no mapping template is defined in the integration request.

iUri :: Lens' Integration (Maybe Text)

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.

Example: Get integration responses of a method

Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160607T191449Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160607/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns '200 OK' status and a payload as follows:

{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": ">util.urlDecode(\"%3CkinesisStreams%3E#foreach(>stream in >input.path('>.StreamNames'))%3Cstream%3E%3Cname%3E>stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" }

Creating an API

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 back-end response.

Creating an API

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

Hashable IntegrationResponse

Methods

hashWithSalt :: Int -> IntegrationResponse -> Int

hash :: IntegrationResponse -> Int

NFData IntegrationResponse

Methods

rnf :: IntegrationResponse -> ()

FromJSON IntegrationResponse

Methods

parseJSON :: Value -> Parser IntegrationResponse

type Rep IntegrationResponse

type Rep IntegrationResponse = D1 (MetaData "IntegrationResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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 back end. For example, if the success response returns nothing and the error response returns some string, you could use the .+ regex to match error response. However, make sure that the error response does not contain any newline ('\\n') character in such cases. If the back end is an AWS Lambda function, the AWS Lambda function error header is matched. For all other HTTP and AWS back ends, the HTTP status code is matched.

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)

A key-value map specifying response parameters that are passed to the method response from the back end. The key is a method response header parameter name and the mapped value is an integration response header value, a static value enclosed within a pair of single quotes, or a JSON expression from the integration response body. The mapping key must match the pattern of 'method.response.header.{name}', where name is a valid and unique header name. The mapped non-static value must match the pattern of 'integration.response.header.{name}' or 'integration.response.body.{JSON-expression}', where name is a valid and unique response header name and 'JSON-expression' is a valid JSON expression without the > prefix.

Method

data Method

Represents a client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

Example: Retrive the GET method on a specified resource

Request

The following example request retrieves the information about the GET method on an API resource ('3kzxbg5sa2') of an API (fugvjdxtri).

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns a '200 OK' status code and a payload similar to the following:

{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": ">util.urlDecode(\"%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E\")" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }

In the example above, the response template for the '200 OK' response maps the JSON output from the ListStreams action in the back end to an XML output. The mapping template is URL-encoded as '%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E' and the output is decoded using the http://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-mapping-template-reference.html#util-templat-referenceutil.urlDecode()> helper function.

MethodResponse, Integration, IntegrationResponse, Resource, Set up an API's 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

Hashable Method

Methods

hashWithSalt :: Int -> Method -> Int

hash :: Method -> Int

NFData Method

Methods

rnf :: Method -> ()

FromJSON Method

Methods

parseJSON :: Value -> Parser Method

type Rep Method

type Rep Method = D1 (MetaData "Method" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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)

Gets a method response associated with a given HTTP status code.

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response.

Example: Get a 200 OK response of a GET method

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns a '200 OK' status code and a payload similar to the following:

{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false }, "statusCode": "200" }

AWS CLI

mHttpMethod :: Lens' Method (Maybe Text)

The method's HTTP verb.

mRequestModels :: Lens' Method (HashMap Text Text)

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

mRequestParameters :: Lens' Method (HashMap Text Bool)

A key-value map defining required or optional method request parameters that can be accepted by Amazon API Gateway. A key is a method request parameter name matching the pattern of 'method.request.{location}.{name}', where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or templates.

mAuthorizerId :: Lens' Method (Maybe Text)

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)

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

mMethodIntegration :: Lens' Method (Maybe Integration)

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Example:

Request

GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns a '200 OK' status code and a payload similar to the following:

{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true } ], "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integration:responses": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": { "application/json": "{\n \"a\": \">input.params('operand1')\",\n \"b\": \">input.params('operand2')\", \n \"op\": \">input.params('operator')\" \n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" }, "responseTemplates": { "application/json": "#set(>res = >input.path('>'))\n{\n \"result\": \">res.a, >res.b, >res.op => >res.c\",\n \"a\" : \">res.a\",\n \"b\" : \">res.b\",\n \"op\" : \">res.op\",\n \"c\" : \">res.c\"\n}" }, "selectionPattern": "", "statusCode": "200" } } }

AWS CLI

MethodResponse

data MethodResponse

Represents a method response of a given HTTP status code returned to the client. The method response is passed from the back end through the associated integration response that can be transformed using a mapping template.

Example: A MethodResponse instance of an API

Request

The example request retrieves a MethodResponse of the 200 status code.

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T222952Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

The successful response returns '200 OK' status and a payload as follows:

{ "_links": { "curies": { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true }, "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" }

Method, IntegrationResponse, Integration Creating an API

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

Hashable MethodResponse

Methods

hashWithSalt :: Int -> MethodResponse -> Int

hash :: MethodResponse -> Int

NFData MethodResponse

Methods

rnf :: MethodResponse -> ()

FromJSON MethodResponse

Methods

parseJSON :: Value -> Parser MethodResponse

type Rep MethodResponse

type Rep MethodResponse = D1 (MetaData "MethodResponse" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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)

A key-value map specifying required or optional response parameters that Amazon API Gateway can send back to the caller. A key defines a method response header and the value specifies whether the associated method response header is required or not. The expression of the key must match the pattern 'method.response.header.{name}', where name is a valid and unique header name. Amazon API Gateway passes certain integration response data to the method response headers specified here according to the mapping you prescribe in the API's IntegrationResponse. The integration response data that can be mapped include an integration response header expressed in 'integration.response.header.{name}', a static value enclosed within a pair of single quotes (e.g., '\'application\/json\''), or a JSON expression from the back-end response payload in the form of 'integration.response.body.{JSON-expression}', where 'JSON-expression' is a valid JSON expression without the > prefix.)

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

Hashable MethodSetting

Methods

hashWithSalt :: Int -> MethodSetting -> Int

hash :: MethodSetting -> Int

NFData MethodSetting

Methods

rnf :: MethodSetting -> ()

FromJSON MethodSetting

Methods

parseJSON :: Value -> Parser MethodSetting

type Rep MethodSetting

type Rep MethodSetting = D1 (MetaData "MethodSetting" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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 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 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 how to handle unauthorized requests for cache invalidation. The PATCH path for this setting is '/{method_setting_key}/caching/unauthorizedCacheControlHeaderStrategy', and the available values are FAIL_WITH_403, SUCCEED_WITH_RESPONSE_HEADER, SUCCEED_WITHOUT_RESPONSE_HEADER.

MethodSnapshot

data MethodSnapshot

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

Hashable MethodSnapshot

Methods

hashWithSalt :: Int -> MethodSnapshot -> Int

hash :: MethodSnapshot -> Int

NFData MethodSnapshot

Methods

rnf :: MethodSnapshot -> ()

FromJSON MethodSnapshot

Methods

parseJSON :: Value -> Parser MethodSnapshot

type Rep MethodSnapshot

type Rep MethodSnapshot = D1 (MetaData "MethodSnapshot" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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 data structure of a method's request or response payload.

A request model defines the data structure of the client-supplied request payload. A response model defines the data structure of the response payload returned by the back end. Although not required, models are useful for mapping payloads between the front end and back end.

A model is used for generating an API's SDK, validating the input request body, and creating a skeletal mapping template.

Method, MethodResponse, Models and Mappings

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

Hashable Model

Methods

hashWithSalt :: Int -> Model -> Int

hash :: Model -> Int

NFData Model

Methods

rnf :: Model -> ()

FromJSON Model

Methods

parseJSON :: Value -> Parser Model

type Rep Model

type Rep Model = D1 (MetaData "Model" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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. Do not include "\*/" characters in the description of any properties because such "\*/" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

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

Hashable PatchOperation

Methods

hashWithSalt :: Int -> PatchOperation -> Int

hash :: PatchOperation -> Int

NFData PatchOperation

Methods

rnf :: PatchOperation -> ()

ToJSON PatchOperation

Methods

toJSON :: PatchOperation -> Value

toEncoding :: PatchOperation -> Encoding

type Rep PatchOperation

type Rep PatchOperation = D1 (MetaData "PatchOperation" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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)

An update operation to be performed with this PATCH request. The valid value can be "add", "remove", or "replace". Not all valid operations are supported for a given resource. Support of the operations depends on specific operational contexts. Attempts to apply an unsupported operation on a resource will return an error message.

poPath :: Lens' PatchOperation (Maybe Text)

The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of '{"name":"value"}', the path for this property is '\/name'. If the name property value is a JSON object (e.g., '{"name": {"child/name": "child-value"}}'), the path for the 'child\/name' property will be '\/name\/child~1name'. Any slash ("/") character appearing in path names must be escaped with "~1", as shown in the example above. Each op operation can have only one path associated with it.

poValue :: Lens' PatchOperation (Maybe Text)

The new target value of the update operation.

poFrom :: Lens' PatchOperation (Maybe Text)

Not supported.

QuotaSettings

data QuotaSettings

Quotas configured for a usage plan.

See: quotaSettings smart constructor.

Instances

Eq QuotaSettings

Methods

(==) :: QuotaSettings -> QuotaSettings -> Bool

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

Data QuotaSettings

Methods

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

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

toConstr :: QuotaSettings -> Constr

dataTypeOf :: QuotaSettings -> DataType

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

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

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

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

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

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

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

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

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

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

Read QuotaSettings

Methods

readsPrec :: Int -> ReadS QuotaSettings

readList :: ReadS [QuotaSettings]

readPrec :: ReadPrec QuotaSettings

readListPrec :: ReadPrec [QuotaSettings]

Show QuotaSettings

Methods

showsPrec :: Int -> QuotaSettings -> ShowS

show :: QuotaSettings -> String

showList :: [QuotaSettings] -> ShowS

Generic QuotaSettings

Associated Types

type Rep QuotaSettings :: * -> *

Methods

from :: QuotaSettings -> Rep QuotaSettings x

to :: Rep QuotaSettings x -> QuotaSettings

Hashable QuotaSettings

Methods

hashWithSalt :: Int -> QuotaSettings -> Int

hash :: QuotaSettings -> Int

NFData QuotaSettings

Methods

rnf :: QuotaSettings -> ()

FromJSON QuotaSettings

Methods

parseJSON :: Value -> Parser QuotaSettings

ToJSON QuotaSettings

Methods

toJSON :: QuotaSettings -> Value

toEncoding :: QuotaSettings -> Encoding

type Rep QuotaSettings

type Rep QuotaSettings = D1 (MetaData "QuotaSettings" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" False) (C1 (MetaCons "QuotaSettings'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_qsOffset") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))) ((:*:) (S1 (MetaSel (Just Symbol "_qsPeriod") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe QuotaPeriodType))) (S1 (MetaSel (Just Symbol "_qsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Int))))))

quotaSettings :: QuotaSettings

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

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

• qsOffset
• qsPeriod
• qsLimit

qsOffset :: Lens' QuotaSettings (Maybe Int)

The number of requests subtracted from the given limit in the initial time period.

qsPeriod :: Lens' QuotaSettings (Maybe QuotaPeriodType)

The time period in which the limit applies. Valid values are "DAY", "WEEK" or "MONTH".

qsLimit :: Lens' QuotaSettings (Maybe Int)

The maximum number of requests that can be made in a given time period.

Resource

data Resource

Represents an API resource.

Create an API

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

Hashable Resource

Methods

hashWithSalt :: Int -> Resource -> Int

hash :: Resource -> Int

NFData Resource

Methods

rnf :: Resource -> ()

FromJSON Resource

Methods

parseJSON :: Value -> Parser Resource

type Rep Resource

type Rep Resource = D1 (MetaData "Resource" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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)

Gets an API resource's method of a given HTTP verb.

The resource methods are a map of methods indexed by methods' HTTP verbs enabled on the resource. This method map is included in the '200 OK' response of the 'GET /restapis/{restapi_id}/resources/{resource_id}' or 'GET /restapis/{restapi_id}/resources/{resource_id}?embed=methods' request.

Example: Get the GET method of an API resource

Request

GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160608T031827Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160608/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash}

Response

{ "_links": { "curies": [ { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel}.html", "name": "integration", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel}.html", "name": "integrationresponse", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel}.html", "name": "method", "templated": true }, { "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel}.html", "name": "methodresponse", "templated": true } ], "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET", "name": "GET", "title": "GET" }, "integration:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "method:integration": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "method:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "method:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" }, "methodresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}", "templated": true } }, "apiKeyRequired": false, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": { "method:integration": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integration:responses": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integration:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" }, "integrationresponse:put": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code}", "templated": true } }, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": { "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" }, "requestTemplates": { "application/json": "{\n}" }, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": { "integration:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" }, "integrationresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" }, "integrationresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" } }, "responseParameters": { "method.response.header.Content-Type": "'application/xml'" }, "responseTemplates": { "application/json": ">util.urlDecode(\"%3CkinesisStreams%3E#foreach(>stream in >input.path('>.StreamNames'))%3Cstream%3E%3Cname%3E>stream%3C/name%3E%3C/stream%3E#end%3C/kinesisStreams%3E\")\n" }, "statusCode": "200" } } }, "method:responses": { "_links": { "self": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" }, "methodresponse:delete": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" }, "methodresponse:update": { "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" } }, "responseModels": { "application/json": "Empty" }, "responseParameters": { "method.response.header.Content-Type": false }, "statusCode": "200" } } }

If the OPTIONS is enabled on the resource, you can follow the example here to get that method. Just replace the GET of the last path segment in the request URL with OPTIONS.

rParentId :: Lens' Resource (Maybe Text)

The parent resource's identifier.

RestAPI

data RestAPI

Represents a REST API.

Create an 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

Hashable RestAPI

Methods

hashWithSalt :: Int -> RestAPI -> Int

hash :: RestAPI -> Int

NFData RestAPI

Methods

rnf :: RestAPI -> ()

FromJSON RestAPI

Methods

parseJSON :: Value -> Parser RestAPI

type Rep RestAPI

type Rep RestAPI = D1 (MetaData "RestAPI" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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 POSIX)))) ((:*:) (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]

The warning messages reported when failonwarnings is turned on during API import.

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.

Deploy an API

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

Hashable Stage

Methods

hashWithSalt :: Int -> Stage -> Int

hash :: Stage -> Int

NFData Stage

Methods

rnf :: Stage -> ()

FromJSON Stage

Methods

parseJSON :: Value -> Parser Stage

type Rep Stage

type Rep Stage = D1 (MetaData "Stage" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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 POSIX))) (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 POSIX))) (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 and underscore characters, and the values must match '[A-Za-z0-9-._~:/?#&=,]+'.

sClientCertificateId :: Lens' Stage (Maybe Text)

The identifier of a client certificate for an API stage.

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 (designated as '/{method_setting_key' below) are method paths defined as '{resource_path}/{http_method}' for an individual method override, or \/\\*\/\\* for overriding all methods in the stage. Any forward slash ("/") characters in the resource_path part must be encoded as "~1" as in, for example, '~1resource~1sub-resource\/GET'.

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

Hashable StageKey

Methods

hashWithSalt :: Int -> StageKey -> Int

hash :: StageKey -> Int

NFData StageKey

Methods

rnf :: StageKey -> ()

ToJSON StageKey

Methods

toJSON :: StageKey -> Value

toEncoding :: StageKey -> Encoding

type Rep StageKey

type Rep StageKey = D1 (MetaData "StageKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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

The API request rate limits.

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

Hashable ThrottleSettings

Methods

hashWithSalt :: Int -> ThrottleSettings -> Int

hash :: ThrottleSettings -> Int

NFData ThrottleSettings

Methods

rnf :: ThrottleSettings -> ()

FromJSON ThrottleSettings

Methods

parseJSON :: Value -> Parser ThrottleSettings

ToJSON ThrottleSettings

Methods

toJSON :: ThrottleSettings -> Value

toEncoding :: ThrottleSettings -> Encoding

type Rep ThrottleSettings

type Rep ThrottleSettings = D1 (MetaData "ThrottleSettings" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" 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)

The API request burst limit, the maximum rate limit over a time ranging from one to a few seconds, depending upon whether the underlying token bucket is at its full capacity.

tsRateLimit :: Lens' ThrottleSettings (Maybe Double)

The API request steady-state rate limit.

Usage

data Usage

Represents the usage data of a usage plan.

Create and Use Usage Plans, Manage Usage in a Usage Plan

See: usage smart constructor.

Instances

Eq Usage

Methods

(==) :: Usage -> Usage -> Bool

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

Data Usage

Methods

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

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

toConstr :: Usage -> Constr

dataTypeOf :: Usage -> DataType

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

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

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

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

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

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

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

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

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

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

Read Usage

Methods

readsPrec :: Int -> ReadS Usage

readList :: ReadS [Usage]

readPrec :: ReadPrec Usage

readListPrec :: ReadPrec [Usage]

Show Usage

Methods

showsPrec :: Int -> Usage -> ShowS

show :: Usage -> String

showList :: [Usage] -> ShowS

Generic Usage

Associated Types

type Rep Usage :: * -> *

Methods

from :: Usage -> Rep Usage x

to :: Rep Usage x -> Usage

Hashable Usage

Methods

hashWithSalt :: Int -> Usage -> Int

hash :: Usage -> Int

NFData Usage

Methods

rnf :: Usage -> ()

FromJSON Usage

Methods

parseJSON :: Value -> Parser Usage

type Rep Usage

type Rep Usage = D1 (MetaData "Usage" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" False) (C1 (MetaCons "Usage'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_uUsagePlanId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uEndDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_uItems") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text [[Integer]])))) ((:*:) (S1 (MetaSel (Just Symbol "_uStartDate") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_uPosition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

usage :: Usage

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

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

• uUsagePlanId
• uEndDate
• uItems
• uStartDate
• uPosition

uUsagePlanId :: Lens' Usage (Maybe Text)

The plan Id associated with this usage data.

uEndDate :: Lens' Usage (Maybe Text)

The ending date of the usage data.

uItems :: Lens' Usage (HashMap Text [[Integer]])

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, '{..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}', where '{api_key}' stands for an API key value and the daily log entry is of the format '[used quota, remaining quota]'.

uStartDate :: Lens' Usage (Maybe Text)

The starting date of the usage data.

uPosition :: Lens' Usage (Maybe Text)

Undocumented member.

UsagePlan

data UsagePlan

Represents a usage plan than can specify who can assess associated API stages with specified request limits and quotas.

In a usage plan, you associate an API by specifying the API's Id and a stage name of the specified API. You add plan customers by adding API keys to the plan.

Create and Use Usage Plans

See: usagePlan smart constructor.

Instances

Eq UsagePlan

Methods

(==) :: UsagePlan -> UsagePlan -> Bool

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

Data UsagePlan

Methods

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

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

toConstr :: UsagePlan -> Constr

dataTypeOf :: UsagePlan -> DataType

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

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

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

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

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

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

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

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

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

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

Read UsagePlan

Methods

readsPrec :: Int -> ReadS UsagePlan

readList :: ReadS [UsagePlan]

readPrec :: ReadPrec UsagePlan

readListPrec :: ReadPrec [UsagePlan]

Show UsagePlan

Methods

showsPrec :: Int -> UsagePlan -> ShowS

show :: UsagePlan -> String

showList :: [UsagePlan] -> ShowS

Generic UsagePlan

Associated Types

type Rep UsagePlan :: * -> *

Methods

from :: UsagePlan -> Rep UsagePlan x

to :: Rep UsagePlan x -> UsagePlan

Hashable UsagePlan

Methods

hashWithSalt :: Int -> UsagePlan -> Int

hash :: UsagePlan -> Int

NFData UsagePlan

Methods

rnf :: UsagePlan -> ()

FromJSON UsagePlan

Methods

parseJSON :: Value -> Parser UsagePlan

type Rep UsagePlan

type Rep UsagePlan = D1 (MetaData "UsagePlan" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" False) (C1 (MetaCons "UsagePlan'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upApiStages") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [APIStage]))) ((:*:) (S1 (MetaSel (Just Symbol "_upName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_upThrottle") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ThrottleSettings))) ((:*:) (S1 (MetaSel (Just Symbol "_upQuota") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe QuotaSettings))) (S1 (MetaSel (Just Symbol "_upDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

usagePlan :: UsagePlan

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

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

• upApiStages
• upName
• upId
• upThrottle
• upQuota
• upDescription

upApiStages :: Lens' UsagePlan [APIStage]

The associated API stages of a usage plan.

upName :: Lens' UsagePlan (Maybe Text)

The name of a usage plan.

upId :: Lens' UsagePlan (Maybe Text)

The identifier of a UsagePlan resource.

upThrottle :: Lens' UsagePlan (Maybe ThrottleSettings)

The request throttle limits of a usage plan.

upQuota :: Lens' UsagePlan (Maybe QuotaSettings)

The maximum number of permitted requests per a given unit time interval.

upDescription :: Lens' UsagePlan (Maybe Text)

The description of a usage plan.

UsagePlanKey

data UsagePlanKey

Represents a usage plan key to identify a plan customer.

To associate an API stage with a selected API key in a usage plan, you must create a UsagePlanKey resource to represent the selected ApiKey.

"

Create and Use Usage Plans

See: usagePlanKey smart constructor.

Instances

Eq UsagePlanKey

Methods

(==) :: UsagePlanKey -> UsagePlanKey -> Bool

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

Data UsagePlanKey

Methods

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

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

toConstr :: UsagePlanKey -> Constr

dataTypeOf :: UsagePlanKey -> DataType

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

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

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

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

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

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

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

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

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

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

Read UsagePlanKey

Methods

readsPrec :: Int -> ReadS UsagePlanKey

readList :: ReadS [UsagePlanKey]

readPrec :: ReadPrec UsagePlanKey

readListPrec :: ReadPrec [UsagePlanKey]

Show UsagePlanKey

Methods

showsPrec :: Int -> UsagePlanKey -> ShowS

show :: UsagePlanKey -> String

showList :: [UsagePlanKey] -> ShowS

Generic UsagePlanKey

Associated Types

type Rep UsagePlanKey :: * -> *

Methods

from :: UsagePlanKey -> Rep UsagePlanKey x

to :: Rep UsagePlanKey x -> UsagePlanKey

Hashable UsagePlanKey

Methods

hashWithSalt :: Int -> UsagePlanKey -> Int

hash :: UsagePlanKey -> Int

NFData UsagePlanKey

Methods

rnf :: UsagePlanKey -> ()

FromJSON UsagePlanKey

Methods

parseJSON :: Value -> Parser UsagePlanKey

type Rep UsagePlanKey

type Rep UsagePlanKey = D1 (MetaData "UsagePlanKey" "Network.AWS.APIGateway.Types.Product" "amazonka-apigateway-1.4.4-IZnuIXoXoORFOGBhN7tIo9" False) (C1 (MetaCons "UsagePlanKey'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_upkValue") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upkName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_upkId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_upkType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

usagePlanKey :: UsagePlanKey

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

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

• upkValue
• upkName
• upkId
• upkType

upkValue :: Lens' UsagePlanKey (Maybe Text)

The value of a usage plan key.

upkName :: Lens' UsagePlanKey (Maybe Text)

The name of a usage plan key.

upkId :: Lens' UsagePlanKey (Maybe Text)

The Id of a usage plan key.

upkType :: Lens' UsagePlanKey (Maybe Text)

The type of a usage plan key. Currently, the valid key type is API_KEY.