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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Generates a client SDK for a RestApi and Stage.

Synopsis

data GetSdk = GetSdk' {
- parameters :: Maybe (HashMap Text Text)
- restApiId :: Text
- stageName :: Text
- sdkType :: Text
}
newGetSdk :: Text -> Text -> Text -> GetSdk
getSdk_parameters :: Lens' GetSdk (Maybe (HashMap Text Text))
getSdk_restApiId :: Lens' GetSdk Text
getSdk_stageName :: Lens' GetSdk Text
getSdk_sdkType :: Lens' GetSdk Text
data GetSdkResponse = GetSdkResponse' {
- body :: Maybe ByteString
- contentDisposition :: Maybe Text
- contentType :: Maybe Text
- httpStatus :: Int
}
newGetSdkResponse :: Int -> GetSdkResponse
getSdkResponse_body :: Lens' GetSdkResponse (Maybe ByteString)
getSdkResponse_contentDisposition :: Lens' GetSdkResponse (Maybe Text)
getSdkResponse_contentType :: Lens' GetSdkResponse (Maybe Text)
getSdkResponse_httpStatus :: Lens' GetSdkResponse Int

Creating a Request

data GetSdk Source #

Request a new generated client SDK for a RestApi and Stage.

See: newGetSdk smart constructor.

Constructors

GetSdk'

Fields

parameters :: Maybe (HashMap Text Text)
A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.
restApiId :: Text
The string identifier of the associated RestApi.
stageName :: Text
The name of the Stage that the SDK will use.
sdkType :: Text
The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

Instances

Instances details

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

newGetSdk Source #

Arguments

:: Text	`GetSdk`
-> Text	`GetSdk`
-> Text	`$sel:sdkType:GetSdk'`
-> GetSdk

Create a value of GetSdk 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:parameters:GetSdk', getSdk_parameters - A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.

GetSdk, getSdk_restApiId - The string identifier of the associated RestApi.

GetSdk, getSdk_stageName - The name of the Stage that the SDK will use.

$sel:sdkType:GetSdk', getSdk_sdkType - The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

Request Lenses

getSdk_parameters :: Lens' GetSdk (Maybe (HashMap Text Text)) Source #

A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK. For sdkType of objectivec or swift, a parameter named classPrefix is required. For sdkType of android, parameters named groupId, artifactId, artifactVersion, and invokerPackage are required. For sdkType of java, parameters named serviceName and javaPackageName are required.

getSdk_restApiId :: Lens' GetSdk Text Source #

The string identifier of the associated RestApi.

getSdk_stageName :: Lens' GetSdk Text Source #

The name of the Stage that the SDK will use.

getSdk_sdkType :: Lens' GetSdk Text Source #

The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.

Destructuring the Response

data GetSdkResponse Source #

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

See: newGetSdkResponse smart constructor.

Constructors

GetSdkResponse'
Fields body :: Maybe ByteString The binary blob response to GetSdk, which contains the generated SDK. contentDisposition :: Maybe Text The content-disposition header value in the HTTP response. contentType :: Maybe Text The content-type header value in the HTTP response. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Associated Types type Rep GetSdkResponse :: Type -> Type # Methods from :: GetSdkResponse -> Rep GetSdkResponse x # to :: Rep GetSdkResponse x -> GetSdkResponse #
Show GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods showsPrec :: Int -> GetSdkResponse -> ShowS # show :: GetSdkResponse -> String # showList :: [GetSdkResponse] -> ShowS #
NFData GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods rnf :: GetSdkResponse -> () #
Eq GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk Methods (==) :: GetSdkResponse -> GetSdkResponse -> Bool # (/=) :: GetSdkResponse -> GetSdkResponse -> Bool #
type Rep GetSdkResponse Source #
Instance details Defined in Amazonka.APIGateway.GetSdk type Rep GetSdkResponse = D1 ('MetaData "GetSdkResponse" "Amazonka.APIGateway.GetSdk" "amazonka-apigateway-2.0-zw0Lbt4rUGxZBjJ4Rpfi" 'False) (C1 ('MetaCons "GetSdkResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "body") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ByteString)) :: S1 ('MetaSel ('Just "contentDisposition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "contentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetSdkResponse Source #

Arguments

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

Create a value of GetSdkResponse 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:body:GetSdkResponse', getSdkResponse_body - The binary blob response to GetSdk, which contains the generated SDK.

$sel:contentDisposition:GetSdkResponse', getSdkResponse_contentDisposition - The content-disposition header value in the HTTP response.

GetSdkResponse, getSdkResponse_contentType - The content-type header value in the HTTP response.

$sel:httpStatus:GetSdkResponse', getSdkResponse_httpStatus - The response's http status code.

Response Lenses

getSdkResponse_body :: Lens' GetSdkResponse (Maybe ByteString) Source #

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

getSdkResponse_contentDisposition :: Lens' GetSdkResponse (Maybe Text) Source #

The content-disposition header value in the HTTP response.

getSdkResponse_contentType :: Lens' GetSdkResponse (Maybe Text) Source #

The content-type header value in the HTTP response.

getSdkResponse_httpStatus :: Lens' GetSdkResponse Int Source #

The response's http status code.