Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSdk

Generates a client SDK for a RestApi and Stage.

Request Syntax


GET /restapis/restapi_id/stages/stage_name/sdks/sdk_type?parameters HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

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.

restapi_id

The string identifier of the associated RestApi.

Required: Yes

sdk_type

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

Required: Yes

stage_name

The name of the Stage that the SDK will use.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-Type: contentType
Content-Disposition: contentDisposition

body

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

contentDisposition: The content-disposition header value in the HTTP response.
contentType: The content-type header value in the HTTP response.

The response returns the following as the HTTP body.

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

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The submitted request is not valid, for example, the input is incomplete or incorrect. See the accompanying error message for details.

HTTP Status Code: 400

ConflictException

The request configuration has conflicts. For details, see the accompanying error message.

HTTP Status Code: 409

LimitExceededException

The request exceeded the rate limit. Retry after the specified time period.

HTTP Status Code: 429

NotFoundException

The requested resource is not found. Make sure that the request URI is correct.

HTTP Status Code: 404

TooManyRequestsException

The request has reached its throttling limit. Retry after the specified time period.

HTTP Status Code: 429

UnauthorizedException

The request is denied because the caller has insufficient permissions.

HTTP Status Code: 401