We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
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.FreeTier

Inherits:
AWS.Service show all
Identifier:
freetier
API Version:
2023-09-07
Defined in:
(unknown)

Overview

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

Service Description

You can use the Amazon Web Services Free Tier API to query programmatically your Free Tier usage data.

Free Tier tracks your monthly usage data for all free tier offers that are associated with your Amazon Web Services account. You can use the Free Tier API to filter and show only the data that you want.

Service endpoint

The Free Tier API provides the following endpoint:

For more information, see Using the Amazon Web Services Free Tier in the Billing User Guide.

Sending a Request Using FreeTier

var freetier = new AWS.FreeTier();
freetier.getFreeTierUsage(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 FreeTier object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var freetier = new AWS.FreeTier({apiVersion: '2023-09-07'});

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

AWS.config.apiVersions = {
  freetier: '2023-09-07',
  // other service API versions
};

var freetier = new AWS.FreeTier();

Version:

  • 2023-09-07

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.FreeTier(options = {}) ⇒ Object

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

Examples:

Constructing a FreeTier object

var freetier = new AWS.FreeTier({apiVersion: '2023-09-07'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.FreeTier.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.FreeTier.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.FreeTier.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean) —

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean) —

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Returns a list of all Free Tier usage objects that match your filters.

Service Reference:

Examples:

Calling the getFreeTierUsage operation

var params = {
  filter: { /* Expression */
    And: [
      /* recursive Expression */,
      /* more items */
    ],
    Dimensions: {
      Key: SERVICE | OPERATION | USAGE_TYPE | REGION | FREE_TIER_TYPE | DESCRIPTION | USAGE_PERCENTAGE, /* required */
      MatchOptions: [ /* required */
        EQUALS | STARTS_WITH | ENDS_WITH | CONTAINS | GREATER_THAN_OR_EQUAL,
        /* more items */
      ],
      Values: [ /* required */
        'STRING_VALUE',
        /* more items */
      ]
    },
    Not: /* recursive Expression */,
    Or: [
      /* recursive Expression */,
      /* more items */
    ]
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
freetier.getFreeTierUsage(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • filter — (map)

      An expression that specifies the conditions that you want each FreeTierUsage object to meet.

      • And — (Array<map>)

        Return results that match all Expressions that you specified in the array.

        • Dimensions — (map)

          The specific dimension, values, and match type to filter objects with.

          • Key — required — (String)

            The name of the dimension that you want to filter on.

            Possible values include:
            • "SERVICE"
            • "OPERATION"
            • "USAGE_TYPE"
            • "REGION"
            • "FREE_TIER_TYPE"
            • "DESCRIPTION"
            • "USAGE_PERCENTAGE"
          • MatchOptions — required — (Array<String>)

            The match options that you can use to filter your results. You can specify only one of these values in the array.

          • Values — required — (Array<String>)

            The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.

      • Dimensions — (map)

        The specific dimension, values, and match type to filter objects with.

        • Key — required — (String)

          The name of the dimension that you want to filter on.

          Possible values include:
          • "SERVICE"
          • "OPERATION"
          • "USAGE_TYPE"
          • "REGION"
          • "FREE_TIER_TYPE"
          • "DESCRIPTION"
          • "USAGE_PERCENTAGE"
        • MatchOptions — required — (Array<String>)

          The match options that you can use to filter your results. You can specify only one of these values in the array.

        • Values — required — (Array<String>)

          The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.

      • Not — (map)

        Return results that don’t match the Expression that you specified.

        • And — (Array<map>)

          Return results that match all Expressions that you specified in the array.

        • Dimensions — (map)

          The specific dimension, values, and match type to filter objects with.

          • Key — required — (String)

            The name of the dimension that you want to filter on.

            Possible values include:
            • "SERVICE"
            • "OPERATION"
            • "USAGE_TYPE"
            • "REGION"
            • "FREE_TIER_TYPE"
            • "DESCRIPTION"
            • "USAGE_PERCENTAGE"
          • MatchOptions — required — (Array<String>)

            The match options that you can use to filter your results. You can specify only one of these values in the array.

          • Values — required — (Array<String>)

            The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.

        • Or — (Array<map>)

          Return results that match any of the Expressions that you specified. in the array.

      • Or — (Array<map>)

        Return results that match any of the Expressions that you specified. in the array.

        • Dimensions — (map)

          The specific dimension, values, and match type to filter objects with.

          • Key — required — (String)

            The name of the dimension that you want to filter on.

            Possible values include:
            • "SERVICE"
            • "OPERATION"
            • "USAGE_TYPE"
            • "REGION"
            • "FREE_TIER_TYPE"
            • "DESCRIPTION"
            • "USAGE_PERCENTAGE"
          • MatchOptions — required — (Array<String>)

            The match options that you can use to filter your results. You can specify only one of these values in the array.

          • Values — required — (Array<String>)

            The metadata values you can specify to filter upon, so that the results all match at least one of the specified values.

    • maxResults — (Integer)

      The maximum number of results to return in the response. MaxResults means that there can be up to the specified number of values, but there might be fewer results based on your filters.

    • nextToken — (String)

      The pagination token that indicates the next set of results to retrieve.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • freeTierUsages — (Array<map>)

        The list of Free Tier usage objects that meet your filter expression.

        • actualUsageAmount — (Float)

          Describes the actual usage accrued month-to-day (MTD) that you've used so far.

        • description — (String)

          The description of the Free Tier offer.

        • forecastedUsageAmount — (Float)

          Describes the forecasted usage by the month that you're expected to use.

        • freeTierType — (String)

          Describes the type of the Free Tier offer. For example, the offer can be "12 Months Free", "Always Free", and "Free Trial".

        • limit — (Float)

          Describes the maximum usage allowed in Free Tier.

        • operation — (String)

          Describes usageType more granularly with the specific Amazon Web Service API operation. For example, this can be the RunInstances API operation for Amazon Elastic Compute Cloud.

        • region — (String)

          Describes the Amazon Web Services Region for which this offer is applicable

        • service — (String)

          The name of the Amazon Web Service providing the Free Tier offer. For example, this can be Amazon Elastic Compute Cloud.

        • unit — (String)

          Describes the unit of the usageType, such as Hrs.

        • usageType — (String)

          Describes the usage details of the offer. For example, this might be Global-BoxUsage:freetrial.

      • nextToken — (String)

        The pagination token that indicates the next set of results to retrieve.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.