Get Api Keys

apigateway_get_api_keys

R Documentation

Gets information about the current ApiKeys resource

Description

Gets information about the current ApiKeys resource.

Usage

apigateway_get_api_keys(position, limit, nameQuery, customerId,
  includeValues)

Arguments

position

The current pagination position in the paged result set.

limit

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

nameQuery

The name of queried API keys.

customerId

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

includeValues

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

Value

A list with the following syntax:

list(
  warnings = list(
    "string"
  ),
  position = "string",
  items = list(
    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_keys(
  position = "string",
  limit = 123,
  nameQuery = "string",
  customerId = "string",
  includeValues = TRUE|FALSE
)