Class: Aws::APIGateway::Types::GetApiKeysRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::GetApiKeysRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

A request to get information about the current ApiKeys resource.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #customer_id ⇒ String

  The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

• #include_values ⇒ Boolean

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

• #limit ⇒ Integer

  The maximum number of returned results per page.

• #name_query ⇒ String

  The name of queried API keys.

• #position ⇒ String

  The current pagination position in the paged result set.

Instance Attribute Details

#customer_id ⇒ String

The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.

Returns:

• (String)

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

class GetApiKeysRequest < Struct.new(
  :position,
  :limit,
  :name_query,
  :customer_id,
  :include_values)
  SENSITIVE = []
  include Aws::Structure
end

#include_values ⇒ Boolean

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

Returns:

• (Boolean)

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

class GetApiKeysRequest < Struct.new(
  :position,
  :limit,
  :name_query,
  :customer_id,
  :include_values)
  SENSITIVE = []
  include Aws::Structure
end

#limit ⇒ Integer

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

Returns:

• (Integer)

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

class GetApiKeysRequest < Struct.new(
  :position,
  :limit,
  :name_query,
  :customer_id,
  :include_values)
  SENSITIVE = []
  include Aws::Structure
end

#name_query ⇒ String

The name of queried API keys.

Returns:

• (String)

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

class GetApiKeysRequest < Struct.new(
  :position,
  :limit,
  :name_query,
  :customer_id,
  :include_values)
  SENSITIVE = []
  include Aws::Structure
end

#position ⇒ String

The current pagination position in the paged result set.

Returns:

• (String)

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

class GetApiKeysRequest < Struct.new(
  :position,
  :limit,
  :name_query,
  :customer_id,
  :include_values)
  SENSITIVE = []
  include Aws::Structure
end