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:
|
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: |
NoExpiry |
Optionally set to |
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: Restrictions:
|
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"
)
)