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<Tag>? = null)

Constructors

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

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val apiKeyId: String? = null

The ID for the API key. For example: abc123 .

Link copied to clipboard
val customerId: String? = null

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

Link copied to clipboard
val description: String? = null

The description of the ApiKey.

Link copied to clipboard
val enabled: Boolean? = null

Specifies whether the ApiKey can be used by callers.

Link copied to clipboard

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

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

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.