You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::APIGateway::Types::Method

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

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.

#### Example: Retrive the GET method on a specified resource ##### Request The following example request retrieves the information about the GET method on an API resource (`3kzxbg5sa2`) of an API (`fugvjdxtri`). GET /restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com X-Amz-Date: 20160603T210259Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID\}/20160603/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash\} ##### Response The successful response returns a `200 OK` status code and a payload similar to the following: \{ "_links": \{ "curies": [ \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel\}.html", "name": "integration", "templated": true \}, \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel\}.html", "name": "integrationresponse", "templated": true \}, \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-{rel\}.html", "name": "method", "templated": true \}, \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel\}.html", "name": "methodresponse", "templated": true \} ], "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:integration": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "method:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "method:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET" \}, "methodresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/{status_code\}", "templated": true \} \}, "apiKeyRequired": true, "authorizationType": "NONE", "httpMethod": "GET", "_embedded": \{ "method:integration": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integration:responses": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integration:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration" \}, "integrationresponse:put": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/{status_code\}", "templated": true \} \}, "cacheKeyParameters": [], "cacheNamespace": "3kzxbg5sa2", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestParameters": \{ "integration.request.header.Content-Type": "'application/x-amz-json-1.1'" \}, "requestTemplates": \{ "application/json": "{\n\}" \}, "type": "AWS", "uri": "arn:aws:apigateway:us-east-1:kinesis:action/ListStreams", "_embedded": \{ "integration:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.Content-Type": "'application/xml'" \}, "responseTemplates": \{ "application/json": "$util.urlDecode("%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E")" \}, "statusCode": "200" \} \} \}, "method:responses": \{ "_links": \{ "self": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200", "name": "200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/fugvjdxtri/resources/3kzxbg5sa2/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.Content-Type": false \}, "statusCode": "200" \} \} \} In the example above, the response template for the `200 OK` response maps the JSON output from the `ListStreams` action in the back end to an XML output. The mapping template is URL-encoded as `%3CkinesisStreams%3E%23foreach(%24stream%20in%20%24input.path(%27%24.StreamNames%27))%3Cstream%3E%3Cname%3E%24stream%3C%2Fname%3E%3C%2Fstream%3E%23end%3C%2FkinesisStreams%3E` and the output is decoded using the [$util.urlDecode()][1] helper function.
MethodResponse, Integration, IntegrationResponse, Resource, [Set up an API's method][2]

Instance Attribute Summary collapse

Instance Attribute Details

#api_key_requiredBoolean

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

Returns:

  • (Boolean)


4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end

#authorization_typeString

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.

Returns:

  • (String)


4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end

#authorizer_idString

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

Returns:

  • (String)


4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end

#http_methodString

The method's HTTP verb.

Returns:

  • (String)


4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end

#method_integrationTypes::Integration

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.

#### Example: ##### Request GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T213210Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID\}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash\} ##### Response The successful response returns a `200 OK` status code and a payload similar to the following: \{ "_links": \{ "curies": [ \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-{rel\}.html", "name": "integration", "templated": true \}, \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-integration-response-{rel\}.html", "name": "integrationresponse", "templated": true \} ], "self": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" \}, "integration:delete": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" \}, "integration:responses": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integration:update": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration" \}, "integrationresponse:put": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/{status_code\}", "templated": true \} \}, "cacheKeyParameters": [], "cacheNamespace": "0cjtch", "credentials": "arn:aws:iam::123456789012:role/apigAwsProxyRole", "httpMethod": "POST", "passthroughBehavior": "WHEN_NO_MATCH", "requestTemplates": \{ "application/json": "{\n "a": "$input.params('operand1')",\n "b": "$input.params('operand2')", \n "op": "$input.params('operator')" \n\}" \}, "type": "AWS", "uri": "arn:aws:apigateway:us-west-2:lambda:path//2015-03-31/functions/arn:aws:lambda:us-west-2:123456789012:function:Calc/invocations", "_embedded": \{ "integration:responses": \{ "_links": \{ "self": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200", "name": "200", "title": "200" \}, "integrationresponse:delete": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" \}, "integrationresponse:update": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/integration/responses/200" \} \}, "responseParameters": \{ "method.response.header.operator": "integration.response.body.op", "method.response.header.operand_2": "integration.response.body.b", "method.response.header.operand_1": "integration.response.body.a" \}, "responseTemplates": \{ "application/json": "#set($res = $input.path('$'))\n{\n "result": "$res.a, $res.b, $res.op => $res.c",\n "a" : "$res.a",\n "b" : "$res.b",\n "op" : "$res.op",\n "c" : "$res.c"\n\}" \}, "selectionPattern": "", "statusCode": "200" \} \} \}
[AWS CLI][1]

Returns:



4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end

#method_responsesHash<String,Types::MethodResponse>

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

The collection of method responses are encapsulated in a key-value map, where the key is a response's HTTP status code and the value is a MethodResponse resource that specifies the response returned to the caller from the back end through the integration response. #### Example: Get a 200 OK response of a GET method ##### Request GET /restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200 HTTP/1.1 Content-Type: application/json Host: apigateway.us-east-1.amazonaws.com Content-Length: 117 X-Amz-Date: 20160613T215008Z Authorization: AWS4-HMAC-SHA256 Credential={access_key_ID\}/20160613/us-east-1/apigateway/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature={sig4_hash\} ##### Response The successful response returns a `200 OK` status code and a payload similar to the following: \{ "_links": \{ "curies": \{ "href": "http://docs.aws.amazon.com/apigateway/latest/developerguide/restapi-method-response-{rel\}.html", "name": "methodresponse", "templated": true \}, "self": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200", "title": "200" \}, "methodresponse:delete": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" \}, "methodresponse:update": \{ "href": "/restapis/uojnr9hd57/resources/0cjtch/methods/GET/responses/200" \} \}, "responseModels": \{ "application/json": "Empty" \}, "responseParameters": \{ "method.response.header.operator": false, "method.response.header.operand_2": false, "method.response.header.operand_1": false \}, "statusCode": "200" \}
[AWS CLI][1]

Returns:



4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end

#operation_nameString

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

Returns:

  • (String)


4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end

#request_modelsHash<String,String>

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

Returns:

  • (Hash<String,String>)


4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end

#request_parametersHash<String,Boolean>

A key-value map defining required or optional method request parameters that can be accepted by Amazon 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.

Returns:

  • (Hash<String,Boolean>)


4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end

#request_validator_idString

The identifier of a RequestValidator for request validation.

Returns:

  • (String)


4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 4164

class Method < Struct.new(
  :http_method,
  :authorization_type,
  :authorizer_id,
  :api_key_required,
  :request_validator_id,
  :operation_name,
  :request_parameters,
  :request_models,
  :method_responses,
  :method_integration)
  include Aws::Structure
end