ActivateDesktopProduct

Description

The ActivateDesktopProduct action is meant for desktop products or products installed in any type of distributed location (e.g., desktops, handheld devices, etc.). We recommend that web products use ActivateHostedProduct.

Calling ActivateDesktopProduct provides your desktop product with the following credentials for a specific customer:

User token
Secret Access Key
Access Key ID

	Note
	The Secret Access Key and Access Key ID that `ActivateDesktopProduct` provides are not identical to the credentials available from the AWS web site. They work only with AWS service calls associated with Amazon DevPay. They can't be used for regular AWS service calls.

For information about how your product should store the credentials, see Credential Storage.

The credentials must be available and ready to use each time your product makes an Amazon Simple Storage Service request on behalf of that customer. The items work together as a unit. If one part is missing, your product must get a whole new set. For more information, see Desktop Product Exceptions.

Your product calls ActivateDesktopProduct to activate itself when the customer initially installs it. The product might require reactivation at other times. For more information, see Desktop Product Exceptions.

Request Authentication

Requests for ActivateDesktopProduct must be made over HTTPS, but they do not require any other special authentication.

Request Parameters

Name	Description	Required
`Action`	The License Service action to perform. Set this to `ActivateDesktopProduct`. Type: String Default: None Condition: Required for REST-Query requests (for more information, see REST-Query Requests). For SOAP requests, the action is automatically indicated in the SOAP request's root element (for more information, see SOAP Requests).	Conditional
`ActivationKey`	A product activation key, which the product obtains from the customer. For more information, see Desktop Product Activation. Type: String with a maximum 30 characters; the length of this key could increase in the future Default: None	Yes
`ProductToken`	The product token for your product, which is obtained during product registration. For more information, see Registering Your Product. The product token is prefixed with the literal string `{ProductToken}`. Type: String Default: None	Yes
`TokenExpiration`	The amount of elapsed time (in seconds) before the user token returned by the service should expire. The user token never expires unless you use this optional parameter. Once the user token expires, the product must reactive itself, or the customer won't be able to use it. For more information, see Reactivating the Product. Type: xsd:duration (in seconds) Default: No expiration time	No
`Version`	The version of the API to use. For example: `2008-04-28` Type: String Default: `2007-06-05` Condition: Highly recommended for REST-Query requests. Not applicable to SOAP requests (the API version is indicated in the namespace).	Conditional

Response Elements

The response to this action contains the following elements in addition to the elements returned in all successful responses (for more information, see Structure of a Successful Response).

Name Description

Name	Description
`AWSAccessKeyId`	The customer's AWS Access Key ID. Type: String Ancestor: `ActivateDesktopProductResult`
`SecretAccessKey`	The customer's Secret Access Key, which you use to sign requests for Amazon S3. Type: String Ancestor: `ActivateDesktopProductResult`
`UserToken`	The user token associated with the returned Secret Access Key and Access Key ID. The user token is prefixed with the literal string `{UserToken}`. Each time you request `ActivateDesktopProduct` for a particular customer, the user token you receive is different because the creation time is part of the information included in the token. Type: String Ancestor: `ActivateDesktopProductResult`

AWSAccessKeyId

The customer's AWS Access Key ID.

Type: String

Ancestor: ActivateDesktopProductResult

SecretAccessKey

The customer's Secret Access Key, which you use to sign requests for Amazon S3.

Type: String

Ancestor: ActivateDesktopProductResult

UserToken

The user token associated with the returned Secret Access Key and Access Key ID. The user token is prefixed with the literal string {UserToken}. Each time you request ActivateDesktopProduct for a particular customer, the user token you receive is different because the creation time is part of the information included in the token.

Type: String

Ancestor: ActivateDesktopProductResult

Errors

The errors listed in the following table are returned in addition to the errors returned by all actions. For more information, see Errors.

	Important
	We might throttle requests to the License Service as necessary. When we throttle, we return a 503 (service unavailable) HTTP status code. Your system should be prepared to retry any request that receives a 503 code.

Name	Description
`ExpiredActivationKey`	The activation key is expired. Activation keys expire one hour after creation. Action to take: Prompt the customer to go to the activate URL and generate a new activation key (the customer is asked to log in with an Amazon.com login). Prompt the customer for the new activation key. Re-request the action to activate the product with the new activation key and the other required parameters.
`IncorrectActivationKey`	The activation key does not correspond to the product token. Each activation key is associated with a particular customer and a particular product. This error occurs if you provide an activation key for a DevPay product other than the one represented by the product token. Action to take: Follow the instructions listed for `ExpiredActivationKey`.
`InvalidActivationKey`	The activation key is invalid or malformed. Action to take: Same action as for `ExpiredActivationKey`
`InvalidProductToken`	The product token is invalid for the signer. Action to take: Make sure you have copied the product token correctly. You can view the product token for your product at any time by clicking View Product Details on your DevPay Activity page (at http://aws.amazon.com/devpayactivity).
`UserNotSubscribed`	The customer's subscription to your product is pending because the customer's sign-up payment failed. This can happen if the customer provided an invalid credit card, for example. Action to take: The product must wait to retry the `ActivateDesktopProduct` call until the subscription is no longer pending. Your product should tell the customer to go to the Application Billing page to check the payment status and then return to your product after the payment has succeeded. The product can then call `ActivateDesktopProduct` again, but the original activation key will probably have expired (the key expires after one hour). Therefore, the product should also prompt the customer to obtain a new activation key at the activate URL.

Examples

The following example REST-Query request activates a desktop product.

Sample Request

https://ls.amazonaws.com/
?Action=ActivateDesktopProduct
&ActivationKey=ADMAY7DVLJTWHJ76MMBMQYT5LATA
&ProductToken={ProductToken}YLFRL3e4lOHTgGSQa8BOKA....[long encoded token]...
&Version=2008-04-28

Sample Response

<ActivateDesktopProductResponse>
   <ActivateDesktopProductResult>
      <UserToken>
         {UserToken}AAAHVXNlclRrbgfOpSykBAXO7g/zG....[long encoded token]...
      </UserToken>
      <AWSAccessKeyId>
         YSJ4L29BRHP0V8J4A25
      </AWSAccessKeyId>
      <SecretAccessKey>
         kUdrlXJtn55OI/L3EHMGD/aVmHEXAMPLEKEY
      </SecretAccessKey>
   </ActivateDesktopProductResult>
   <ResponseMetadata>
      <RequestId>
         cb919c0a-9bce-4afe-9b48-9bdf2412bb67
      </RequestId>
   </ResponseMetadata>
</ActivateDesktopProductResponse>

ActivateDesktopProduct

Description

Request Authentication

Request Parameters

Response Elements

Errors

Examples

Sample Request

Sample Response

Related Actions