GetAccountActivity - Amazon Billing and Cost Management
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

GetAccountActivity

Returns a specific activity record that is available to the customer.

Request Syntax

{
   "activityId": "string",
   "languageCode": "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.

activityId

A unique identifier that identifies the activity.

Type: String

Length Constraints: Fixed length of 32.

Pattern: [a-zA-Z0-9]+

Required: Yes

languageCode

The language code used to return translated title and description fields.

Type: String

Valid Values: en-US | en-GB | id-ID | de-DE | es-ES | fr-FR | ja-JP | it-IT | pt-PT | ko-KR | zh-CN | zh-TW | tr-TR

Required: No

Response Syntax

{
   "activityId": "string",
   "completedAt": "string",
   "description": "string",
   "estimatedTimeToCompleteInMinutes": number,
   "expiresAt": "string",
   "instructionsUrl": "string",
   "reward": { ... },
   "startedAt": "string",
   "status": "string",
   "title": "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.

activityId

A unique identifier that identifies the activity.

Type: String

Length Constraints: Fixed length of 32.

Pattern: [a-zA-Z0-9]+

completedAt

The timestamp when the activity is completed. This field appears only for activities in the COMPLETED state.

Type: Timestamp

description

Provides detailed information about the activity and its expected outcomes.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\S\s]*

estimatedTimeToCompleteInMinutes

The estimated time to complete the activity. This is the duration in minutes.

Type: Integer

expiresAt

The time by which the activity must be completed to receive a reward.

Type: Timestamp

instructionsUrl

The URL resource that provides guidance on activity requirements and completion.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Pattern: [\S\s]*

reward

A reward granted upon activity completion.

Type: ActivityReward object

Note: This object is a Union. Only one member of this object can be specified or returned.

startedAt

The timestamp when the activity started. This field appears only for activities in the IN_PROGRESS or COMPLETED states.

Type: Timestamp

status

The current activity status.

Type: String

Valid Values: NOT_STARTED | IN_PROGRESS | COMPLETED | EXPIRING

title

A short activity title.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

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

ResourceNotFoundException

This exception is thrown when the requested resource cannot be found.

HTTP Status Code: 400

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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: