Class: Aws::APIGateway::Types::GetApiKeysRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetApiKeysRequest
- 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
-
#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.
2177 2178 2179 2180 2181 2182 2183 2184 2185 |
# File 'gems/aws-sdk-apigateway/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.
2177 2178 2179 2180 2181 2182 2183 2184 2185 |
# File 'gems/aws-sdk-apigateway/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.
2177 2178 2179 2180 2181 2182 2183 2184 2185 |
# File 'gems/aws-sdk-apigateway/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.
2177 2178 2179 2180 2181 2182 2183 2184 2185 |
# File 'gems/aws-sdk-apigateway/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.
2177 2178 2179 2180 2181 2182 2183 2184 2185 |
# File 'gems/aws-sdk-apigateway/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 |