Lists API key resources in your Amazon Web Services account¶

Description¶

Lists API key resources in your Amazon Web Services account.

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

Usage¶

locationservice_list_keys(MaxResults, NextToken, Filter)

Arguments¶

MaxResults

An optional limit for the number of resources returned in a single call.

Default value: 100
NextToken

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null
Filter

Optionally filter the list to only Active or Expired API keys.

Value¶

A list with the following syntax:

list(
  Entries = list(
    list(
      KeyName = "string",
      ExpireTime = as.POSIXct(
        "2015-01-01"
      ),
      Description = "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"
      ),
      UpdateTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_keys(
  MaxResults = 123,
  NextToken = "string",
  Filter = list(
    KeyStatus = "Active"|"Expired"
  )
)