AWS.Pricing — AWS SDK for JavaScript (original) (raw)

We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.Pricing

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

The Amazon Web Services Price List API is a centralized and convenient way to programmatically query Amazon Web Services for services, products, and pricing information. The Amazon Web Services Price List uses standardized product attributes such as Location, Storage Class, and Operating System, and provides prices at the SKU level. You can use the Amazon Web Services Price List to do the following:

Use GetServices without a service code to retrieve the service codes for all Amazon Web Services, then GetServices with a service code to retrieve the attribute names for that service. After you have the service code and attribute names, you can use GetAttributeValues to see what values are available for an attribute. With the service code and an attribute name and value, you can use GetProducts to find specific products that you're interested in, such as an AmazonEC2 instance, with a Provisioned IOPS volumeType.

For more information, see Using the Amazon Web Services Price List API in the Billing User Guide.

Sending a Request Using Pricing

var pricing = new AWS.Pricing();
pricing.describeServices(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the Pricing object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var pricing = new AWS.Pricing({apiVersion: '2017-10-15'});

You can also set the API version globally in AWS.config.apiVersions using the pricing service identifier:

AWS.config.apiVersions = {
  pricing: '2017-10-15',
  // other service API versions
};

var pricing = new AWS.Pricing();

Constructor Summarycollapse

Property Summarycollapse

Properties inherited from AWS.Service

apiVersions

Method Summarycollapse

### Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

## Constructor Details

### new AWS.Pricing(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

## Property Details

### endpoint ⇒ AWS.Endpoint

Returns an Endpoint object representing the endpoint URL for service requests.

## Method Details

### describeServices(params = {}, callback) ⇒ AWS.Request

Returns the metadata for one service or a list of the metadata for all services. Use this without a service code to get the service codes for all services. Use it with a service code, such as AmazonEC2, to get information specific to that service, such as the attribute names available for that service. For example, some of the attribute names available for EC2 are volumeType, maxIopsVolume, operation, locationType, and instanceCapacity10xlarge.

### getAttributeValues(params = {}, callback) ⇒ AWS.Request

### getPriceListFileUrl(params = {}, callback) ⇒ AWS.Request

This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

This returns the URL that you can retrieve your Price List file from. This URL is based on the PriceListArn and FileFormat that you retrieve from the ListPriceLists response.

### getProducts(params = {}, callback) ⇒ AWS.Request

Returns a list of all products that match the filter criteria.

### listPriceLists(params = {}, callback) ⇒ AWS.Request

This feature is in preview release and is subject to change. Your use of Amazon Web Services Price List API is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

This returns a list of Price List references that the requester if authorized to view, given a ServiceCode, CurrencyCode, and an EffectiveDate. Use without a RegionCode filter to list Price List references from all available Amazon Web Services Regions. Use with a RegionCode filter to get the Price List reference that's specific to a specific Amazon Web Services Region. You can use the PriceListArn from the response to get your preferred Price List files through the GetPriceListFileUrl API.

### waitFor(state, params = {}, callback) ⇒ AWS.Request

Waits for a given Pricing resource. The final callback or'complete' event will be fired only when the resource is either in its final state or the waiter has timed out and stopped polling for the final state.