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

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

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

Overview

Note:

When passing ImportRestApiRequest as input to an Aws::Client method, you can use a vanilla 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

[Required] 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)

    [Required] The POST request body containing external API definitions.

#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)

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

#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:

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>)

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