Skip to content

Create Key

locationservice_create_key R Documentation

Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer

Description

Creates an API key resource in your Amazon Web Services account, which lets you grant actions for Amazon Location resources to the API key bearer.

For more information, see Using API keys.

Usage

locationservice_create_key(KeyName, Restrictions, Description,
  ExpireTime, NoExpiry, Tags)

Arguments

KeyName

[required] A custom name for the API key resource.

Requirements:

  • Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

  • Must be a unique API key name.

  • No spaces allowed. For example, ExampleAPIKey.

Restrictions

[required] The API key restrictions for the API key resource.

Description

An optional description for the API key resource.

ExpireTime

The optional timestamp for when the API key resource will expire in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. One of NoExpiry or ExpireTime must be set.

NoExpiry

Optionally set to true to set no expiration time for the API key. One of NoExpiry or ExpireTime must be set.

Tags

Applies one or more tags to the map resource. A tag is a key-value pair that helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

  • Maximum 50 tags per resource

  • Each resource tag must be unique with a maximum of one value.

  • Maximum key length: 128 Unicode characters in UTF-8

  • Maximum value length: 256 Unicode characters in UTF-8

  • Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

  • Cannot use "aws:" as a prefix for a key.

Value

A list with the following syntax: 

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

Request syntax

svc$create_key(
  KeyName = "string",
  Restrictions = list(
    AllowActions = list(
      "string"
    ),
    AllowResources = list(
      "string"
    ),
    AllowReferers = list(
      "string"
    )
  ),
  Description = "string",
  ExpireTime = as.POSIXct(
    "2015-01-01"
  ),
  NoExpiry = TRUE|FALSE,
  Tags = list(
    "string"
  )
)