Get Api Key

apigateway_get_api_key

R Documentation

Gets information about the current ApiKey resource¶

Description¶

Gets information about the current ApiKey resource.

Usage¶

apigateway_get_api_key(apiKey, includeValue)

Arguments¶

apiKey

[required] The identifier of the ApiKey resource.

includeValue

A boolean flag to specify whether (true) or not (false) the result contains the key value.

Value¶

A list with the following syntax:

list(
  id = "string",
  value = "string",
  name = "string",
  customerId = "string",
  description = "string",
  enabled = TRUE|FALSE,
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedDate = as.POSIXct(
    "2015-01-01"
  ),
  stageKeys = list(
    "string"
  ),
  tags = list(
    "string"
  )
)

Request syntax¶

svc$get_api_key(
  apiKey = "string",
  includeValue = TRUE|FALSE
)