You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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.

Instance Attribute Summary collapse

Instance Attribute Details

#api_keyString

The identifier of the ApiKey resource.

Returns:

  • (String)


2712
2713
2714
2715
2716
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2712

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

#include_valueBoolean

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

Returns:

  • (Boolean)


2712
2713
2714
2715
2716
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2712

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