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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb

Overview

A request to get information about the current ApiKeys resource.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

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) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2317

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) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2317

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) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2317

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) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2317

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) 


2317
2318
2319
2320
2321
2322
2323
2324
2325
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2317

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