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
show all
Defined in:
(unknown)

Overview

Note:

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

Instance Attribute Details

#customer_idString

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

Returns:

  • (String)

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

#include_valuesBoolean

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

Returns:

  • (Boolean)

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

#limitInteger

The maximum number of returned results per page.

Returns:

  • (Integer)

    The maximum number of returned results per page.

#name_queryString

The name of queried API keys.

Returns:

  • (String)

    The name of queried API keys.

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)

    The current pagination position in the paged result set.