Network.AWS.APIGateway.ImportAPIKeys

Import API keys from an external source, such as a CSV-formatted file.

Creating a Request

importAPIKeys

Arguments

:: ByteString

iakBody

-> APIKeysFormat

iakFormat

-> ImportAPIKeys

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

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

• iakFailOnWarnings - A query parameter to indicate whether to rollback ApiKey importation (true ) or not (false ) when error is encountered.
• iakBody - The payload of the POST request to import API keys. For the payload format, see API Key File Format .
• iakFormat - A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

data ImportAPIKeys

The POST request to import API keys from an external source, such as a CSV-formatted file.

See: importAPIKeys smart constructor.

Instances

Eq ImportAPIKeys

Methods

(==) :: ImportAPIKeys -> ImportAPIKeys -> Bool

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

Data ImportAPIKeys

Methods

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

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

toConstr :: ImportAPIKeys -> Constr

dataTypeOf :: ImportAPIKeys -> DataType

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

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

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

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

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

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

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

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

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

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

Show ImportAPIKeys

Methods

showsPrec :: Int -> ImportAPIKeys -> ShowS

show :: ImportAPIKeys -> String

showList :: [ImportAPIKeys] -> ShowS

Generic ImportAPIKeys

Associated Types

type Rep ImportAPIKeys :: * -> *

Methods

from :: ImportAPIKeys -> Rep ImportAPIKeys x

to :: Rep ImportAPIKeys x -> ImportAPIKeys

Hashable ImportAPIKeys

Methods

hashWithSalt :: Int -> ImportAPIKeys -> Int

hash :: ImportAPIKeys -> Int

NFData ImportAPIKeys

Methods

rnf :: ImportAPIKeys -> ()

AWSRequest ImportAPIKeys

Associated Types

type Rs ImportAPIKeys :: *

Methods

request :: ImportAPIKeys -> Request ImportAPIKeys

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * ImportAPIKeys -> ClientResponse -> m (Response ImportAPIKeys)

ToBody ImportAPIKeys

Methods

toBody :: ImportAPIKeys -> RqBody

ToHeaders ImportAPIKeys

Methods

toHeaders :: ImportAPIKeys -> [Header]

ToPath ImportAPIKeys

Methods

toPath :: ImportAPIKeys -> ByteString

ToQuery ImportAPIKeys

Methods

toQuery :: ImportAPIKeys -> QueryString

type Rep ImportAPIKeys

type Rep ImportAPIKeys = D1 * (MetaData "ImportAPIKeys" "Network.AWS.APIGateway.ImportAPIKeys" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "ImportAPIKeys'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_iakFailOnWarnings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Bool))) ((:*:) * (S1 * (MetaSel (Just Symbol "_iakBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * ByteString)) (S1 * (MetaSel (Just Symbol "_iakFormat") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * APIKeysFormat)))))

type Rs ImportAPIKeys

type Rs ImportAPIKeys = ImportAPIKeysResponse

Request Lenses

iakFailOnWarnings :: Lens' ImportAPIKeys (Maybe Bool)

A query parameter to indicate whether to rollback ApiKey importation (true ) or not (false ) when error is encountered.

iakBody :: Lens' ImportAPIKeys ByteString

The payload of the POST request to import API keys. For the payload format, see API Key File Format .

iakFormat :: Lens' ImportAPIKeys APIKeysFormat

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

Destructuring the Response

importAPIKeysResponse

Arguments

:: Int

iakrsResponseStatus

-> ImportAPIKeysResponse

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

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

• iakrsIds - A list of all the ApiKey identifiers.
• iakrsWarnings - A list of warning messages.
• iakrsResponseStatus - -- | The response status code.

data ImportAPIKeysResponse

The identifier of an ApiKey used in a UsagePlan .

See: importAPIKeysResponse smart constructor.

Instances

Eq ImportAPIKeysResponse

Methods

(==) :: ImportAPIKeysResponse -> ImportAPIKeysResponse -> Bool

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

Data ImportAPIKeysResponse

Methods

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

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

toConstr :: ImportAPIKeysResponse -> Constr

dataTypeOf :: ImportAPIKeysResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ImportAPIKeysResponse

Methods

readsPrec :: Int -> ReadS ImportAPIKeysResponse

readList :: ReadS [ImportAPIKeysResponse]

readPrec :: ReadPrec ImportAPIKeysResponse

readListPrec :: ReadPrec [ImportAPIKeysResponse]

Show ImportAPIKeysResponse

Methods

showsPrec :: Int -> ImportAPIKeysResponse -> ShowS

show :: ImportAPIKeysResponse -> String

showList :: [ImportAPIKeysResponse] -> ShowS

Generic ImportAPIKeysResponse

Associated Types

type Rep ImportAPIKeysResponse :: * -> *

Methods

from :: ImportAPIKeysResponse -> Rep ImportAPIKeysResponse x

to :: Rep ImportAPIKeysResponse x -> ImportAPIKeysResponse

NFData ImportAPIKeysResponse

Methods

rnf :: ImportAPIKeysResponse -> ()

type Rep ImportAPIKeysResponse

type Rep ImportAPIKeysResponse = D1 * (MetaData "ImportAPIKeysResponse" "Network.AWS.APIGateway.ImportAPIKeys" "amazonka-apigateway-1.6.0-JJ9NJtNe0aRBcVRYpJCEA2" False) (C1 * (MetaCons "ImportAPIKeysResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_iakrsIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) ((:*:) * (S1 * (MetaSel (Just Symbol "_iakrsWarnings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe [Text]))) (S1 * (MetaSel (Just Symbol "_iakrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)))))

Response Lenses

iakrsIds :: Lens' ImportAPIKeysResponse [Text]

A list of all the ApiKey identifiers.

iakrsWarnings :: Lens' ImportAPIKeysResponse [Text]

A list of warning messages.

iakrsResponseStatus :: Lens' ImportAPIKeysResponse Int

• - | The response status code.