Copyright | (c) 2013-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Exports a deployed version of a RestApi in a specified format.
- getExport :: Text -> Text -> Text -> GetExport
- data GetExport
- geParameters :: Lens' GetExport (HashMap Text Text)
- geAccepts :: Lens' GetExport (Maybe Text)
- geRestAPIId :: Lens' GetExport Text
- geStageName :: Lens' GetExport Text
- geExportType :: Lens' GetExport Text
- getExportResponse :: Int -> GetExportResponse
- data GetExportResponse
- gersBody :: Lens' GetExportResponse (Maybe (HashMap Text Value))
- gersContentDisposition :: Lens' GetExportResponse (Maybe Text)
- gersContentType :: Lens' GetExportResponse (Maybe Text)
- gersResponseStatus :: Lens' GetExportResponse Int
Creating a Request
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:
Request Lenses
geParameters :: Lens' GetExport (HashMap Text Text) Source #
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 x-amazon-apigateway-integration extensions 'authorizers' will export x-amazon-apigateway-authorizer extensions 'postman' will export with Postman extensions, allowing for import to the Postman tool
geAccepts :: Lens' GetExport (Maybe Text) Source #
The content-type of the export, for example 'application/json'. Currently 'application/json' and 'application/yaml' are supported for exportType 'swagger'. Should be specifed in the 'Accept' header for direct API requests.
geExportType :: Lens' GetExport Text Source #
The type of export. Currently only 'swagger' is supported.
Destructuring the Response
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:
data GetExportResponse Source #
The binary blob response to GetExport, which contains the generated SDK.
See: getExportResponse
smart constructor.
Response Lenses
gersBody :: Lens' GetExportResponse (Maybe (HashMap Text Value)) Source #
The binary blob response to GetExport, which contains the export.
gersContentDisposition :: Lens' GetExportResponse (Maybe Text) Source #
The content-disposition header value in the HTTP reseponse.
gersContentType :: Lens' GetExportResponse (Maybe Text) Source #
The content-type header value in the HTTP response. This will correspond to a valid 'accept' type in the request.
gersResponseStatus :: Lens' GetExportResponse Int Source #
The response status code.