sdks

Creates, updates, deletes, gets or lists a sdks resource.

Overview

Name	sdks
Type	Resource
Id	aws.apigateway.sdks

Fields

The following fields are returned by SELECT queries:

get_sdk

Name	Datatype	Description
body	string (byte)	The binary blob response to GetSdk, which contains the generated SDK.
content_disposition	string	The content-disposition header value in the HTTP response.
content_type	string	The content-type header value in the HTTP response.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_sdk	select	restapi_id, stage_name, sdk_type, region	parameters	Generates a client SDK for a RestApi and Stage.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
restapi_id	string	The string identifier of the associated RestApi.
sdk_type	string	The language for the generated SDK. Currently java, javascript, android, objectivec (for iOS), swift (for iOS), and ruby are supported.
stage_name	string	The name of the Stage that the SDK will use.
parameters	object	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.

SELECT examples

get_sdk

Generates a client SDK for a RestApi and Stage.

SELECT
body,
content_disposition,
content_type
FROM aws.apigateway.sdks
WHERE restapi_id = '{{ restapi_id }}' -- required
AND stage_name = '{{ stage_name }}' -- required
AND sdk_type = '{{ sdk_type }}' -- required
AND region = '{{ region }}' -- required
AND parameters = '{{ parameters }}'
;