Menu
AWS Device Farm
API Reference (API Version 2015-06-23)

GetOfferingStatus

Gets the current status and future status of all offerings purchased by an AWS account. The response indicates how many offerings are currently available and the offerings that will be available in the next period. The API returns a NotEligible error if the user is not permitted to invoke the operation. Please contact aws-devicefarm-support@amazon.com if you believe that you should be able to invoke this operation.

Request Syntax

{
   "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.

nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Type: String

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

Required: No

Response Syntax

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

current

When specified, gets the offering status for the current period.

Type: String to OfferingStatus object map

Key Length Constraints: Minimum length of 32.

nextPeriod

When specified, gets the offering status for the next period.

Type: String to OfferingStatus object map

Key Length Constraints: Minimum length of 32.

nextToken

An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.

Type: String

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

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

Example

The following example checks the current and renewal status.

Sample Response

{
    "current": {
        "offering-id-ios": {
            "offering": {
                "platform": "IOS",
                "type": "RECURRING",
                "id": "offering-id-ios",
                "description": "iOS Unmetered Device Slot"
            },
            "quantity": 1
        }
    },
    "nextPeriod": {
        "offering-id-ios": {
              "effectiveOn": 1459468800.0,
              "offering": {
                  "platform": "IOS",
                  "type": "RECURRING",
                  "id": "offering-id-ios",
                  "description": "iOS Unmetered Device Slot"
              },
              "quantity": 1
          }
    }
}

See Also

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