An API Gateway Method in AWS defines the specific HTTP request type (such as GET, POST, PUT, DELETE) that can be called on a resource within an API Gateway REST API. It specifies how the request is handled, including integration with backend services, request and response parameters, and authorization settings. This resource is essential for configuring the behavior of individual API endpoints.
Fields
| Title | ID | Type | Data Type | Description |
|---|
| _key | core | string | |
| account_id | core | string | |
| api_key_required | core | bool | A boolean flag specifying whether a valid ApiKey is required to invoke this method. |
| authorization_scopes | core | array<string> | 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. |
| authorization_type | core | string | 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. |
| authorizer_id | core | string | The identifier of an Authorizer to use on this method. The authorizationType must be CUSTOM. |
| http_method | core | string | The method's HTTP verb. |
| method_integration | core | json | 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. |
| method_responses | core | string | Gets a method response associated with a given HTTP status code. |
| operation_name | core | string | 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. |
| request_models | core | hstore | 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). |
| request_parameters | core | string | 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. |
| request_validator_id | core | string | The identifier of a RequestValidator for request validation. |
| tags | core | hstore | |
