Amazon API Gateway REST API Reference

method:put

Create a Method resource on a specified Resource resource.

HTTP Request

PUT /restapis/<restapi_id>/resources/<resource_id>/methods/{http_method}

Template Variable

Request Body

{
  "authorizationType" : "String",
  "authorizerId" : "String",
  "apiKeyRequired" : "Boolean",
  "operationName" : "String",
  "requestParameters" : {
    "String" : "Boolean"
  },
  "requestModels" : {
    "String" : "String"
  },
  "requestValidatorId" : "String",
  "authorizationScopes" : [ "String" ]
}

Request Body Fields

The request accepts the following fields in JSON format.

  • 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.

  • 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.

  • apiKeyRequired

  • Specifies whether the method required a valid ApiKey.

  • 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.

  • 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.

  • 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.

  • requestValidatorId

  • The identifier of a RequestValidator for validating the method request.

  • 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.

Response

Method

Remarks

Example: Create a GET method on an API's root resource

Request

The following example request creates a GET method on the API's root resource. The authorizationType is a required input parameter. Other input parameters are optional.

PUT /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1
Content-Type: application/json
Host: apigateway.us-east-1.amazonaws.com
X-Amz-Date: 20160602T180831Z
Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID}/20160602/us-east-1/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature={sig4_hash}

{
    "authorizationType" : "NONE"
}

You cannot call this PUT request against the same method on the same resource more than once. To update the method name or authorization type, you must delete it and recreate one with the new settings. To update other optional parameters, use the PATCH request to update the method. See method:update.

Response

The successful 200 OK response returns the Method resource representing the created method. For brevity, the curies section is abbreviated in the output below.

{
  "_links": {
    "curies": [
      ...
    ],
    "self": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET",
      "name": "GET",
      "title": "GET"
    },
    "integration:put": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration"
    },
    "method:delete": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET"
    },
    "method:update": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET"
    },
    "methodresponse:put": {
      "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code}",
      "templated": true
    }
  },
  "apiKeyRequired": false,
  "authorizationType": "NONE",
  "httpMethod": "GET"
}

You can follow the links, provided in the returned Method resource, to set up the integration request or method response, to update the method, or delete the method.

See Also

Set up method and integration, Integration, MethodResponse, AWS CLI