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

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::ImportRestApiRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

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

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #body ⇒ String

  The POST request body containing external API definitions.

• #fail_on_warnings ⇒ Boolean

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

• #parameters ⇒ Hash<String,String>

  A key-value map of context-specific query string parameters specifying the behavior of different API importing operations.

Instance Attribute Details

#body ⇒ String

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 3445

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

#fail_on_warnings ⇒ Boolean

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)

# File 'lib/aws-sdk-apigateway/types.rb', line 3445

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

#parameters ⇒ Hash<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`.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-apigateway/types.rb', line 3445

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