Get Stage

apigatewayv2_get_stage

R Documentation

Gets a Stage

Description

Gets a Stage.

Usage

apigatewayv2_get_stage(ApiId, StageName)

Arguments

ApiId	[required] The API identifier.
StageName	[required] The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Value

A list with the following syntax:

list(
  AccessLogSettings = list(
    DestinationArn = "string",
    Format = "string"
  ),
  ApiGatewayManaged = TRUE|FALSE,
  AutoDeploy = TRUE|FALSE,
  ClientCertificateId = "string",
  CreatedDate = as.POSIXct(
    "2015-01-01"
  ),
  DefaultRouteSettings = list(
    DataTraceEnabled = TRUE|FALSE,
    DetailedMetricsEnabled = TRUE|FALSE,
    LoggingLevel = "ERROR"|"INFO"|"OFF",
    ThrottlingBurstLimit = 123,
    ThrottlingRateLimit = 123.0
  ),
  DeploymentId = "string",
  Description = "string",
  LastDeploymentStatusMessage = "string",
  LastUpdatedDate = as.POSIXct(
    "2015-01-01"
  ),
  RouteSettings = list(
    list(
      DataTraceEnabled = TRUE|FALSE,
      DetailedMetricsEnabled = TRUE|FALSE,
      LoggingLevel = "ERROR"|"INFO"|"OFF",
      ThrottlingBurstLimit = 123,
      ThrottlingRateLimit = 123.0
    )
  ),
  StageName = "string",
  StageVariables = list(
    "string"
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$get_stage(
  ApiId = "string",
  StageName = "string"
)