Get Stages

apigatewayv2_get_stages

R Documentation

Gets the Stages for an API

Description

Gets the Stages for an API.

Usage

apigatewayv2_get_stages(ApiId, MaxResults, NextToken)

Arguments

ApiId

[required] The API identifier.

MaxResults

The maximum number of elements to be returned for this resource.

NextToken

The next page of elements from this collection. Not valid for the last element of the collection.

Value

A list with the following syntax:

list(
  Items = list(
    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"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_stages(
  ApiId = "string",
  MaxResults = "string",
  NextToken = "string"
)