| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.APIGateway.UpdateMethod
Description
Updates an existing Method resource.
Synopsis
- data UpdateMethod = UpdateMethod' {
- patchOperations :: Maybe [PatchOperation]
- restApiId :: Text
- resourceId :: Text
- httpMethod :: Text
- newUpdateMethod :: Text -> Text -> Text -> UpdateMethod
- updateMethod_patchOperations :: Lens' UpdateMethod (Maybe [PatchOperation])
- updateMethod_restApiId :: Lens' UpdateMethod Text
- updateMethod_resourceId :: Lens' UpdateMethod Text
- updateMethod_httpMethod :: Lens' UpdateMethod Text
- data Method = Method' {
- apiKeyRequired :: Maybe Bool
- authorizationScopes :: Maybe [Text]
- authorizationType :: Maybe Text
- authorizerId :: Maybe Text
- httpMethod :: Maybe Text
- methodIntegration :: Maybe Integration
- methodResponses :: Maybe (HashMap Text MethodResponse)
- operationName :: Maybe Text
- requestModels :: Maybe (HashMap Text Text)
- requestParameters :: Maybe (HashMap Text Bool)
- requestValidatorId :: Maybe Text
- newMethod :: Method
- method_apiKeyRequired :: Lens' Method (Maybe Bool)
- method_authorizationScopes :: Lens' Method (Maybe [Text])
- method_authorizationType :: Lens' Method (Maybe Text)
- method_authorizerId :: Lens' Method (Maybe Text)
- method_httpMethod :: Lens' Method (Maybe Text)
- method_methodIntegration :: Lens' Method (Maybe Integration)
- method_methodResponses :: Lens' Method (Maybe (HashMap Text MethodResponse))
- method_operationName :: Lens' Method (Maybe Text)
- method_requestModels :: Lens' Method (Maybe (HashMap Text Text))
- method_requestParameters :: Lens' Method (Maybe (HashMap Text Bool))
- method_requestValidatorId :: Lens' Method (Maybe Text)
Creating a Request
data UpdateMethod Source #
Request to update an existing Method resource.
See: newUpdateMethod smart constructor.
Constructors
| UpdateMethod' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> Text | |
| -> UpdateMethod |
Create a value of UpdateMethod with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:patchOperations:UpdateMethod', updateMethod_patchOperations - For more information about supported patch operations, see
Patch Operations.
UpdateMethod, updateMethod_restApiId - The string identifier of the associated RestApi.
$sel:resourceId:UpdateMethod', updateMethod_resourceId - The Resource identifier for the Method resource.
UpdateMethod, updateMethod_httpMethod - The HTTP verb of the Method resource.
Request Lenses
updateMethod_patchOperations :: Lens' UpdateMethod (Maybe [PatchOperation]) Source #
For more information about supported patch operations, see Patch Operations.
updateMethod_restApiId :: Lens' UpdateMethod Text Source #
The string identifier of the associated RestApi.
updateMethod_resourceId :: Lens' UpdateMethod Text Source #
The Resource identifier for the Method resource.
updateMethod_httpMethod :: Lens' UpdateMethod Text Source #
The HTTP verb of the Method resource.
Destructuring the Response
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.
See: newMethod smart constructor.
Constructors
| Method' | |
Fields
| |
Instances
Create a value of Method with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiKeyRequired:Method', method_apiKeyRequired - A boolean flag specifying whether a valid ApiKey is required to invoke
this method.
$sel:authorizationScopes:Method', method_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.
$sel:authorizationType:Method', method_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.
$sel:authorizerId:Method', method_authorizerId - The identifier of an Authorizer to use on this method. The
authorizationType must be CUSTOM.
Method, method_httpMethod - The method's HTTP verb.
$sel:methodIntegration:Method', method_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.
$sel:methodResponses:Method', method_methodResponses - Gets a method response associated with a given HTTP status code.
$sel:operationName:Method', method_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.
$sel:requestModels:Method', method_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).
Method, method_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.
$sel:requestValidatorId:Method', method_requestValidatorId - The identifier of a RequestValidator for request validation.
Response Lenses
method_apiKeyRequired :: Lens' Method (Maybe Bool) Source #
A boolean flag specifying whether a valid ApiKey is required to invoke this method.
method_authorizationScopes :: Lens' Method (Maybe [Text]) Source #
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.
method_authorizationType :: Lens' Method (Maybe Text) Source #
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.
method_authorizerId :: Lens' Method (Maybe Text) Source #
The identifier of an Authorizer to use on this method. The
authorizationType must be CUSTOM.
method_methodIntegration :: Lens' Method (Maybe Integration) Source #
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.
method_methodResponses :: Lens' Method (Maybe (HashMap Text MethodResponse)) Source #
Gets a method response associated with a given HTTP status code.
method_operationName :: Lens' Method (Maybe Text) Source #
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.
method_requestModels :: Lens' Method (Maybe (HashMap Text Text)) Source #
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).
method_requestParameters :: Lens' Method (Maybe (HashMap Text Bool)) Source #
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.