Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

RenewOffering

Explicitly sets the quantity of devices to renew for an offering, starting from the effectiveDate of the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. If you must be able to invoke this operation, contact aws-devicefarm-support@amazon.com.

Request Syntax


{
   "offeringId": "string",
   "quantity": number
}

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.

offeringId

The ID of a request to renew an offering.

Type: String

Length Constraints: Minimum length of 32.

Required: Yes

quantity

The quantity requested in an offering renewal.

Type: Integer

Required: Yes

Response Syntax


{
   "offeringTransaction": { 
      "cost": { 
         "amount": number,
         "currencyCode": "string"
      },
      "createdOn": number,
      "offeringPromotionId": "string",
      "offeringStatus": { 
         "effectiveOn": number,
         "offering": { 
            "description": "string",
            "id": "string",
            "platform": "string",
            "recurringCharges": [ 
               { 
                  "cost": { 
                     "amount": number,
                     "currencyCode": "string"
                  },
                  "frequency": "string"
               }
            ],
            "type": "string"
         },
         "quantity": number,
         "type": "string"
      },
      "transactionId": "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.

offeringTransaction

Represents the status of the offering transaction for the renewal.

Type: OfferingTransaction object

Errors

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

ArgumentException

An invalid argument was specified.

HTTP Status Code: 400

LimitExceededException

A limit was exceeded.

HTTP Status Code: 400

NotEligibleException

Exception gets thrown when a user is not eligible to perform the specified transaction.

HTTP Status Code: 400

NotFoundException

The specified entity was not found.

HTTP Status Code: 400

ServiceAccountException

There was a problem with the service account.

HTTP Status Code: 400

Examples

Example

The following example renews the offering for one unmetered iOS device.

Sample Request


{
    "transactions": [
        "renew": {
            "offeringId": "offering-id-ios",
            "quantity": 1,
        }
    ]
}

Sample Response


{
    "offeringTransaction": {
        "createdOn": 1458596930.431,
        "offeringStatus": {
            "effectiveOn": 1459468800.0,
            "type": "RECURRING",
            "offering": {
                "platform": "IOS",
                "type": "RECURRING",
                "id": "offering-id-ios",
                "description": "iOS Unmetered Device Slot"
            },
            "quantity": 1
        },
        "cost": {
            "amount": 250.0,
            "currencyCode": "USD"
        },
        "transactionId": "transaction-id"
    }
}