/AWS1/CL_AGWMETHOD

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_httpmethod TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The method's HTTP verb.

iv_authorizationtype TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

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.

iv_authorizerid TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

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

iv_apikeyrequired TYPE /AWS1/AGWNULLABLEBOOLEAN /AWS1/AGWNULLABLEBOOLEAN

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

iv_requestvalidatorid TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

The identifier of a RequestValidator for request validation.

iv_operationname TYPE /AWS1/AGWSTRING /AWS1/AGWSTRING

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.

it_requestparameters TYPE /AWS1/CL_AGWMAPOFSTRINGTOBLN_W=>TT_MAPOFSTRINGTOBOOLEAN TT_MAPOFSTRINGTOBOOLEAN

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.

it_requestmodels TYPE /AWS1/CL_AGWMAPOFSTRTOSTR_W=>TT_MAPOFSTRINGTOSTRING TT_MAPOFSTRINGTOSTRING

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

it_methodresponses TYPE /AWS1/CL_AGWMETHODRESPONSE=>TT_MAPOFMETHODRESPONSE TT_MAPOFMETHODRESPONSE

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

io_methodintegration TYPE REF TO /AWS1/CL_AGWINTEGRATION /AWS1/CL_AGWINTEGRATION

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.

it_authorizationscopes TYPE /AWS1/CL_AGWLISTOFSTRING_W=>TT_LISTOFSTRING TT_LISTOFSTRING

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.

---

Queryable Attributes

httpMethod

The method's HTTP verb.

Accessible with the following methods

Method	Description
GET_HTTPMETHOD()	Getter for HTTPMETHOD, with configurable default
ASK_HTTPMETHOD()	Getter for HTTPMETHOD w/ exceptions if field has no value
HAS_HTTPMETHOD()	Determine if HTTPMETHOD has a value

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.

Accessible with the following methods

Method	Description
GET_AUTHORIZATIONTYPE()	Getter for AUTHORIZATIONTYPE, with configurable default
ASK_AUTHORIZATIONTYPE()	Getter for AUTHORIZATIONTYPE w/ exceptions if field has no v
HAS_AUTHORIZATIONTYPE()	Determine if AUTHORIZATIONTYPE has a value

authorizerId

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

Accessible with the following methods

Method	Description
GET_AUTHORIZERID()	Getter for AUTHORIZERID, with configurable default
ASK_AUTHORIZERID()	Getter for AUTHORIZERID w/ exceptions if field has no value
HAS_AUTHORIZERID()	Determine if AUTHORIZERID has a value

apiKeyRequired

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

Accessible with the following methods

Method	Description
GET_APIKEYREQUIRED()	Getter for APIKEYREQUIRED, with configurable default
ASK_APIKEYREQUIRED()	Getter for APIKEYREQUIRED w/ exceptions if field has no valu
HAS_APIKEYREQUIRED()	Determine if APIKEYREQUIRED has a value

requestValidatorId

The identifier of a RequestValidator for request validation.

Accessible with the following methods

Method	Description
GET_REQUESTVALIDATORID()	Getter for REQUESTVALIDATORID, with configurable default
ASK_REQUESTVALIDATORID()	Getter for REQUESTVALIDATORID w/ exceptions if field has no
HAS_REQUESTVALIDATORID()	Determine if REQUESTVALIDATORID has a value

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.

Accessible with the following methods

Method	Description
GET_OPERATIONNAME()	Getter for OPERATIONNAME, with configurable default
ASK_OPERATIONNAME()	Getter for OPERATIONNAME w/ exceptions if field has no value
HAS_OPERATIONNAME()	Determine if OPERATIONNAME has a value

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.

Accessible with the following methods

Method	Description
GET_REQUESTPARAMETERS()	Getter for REQUESTPARAMETERS, with configurable default
ASK_REQUESTPARAMETERS()	Getter for REQUESTPARAMETERS w/ exceptions if field has no v
HAS_REQUESTPARAMETERS()	Determine if REQUESTPARAMETERS has a value

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

Accessible with the following methods

Method	Description
GET_REQUESTMODELS()	Getter for REQUESTMODELS, with configurable default
ASK_REQUESTMODELS()	Getter for REQUESTMODELS w/ exceptions if field has no value
HAS_REQUESTMODELS()	Determine if REQUESTMODELS has a value

methodResponses

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

Accessible with the following methods

Method	Description
GET_METHODRESPONSES()	Getter for METHODRESPONSES, with configurable default
ASK_METHODRESPONSES()	Getter for METHODRESPONSES w/ exceptions if field has no val
HAS_METHODRESPONSES()	Determine if METHODRESPONSES has a value

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.

Accessible with the following methods

Method	Description
GET_METHODINTEGRATION()	Getter for METHODINTEGRATION

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.

Accessible with the following methods

Method	Description
GET_AUTHORIZATIONSCOPES()	Getter for AUTHORIZATIONSCOPES, with configurable default
ASK_AUTHORIZATIONSCOPES()	Getter for AUTHORIZATIONSCOPES w/ exceptions if field has no
HAS_AUTHORIZATIONSCOPES()	Determine if AUTHORIZATIONSCOPES has a value

Public Local Types In This Class

Internal table types, representing arrays and maps of this class, are defined as local types:

TT_MAPOFMETHOD

TYPES TT_MAPOFMETHOD TYPE HASHED TABLE OF /AWS1/CL_AGWMETHOD=>TS_MAPOFMETHOD_MAPROW WITH UNIQUE KEY key
.

TS_MAPOFMETHOD_MAPROW

TYPES: BEGIN OF TS_MAPOFMETHOD_MAPROW,
  key TYPE /AWS1/AGWSTRING,
  value TYPE REF TO /AWS1/CL_AGWMETHOD,
END OF TS_MAPOFMETHOD_MAPROW.