Help Response Group

The Help response group returns information about operations and response groups that you request information about.

If you request information about an operation (HelpType=Operation), the Help response group will return OperationName, OperationDescription, RequiredParameters, AvailableParameters, DefaultResponseGroup, and AvailableResponseGroups for the operation you specified in the About parameter.

If you request information about a response group (HelpType=ResponseGroup), the Help response group will return the response group name, its creation date, names of operations that employ the response group, available versions, and a list of the child elements composing the response group.

REST Sample Response and Request

Sample Response (REST)

<?xml version="1.0" encoding="UTF-8"?>
<HelpResponse xmlns="http://webservices.amazon.com/AWSECommerceService/2005-03-23">
  <OperationRequest>
    <HTTPHeaders>
      <Header Name="UserAgent" Value="Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.1)"/>
    </HTTPHeaders>
    <RequestId>0FMMJTCM2T317QDX374Q</RequestId>
    <Arguments>
      <Argument Name="Service" Value="AWSECommerceService"/>
      <Argument Name="AssociateTag" Value="[Your Associate ID Here]"/>
      <Argument Name="SubscriptionId" Value="[Your Subscription ID Here]"/>
      <Argument Name="HelpType" Value="Operation"/>
      <Argument Name="About" Value="ItemSearch"/>
      <Argument Name="ResponseGroup" Value="Help"/>
      <Argument Name="Operation" Value="Help"/>
    </Arguments>
  </OperationRequest>
  <Information>
    <Request>
      <IsValid>True</IsValid>
    </Request>
    <OperationInformation>
      <Name>ItemSearch</Name>
      <RequiredParameters>
        <Parameter>SearchIndex</Parameter>
        <Parameter>SubscriptionId</Parameter>
      </RequiredParameters>
      <AvailableParameters>
        <Parameter>Actor</Parameter>
        <Parameter>Artist</Parameter>
        <Parameter>AssociateTag</Parameter>
        <Parameter>AudienceRating</Parameter>
        <Parameter>Author</Parameter>
        <Parameter>Brand</Parameter>
        <Parameter>BrowseNode</Parameter>
        <Parameter>City</Parameter>
        <Parameter>Composer</Parameter>
        <Parameter>Condition</Parameter>
        <Parameter>Conductor</Parameter>
        <Parameter>ContentType</Parameter>
        <Parameter>Cuisine</Parameter>
        <Parameter>DeliveryMethod</Parameter>
        <Parameter>Director</Parameter>
        <Parameter>ItemPage</Parameter>
        <Parameter>Keywords</Parameter>
        <Parameter>Manufacturer</Parameter>
        <Parameter>Marketplace</Parameter>
        <Parameter>MaximumPrice</Parameter>
        <Parameter>MerchantId</Parameter>
        <Parameter>MinimumPrice</Parameter>
        <Parameter>MusicLabel</Parameter>
        <Parameter>Neighborhood</Parameter>
        <Parameter>Orchestra</Parameter>
        <Parameter>PostalCode</Parameter>
        <Parameter>Power</Parameter>
        <Parameter>Publisher</Parameter>
        <Parameter>Sort</Parameter>
        <Parameter>State</Parameter>
        <Parameter>Style</Parameter>
        <Parameter>TextStream</Parameter>
        <Parameter>Title</Parameter>
        <Parameter>Validate</Parameter>
        <Parameter>VariationPage</Parameter>
        <Parameter>XMLEscaping</Parameter>
      </AvailableParameters>
      <DefaultResponseGroups>
        <ResponseGroup>Request</ResponseGroup>
        <ResponseGroup>Small</ResponseGroup>
      </DefaultResponseGroups>
      <AvailableResponseGroups>
        <ResponseGroup>Request</ResponseGroup>
        <ResponseGroup>ItemIds</ResponseGroup>
        <ResponseGroup>Small</ResponseGroup>
        <ResponseGroup>Medium</ResponseGroup>
        <ResponseGroup>Large</ResponseGroup>
        <ResponseGroup>Offers</ResponseGroup>
        <ResponseGroup>OfferFull</ResponseGroup>
        <ResponseGroup>OfferSummary</ResponseGroup>
        <ResponseGroup>VariationMinimum</ResponseGroup>
        <ResponseGroup>VariationSummary</ResponseGroup>
        <ResponseGroup>VariationImages</ResponseGroup>
        <ResponseGroup>Variations</ResponseGroup>
        <ResponseGroup>ItemAttributes</ResponseGroup>
        <ResponseGroup>Tracks</ResponseGroup>
        <ResponseGroup>Accessories</ResponseGroup>
        <ResponseGroup>EditorialReview</ResponseGroup>
        <ResponseGroup>SalesRank</ResponseGroup>
        <ResponseGroup>BrowseNodes</ResponseGroup>
        <ResponseGroup>Images</ResponseGroup>
        <ResponseGroup>Similarities</ResponseGroup>
        <ResponseGroup>Reviews</ResponseGroup>
        <ResponseGroup>ListmaniaLists</ResponseGroup>
        <ResponseGroup>SearchInside</ResponseGroup>
      </AvailableResponseGroups>
    </OperationInformation>
  </Information>
</HelpResponse>