apigateway_get_api_key: Gets information about the current ApiKey resource

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Gets information about the current ApiKey resource.

Usage

1
apigateway_get_api_key(apiKey, includeValue)

Arguments

apiKey

[required] [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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
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

1
2
3
4
svc$get_api_key(
  apiKey = "string",
  includeValue = TRUE|FALSE
)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.