GetMethodResult

data class GetMethodResult(val apiKeyRequired: Boolean? = null, val authorizationScopes: List<String>? = null, val authorizationType: String? = null, val authorizerId: String? = null, val integration: MethodIntegration? = null, val methodResponses: List<MethodResponse>? = null, val operationName: String? = null, val requestModels: Map<String, String>? = null, val requestParameters: Map<String, Either<Boolean, String>>? = null, val requestValidatorId: String? = null)

Constructors

Link copied to clipboard
constructor(apiKeyRequired: Boolean? = null, authorizationScopes: List<String>? = null, authorizationType: String? = null, authorizerId: String? = null, integration: MethodIntegration? = null, methodResponses: List<MethodResponse>? = null, operationName: String? = null, requestModels: Map<String, String>? = null, requestParameters: Map<String, Either<Boolean, String>>? = null, requestValidatorId: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val apiKeyRequired: Boolean? = null

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

Link copied to clipboard

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.

Link copied to clipboard

The method's authorization type. This parameter is required. For valid values, see Method in the API Gateway API Reference. If you specify the `AuthorizerId` property, specify `CUSTOM` or `COGNITO_USER_POOLS` for this property.

Link copied to clipboard
val authorizerId: String? = null

The identifier of an authorizer to use on this method. The method's authorization type must be `CUSTOM` or `COGNITO_USER_POOLS`.

Link copied to clipboard

Represents an `HTTP`, `HTTP_PROXY`, `AWS`, `AWS_PROXY`, or Mock integration.

Link copied to clipboard

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

Link copied to clipboard
val operationName: String? = null

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.

Link copied to clipboard

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

Link copied to clipboard
val requestParameters: Map<String, Either<Boolean, String>>? = null

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.

Link copied to clipboard

The identifier of a RequestValidator for request validation.