Retrieves the API key resource details¶

Description¶

Retrieves the API key resource details.

For more information, see Use API keys to authenticate in the Amazon Location Service Developer Guide.

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"
    ),
    AllowAndroidApps = list(
      list(
        Package = "string",
        CertificateFingerprint = "string"
      )
    ),
    AllowAppleApps = list(
      list(
        BundleId = "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"
)