apigateway_test_invoke_authorizer: Simulate the execution of an Authorizer in your RestApi with...

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Simulate the execution of an Authorizer in your RestApi with headers, parameters, and an incoming request body.<div class="seeAlso">

Use Lambda Function as Authorizer Use Cognito User Pool as Authorizer</div>

Usage

1
2
3
apigateway_test_invoke_authorizer(restApiId, authorizerId, headers,
  multiValueHeaders, pathWithQueryString, body, stageVariables,
  additionalContext)

Arguments

restApiId

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

authorizerId

[required] [Required] Specifies a test invoke authorizer request's Authorizer ID.

headers

[Required] A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

multiValueHeaders

[Optional] The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

pathWithQueryString

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

body

[Optional] The simulated request body of an incoming invocation request.

stageVariables

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

additionalContext

[Optional] A key-value map of additional context variables.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
list(
  clientStatus = 123,
  log = "string",
  latency = 123,
  principalId = "string",
  policy = "string",
  authorization = list(
    list(
      "string"
    )
  ),
  claims = list(
    "string"
  )
)

Request syntax

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

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