You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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_idString

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

Returns:

  • (String)


2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2367

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

#include_valuesBoolean

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

Returns:

  • (Boolean)


2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2367

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

#limitInteger

The maximum number of returned results per page.

Returns:

  • (Integer)


2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2367

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

#name_queryString

The name of queried API keys.

Returns:

  • (String)


2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2367

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

#positionString

The current pagination position in the paged result set.

Returns:

  • (String)


2367
2368
2369
2370
2371
2372
2373
2374
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 2367

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