apigateway_create_api_key: Create an ApiKey resource

Description Usage Arguments Value Request syntax

View source: R/apigateway_operations.R

Description

Create an ApiKey resource.<div class="seeAlso">

AWS CLI</div>

Usage

1
2
apigateway_create_api_key(name, description, enabled,
  generateDistinctId, value, stageKeys, customerId, tags)

Arguments

name

The name of the ApiKey.

description

The description of the ApiKey.

enabled

Specifies whether the ApiKey can be used by callers.

generateDistinctId

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value. This parameter is deprecated and should not be used.

value

Specifies a value of the API key.

stageKeys

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

customerId

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

tags

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
list(
  id = "string",
  value = "string",
  name = "string",
  customerId = "string",
  description = "string",
  enabled = TRUE|FALSE,
  createdDate = as.POSIXct(
    "2015-01-01"
  ),
  lastUpdatedDate = as.POSIXct(
    "2015-01-01"
  ),
  stageKeys = list(
    "string"
  ),
  tags = list(
    "string"
  )
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
svc$create_api_key(
  name = "string",
  description = "string",
  enabled = TRUE|FALSE,
  generateDistinctId = TRUE|FALSE,
  value = "string",
  stageKeys = list(
    list(
      restApiId = "string",
      stageName = "string"
    )
  ),
  customerId = "string",
  tags = list(
    "string"
  )
)

paws.networking documentation built on Aug. 23, 2021, 9:07 a.m.