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

Amazonka.APIGateway.ImportApiKeys

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data ImportApiKeys Source #

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

See: newImportApiKeys smart constructor.

Constructors

ImportApiKeys'

Fields

failOnWarnings :: Maybe Bool
A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.
body :: ByteString
The payload of the POST request to import API keys. For the payload format, see API Key File Format.
format :: ApiKeysFormat
A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

Instances

Instances details

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

newImportApiKeys Source #

Arguments

:: ByteString	`$sel:body:ImportApiKeys'`
-> ApiKeysFormat	`ImportApiKeys`
-> ImportApiKeys

Create a value of ImportApiKeys with all optional fields omitted.

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

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

$sel:failOnWarnings:ImportApiKeys', importApiKeys_failOnWarnings - A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

$sel:body:ImportApiKeys', importApiKeys_body - The payload of the POST request to import API keys. For the payload format, see API Key File Format.

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

Request Lenses

importApiKeys_failOnWarnings :: Lens' ImportApiKeys (Maybe Bool) Source #

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

importApiKeys_body :: Lens' ImportApiKeys ByteString Source #

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

importApiKeys_format :: Lens' ImportApiKeys ApiKeysFormat Source #

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

Destructuring the Response

data ImportApiKeysResponse Source #

The identifier of an ApiKey used in a UsagePlan.

See: newImportApiKeysResponse smart constructor.

Constructors

ImportApiKeysResponse'
Fields ids :: Maybe [Text] A list of all the ApiKey identifiers. warnings :: Maybe [Text] A list of warning messages. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newImportApiKeysResponse Source #

Arguments

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

Create a value of ImportApiKeysResponse with all optional fields omitted.

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

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

$sel:ids:ImportApiKeysResponse', importApiKeysResponse_ids - A list of all the ApiKey identifiers.

ImportApiKeysResponse, importApiKeysResponse_warnings - A list of warning messages.

$sel:httpStatus:ImportApiKeysResponse', importApiKeysResponse_httpStatus - The response's http status code.

Response Lenses

importApiKeysResponse_ids :: Lens' ImportApiKeysResponse (Maybe [Text]) Source #

A list of all the ApiKey identifiers.

importApiKeysResponse_warnings :: Lens' ImportApiKeysResponse (Maybe [Text]) Source #

A list of warning messages.

importApiKeysResponse_httpStatus :: Lens' ImportApiKeysResponse Int Source #

The response's http status code.