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.ImportDocumentationParts

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Imports documentation parts

Synopsis

data ImportDocumentationParts = ImportDocumentationParts' {
- failOnWarnings :: Maybe Bool
- mode :: Maybe PutMode
- restApiId :: Text
- body :: ByteString
}
newImportDocumentationParts :: Text -> ByteString -> ImportDocumentationParts
importDocumentationParts_failOnWarnings :: Lens' ImportDocumentationParts (Maybe Bool)
importDocumentationParts_mode :: Lens' ImportDocumentationParts (Maybe PutMode)
importDocumentationParts_restApiId :: Lens' ImportDocumentationParts Text
importDocumentationParts_body :: Lens' ImportDocumentationParts ByteString
data ImportDocumentationPartsResponse = ImportDocumentationPartsResponse' {
- ids :: Maybe [Text]
- warnings :: Maybe [Text]
- httpStatus :: Int
}
newImportDocumentationPartsResponse :: Int -> ImportDocumentationPartsResponse
importDocumentationPartsResponse_ids :: Lens' ImportDocumentationPartsResponse (Maybe [Text])
importDocumentationPartsResponse_warnings :: Lens' ImportDocumentationPartsResponse (Maybe [Text])
importDocumentationPartsResponse_httpStatus :: Lens' ImportDocumentationPartsResponse Int

Creating a Request

data ImportDocumentationParts Source #

Import documentation parts from an external (e.g., OpenAPI) definition file.

See: newImportDocumentationParts smart constructor.

Constructors

ImportDocumentationParts'

Fields

failOnWarnings :: Maybe Bool
A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.
mode :: Maybe PutMode
A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.
restApiId :: Text
The string identifier of the associated RestApi.
body :: ByteString
Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

Instances

Instances details

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

newImportDocumentationParts Source #

Arguments

:: Text	`ImportDocumentationParts`
-> ByteString	`$sel:body:ImportDocumentationParts'`
-> ImportDocumentationParts

Create a value of ImportDocumentationParts 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:ImportDocumentationParts', importDocumentationParts_failOnWarnings - A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

$sel:mode:ImportDocumentationParts', importDocumentationParts_mode - A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

ImportDocumentationParts, importDocumentationParts_restApiId - The string identifier of the associated RestApi.

$sel:body:ImportDocumentationParts', importDocumentationParts_body - Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

Request Lenses

importDocumentationParts_failOnWarnings :: Lens' ImportDocumentationParts (Maybe Bool) Source #

A query parameter to specify whether to rollback the documentation importation (true) or not (false) when a warning is encountered. The default value is false.

importDocumentationParts_mode :: Lens' ImportDocumentationParts (Maybe PutMode) Source #

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

importDocumentationParts_restApiId :: Lens' ImportDocumentationParts Text Source #

The string identifier of the associated RestApi.

importDocumentationParts_body :: Lens' ImportDocumentationParts ByteString Source #

Raw byte array representing the to-be-imported documentation parts. To import from an OpenAPI file, this is a JSON object.

Destructuring the Response

data ImportDocumentationPartsResponse Source #

A collection of the imported DocumentationPart identifiers.

See: newImportDocumentationPartsResponse smart constructor.

Constructors

ImportDocumentationPartsResponse'
Fields ids :: Maybe [Text] A list of the returned documentation part identifiers. warnings :: Maybe [Text] A list of warning messages reported during import of documentation parts. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Associated Types type Rep ImportDocumentationPartsResponse :: Type -> Type # Methods from :: ImportDocumentationPartsResponse -> Rep ImportDocumentationPartsResponse x # to :: Rep ImportDocumentationPartsResponse x -> ImportDocumentationPartsResponse #
Read ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods readsPrec :: Int -> ReadS ImportDocumentationPartsResponse # readList :: ReadS [ImportDocumentationPartsResponse] # readPrec :: ReadPrec ImportDocumentationPartsResponse # readListPrec :: ReadPrec [ImportDocumentationPartsResponse] #
Show ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods showsPrec :: Int -> ImportDocumentationPartsResponse -> ShowS # show :: ImportDocumentationPartsResponse -> String # showList :: [ImportDocumentationPartsResponse] -> ShowS #
NFData ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods rnf :: ImportDocumentationPartsResponse -> () #
Eq ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts Methods (==) :: ImportDocumentationPartsResponse -> ImportDocumentationPartsResponse -> Bool # (/=) :: ImportDocumentationPartsResponse -> ImportDocumentationPartsResponse -> Bool #
type Rep ImportDocumentationPartsResponse Source #
Instance details Defined in Amazonka.APIGateway.ImportDocumentationParts type Rep ImportDocumentationPartsResponse = D1 ('MetaData "ImportDocumentationPartsResponse" "Amazonka.APIGateway.ImportDocumentationParts" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "ImportDocumentationPartsResponse'" '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))))

newImportDocumentationPartsResponse Source #

Arguments

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

Create a value of ImportDocumentationPartsResponse 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:ImportDocumentationPartsResponse', importDocumentationPartsResponse_ids - A list of the returned documentation part identifiers.

ImportDocumentationPartsResponse, importDocumentationPartsResponse_warnings - A list of warning messages reported during import of documentation parts.

$sel:httpStatus:ImportDocumentationPartsResponse', importDocumentationPartsResponse_httpStatus - The response's http status code.

Response Lenses

importDocumentationPartsResponse_ids :: Lens' ImportDocumentationPartsResponse (Maybe [Text]) Source #

A list of the returned documentation part identifiers.

importDocumentationPartsResponse_warnings :: Lens' ImportDocumentationPartsResponse (Maybe [Text]) Source #

A list of warning messages reported during import of documentation parts.

importDocumentationPartsResponse_httpStatus :: Lens' ImportDocumentationPartsResponse Int Source #

The response's http status code.