apigateway_test_invoke_method: Simulate the execution of a Method in your RestApi with...

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Simulate the execution of a Method in your RestApi with headers, parameters, and an incoming request body.

Usage

1
2
3
apigateway_test_invoke_method(restApiId, resourceId, httpMethod,
  pathWithQueryString, body, headers, multiValueHeaders,
  clientCertificateId, stageVariables)

Arguments

restApiId

[required] [Required] The string identifier of the associated RestApi.

resourceId

[required] [Required] Specifies a test invoke method request's resource ID.

httpMethod

[required] [Required] Specifies a test invoke method request's HTTP method.

pathWithQueryString

The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

body

The simulated request body of an incoming invocation request.

headers

A key-value map of headers to simulate an incoming invocation request.

multiValueHeaders

The headers as a map from string to list of values to simulate an incoming invocation request.

clientCertificateId

A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

stageVariables

A key-value map of stage variables to simulate an invocation on a deployed Stage.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
list(
  status = 123,
  body = "string",
  headers = list(
    "string"
  ),
  multiValueHeaders = list(
    list(
      "string"
    )
  ),
  log = "string",
  latency = 123
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
svc$test_invoke_method(
  restApiId = "string",
  resourceId = "string",
  httpMethod = "string",
  pathWithQueryString = "string",
  body = "string",
  headers = list(
    "string"
  ),
  multiValueHeaders = list(
    list(
      "string"
    )
  ),
  clientCertificateId = "string",
  stageVariables = list(
    "string"
  )
)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.