Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/APIGateway/Types/ImportRestApiRequest.html below:

ImportRestApiRequest — AWS SDK for Ruby V2

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

Inherits:

Struct

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

show all

Defined in:

(unknown)

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", }

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

• #body ⇒ String

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

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

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.

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'

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4