Skip to content

Get Route

apigatewayv2_get_route R Documentation

Gets a Route

Description

Gets a Route.

Usage

apigatewayv2_get_route(ApiId, RouteId)

Arguments

ApiId

[required] The API identifier.

RouteId

[required] The route ID.

Value

A list with the following syntax:

list(
  ApiGatewayManaged = TRUE|FALSE,
  ApiKeyRequired = TRUE|FALSE,
  AuthorizationScopes = list(
    "string"
  ),
  AuthorizationType = "NONE"|"AWS_IAM"|"CUSTOM"|"JWT",
  AuthorizerId = "string",
  ModelSelectionExpression = "string",
  OperationName = "string",
  RequestModels = list(
    "string"
  ),
  RequestParameters = list(
    list(
      Required = TRUE|FALSE
    )
  ),
  RouteId = "string",
  RouteKey = "string",
  RouteResponseSelectionExpression = "string",
  Target = "string"
)

Request syntax

svc$get_route(
  ApiId = "string",
  RouteId = "string"
)