You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::GetApiKeysRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::GetApiKeysRequest
- Defined in:
- (unknown)
Overview
When passing GetApiKeysRequest as input to an Aws::Client method, you can use a vanilla 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
-
#customer_id ⇒ String
The identifier of a customer in AWS 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 AWS 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. The default value is 25 and the maximum value is 500.
#name_query ⇒ String
The name of queried API keys.
#position ⇒ String
The current pagination position in the paged result set.