ImportRestApiRequest Class | AWS SDK for .NET V3

Container for the parameters to the ImportRestApi operation. A feature of the API Gateway control service for creating a new API from an external API definition file.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.APIGateway.AmazonAPIGatewayRequest
      Amazon.APIGateway.Model.ImportRestApiRequest

Namespace: Amazon.APIGateway.Model
Assembly: AWSSDK.APIGateway.dll
Version: 3.x.y.z

Syntax

public class ImportRestApiRequest : AmazonAPIGatewayRequest
         IAmazonWebServiceRequest

The ImportRestApiRequest type exposes the following members

Constructors

	Name	Description
	ImportRestApiRequest()

Properties

Name Type Description

Name	Type	Description
Body	System.IO.MemoryStream	Gets and sets the property Body. 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.
FailOnWarnings	System.Boolean	Gets and sets the property FailOnWarnings. 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`.
Parameters	System.Collections.Generic.Dictionary<System.String, System.String>	Gets and sets the property Parameters. 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`.

Body

System.IO.MemoryStream

Gets and sets the property Body.

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.

FailOnWarnings

System.Boolean

Gets and sets the property FailOnWarnings.

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.

Parameters

System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Parameters.

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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5