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 PutMethod operation. Add a method to an existing Resource resource.

Inheritance Hierarchy


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


public class PutMethodRequest : AmazonAPIGatewayRequest

The PutMethodRequest type exposes the following members


Public Method PutMethodRequest()


Public Property ApiKeyRequired System.Boolean

Gets and sets the property ApiKeyRequired.

Specifies whether the method required a valid ApiKey.

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

Gets and sets the property AuthorizationScopes.

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

Public Property AuthorizationType System.String

Gets and sets the property AuthorizationType.

[Required] The method's authorization type. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, CUSTOM for using a custom authorizer, or COGNITO_USER_POOLS for using a Cognito user pool.

Public Property AuthorizerId System.String

Gets and sets the property AuthorizerId.

Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer.

Public Property HttpMethod System.String

Gets and sets the property HttpMethod.

[Required] Specifies the method request's HTTP method type.

Public Property OperationName System.String

Gets and sets the property OperationName.

A human-friendly operation identifier for the method. For example, you can assign the operationName of ListPets for the GET /pets method in the PetStore example.

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

Gets and sets the property RequestModels.

Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value.

Public Property RequestParameters System.Collections.Generic.Dictionary<System.String, System.Boolean>

Gets and sets the property RequestParameters.

A key-value map defining required or optional method request parameters that can be accepted by API Gateway. A key defines a method request parameter name matching the pattern of method.request.{location}.{name}, where location is querystring, path, or header and name is a valid and unique parameter name. The value associated with the key is a Boolean flag indicating whether the parameter is required (true) or optional (false). The method request parameter names defined here are available in Integration to be mapped to integration request parameters or body-mapping templates.

Public Property RequestValidatorId System.String

Gets and sets the property RequestValidatorId.

The identifier of a RequestValidator for validating the method request.

Public Property ResourceId System.String

Gets and sets the property ResourceId.

[Required] The Resource identifier for the new Method resource.

Public Property RestApiId System.String

Gets and sets the property RestApiId.

[Required] The string identifier of the associated RestApi.

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