APIGateway / Client / get_sdk

get_sdk

APIGateway.Client.get_sdk(**kwargs)

Generates a client SDK for a RestApi and Stage.

See also: AWS API Documentation

Request Syntax

response = client.get_sdk(
    restApiId='string',
    stageName='string',
    sdkType='string',
    parameters={
        'string': 'string'
    }
)

Parameters:

• restApiId (string) –

  [REQUIRED]

  The string identifier of the associated RestApi.

• stageName (string) –

  [REQUIRED]

  The name of the Stage that the SDK will use.

• sdkType (string) –

  [REQUIRED]

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

• parameters (dict) –

  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.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'contentType': 'string',
    'contentDisposition': 'string',
    'body': StreamingBody()
}

Response Structure

• (dict) –

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

  • contentType (string) –

    The content-type header value in the HTTP response.

  • contentDisposition (string) –

    The content-disposition header value in the HTTP response.

  • body (StreamingBody) –

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

Exceptions

• APIGateway.Client.exceptions.BadRequestException

• APIGateway.Client.exceptions.ConflictException

• APIGateway.Client.exceptions.LimitExceededException

• APIGateway.Client.exceptions.NotFoundException

• APIGateway.Client.exceptions.UnauthorizedException

• APIGateway.Client.exceptions.TooManyRequestsException