Get Sdk

apigateway_get_sdk

R Documentation

Generates a client SDK for a RestApi and Stage¶

Description¶

Generates a client SDK for a RestApi and Stage.

Usage¶

apigateway_get_sdk(restApiId, stageName, sdkType, parameters)

Arguments¶

restApiId

[required] The string identifier of the associated RestApi.

stageName

[required] The name of the Stage that the SDK will use.

sdkType

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

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.

Value¶

A list with the following syntax:

list(
  contentType = "string",
  contentDisposition = "string",
  body = raw
)

Request syntax¶

svc$get_sdk(
  restApiId = "string",
  stageName = "string",
  sdkType = "string",
  parameters = list(
    "string"
  )
)