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.

This is the response object from the GetRoute operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.ApiGatewayV2.Model.GetRouteResponse

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

Syntax

C#
public class GetRouteResponse : AmazonWebServiceResponse

The GetRouteResponse type exposes the following members

Constructors

NameDescription
Public Method GetRouteResponse()

Properties

NameTypeDescription
Public Property ApiGatewayManaged System.Boolean

Gets and sets the property ApiGatewayManaged.

Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.

Public Property ApiKeyRequired System.Boolean

Gets and sets the property ApiKeyRequired.

Specifies whether an API key is required for this route. Supported only for WebSocket APIs.

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

Gets and sets the property AuthorizationScopes.

A list of authorization scopes configured on a route. The scopes are used with a JWT authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Public Property AuthorizationType Amazon.ApiGatewayV2.AuthorizationType

Gets and sets the property AuthorizationType.

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, or JWT for using JSON Web Tokens.

Public Property AuthorizerId System.String

Gets and sets the property AuthorizerId.

The identifier of the Authorizer resource to be associated with this route. The authorizer identifier is generated by API Gateway when you created the authorizer.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ModelSelectionExpression System.String

Gets and sets the property ModelSelectionExpression.

The model selection expression for the route. Supported only for WebSocket APIs.

Public Property OperationName System.String

Gets and sets the property OperationName.

The operation name for the route.

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

Gets and sets the property RequestModels.

The request models for the route. Supported only for WebSocket APIs.

Public Property RequestParameters System.Collections.Generic.Dictionary<System.String, Amazon.ApiGatewayV2.Model.ParameterConstraints>

Gets and sets the property RequestParameters.

The request parameters for the route. Supported only for WebSocket APIs.

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

Gets and sets the property RouteId.

The route ID.

Public Property RouteKey System.String

Gets and sets the property RouteKey.

The route key for the route.

Public Property RouteResponseSelectionExpression System.String

Gets and sets the property RouteResponseSelectionExpression.

The route response selection expression for the route. Supported only for WebSocket APIs.

Public Property Target System.String

Gets and sets the property Target.

The target for the route.

Version Information

.NET Standard:
Supported in: 2.0, 1.3

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

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