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

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

Overview

Note:

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

{
  position: "String",
  limit: 1,
  name_query: "String",
  customer_id: "String",
  include_values: false,
}

A request to get information about the current ApiKeys resource.

Instance Attribute Summary collapse

Instance Attribute Details

#customer_id ⇒ String

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

Returns:

  • (String) 


2983
2984
2985
2986
2987
2988
2989
2990
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2983

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

#include_values ⇒ Boolean

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

Returns:

  • (Boolean) 


2983
2984
2985
2986
2987
2988
2989
2990
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2983

class GetApiKeysRequest < Struct.new(
  :position,
  :limit,
  :name_query,
  :customer_id,
  :include_values)
  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) 


2983
2984
2985
2986
2987
2988
2989
2990
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2983

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

#name_query ⇒ String

The name of queried API keys.

Returns:

  • (String) 


2983
2984
2985
2986
2987
2988
2989
2990
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2983

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

#position ⇒ String

The current pagination position in the paged result set.

Returns:

  • (String) 


2983
2984
2985
2986
2987
2988
2989
2990
 
# File 'lib/aws-sdk-apigateway/types.rb', line 2983

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