Skip to content

Describe Key

locationservice_describe_key R Documentation

Retrieves the API key resource details

Description

Retrieves the API key resource details.

Usage

locationservice_describe_key(KeyName)

Arguments

KeyName

[required] The name of the API key resource.

Value

A list with the following syntax:

list(
  Key = "string",
  KeyArn = "string",
  KeyName = "string",
  Restrictions = list(
    AllowActions = list(
      "string"
    ),
    AllowResources = list(
      "string"
    ),
    AllowReferers = list(
      "string"
    )
  ),
  CreateTime = as.POSIXct(
    "2015-01-01"
  ),
  ExpireTime = as.POSIXct(
    "2015-01-01"
  ),
  UpdateTime = as.POSIXct(
    "2015-01-01"
  ),
  Description = "string",
  Tags = list(
    "string"
  )
)

Request syntax

svc$describe_key(
  KeyName = "string"
)