AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the PutRestApi operation. A feature of the Amazon API Gateway control service for updating an existing API with an input of external API definitions. The update can take the form of merging the supplied definition into the existing API or overwriting the existing API.

Inheritance Hierarchy

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

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

Syntax

C#
public class PutRestApiRequest : AmazonAPIGatewayRequest
         IAmazonWebServiceRequest

The PutRestApiRequest type exposes the following members

Constructors

NameDescription
Public Method PutRestApiRequest()

Properties

NameTypeDescription
Public Property Body System.IO.MemoryStream

Gets and sets the property Body.

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

Public Property FailOnWarnings System.Boolean

Gets and sets the property FailOnWarnings.

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

Public Property Mode Amazon.APIGateway.PutMode

Gets and sets the property Mode.

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Public Property Parameters System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Parameters.

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of

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

Public Property RestApiId System.String

Gets and sets the property RestApiId.

The string identifier of the associated RestApi.

Version Information

.NET Standard:
Supported in: 1.3

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

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms