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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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.

Constant Summary collapse

SENSITIVE =
[]

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)


3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#authorization_scopesArray<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.

Returns:

  • (Array<String>)


3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  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)


3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#authorizer_idString

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

Returns:

  • (String)


3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#http_methodString

The method’s HTTP verb.

Returns:

  • (String)


3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  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.

Returns:



3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#method_responsesHash<String,Types::MethodResponse>

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

Returns:



3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  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 the `PetStore` example.

Returns:

  • (String)


3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  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>)


3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#request_parametersHash<String,Boolean>

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.

Returns:

  • (Hash<String,Boolean>)


3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end

#request_validator_idString

The identifier of a RequestValidator for request validation.

Returns:

  • (String)


3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
# File 'lib/aws-sdk-apigateway/types.rb', line 3787

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,
  :authorization_scopes)
  SENSITIVE = []
  include Aws::Structure
end