Class: Aws::APIGateway::Types::GetApiKeyRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GetApiKeyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Note:

When making an API call, you may pass GetApiKeyRequest data as a hash:

{
  api_key: "String", # required
  include_value: false,
}

A request to get information about the current ApiKey resource.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #api_key ⇒ String

  [Required] The identifier of the ApiKey resource.

• #include_value ⇒ Boolean

  A boolean flag to specify whether (‘true`) or not (`false`) the result contains the key value.

Instance Attribute Details

#api_key ⇒ String

[Required] The identifier of the ApiKey resource.

Returns:

• (String)

# File 'lib/aws-sdk-apigateway/types.rb', line 3023

class GetApiKeyRequest < Struct.new(
  :api_key,
  :include_value)
  SENSITIVE = []
  include Aws::Structure
end

#include_value ⇒ Boolean

A boolean flag to specify whether (‘true`) or not (`false`) the result contains the key value.

Returns:

• (Boolean)

# File 'lib/aws-sdk-apigateway/types.rb', line 3023

class GetApiKeyRequest < Struct.new(
  :api_key,
  :include_value)
  SENSITIVE = []
  include Aws::Structure
end