GetSdkCommand

Suggest an Edit

Generates a client SDK for a RestApi and Stage.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { APIGatewayClient, GetSdkCommand } from "@aws-sdk/client-api-gateway"; // ES Modules import
// const { APIGatewayClient, GetSdkCommand } = require("@aws-sdk/client-api-gateway"); // CommonJS import
const client = new APIGatewayClient(config);
const input = { // GetSdkRequest
  restApiId: "STRING_VALUE", // required
  stageName: "STRING_VALUE", // required
  sdkType: "STRING_VALUE", // required
  parameters: { // MapOfStringToString
    "<keys>": "STRING_VALUE",
  },
};
const command = new GetSdkCommand(input);
const response = await client.send(command);
// { // SdkResponse
//   contentType: "STRING_VALUE",
//   contentDisposition: "STRING_VALUE",
//   body: new Uint8Array(),
// };

GetSdkCommand Input

See GetSdkCommandInput for more details

Parameter
Type
Description
restApiId
Required
string | undefined

The string identifier of the associated RestApi.

sdkType
Required
string | undefined

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

stageName
Required
string | undefined

The name of the Stage that the SDK will use.

parameters
Record<string, string> | undefined

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.

GetSdkCommand Output

See GetSdkCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
BadRequestException
client

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

ConflictException
client

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

LimitExceededException
client

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

NotFoundException
client

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

TooManyRequestsException
client

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

UnauthorizedException
client

The request is denied because the caller has insufficient permissions.

APIGatewayServiceException
Base exception class for all service exceptions from APIGateway service.