Skip to content

Update Api Key

apigateway_update_api_key R Documentation

Changes information about an ApiKey resource

Description

Changes information about an ApiKey resource.

Usage

apigateway_update_api_key(apiKey, patchOperations)

Arguments

apiKey

[required] The identifier of the ApiKey resource to be updated.

patchOperations

For more information about supported patch operations, see Patch Operations.

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$update_api_key(
  apiKey = "string",
  patchOperations = list(
    list(
      op = "add"|"remove"|"replace"|"move"|"copy"|"test",
      path = "string",
      value = "string",
      from = "string"
    )
  )
)