Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListAccountActivities

Returns a list of activities that are available. This operation supports pagination and filtering by status.

Request Syntax


{
   "filterActivityStatuses": [ "string" ],
   "languageCode": "string",
   "maxResults": number,
   "nextToken": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

filterActivityStatuses

The activity status filter. This field can be used to filter the response by activities status.

Type: Array of strings

Valid Values: NOT_STARTED | IN_PROGRESS | COMPLETED | EXPIRING

Required: No

languageCode

The language code used to return translated titles.

Type: String

Required: No

maxResults

The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

A token from a previous paginated response. If this is specified, the response includes records beginning from this token (inclusive), up to the number specified by maxResults.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: [\S\s]*

Required: No

Response Syntax


{
   "activities": [ 
      { 
         "activityId": "string",
         "reward": { ... },
         "status": "string",
         "title": "string"
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

activities

A brief information about the activities.

Type: Array of ActivitySummary objects

nextToken

The token to include in another request to get the next page of items. This value is null when there are no more items to return.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 8192.

Pattern: [\S\s]*

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An unexpected error occurred during the processing of your request.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an Amazon Web Services service.

HTTP Status Code: 400