Network.AWS.APIGateway.GetSDK

Generates a client SDK for a RestApi and Stage .

Creating a Request

getSDK

Arguments

:: Text

gsdkRestAPIId

-> Text

gsdkStageName

-> Text

gsdkSdkType

-> GetSDK

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 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.
• gsdkRestAPIId - [Required] The string identifier of the associated RestApi .
• gsdkStageName - [Required] The name of the Stage that the SDK will use.
• gsdkSdkType - [Required] The language for the generated SDK. Currently java , javascript , android , objectivec (for iOS), swift (for iOS), and ruby are supported.

data GetSDK

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

See: getSDK smart constructor.

Instances

Eq GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Methods

(==) :: GetSDK -> GetSDK -> Bool

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

Data GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Methods

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

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

toConstr :: GetSDK -> Constr

dataTypeOf :: GetSDK -> DataType

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

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

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

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

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

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

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

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

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

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

Read GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Methods

readsPrec :: Int -> ReadS GetSDK

readList :: ReadS [GetSDK]

readPrec :: ReadPrec GetSDK

readListPrec :: ReadPrec [GetSDK]

Show GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Methods

showsPrec :: Int -> GetSDK -> ShowS

show :: GetSDK -> String

showList :: [GetSDK] -> ShowS

Generic GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Associated Types

type Rep GetSDK :: Type -> Type

Methods

from :: GetSDK -> Rep GetSDK x

to :: Rep GetSDK x -> GetSDK

Hashable GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Methods

hashWithSalt :: Int -> GetSDK -> Int

hash :: GetSDK -> Int

AWSRequest GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Associated Types

type Rs GetSDK :: Type

Methods

request :: GetSDK -> Request GetSDK

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

ToHeaders GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Methods

toHeaders :: GetSDK -> [Header]

ToPath GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Methods

toPath :: GetSDK -> ByteString

ToQuery GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Methods

toQuery :: GetSDK -> QueryString

NFData GetSDK

Defined in Network.AWS.APIGateway.GetSDK

Methods

rnf :: GetSDK -> ()

type Rep GetSDK

Defined in Network.AWS.APIGateway.GetSDK

type Rep GetSDK = D1 (MetaData "GetSDK" "Network.AWS.APIGateway.GetSDK" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "GetSDK'" PrefixI True) ((S1 (MetaSel (Just "_gsdkParameters") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map Text Text))) :*: S1 (MetaSel (Just "_gsdkRestAPIId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :*: (S1 (MetaSel (Just "_gsdkStageName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_gsdkSdkType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs GetSDK

Defined in Network.AWS.APIGateway.GetSDK

type Rs GetSDK = GetSDKResponse

Request Lenses

gsdkParameters :: Lens' GetSDK (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.

gsdkRestAPIId :: Lens' GetSDK Text

Required

The string identifier of the associated RestApi .

gsdkStageName :: Lens' GetSDK Text

Required

The name of the Stage that the SDK will use.

gsdkSdkType :: Lens' GetSDK Text

Required

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

Destructuring the Response

getSDKResponse

Arguments

:: Int

gsdkrsResponseStatus

-> GetSDKResponse

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 to GetSdk , 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

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

See: getSDKResponse smart constructor.

Instances

Eq GetSDKResponse

Defined in Network.AWS.APIGateway.GetSDK

Methods

(==) :: GetSDKResponse -> GetSDKResponse -> Bool

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

Data GetSDKResponse

Defined in Network.AWS.APIGateway.GetSDK

Methods

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

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

toConstr :: GetSDKResponse -> Constr

dataTypeOf :: GetSDKResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Show GetSDKResponse

Defined in Network.AWS.APIGateway.GetSDK

Methods

showsPrec :: Int -> GetSDKResponse -> ShowS

show :: GetSDKResponse -> String

showList :: [GetSDKResponse] -> ShowS

Generic GetSDKResponse

Defined in Network.AWS.APIGateway.GetSDK

Associated Types

type Rep GetSDKResponse :: Type -> Type

Methods

from :: GetSDKResponse -> Rep GetSDKResponse x

to :: Rep GetSDKResponse x -> GetSDKResponse

NFData GetSDKResponse

Defined in Network.AWS.APIGateway.GetSDK

Methods

rnf :: GetSDKResponse -> ()

type Rep GetSDKResponse

Defined in Network.AWS.APIGateway.GetSDK

type Rep GetSDKResponse = D1 (MetaData "GetSDKResponse" "Network.AWS.APIGateway.GetSDK" "amazonka-apigateway-1.6.1-BCCM2RP3l9Q2ENgHvKrj59" False) (C1 (MetaCons "GetSDKResponse'" PrefixI True) ((S1 (MetaSel (Just "_gsdkrsBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ByteString)) :*: S1 (MetaSel (Just "_gsdkrsContentDisposition") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_gsdkrsContentType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_gsdkrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gsdkrsBody :: Lens' GetSDKResponse (Maybe ByteString)

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

gsdkrsContentDisposition :: Lens' GetSDKResponse (Maybe Text)

The content-disposition header value in the HTTP response.

gsdkrsContentType :: Lens' GetSDKResponse (Maybe Text)

The content-type header value in the HTTP response.

gsdkrsResponseStatus :: Lens' GetSDKResponse Int

• - | The response status code.