Class: Aws::APIGateway::Types::ImportRestApiRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass ImportRestApiRequest data as a hash:

{
  fail_on_warnings: false,
  parameters: {
    "String" => "String",
  },
  body: "data", # required
}

A POST request to import an API to API Gateway using an input of an API definition file.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

The POST request body containing external API definitions. Currently, only OpenAPI definition JSON/YAML files are supported. The maximum size of the API definition file is 6MB.

Returns:

  • (String)

4182
4183
4184
4185
4186
4187
4188
# File 'lib/aws-sdk-apigateway/types.rb', line 4182

class ImportRestApiRequest < Struct.new(
  :fail_on_warnings,
  :parameters,
  :body)
  SENSITIVE = []
  include Aws::Structure
end

#fail_on_warningsBoolean

A query parameter to indicate whether to rollback the API creation (`true`) or not (`false`) when a warning is encountered. The default value is `false`.

Returns:

  • (Boolean)

4182
4183
4184
4185
4186
4187
4188
# File 'lib/aws-sdk-apigateway/types.rb', line 4182

class ImportRestApiRequest < Struct.new(
  :fail_on_warnings,
  :parameters,
  :body)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,String>

A key-value map of context-specific query string parameters specifying the behavior of different API importing operations. The following shows operation-specific parameters and their supported values.

To exclude DocumentationParts from the import, set `parameters` as `ignore=documentation`.

To configure the endpoint type, set `parameters` as `endpointConfigurationTypes=EDGE`, `endpointConfigurationTypes=REGIONAL`, or `endpointConfigurationTypes=PRIVATE`. The default endpoint type is `EDGE`.

To handle imported `basepath`, set `parameters` as `basepath=ignore`, `basepath=prepend` or `basepath=split`.

For example, the AWS CLI command to exclude documentation from the imported API is:

The AWS CLI command to set the regional endpoint on the imported API is:

Returns:

  • (Hash<String,String>)

4182
4183
4184
4185
4186
4187
4188
# File 'lib/aws-sdk-apigateway/types.rb', line 4182

class ImportRestApiRequest < Struct.new(
  :fail_on_warnings,
  :parameters,
  :body)
  SENSITIVE = []
  include Aws::Structure
end