Description Usage Arguments Value Request syntax
View source: R/apigateway_operations.R
Add a method to an existing Resource resource.
1 2 3 4 | apigateway_put_method(restApiId, resourceId, httpMethod,
authorizationType, authorizerId, apiKeyRequired, operationName,
requestParameters, requestModels, requestValidatorId,
authorizationScopes)
|
restApiId |
[required] [Required] The string identifier of the associated RestApi. |
resourceId |
[required] [Required] The Resource identifier for the new Method resource. |
httpMethod |
[required] [Required] Specifies the method request's HTTP method type. |
authorizationType |
[required] [Required] The method's authorization type. Valid values are |
authorizerId |
Specifies the identifier of an Authorizer to use on this Method, if the type is CUSTOM or COGNITO_USER_POOLS. The authorizer identifier is generated by API Gateway when you created the authorizer. |
apiKeyRequired |
Specifies whether the method required a valid ApiKey. |
operationName |
A human-friendly operation identifier for the method. For example, you
can assign the |
requestParameters |
A key-value map defining required or optional method request parameters
that can be accepted by API Gateway. A key defines a method request
parameter name matching the pattern of
|
requestModels |
Specifies the Model resources used for the request's content type. Request models are represented as a key/value map, with a content type as the key and a Model name as the value. |
requestValidatorId |
The identifier of a RequestValidator for validating the method request. |
authorizationScopes |
A list of authorization scopes configured on the method. The scopes are
used with a |
A list with the following syntax:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 | list(
httpMethod = "string",
authorizationType = "string",
authorizerId = "string",
apiKeyRequired = TRUE|FALSE,
requestValidatorId = "string",
operationName = "string",
requestParameters = list(
TRUE|FALSE
),
requestModels = list(
"string"
),
methodResponses = list(
list(
statusCode = "string",
responseParameters = list(
TRUE|FALSE
),
responseModels = list(
"string"
)
)
),
methodIntegration = list(
type = "HTTP"|"AWS"|"MOCK"|"HTTP_PROXY"|"AWS_PROXY",
httpMethod = "string",
uri = "string",
connectionType = "INTERNET"|"VPC_LINK",
connectionId = "string",
credentials = "string",
requestParameters = list(
"string"
),
requestTemplates = list(
"string"
),
passthroughBehavior = "string",
contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT",
timeoutInMillis = 123,
cacheNamespace = "string",
cacheKeyParameters = list(
"string"
),
integrationResponses = list(
list(
statusCode = "string",
selectionPattern = "string",
responseParameters = list(
"string"
),
responseTemplates = list(
"string"
),
contentHandling = "CONVERT_TO_BINARY"|"CONVERT_TO_TEXT"
)
),
tlsConfig = list(
insecureSkipVerification = TRUE|FALSE
)
),
authorizationScopes = list(
"string"
)
)
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | svc$put_method(
restApiId = "string",
resourceId = "string",
httpMethod = "string",
authorizationType = "string",
authorizerId = "string",
apiKeyRequired = TRUE|FALSE,
operationName = "string",
requestParameters = list(
TRUE|FALSE
),
requestModels = list(
"string"
),
requestValidatorId = "string",
authorizationScopes = list(
"string"
)
)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.