Network.AWS.APIGateway.ImportDocumentationParts

Undocumented operation.

Creating a Request

importDocumentationParts

Arguments

:: Text

idpRestAPIId

-> HashMap Text Value

idpBody

-> ImportDocumentationParts

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

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

• idpMode - 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 .
• idpFailOnWarnings - 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 .
• idpRestAPIId - [Required] The identifier of an API of the to-be-imported documentation parts.
• idpBody - [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.

data ImportDocumentationParts

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

See: importDocumentationParts smart constructor.

Instances

Eq ImportDocumentationParts

Methods

(==) :: ImportDocumentationParts -> ImportDocumentationParts -> Bool

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

Data ImportDocumentationParts

Methods

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

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

toConstr :: ImportDocumentationParts -> Constr

dataTypeOf :: ImportDocumentationParts -> DataType

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

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

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

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

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

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

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

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

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

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

Show ImportDocumentationParts

Methods

showsPrec :: Int -> ImportDocumentationParts -> ShowS

show :: ImportDocumentationParts -> String

showList :: [ImportDocumentationParts] -> ShowS

Generic ImportDocumentationParts

Associated Types

type Rep ImportDocumentationParts :: * -> *

Methods

from :: ImportDocumentationParts -> Rep ImportDocumentationParts x

to :: Rep ImportDocumentationParts x -> ImportDocumentationParts

Hashable ImportDocumentationParts

Methods

hashWithSalt :: Int -> ImportDocumentationParts -> Int

hash :: ImportDocumentationParts -> Int

NFData ImportDocumentationParts

Methods

rnf :: ImportDocumentationParts -> ()

AWSRequest ImportDocumentationParts

Associated Types

type Rs ImportDocumentationParts :: *

Methods

request :: ImportDocumentationParts -> Request ImportDocumentationParts

response :: MonadResource m => Logger -> Service -> Proxy * ImportDocumentationParts -> ClientResponse -> m (Response ImportDocumentationParts)

ToBody ImportDocumentationParts

Methods

toBody :: ImportDocumentationParts -> RqBody

ToPath ImportDocumentationParts

Methods

toPath :: ImportDocumentationParts -> ByteString

ToHeaders ImportDocumentationParts

Methods

toHeaders :: ImportDocumentationParts -> [Header]

ToQuery ImportDocumentationParts

Methods

toQuery :: ImportDocumentationParts -> QueryString

type Rep ImportDocumentationParts

type Rep ImportDocumentationParts = D1 (MetaData "ImportDocumentationParts" "Network.AWS.APIGateway.ImportDocumentationParts" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "ImportDocumentationParts'" PrefixI True) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_idpMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe PutMode))) (S1 (MetaSel (Just Symbol "_idpFailOnWarnings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_idpRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_idpBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (HashMap Text Value))))))

type Rs ImportDocumentationParts

type Rs ImportDocumentationParts = ImportDocumentationPartsResponse

Request Lenses

idpMode :: Lens' ImportDocumentationParts (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 .

idpFailOnWarnings :: Lens' ImportDocumentationParts (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 .

idpRestAPIId :: Lens' ImportDocumentationParts Text

Required

The identifier of an API of the to-be-imported documentation parts.

idpBody :: Lens' ImportDocumentationParts (HashMap Text Value)

Required

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

Destructuring the Response

importDocumentationPartsResponse

Arguments

:: Int

idprsResponseStatus

-> ImportDocumentationPartsResponse

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

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

• idprsIds - A list of the returned documentation part identifiers.
• idprsWarnings - A list of warning messages reported during import of documentation parts.
• idprsResponseStatus - -- | The response status code.

data ImportDocumentationPartsResponse

A collection of the imported DocumentationPart identifiers.

This is used to return the result when documentation parts in an external (e.g., Swagger) file are imported into Amazon API GatewayDocumenting an API , documentationpart:import , DocumentationPart

See: importDocumentationPartsResponse smart constructor.

Instances

Eq ImportDocumentationPartsResponse

Methods

(==) :: ImportDocumentationPartsResponse -> ImportDocumentationPartsResponse -> Bool

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

Data ImportDocumentationPartsResponse

Methods

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

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

toConstr :: ImportDocumentationPartsResponse -> Constr

dataTypeOf :: ImportDocumentationPartsResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read ImportDocumentationPartsResponse

Methods

readsPrec :: Int -> ReadS ImportDocumentationPartsResponse

readList :: ReadS [ImportDocumentationPartsResponse]

readPrec :: ReadPrec ImportDocumentationPartsResponse

readListPrec :: ReadPrec [ImportDocumentationPartsResponse]

Show ImportDocumentationPartsResponse

Methods

showsPrec :: Int -> ImportDocumentationPartsResponse -> ShowS

show :: ImportDocumentationPartsResponse -> String

showList :: [ImportDocumentationPartsResponse] -> ShowS

Generic ImportDocumentationPartsResponse

Associated Types

type Rep ImportDocumentationPartsResponse :: * -> *

Methods

from :: ImportDocumentationPartsResponse -> Rep ImportDocumentationPartsResponse x

to :: Rep ImportDocumentationPartsResponse x -> ImportDocumentationPartsResponse

NFData ImportDocumentationPartsResponse

Methods

rnf :: ImportDocumentationPartsResponse -> ()

type Rep ImportDocumentationPartsResponse

type Rep ImportDocumentationPartsResponse = D1 (MetaData "ImportDocumentationPartsResponse" "Network.AWS.APIGateway.ImportDocumentationParts" "amazonka-apigateway-1.4.5-BIK2fycuXdJFBbWQ9Hqf16" False) (C1 (MetaCons "ImportDocumentationPartsResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_idprsIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) ((:*:) (S1 (MetaSel (Just Symbol "_idprsWarnings") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) (S1 (MetaSel (Just Symbol "_idprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)))))

Response Lenses

idprsIds :: Lens' ImportDocumentationPartsResponse [Text]

A list of the returned documentation part identifiers.

idprsWarnings :: Lens' ImportDocumentationPartsResponse [Text]

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

idprsResponseStatus :: Lens' ImportDocumentationPartsResponse Int

• - | The response status code.