Help

Description

The Help operation returns information about the Amazon Mechanical Turk Service operations and response groups. You can use it to facilitate development and documentation of your web site and tools. It is similar to the Help operation found in other AWS web services.

Request Parameters

The Help operation accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameters are specific to the Help operation:

Name Description Required

Name	Description	Required
`Operation`	The name of the operation Type: String Valid Values: Help Default: None	Yes
`HelpType`	Specifies whether you want help with an operation or with a response group. Type: String Valid Values: Operation \| ResponseGroup Default: None	Yes
`About`	The name of the operation or response group for which to return help. Type: String Default: None	Yes

Operation

The name of the operation

Type: String

Valid Values: Help

Default: None

Yes

HelpType

Specifies whether you want help with an operation or with a response group.

Type: String

Valid Values: Operation | ResponseGroup

Default: None

Yes

About

The name of the operation or response group for which to return help.

Type: String

Default: None

Yes

Response Elements

A successful request for the Help operation has an Information element in the response. The Information element contains either an OperationInformation element or a ResponseGroup element, depending on the HelpType requested.

The OperationInformation element contains the elements described in the following table:

Name	Description
`Name`	The name of the operation Type: String
`Description`	A description of the operation result. Type: String
`RequiredParameters`	A list of required parameters for the operation. Type: a list of `Parameter` elements. The `Parameter` element is a string.
`AvailableParameters`	A list of optional parameters for the operation. Type: a list of `Parameter` elements. The `Parameter` element is a string.
DefaultResponseGroups	A list of default `ResponseGroup`s for the operation. Type: a list of `ResponseGroup` elements. The `ResponseGroup` element is a string.
AvailableResponseGroups	A list of optional `ResponseGroup`s for the operation. Type: a list of `ResponseGroup` elements. The `ResponseGroup` element is a string.

The ResponseGroupInformation element contains the elements described in the following table:

Name	Description
`Name`	The name of the response group Type: String
`CreationDate`	The date the response group was created Type: String
`ValidOperations`	A list of the `Operation` elements that return data for the response group. Type: a list `Operation` elements. The `Operation` element is a string.
`Elements`	A list of the `Elements` elements for the response group. Type: a list `Elements` elements. The `Elements` element is a string.

Examples

The following example shows how to use the Help operation.

Sample Request

The following example of a Help operation returns information about the GetReviewableHITs operation.

http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2008-08-02
&Operation=Help
&Signature=[signature for this request]
&Timestamp=[your system's local time]
&HelpType=Operation
&About=GetReviewableHITs

Sample Response

The following is an example response.

<Information>
  <Request>
    <IsValid>True</IsValid>
    <HelpRequest>
      <Operation>Help</Operation>
    </HelpRequest>
  </Request>
  <OperationInformation>
    <Name>
    Please see our online documentation at 
    http://developer.amazonwebservices.com/connect/kbcategory.jspa?categoryID=28
    </Name>
  </OperationInformation>
</Information>