Updates the specified properties of a given API key resource¶

Description¶

Updates the specified properties of a given API key resource.

Usage¶

locationservice_update_key(KeyName, Description, ExpireTime, NoExpiry,
  ForceUpdate, Restrictions)

Arguments¶

• KeyName

  [required] The name of the API key resource to update.

• Description

  Updates the description for the API key resource.

• ExpireTime

  Updates the timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.

• NoExpiry

  Whether the API key should expire. Set to true to set the API key to have no expiration time.

• ForceUpdate

  The boolean flag to be included for updating ExpireTime or Restrictions details.

  Must be set to true to update an API key resource that has been used in the past 7 days.

  False if force update is not preferred

  Default value: False

• Restrictions

  Updates the API key restrictions for the API key resource.

Value¶

A list with the following syntax:

list(
  KeyArn = "string",
  KeyName = "string",
  UpdateTime = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$update_key(
  KeyName = "string",
  Description = "string",
  ExpireTime = as.POSIXct(
    "2015-01-01"
  ),
  NoExpiry = TRUE|FALSE,
  ForceUpdate = TRUE|FALSE,
  Restrictions = list(
    AllowActions = list(
      "string"
    ),
    AllowResources = list(
      "string"
    ),
    AllowReferers = list(
      "string"
    ),
    AllowAndroidApps = list(
      list(
        Package = "string",
        CertificateFingerprint = "string"
      )
    ),
    AllowAppleApps = list(
      list(
        BundleId = "string"
      )
    )
  )
)