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 client-facing interface by which the client calls the API to access back-end resources. A Method resource is integrated with an Integration resource. Both consist of a request and one or more responses. The method request takes the client input that is passed to the back end through the integration request. A method response returns the output from the back end to the client through an integration response. A method request is embodied in a Method resource, whereas an integration request is embodied in an Integration resource. On the other hand, a method response is represented by a MethodResponse resource, whereas an integration response is represented by an IntegrationResponse resource.

Inheritance Hierarchy

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

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

Syntax

C#
public class UpdateMethodResponse : AmazonWebServiceResponse

The UpdateMethodResponse type exposes the following members

Constructors

NameDescription
Public Method UpdateMethodResponse()

Properties

NameTypeDescription
Public Property ApiKeyRequired System.Boolean

Gets and sets the property ApiKeyRequired.

A boolean flag specifying whether a valid ApiKey is required to invoke this method.

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.

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.

The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property HttpMethod System.String

Gets and sets the property HttpMethod.

The method's HTTP verb.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property MethodIntegration Amazon.APIGateway.Model.Integration

Gets and sets the property MethodIntegration.

Gets the method's integration responsible for passing the client-submitted request to the back end and performing necessary transformations to make the request compliant with the back end.

Public Property MethodResponses System.Collections.Generic.Dictionary<System.String, Amazon.APIGateway.Model.MethodResponse>

Gets and sets the property MethodResponses.

Gets a method response associated with a given HTTP status code.

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.

A key-value map specifying data schemas, represented by Model resources, (as the mapped value) of the request payloads of given content types (as the mapping key).

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 is 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 templates.

Public Property RequestValidatorId System.String

Gets and sets the property RequestValidatorId.

The identifier of a RequestValidator for request validation.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.

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