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 |
Generates a client SDK for a RestApi
and Stage
.
- getSDK :: Text -> Text -> Text -> GetSDK
- data GetSDK
- gsdkParameters :: Lens' GetSDK (HashMap Text Text)
- gsdkRestAPIId :: Lens' GetSDK Text
- gsdkStageName :: Lens' GetSDK Text
- gsdkSdkType :: Lens' GetSDK Text
- getSDKResponse :: Int -> GetSDKResponse
- data GetSDKResponse
- gsdkrsBody :: Lens' GetSDKResponse (Maybe (HashMap Text Value))
- gsdkrsContentDisposition :: Lens' GetSDKResponse (Maybe Text)
- gsdkrsContentType :: Lens' GetSDKResponse (Maybe Text)
- gsdkrsResponseStatus :: Lens' GetSDKResponse Int
Creating a Request
Creates a value of GetSDK
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gsdkParameters
- A key-value map of query string parameters that specify properties of the SDK, depending on the requestedsdkType
. ForsdkType
ofobjectivec
, a parameter namedclassPrefix
is required. ForsdkType
ofandroid
, parameters namedgroupId
,artifactId
,artifactVersion
, andinvokerPackage
are required.gsdkRestAPIId
- The identifier of theRestApi
that the SDK will use.gsdkStageName
- The name of theStage
that the SDK will use.gsdkSdkType
- The language for the generated SDK. Currentlyjavascript
,android
, andobjectivec
(for iOS) are supported.
Eq GetSDK Source # | |
Data GetSDK Source # | |
Read GetSDK Source # | |
Show GetSDK Source # | |
Generic GetSDK Source # | |
Hashable GetSDK Source # | |
NFData GetSDK Source # | |
AWSRequest GetSDK Source # | |
ToPath GetSDK Source # | |
ToHeaders GetSDK Source # | |
ToQuery GetSDK Source # | |
type Rep GetSDK Source # | |
type Rs GetSDK Source # | |
Request Lenses
gsdkParameters :: Lens' GetSDK (HashMap Text Text) Source #
A key-value map of query string parameters that specify properties of the SDK, depending on the requested sdkType
. For sdkType
of objectivec
, a parameter named classPrefix
is required. For sdkType
of android
, parameters named groupId
, artifactId
, artifactVersion
, and invokerPackage
are required.
gsdkSdkType :: Lens' GetSDK Text Source #
The language for the generated SDK. Currently javascript
, android
, and objectivec
(for iOS) are supported.
Destructuring the Response
Creates a value of GetSDKResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gsdkrsBody
- The binary blob response toGetSdk
, which contains the generated SDK.gsdkrsContentDisposition
- The content-disposition header value in the HTTP response.gsdkrsContentType
- The content-type header value in the HTTP response.gsdkrsResponseStatus
- -- | The response status code.
data GetSDKResponse Source #
The binary blob response to GetSdk
, which contains the generated SDK.
See: getSDKResponse
smart constructor.
Response Lenses
gsdkrsBody :: Lens' GetSDKResponse (Maybe (HashMap Text Value)) Source #
The binary blob response to GetSdk
, which contains the generated SDK.
gsdkrsContentDisposition :: Lens' GetSDKResponse (Maybe Text) Source #
The content-disposition header value in the HTTP response.
gsdkrsContentType :: Lens' GetSDKResponse (Maybe Text) Source #
The content-type header value in the HTTP response.
gsdkrsResponseStatus :: Lens' GetSDKResponse Int Source #
- - | The response status code.