ListOfferings
Returns a list of products or offerings that the user can manage through the API. Each offering record
indicates the recurring price per unit and the frequency for that offering. 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
{
"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
{
"nextToken": "string",
"offerings": [
{
"description": "string",
"id": "string",
"platform": "string",
"recurringCharges": [
{
"cost": {
"amount": number,
"currencyCode": "string"
},
"frequency": "string"
}
],
"type": "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.
- 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.
- offerings
-
A value that represents the list offering results.
Type: Array of Offering objects
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 response shows a list of device offerings for the user's account.
Sample Response
{
"offerings": [
{
"recurringCharges": [
{
"cost": {
"amount": 250.0,
"currencyCode": "USD"
},
"frequency": "MONTHLY"
}
],
"platform": "IOS",
"type": "RECURRING",
"id": "offering-id-ios",
"description": "iOS Unmetered Device Slot"
},
{
"recurringCharges": [
{
"cost": {
"amount": 250.0,
"currencyCode": "USD"
},
"frequency": "MONTHLY"
}
],
"platform": "ANDROID",
"type": "RECURRING",
"id": "offering-id-android",
"description": "Android Unmetered Device Slot"
}
]
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
