Network.AWS.APIGateway.GetExport

Exports a deployed version of a RestApi in a specified format.

Creating a Request

getExport

Arguments

:: Text

geRestAPIId

-> Text

geStageName

-> Text

geExportType

-> GetExport

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

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

• geParameters - A key-value map of query string parameters that specify properties of the export, depending on the requested exportType . For exportType swagger , any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration extensions. authorizers will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool
• geAccepts - The content-type of the export, for example application/json . Currently application/json and application/yaml are supported for exportType of swagger . This should be specified in the Accept header for direct API requests.
• geRestAPIId - [Required] The string identifier of the associated RestApi .
• geStageName - [Required] The name of the Stage that will be exported.
• geExportType - [Required] The type of export. Currently only swagger is supported.

data GetExport

Request a new export of a RestApi for a particular Stage .

See: getExport smart constructor.

Instances

Eq GetExport

Defined in Network.AWS.APIGateway.GetExport

Methods

(==) :: GetExport -> GetExport -> Bool

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

Data GetExport

Defined in Network.AWS.APIGateway.GetExport

Methods

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

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

toConstr :: GetExport -> Constr

dataTypeOf :: GetExport -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetExport

Defined in Network.AWS.APIGateway.GetExport

Methods

readsPrec :: Int -> ReadS GetExport

readList :: ReadS [GetExport]

readPrec :: ReadPrec GetExport

readListPrec :: ReadPrec [GetExport]

Show GetExport

Defined in Network.AWS.APIGateway.GetExport

Methods

showsPrec :: Int -> GetExport -> ShowS

show :: GetExport -> String

showList :: [GetExport] -> ShowS

Generic GetExport

Defined in Network.AWS.APIGateway.GetExport

Associated Types

type Rep GetExport :: Type -> Type

Methods

from :: GetExport -> Rep GetExport x

to :: Rep GetExport x -> GetExport

Hashable GetExport

Defined in Network.AWS.APIGateway.GetExport

Methods

hashWithSalt :: Int -> GetExport -> Int

hash :: GetExport -> Int

AWSRequest GetExport

Defined in Network.AWS.APIGateway.GetExport

Associated Types

type Rs GetExport :: Type

Methods

request :: GetExport -> Request GetExport

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

ToHeaders GetExport

Defined in Network.AWS.APIGateway.GetExport

Methods

toHeaders :: GetExport -> [Header]

ToPath GetExport

Defined in Network.AWS.APIGateway.GetExport

Methods

toPath :: GetExport -> ByteString

ToQuery GetExport

Defined in Network.AWS.APIGateway.GetExport

Methods

toQuery :: GetExport -> QueryString

NFData GetExport

Defined in Network.AWS.APIGateway.GetExport

Methods

rnf :: GetExport -> ()

type Rep GetExport

Defined in Network.AWS.APIGateway.GetExport

type Rep GetExport = D1 (MetaData "GetExport" "Network.AWS.APIGateway.GetExport" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "GetExport'" PrefixI True) ((S1 (MetaSel (Just "_geParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_geAccepts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_geRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_geStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_geExportType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))

type Rs GetExport

Defined in Network.AWS.APIGateway.GetExport

type Rs GetExport = GetExportResponse

Request Lenses

geParameters :: Lens' GetExport (HashMap Text Text)

A key-value map of query string parameters that specify properties of the export, depending on the requested exportType . For exportType swagger , any combination of the following parameters are supported: integrations will export the API with x-amazon-apigateway-integration extensions. authorizers will export the API with x-amazon-apigateway-authorizer extensions. postman will export the API with Postman extensions, allowing for import to the Postman tool

geAccepts :: Lens' GetExport (Maybe Text)

The content-type of the export, for example application/json . Currently application/json and application/yaml are supported for exportType of swagger . This should be specified in the Accept header for direct API requests.

geRestAPIId :: Lens' GetExport Text

Required

The string identifier of the associated RestApi .

geStageName :: Lens' GetExport Text

Required

The name of the Stage that will be exported.

geExportType :: Lens' GetExport Text

Required

The type of export. Currently only swagger is supported.

Destructuring the Response

getExportResponse

Arguments

:: Int

gersResponseStatus

-> GetExportResponse

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

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

• gersBody - The binary blob response to GetExport , which contains the export.
• gersContentDisposition - The content-disposition header value in the HTTP response.
• gersContentType - The content-type header value in the HTTP response. This will correspond to a valid accept type in the request.
• gersResponseStatus - -- | The response status code.

data GetExportResponse

The binary blob response to GetExport , which contains the generated SDK.

See: getExportResponse smart constructor.

Instances

Eq GetExportResponse

Defined in Network.AWS.APIGateway.GetExport

Methods

(==) :: GetExportResponse -> GetExportResponse -> Bool

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

Data GetExportResponse

Defined in Network.AWS.APIGateway.GetExport

Methods

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

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

toConstr :: GetExportResponse -> Constr

dataTypeOf :: GetExportResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show GetExportResponse

Defined in Network.AWS.APIGateway.GetExport

Methods

showsPrec :: Int -> GetExportResponse -> ShowS

show :: GetExportResponse -> String

showList :: [GetExportResponse] -> ShowS

Generic GetExportResponse

Defined in Network.AWS.APIGateway.GetExport

Associated Types

type Rep GetExportResponse :: Type -> Type

Methods

from :: GetExportResponse -> Rep GetExportResponse x

to :: Rep GetExportResponse x -> GetExportResponse

NFData GetExportResponse

Defined in Network.AWS.APIGateway.GetExport

Methods

rnf :: GetExportResponse -> ()

type Rep GetExportResponse

Defined in Network.AWS.APIGateway.GetExport

type Rep GetExportResponse = D1 (MetaData "GetExportResponse" "Network.AWS.APIGateway.GetExport" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "GetExportResponse'" PrefixI True) ((S1 (MetaSel (Just "_gersBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 (MetaSel (Just "_gersContentDisposition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gersContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gersResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gersBody :: Lens' GetExportResponse (Maybe ByteString)

The binary blob response to GetExport , which contains the export.

gersContentDisposition :: Lens' GetExportResponse (Maybe Text)

The content-disposition header value in the HTTP response.

gersContentType :: Lens' GetExportResponse (Maybe Text)

The content-type header value in the HTTP response. This will correspond to a valid accept type in the request.

gersResponseStatus :: Lens' GetExportResponse Int

• - | The response status code.