Help Response Group

The Help response group returns information about operations and response groups. Information returned about operations includes:

Operation name
Operation description
Required parameters for the operation
AvailableParameters
Default response group
Available response groups for the operation specified in the About parameter of the Help operation

Information returned about response groups includes:

Response group name
Creation date
Names of operations that can use the response group
Available versions
List of the child elements composing the response group

This information is useful when creating a developer tool that helps create Product Advertising API applications.

Relevant Operations

Operations that can use this response group include:

Help

Response Elements

The following table describes the elements returned by Help.

Help also returns the elements that all response groups return, which is described in Elements Common to All Response Groups.

Parent Response Group

The following response groups are parent response groups of Help.

None

Child Response Group

The following response groups are child response groups of Help.

None

Sample REST Use Case

All locales.

http://ecs.amazonaws.com/onca/xml?
Service=AWSECommerceService&
AWSAccessKeyId=[AWS Access Key ID]&
Operation=Help&
HelpType=Operation&
About=CustomerContentLookup&
Version=2008-08-19
&Timestamp=[YYYY-MM-DDThh:mm:ssZ]
&Signature=[Request Signature]

Sample Response Snippet

The following response snippet shows the elements returned by Help.

<OperationInformation>
  <Name>CustomerContentLookup</Name>
  <RequiredParameters>
    <Parameter>CustomerId</Parameter>
  </RequiredParameters>
  <AvailableParameters>
    <Parameter>AssociateTag</Parameter>
    <Parameter>ContentType</Parameter>
     <Parameter>Marketplace</Parameter>
    <Parameter>MarketplaceDomain</Parameter>
    <Parameter>ReviewPage</Parameter>
    <Parameter>Style</Parameter>
    <Parameter>Validate</Parameter>
    <Parameter>Version</Parameter>
    <Parameter>XMLEscaping</Parameter>
  </AvailableParameters>
  <DefaultResponseGroups>
    <ResponseGroup>Request</ResponseGroup>
    <ResponseGroup>CustomerInfo</ResponseGroup>
  </DefaultResponseGroups>
  <AvailableResponseGroups>
    <ResponseGroup>Request</ResponseGroup>
    <ResponseGroup>CustomerInfo</ResponseGroup>
    <ResponseGroup>CustomerReviews</ResponseGroup>
    <ResponseGroup>CustomerLists</ResponseGroup>
    <ResponseGroup>CustomerFull</ResponseGroup>
  </AvailableResponseGroups>
</OperationInformation>