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.

Represents a REST API.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.APIGateway.Model.UpdateRestApiResponse

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

Syntax

C#
public class UpdateRestApiResponse : AmazonWebServiceResponse

The UpdateRestApiResponse type exposes the following members

Constructors

NameDescription
Public Method UpdateRestApiResponse()

Properties

NameTypeDescription
Public Property ApiKeySource Amazon.APIGateway.ApiKeySourceType

Gets and sets the property ApiKeySource.

The source of the API key for metering requests according to a usage plan. Valid values are: >HEADER to read the API key from the X-API-Key header of a request. AUTHORIZER to read the API key from the UsageIdentifierKey from a custom authorizer.

Public Property BinaryMediaTypes System.Collections.Generic.List<System.String>

Gets and sets the property BinaryMediaTypes.

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreatedDate System.DateTime

Gets and sets the property CreatedDate.

The timestamp when the API was created.

Public Property Description System.String

Gets and sets the property Description.

The API's description.

Public Property DisableExecuteApiEndpoint System.Boolean

Gets and sets the property DisableExecuteApiEndpoint.

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Public Property EndpointConfiguration Amazon.APIGateway.Model.EndpointConfiguration

Gets and sets the property EndpointConfiguration.

The endpoint configuration of this RestApi showing the endpoint types of the API.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Id System.String

Gets and sets the property Id.

The API's identifier. This identifier is unique across all of your APIs in API Gateway.

Public Property MinimumCompressionSize System.Int32

Gets and sets the property MinimumCompressionSize.

A nullable integer that is used to enable compression (with non-negative between 0 and 10485760 (10M) bytes, inclusive) or disable compression (with a null value) on an API. When compression is enabled, compression or decompression is not applied on the payload if the payload size is smaller than this value. Setting it to zero allows compression for any payload size.

Public Property Name System.String

Gets and sets the property Name.

The API's name.

Public Property Policy System.String

Gets and sets the property Policy.

A stringified JSON policy document that applies to this RestApi regardless of the caller and Method configuration.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property RootResourceId System.String

Gets and sets the property RootResourceId.

The API's root resource ID.

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

Gets and sets the property Tags.

The collection of tags. Each tag element is associated with a given resource.

Public Property Version System.String

Gets and sets the property Version.

A version identifier for the API.

Public Property Warnings System.Collections.Generic.List<System.String>

Gets and sets the property Warnings.

The warning messages reported when failonwarnings is turned on during API import.

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