Get Rest Api

apigateway_get_rest_api

R Documentation

Lists the RestApi resource in the collection¶

Description¶

Lists the RestApi resource in the collection.

Usage¶

apigateway_get_rest_api(restApiId)

Arguments¶

restApiId: [required] The string identifier of the associated RestApi.

Value¶

A list with the following syntax:

list(
  id = "string",
  name = "string",
  description = "string",
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  version = "string",
  warnings = list(
    "string"
  ),
  binaryMediaTypes = list(
    "string"
  ),
  minimumCompressionSize = 123,
  apiKeySource = "HEADER"|"AUTHORIZER",
  endpointConfiguration = list(
    types = list(
      "REGIONAL"|"EDGE"|"PRIVATE"
    ),
    vpcEndpointIds = list(
      "string"
    )
  ),
  policy = "string",
  tags = list(
    "string"
  ),
  disableExecuteApiEndpoint = TRUE|FALSE,
  rootResourceId = "string"
)

Request syntax¶

svc$get_rest_api(
  restApiId = "string"
)