You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::APIGateway::Types::GetSdkRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetSdkRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  rest_api_id: "String", # required
  stage_name: "String", # required
  sdk_type: "String", # required
  parameters: {
    "String" => "String",
  },
}

Request a new generated client SDK for a RestApi and Stage.

Instance Attribute Summary collapse

Instance Attribute Details

#parameters ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) —

    A string-to-string key-value map of query parameters sdkType-dependent properties of the SDK.

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) —

    [Required] The string identifier of the associated RestApi.

#sdk_type ⇒ String

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

Returns:

  • (String) —

    [Required] The language for the generated SDK.

#stage_name ⇒ String

[Required] The name of the Stage that the SDK will use.

Returns:

  • (String) —

    [Required] The name of the Stage that the SDK will use.