GetApiKeyResult

data class GetApiKeyResult(val apiKeyId: String? = null, val customerId: String? = null, val description: String? = null, val enabled: Boolean? = null, val stageKeys: List<ApiKeyStageKey>? = null, val tags: List<ApiKeyTag>? = null)

Constructors

Link copied to clipboard
fun GetApiKeyResult(apiKeyId: String? = null, customerId: String? = null, description: String? = null, enabled: Boolean? = null, stageKeys: List<ApiKeyStageKey>? = null, tags: List<ApiKeyTag>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val apiKeyId: String? = null

A Unique Key ID which identifies the API Key. Generated by the Create API and returned by the Read and List APIs

Link copied to clipboard
val customerId: String? = null

An AWS Marketplace customer identifier to use when integrating with the AWS SaaS Marketplace.

Link copied to clipboard
val description: String? = null

A description of the purpose of the API key.

Link copied to clipboard
val enabled: Boolean? = null

Indicates whether the API key can be used by clients.

Link copied to clipboard

A list of stages to associate with this API key.

Link copied to clipboard
val tags: List<ApiKeyTag>? = null

An array of arbitrary tags (key-value pairs) to associate with the API key.