Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . apigateway ]
Generates a client SDK for a RestApi and Stage .
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
get-sdk
--rest-api-id <value>
--stage-name <value>
--sdk-type <value>
[--parameters <value>]
<outfile>
--rest-api-id (string)
[Required] The string identifier of the associated RestApi .
--stage-name (string)
[Required] The name of the Stage that the SDK will use.
--sdk-type (string)
[Required] The language for the generated SDK. Currently java , javascript , android , objectivec (for iOS), swift (for iOS), and ruby are supported.
--parameters (map)
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.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=string
JSON Syntax:
{"string": "string"
...}
outfile (string) Filename where the content will be saved
See 'aws help' for descriptions of global parameters.
To get the Android SDK for a REST API stage
Command:
aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type android --parameters groupId='com.mycompany',invokerPackage='com.mycompany.clientsdk',artifactId='Mycompany-client',artifactVersion='1.0.0' /path/to/android_sdk.zip
Output:
{
"contentType": "application/octet-stream",
"contentDisposition": "attachment; filename=\"android_2016-02-22_23-52Z.zip\""
}
To get the IOS SDK for a REST API stage
Command:
aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type objectivec --parameters classPrefix='myprefix' /path/to/iOS_sdk.zip
Output:
{
"contentType": "application/octet-stream",
"contentDisposition": "attachment; filename=\"objectivec_2016-02-22_23-52Z.zip\""
}
To get the Javascript SDK for a REST API stage
Command:
aws apigateway get-sdk --rest-api-id 1234123412 --stage-name dev --sdk-type javascript /path/to/javascript_sdk.zip
Output:
{
"contentType": "application/octet-stream",
"contentDisposition": "attachment; filename=\"javascript_2016-02-22_23-52Z.zip\""
}
contentType -> (string)
The content-type header value in the HTTP response.
contentDisposition -> (string)
The content-disposition header value in the HTTP response.
body -> (blob)
The binary blob response to GetSdk , which contains the generated SDK.