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

Class: Aws::Pricing::Types::GetProductsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb

Overview

Note:

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

{
  service_code: "String",
  filters: [
    {
      type: "TERM_MATCH", # required, accepts TERM_MATCH
      field: "String", # required
      value: "String", # required
    },
  ],
  format_version: "String",
  next_token: "String",
  max_results: 1,
}

Instance Attribute Summary collapse

Instance Attribute Details

#filtersArray<Types::Filter>

The list of filters that limit the returned products. only products that match all filters are returned.

Returns:



240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb', line 240

class GetProductsRequest < Struct.new(
  :service_code,
  :filters,
  :format_version,
  :next_token,
  :max_results)
  include Aws::Structure
end

#format_versionString

The format version that you want the response to be in.

Valid values are: aws_v1

Returns:

  • (String)


240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb', line 240

class GetProductsRequest < Struct.new(
  :service_code,
  :filters,
  :format_version,
  :next_token,
  :max_results)
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to return in the response.

Returns:

  • (Integer)


240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb', line 240

class GetProductsRequest < Struct.new(
  :service_code,
  :filters,
  :format_version,
  :next_token,
  :max_results)
  include Aws::Structure
end

#next_tokenString

The pagination token that indicates the next set of results that you want to retrieve.

Returns:

  • (String)


240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb', line 240

class GetProductsRequest < Struct.new(
  :service_code,
  :filters,
  :format_version,
  :next_token,
  :max_results)
  include Aws::Structure
end

#service_codeString

The code for the service whose products you want to retrieve.

Returns:

  • (String)


240
241
242
243
244
245
246
247
# File 'gems/aws-sdk-pricing/lib/aws-sdk-pricing/types.rb', line 240

class GetProductsRequest < Struct.new(
  :service_code,
  :filters,
  :format_version,
  :next_token,
  :max_results)
  include Aws::Structure
end