Class: Amazon::AWS::ResponseGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/amazon/aws.rb

Overview

Response groups determine which data pertaining to the item(s) being sought is returned. They strongly influence the amount of data returned, so you should always use the smallest response group(s) containing the data of interest to you, to avoid masses of unnecessary data being returned.

Constant Summary collapse

DEFAULT =

The default type of response group to use with each type of operation.

{ 'BrowseNodeLookup'    => [ :BrowseNodeInfo, :TopSellers ],
      'CustomerContentLookup' => [ :CustomerInfo, :CustomerLists ],
      'CustomerContentSearch' => :CustomerInfo,
      'Help'      => :Help,
      'ItemLookup'      => :Large,
      'ItemSearch'      => :Large,
      'ListLookup'      => [ :ListInfo, :Small ],
      'ListSearch'      => :ListInfo,
      'SellerListingLookup'   => :SellerListing,
      'SellerListingSearch'   => :SellerListing,
      'SellerLookup'    => :Seller,
      'SimilarityLookup'    => :Large,
      'TagLookup'     => [ :Tags, :TagsSummary ],
      'TransactionLookup'   => :TransactionDetails,
      'VehiclePartLookup'   => :VehiclePartFit,
      'VehiclePartSearch'   => :VehicleParts,
      'VehicleSearch'   => :VehicleMakes
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*rg) ⇒ ResponseGroup

Define a set of one or more response groups to be applied to items retrieved by an AWS operation.

Example:

rg = ResponseGroup.new( 'Medium', 'Offers', 'Reviews' )



1415
1416
1417
1418
 
# File 'lib/amazon/aws.rb', line 1415

def initialize(*rg)
  @list = rg
  @params = { 'ResponseGroup' => @list.join( ',' ) }
end

Instance Attribute Details

#list ⇒ Object (readonly)

Returns the value of attribute list.



1405
1406
1407
 
# File 'lib/amazon/aws.rb', line 1405

def list
  @list
end

#params ⇒ Object

Returns the value of attribute params.



1406
1407
1408
 
# File 'lib/amazon/aws.rb', line 1406

def params
  @params
end