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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

Instance Attribute Summary collapse

Instance Attribute Details

#bodyString

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

Returns:

  • (String)


4186
4187
4188
4189
4190
4191
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4186

class ImportRestApiRequest < Struct.new(
  :fail_on_warnings,
  :parameters,
  :body)
  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)


4186
4187
4188
4189
4190
4191
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4186

class ImportRestApiRequest < Struct.new(
  :fail_on_warnings,
  :parameters,
  :body)
  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 orendpointConfigurationTypes=REGIONAL. 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:

aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json

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

aws apigateway import-rest-api --parameters endpointConfigurationTypes=REGIONAL --body 'file:///path/to/imported-api-body.json

Returns:

  • (Hash<String,String>)


4186
4187
4188
4189
4190
4191
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4186

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