You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.Billingconductor

Inherits:
AWS.Service show all
Identifier:
billingconductor
API Version:
2021-07-30
Defined in:
(unknown)

Overview

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

Service Description

Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a pro forma version of your billing data each month, to accurately show or chargeback your end customers. Amazon Web Services Billing Conductor doesn't change the way you're billed by Amazon Web Services each month by design. Instead, it provides you with a mechanism to configure, generate, and display rates to certain customers over a given billing period. You can also analyze the difference between the rates you apply to your accounting groupings relative to your actual rates from Amazon Web Services. As a result of your Amazon Web Services Billing Conductor configuration, the payer account can also see the custom rate applied on the billing details page of the Amazon Web Services Billing console, or configure a cost and usage report per billing group.

This documentation shows how you can configure Amazon Web Services Billing Conductor using its API. For more information about using the Amazon Web Services Billing Conductor user interface, see the Amazon Web Services Enterprise Billing Console User Guide.

Sending a Request Using Billingconductor

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

var billingconductor = new AWS.Billingconductor({apiVersion: '2021-07-30'});

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

AWS.config.apiVersions = {
  billingconductor: '2021-07-30',
  // other service API versions
};

var billingconductor = new AWS.Billingconductor();

Version:

  • 2021-07-30

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a Billingconductor object

var billingconductor = new AWS.Billingconductor({apiVersion: '2021-07-30'});

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.Billingconductor.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.Billingconductor.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

endpointAWS.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

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

Connects an array of account IDs in a consolidated billing family to a predefined billing group. The account IDs must be a part of the consolidated billing family during the current month, and not already associated with another billing group. The maximum number of accounts that can be associated in one call is 30.

Service Reference:

Examples:

Calling the associateAccounts operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Arn: 'STRING_VALUE' /* required */
};
billingconductor.associateAccounts(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: {})
    • Arn — (String)

      The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs.

    • AccountIds — (Array<String>)

      The associating array of account IDs.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs.

Returns:

  • (AWS.Request)

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

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

Connects an array of PricingRuleArns to a defined PricingPlan. The maximum number PricingRuleArn that can be associated in one call is 30.

Service Reference:

Examples:

Calling the associatePricingRules operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  PricingRuleArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
billingconductor.associatePricingRules(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: {})
    • Arn — (String)

      The PricingPlanArn that the PricingRuleArns are associated with.

    • PricingRuleArns — (Array<String>)

      The PricingRuleArns that are associated with the Pricing Plan.

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:

      • Arn — (String)

        The PricingPlanArn that the PricingRuleArns are associated with.

Returns:

  • (AWS.Request)

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

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

Associates a batch of resources to a percentage custom line item.

Examples:

Calling the batchAssociateResourcesToCustomLineItem operation

var params = {
  ResourceArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TargetArn: 'STRING_VALUE', /* required */
  BillingPeriodRange: {
    ExclusiveEndBillingPeriod: 'STRING_VALUE', /* required */
    InclusiveStartBillingPeriod: 'STRING_VALUE' /* required */
  }
};
billingconductor.batchAssociateResourcesToCustomLineItem(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: {})
    • TargetArn — (String)

      A percentage custom line item ARN to associate the resources to.

    • ResourceArns — (Array<String>)

      A list containing the ARNs of the resources to be associated.

    • BillingPeriodRange — (map)

      The billing period range in which the custom line item request will be applied.

      • InclusiveStartBillingPeriodrequired — (String)

        The inclusive start billing period that defines a billing period range where a custom line is applied.

      • ExclusiveEndBillingPeriodrequired — (String)

        The inclusive end billing period that defines a billing period range where a custom line is applied.

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:

      • SuccessfullyAssociatedResources — (Array<map>)

        A list of AssociateResourceResponseElement for each resource that's been associated to a percentage custom line item successfully.

        • Arn — (String)

          The resource ARN that was associated to the custom line item.

        • Error — (map)

          An AssociateResourceError that will populate if the resource association fails.

          • Message — (String)

            The reason the resource association failed.

          • Reason — (String)

            A static error code that used to classify the type of failure.

            Possible values include:
            • "INVALID_ARN"
            • "SERVICE_LIMIT_EXCEEDED"
            • "ILLEGAL_CUSTOMLINEITEM"
            • "INTERNAL_SERVER_EXCEPTION"
      • FailedAssociatedResources — (Array<map>)

        A list of AssociateResourceResponseElement for each resource that failed association to a percentage custom line item.

        • Arn — (String)

          The resource ARN that was associated to the custom line item.

        • Error — (map)

          An AssociateResourceError that will populate if the resource association fails.

          • Message — (String)

            The reason the resource association failed.

          • Reason — (String)

            A static error code that used to classify the type of failure.

            Possible values include:
            • "INVALID_ARN"
            • "SERVICE_LIMIT_EXCEEDED"
            • "ILLEGAL_CUSTOMLINEITEM"
            • "INTERNAL_SERVER_EXCEPTION"

Returns:

  • (AWS.Request)

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

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

Disassociates a batch of resources from a percentage custom line item.

Examples:

Calling the batchDisassociateResourcesFromCustomLineItem operation

var params = {
  ResourceArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  TargetArn: 'STRING_VALUE', /* required */
  BillingPeriodRange: {
    ExclusiveEndBillingPeriod: 'STRING_VALUE', /* required */
    InclusiveStartBillingPeriod: 'STRING_VALUE' /* required */
  }
};
billingconductor.batchDisassociateResourcesFromCustomLineItem(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: {})
    • TargetArn — (String)

      A percentage custom line item ARN to disassociate the resources from.

    • ResourceArns — (Array<String>)

      A list containing the ARNs of resources to be disassociated.

    • BillingPeriodRange — (map)

      The billing period range in which the custom line item request will be applied.

      • InclusiveStartBillingPeriodrequired — (String)

        The inclusive start billing period that defines a billing period range where a custom line is applied.

      • ExclusiveEndBillingPeriodrequired — (String)

        The inclusive end billing period that defines a billing period range where a custom line is applied.

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:

      • SuccessfullyDisassociatedResources — (Array<map>)

        A list of DisassociateResourceResponseElement for each resource that's been disassociated from a percentage custom line item successfully.

        • Arn — (String)

          The resource ARN that was disassociated from the custom line item.

        • Error — (map)

          An AssociateResourceError shown if the resource disassociation fails.

          • Message — (String)

            The reason the resource association failed.

          • Reason — (String)

            A static error code that used to classify the type of failure.

            Possible values include:
            • "INVALID_ARN"
            • "SERVICE_LIMIT_EXCEEDED"
            • "ILLEGAL_CUSTOMLINEITEM"
            • "INTERNAL_SERVER_EXCEPTION"
      • FailedDisassociatedResources — (Array<map>)

        A list of DisassociateResourceResponseElement for each resource that failed disassociation from a percentage custom line item.

        • Arn — (String)

          The resource ARN that was disassociated from the custom line item.

        • Error — (map)

          An AssociateResourceError shown if the resource disassociation fails.

          • Message — (String)

            The reason the resource association failed.

          • Reason — (String)

            A static error code that used to classify the type of failure.

            Possible values include:
            • "INVALID_ARN"
            • "SERVICE_LIMIT_EXCEEDED"
            • "ILLEGAL_CUSTOMLINEITEM"
            • "INTERNAL_SERVER_EXCEPTION"

Returns:

  • (AWS.Request)

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

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

Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.

Service Reference:

Examples:

Calling the createBillingGroup operation

var params = {
  AccountGrouping: { /* required */
    LinkedAccountIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  },
  ComputationPreference: { /* required */
    PricingPlanArn: 'STRING_VALUE' /* required */
  },
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  PrimaryAccountId: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
billingconductor.createBillingGroup(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: {})
    • ClientToken — (String)

      The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Name — (String)

      The billing group name. The names must be unique.

    • AccountGrouping — (map)

      The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family.

      • LinkedAccountIdsrequired — (Array<String>)

        The account IDs that make up the billing group. Account IDs must be a part of the consolidated billing family, and not associated with another billing group.

    • ComputationPreference — (map)

      The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

      • PricingPlanArnrequired — (String)

        The Amazon Resource Name (ARN) of the pricing plan used to compute the Amazon Web Services charges for a billing group.

    • PrimaryAccountId — (String)

      The account ID that serves as the main account in a billing group.

    • Description — (String)

      The billing group description.

    • Tags — (map<String>)

      A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the created billing group.

Returns:

  • (AWS.Request)

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

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

Creates a custom line item that can be used to create a one-time fixed charge that can be applied to a single billing group for the current or previous billing period. The one-time fixed charge is either a fee or discount.

Service Reference:

Examples:

Calling the createCustomLineItem operation

var params = {
  BillingGroupArn: 'STRING_VALUE', /* required */
  ChargeDetails: { /* required */
    Type: CREDIT | FEE, /* required */
    Flat: {
      ChargeValue: 'NUMBER_VALUE' /* required */
    },
    Percentage: {
      PercentageValue: 'NUMBER_VALUE', /* required */
      AssociatedValues: [
        'STRING_VALUE',
        /* more items */
      ]
    }
  },
  Description: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  BillingPeriodRange: {
    ExclusiveEndBillingPeriod: 'STRING_VALUE', /* required */
    InclusiveStartBillingPeriod: 'STRING_VALUE' /* required */
  },
  ClientToken: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
billingconductor.createCustomLineItem(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: {})
    • ClientToken — (String)

      The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Name — (String)

      The name of the custom line item.

    • Description — (String)

      The description of the custom line item. This is shown on the Bills page in association with the charge value.

    • BillingGroupArn — (String)

      The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

    • BillingPeriodRange — (map)

      A time range for which the custom line item is effective.

      • InclusiveStartBillingPeriodrequired — (String)

        The inclusive start billing period that defines a billing period range where a custom line is applied.

      • ExclusiveEndBillingPeriodrequired — (String)

        The inclusive end billing period that defines a billing period range where a custom line is applied.

    • Tags — (map<String>)

      A map that contains tag keys and tag values that are attached to a custom line item.

    • ChargeDetails — (map)

      A CustomLineItemChargeDetails that describes the charge details for a custom line item.

      • Flat — (map)

        A CustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.

        • ChargeValuerequired — (Float)

          The custom line item's fixed charge value in USD.

      • Percentage — (map)

        A CustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.

        • PercentageValuerequired — (Float)

          The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

        • AssociatedValues — (Array<String>)

          A list of resource ARNs to associate to the percentage custom line item.

      • Typerequired — (String)

        The type of the custom line item that indicates whether the charge is a fee or credit.

        Possible values include:
        • "CREDIT"
        • "FEE"

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the created custom line item.

Returns:

  • (AWS.Request)

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

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

Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.

Service Reference:

Examples:

Calling the createPricingPlan operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  PricingRuleArns: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
billingconductor.createPricingPlan(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: {})
    • ClientToken — (String)

      The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Name — (String)

      The pricing plan name. The names must be unique to each pricing plan.

    • Description — (String)

      The pricing plan description.

    • PricingRuleArns — (Array<String>)

      A list of Amazon Resource Names (ARNs) that define the pricing plan parameters.

    • Tags — (map<String>)

      A map that contains tag keys and tag values that are attached to a pricing plan.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the created pricing plan.

Returns:

  • (AWS.Request)

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

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

Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.

Service Reference:

Examples:

Calling the createPricingRule operation

var params = {
  ModifierPercentage: 'NUMBER_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: GLOBAL | SERVICE, /* required */
  Type: MARKUP | DISCOUNT, /* required */
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Service: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
billingconductor.createPricingRule(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: {})
    • ClientToken — (String)

      The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Name — (String)

      The pricing rule name. The names must be unique to each pricing rule.

    • Description — (String)

      The pricing rule description.

    • Scope — (String)

      The scope of pricing rule that indicates if it is globally applicable, or is service-specific.

      Possible values include:
      • "GLOBAL"
      • "SERVICE"
    • Type — (String)

      The type of pricing rule.

      Possible values include:
      • "MARKUP"
      • "DISCOUNT"
    • ModifierPercentage — (Float)

      A percentage modifier applied on the public pricing rates.

    • Service — (String)

      If the Scope attribute is set to SERVICE, the attribute indicates which service the PricingRule is applicable for.

    • Tags — (map<String>)

      A map that contains tag keys and tag values that are attached to a pricing rule.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the created pricing rule.

Returns:

  • (AWS.Request)

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

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

Deletes a billing group.

Service Reference:

Examples:

Calling the deleteBillingGroup operation

var params = {
  Arn: 'STRING_VALUE' /* required */
};
billingconductor.deleteBillingGroup(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: {})
    • Arn — (String)

      The Amazon Resource Name (ARN) of the billing group you're deleting.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the deleted billing group.

Returns:

  • (AWS.Request)

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

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

Deletes the custom line item identified by the given ARN in the current, or previous billing period.

Service Reference:

Examples:

Calling the deleteCustomLineItem operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  BillingPeriodRange: {
    ExclusiveEndBillingPeriod: 'STRING_VALUE', /* required */
    InclusiveStartBillingPeriod: 'STRING_VALUE' /* required */
  }
};
billingconductor.deleteCustomLineItem(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: {})
    • Arn — (String)

      The ARN of the custom line item to be deleted.

    • BillingPeriodRange — (map)

      The billing period range in which the custom line item request will be applied.

      • InclusiveStartBillingPeriodrequired — (String)

        The inclusive start billing period that defines a billing period range where a custom line is applied.

      • ExclusiveEndBillingPeriodrequired — (String)

        The inclusive end billing period that defines a billing period range where a custom line is applied.

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:

      • Arn — (String)

        Then ARN of the deleted custom line item.

Returns:

  • (AWS.Request)

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

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

Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.

Service Reference:

Examples:

Calling the deletePricingPlan operation

var params = {
  Arn: 'STRING_VALUE' /* required */
};
billingconductor.deletePricingPlan(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: {})
    • Arn — (String)

      The Amazon Resource Name (ARN) of the pricing plan you're deleting.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the deleted pricing plan.

Returns:

  • (AWS.Request)

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

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

Deletes the pricing rule identified by the input Amazon Resource Name (ARN).

Service Reference:

Examples:

Calling the deletePricingRule operation

var params = {
  Arn: 'STRING_VALUE' /* required */
};
billingconductor.deletePricingRule(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: {})
    • Arn — (String)

      The Amazon Resource Name (ARN) of the pricing rule you are deleting.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the deleted pricing rule.

Returns:

  • (AWS.Request)

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

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

Removes the specified list of account IDs from the given billing group.

Service Reference:

Examples:

Calling the disassociateAccounts operation

var params = {
  AccountIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Arn: 'STRING_VALUE' /* required */
};
billingconductor.disassociateAccounts(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: {})
    • Arn — (String)

      The Amazon Resource Name (ARN) of the billing group that the array of account IDs will disassociate from.

    • AccountIds — (Array<String>)

      The array of account IDs to disassociate.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the billing group that the array of account IDs is disassociated from.

Returns:

  • (AWS.Request)

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

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

Disassociates a list of pricing rules from a pricing plan.

Service Reference:

Examples:

Calling the disassociatePricingRules operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  PricingRuleArns: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
billingconductor.disassociatePricingRules(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: {})
    • Arn — (String)

      The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from.

    • PricingRuleArns — (Array<String>)

      A list containing the Amazon Resource Name (ARN) of the pricing rules that will be disassociated.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the pricing plan that the pricing rules successfully disassociated from.

Returns:

  • (AWS.Request)

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

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

Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).

This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group associated with the linked account.

Service Reference:

Examples:

Calling the listAccountAssociations operation

var params = {
  BillingPeriod: 'STRING_VALUE',
  Filters: {
    AccountId: 'STRING_VALUE',
    Association: 'STRING_VALUE'
  },
  NextToken: 'STRING_VALUE'
};
billingconductor.listAccountAssociations(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: {})
    • BillingPeriod — (String)

      The preferred billing period to get account associations.

    • Filters — (map)

      The filter on the account ID of the linked account, or any of the following:

      MONITORED: linked accounts that are associated to billing groups.

      UNMONITORED: linked accounts that are not associated to billing groups.

      Billing Group Arn: linked accounts that are associated to the provided billing group Arn.

      • Association — (String)

        MONITORED: linked accounts that are associated to billing groups.

        UNMONITORED: linked accounts that are not associated to billing groups.

        Billing Group Arn: linked accounts that are associated to the provided Billing Group Arn.

      • AccountId — (String)

        The Amazon Web Services account ID to filter on.

    • NextToken — (String)

      The pagination token used on subsequent calls to retrieve accounts.

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:

      • LinkedAccounts — (Array<map>)

        The list of linked accounts in the payer account.

        • AccountId — (String)

          The associating array of account IDs.

        • BillingGroupArn — (String)

          The Billing Group Arn that the linked account is associated to.

        • AccountName — (String)

          The Amazon Web Services account name.

        • AccountEmail — (String)

          The Amazon Web Services account email.

      • NextToken — (String)

        The pagination token used on subsequent calls to get accounts.

Returns:

  • (AWS.Request)

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

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

A paginated call to retrieve a summary report of actual Amazon Web Services charges and the calculated Amazon Web Services charges based on the associated pricing plan of a billing group.

Service Reference:

Examples:

Calling the listBillingGroupCostReports operation

var params = {
  BillingPeriod: 'STRING_VALUE',
  Filters: {
    BillingGroupArns: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
billingconductor.listBillingGroupCostReports(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: {})
    • BillingPeriod — (String)

      The preferred billing period for your report.

    • MaxResults — (Integer)

      The maximum number of reports to retrieve.

    • NextToken — (String)

      The pagination token used on subsequent calls to get reports.

    • Filters — (map)

      A ListBillingGroupCostReportsFilter to specify billing groups to retrieve reports from.

      • BillingGroupArns — (Array<String>)

        The list of Amazon Resource Names (ARNs) used to filter billing groups to retrieve reports.

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:

      • BillingGroupCostReports — (Array<map>)

        A list of BillingGroupCostReportElement retrieved.

        • Arn — (String)

          The Amazon Resource Name (ARN) of a billing group.

        • AWSCost — (String)

          The actual Amazon Web Services charges for the billing group.

        • ProformaCost — (String)

          The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group.

        • Margin — (String)

          The billing group margin.

        • MarginPercentage — (String)

          The percentage of billing group margin.

        • Currency — (String)

          The displayed currency.

      • NextToken — (String)

        The pagination token used on subsequent calls to get reports.

Returns:

  • (AWS.Request)

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

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

A paginated call to retrieve a list of billing groups for the given billing period. If you don't provide a billing group, the current billing period is used.

Service Reference:

Examples:

Calling the listBillingGroups operation

var params = {
  BillingPeriod: 'STRING_VALUE',
  Filters: {
    Arns: [
      'STRING_VALUE',
      /* more items */
    ],
    PricingPlan: 'STRING_VALUE'
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
billingconductor.listBillingGroups(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: {})
    • BillingPeriod — (String)

      The preferred billing period to get billing groups.

    • MaxResults — (Integer)

      The maximum number of billing groups to retrieve.

    • NextToken — (String)

      The pagination token used on subsequent calls to get billing groups.

    • Filters — (map)

      A ListBillingGroupsFilter that specifies the billing group and pricing plan to retrieve billing group information.

      • Arns — (Array<String>)

        The list of billing group Amazon Resource Names (ARNs) to retrieve information.

      • PricingPlan — (String)

        The pricing plan Amazon Resource Names (ARNs) to retrieve information.

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:

      • BillingGroups — (Array<map>)

        A list of BillingGroupListElement retrieved.

        • Name — (String)

          The billing group's name.

        • Arn — (String)

          The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group.

        • Description — (String)

          The billing group description.

        • PrimaryAccountId — (String)

          The account ID that serves as the main account in a billing group.

        • ComputationPreference — (map)

          The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

          • PricingPlanArnrequired — (String)

            The Amazon Resource Name (ARN) of the pricing plan used to compute the Amazon Web Services charges for a billing group.

        • Size — (Integer)

          The number of accounts in the particular billing group.

        • CreationTime — (Integer)

          The time the billing group was created.

        • LastModifiedTime — (Integer)

          The most recent time the billing group was modified.

        • Status — (String)

          The billing group status. Only one of the valid values can be used.

          Possible values include:
          • "ACTIVE"
          • "PRIMARY_ACCOUNT_MISSING"
        • StatusReason — (String)

          The reason why the billing group is in its current status.

      • NextToken — (String)

        The pagination token used on subsequent calls to get billing groups.

Returns:

  • (AWS.Request)

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

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

A paginated call to get a list of all custom line items (FFLIs) for the given billing period. If you don't provide a billing period, the current billing period is used.

Service Reference:

Examples:

Calling the listCustomLineItems operation

var params = {
  BillingPeriod: 'STRING_VALUE',
  Filters: {
    Arns: [
      'STRING_VALUE',
      /* more items */
    ],
    BillingGroups: [
      'STRING_VALUE',
      /* more items */
    ],
    Names: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
billingconductor.listCustomLineItems(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: {})
    • BillingPeriod — (String)

      The preferred billing period to get custom line items (FFLIs).

    • MaxResults — (Integer)

      The maximum number of billing groups to retrieve.

    • NextToken — (String)

      The pagination token used on subsequent calls to get custom line items (FFLIs).

    • Filters — (map)

      A ListCustomLineItemsFilter that specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information.

      • Names — (Array<String>)

        A list of custom line items to retrieve information.

      • BillingGroups — (Array<String>)

        The billing group Amazon Resource Names (ARNs) to retrieve information.

      • Arns — (Array<String>)

        A list of custom line item ARNs to retrieve information.

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:

      • CustomLineItems — (Array<map>)

        A list of FreeFormLineItemListElements received.

        • Arn — (String)

          The Amazon Resource Names (ARNs) for custom line items.

        • Name — (String)

          The custom line item's name.

        • ChargeDetails — (map)

          A ListCustomLineItemChargeDetails that describes the charge details of a custom line item.

          • Flat — (map)

            A ListCustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.

            • ChargeValuerequired — (Float)

              The custom line item's fixed charge value in USD.

          • Percentage — (map)

            A ListCustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.

            • PercentageValuerequired — (Float)

              The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

          • Typerequired — (String)

            The type of the custom line item that indicates whether the charge is a fee or credit.

            Possible values include:
            • "CREDIT"
            • "FEE"
        • CurrencyCode — (String)

          The custom line item's charge value currency. Only one of the valid values can be used.

          Possible values include:
          • "USD"
          • "CNY"
        • Description — (String)

          The custom line item's description. This is shown on the Bills page in association with the charge value.

        • ProductCode — (String)

          The product code associated with the custom line item.

        • BillingGroupArn — (String)

          The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.

        • CreationTime — (Integer)

          The time created.

        • LastModifiedTime — (Integer)

          The most recent time the custom line item was modified.

        • AssociationSize — (Integer)

          The number of resources that are associated to the custom line item.

      • NextToken — (String)

        The pagination token used on subsequent calls to get custom line items (FFLIs).

Returns:

  • (AWS.Request)

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

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

A paginated call to get pricing plans for the given billing period. If you don't provide a billing period, the current billing period is used.

Service Reference:

Examples:

Calling the listPricingPlans operation

var params = {
  BillingPeriod: 'STRING_VALUE',
  Filters: {
    Arns: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
billingconductor.listPricingPlans(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: {})
    • BillingPeriod — (String)

      The preferred billing period to get pricing plan.

    • Filters — (map)

      A ListPricingPlansFilter that specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information.

      • Arns — (Array<String>)

        A list of pricing plan Amazon Resource Names (ARNs) to retrieve information.

    • MaxResults — (Integer)

      The maximum number of pricing plans to retrieve.

    • NextToken — (String)

      The pagination token used on subsequent call to get pricing plans.

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:

      • BillingPeriod — (String)

        The billing period for which the described pricing plans are applicable.

      • PricingPlans — (Array<map>)

        A list of PricingPlanListElement retrieved.

        • Name — (String)

          The name of a pricing plan.

        • Arn — (String)

          The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a pricing plan.

        • Description — (String)

          The pricing plan description.

        • Size — (Integer)

          The pricing rules count currently associated with this pricing plan list element.

        • CreationTime — (Integer)

          The time the pricing plan was created.

        • LastModifiedTime — (Integer)

          The most recent time the pricing plan was modified.

      • NextToken — (String)

        The pagination token used on subsequent calls to get pricing plans.

Returns:

  • (AWS.Request)

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

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

A list of the pricing plans associated with a pricing rule.

Examples:

Calling the listPricingPlansAssociatedWithPricingRule operation

var params = {
  PricingRuleArn: 'STRING_VALUE', /* required */
  BillingPeriod: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
billingconductor.listPricingPlansAssociatedWithPricingRule(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: {})
    • BillingPeriod — (String)

      The pricing plan billing period for which associations will be listed.

    • PricingRuleArn — (String)

      The pricing rule Amazon Resource Name (ARN) for which associations will be listed.

    • MaxResults — (Integer)

      The optional maximum number of pricing rule associations to retrieve.

    • NextToken — (String)

      The optional pagination token returned by a previous call.

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:

      • BillingPeriod — (String)

        The pricing plan billing period for which associations will be listed.

      • PricingRuleArn — (String)

        The pricing rule Amazon Resource Name (ARN) for which associations will be listed.

      • PricingPlanArns — (Array<String>)

        The list containing pricing plans associated with the requested pricing rule.

      • NextToken — (String)

        The pagination token to be used on subsequent calls.

Returns:

  • (AWS.Request)

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

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

Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.

Service Reference:

Examples:

Calling the listPricingRules operation

var params = {
  BillingPeriod: 'STRING_VALUE',
  Filters: {
    Arns: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
billingconductor.listPricingRules(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: {})
    • BillingPeriod — (String)

      The preferred billing period to get the pricing plan.

    • Filters — (map)

      A DescribePricingRuleFilter that specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information.

      • Arns — (Array<String>)

        A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API response.

    • MaxResults — (Integer)

      The maximum number of pricing rules to retrieve.

    • NextToken — (String)

      The pagination token used on subsequent call to get pricing rules.

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:

      • BillingPeriod — (String)

        The billing period for which the described pricing rules are applicable.

      • PricingRules — (Array<map>)

        A list containing the described pricing rules.

        • Name — (String)

          The name of a pricing rule.

        • Arn — (String)

          The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.

        • Description — (String)

          The pricing rule description.

        • Scope — (String)

          The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.

          Possible values include:
          • "GLOBAL"
          • "SERVICE"
        • Type — (String)

          The type of pricing rule.

          Possible values include:
          • "MARKUP"
          • "DISCOUNT"
        • ModifierPercentage — (Float)

          A percentage modifier applied on the public pricing rates.

        • Service — (String)

          If the Scope attribute is SERVICE, this attribute indicates which service the PricingRule is applicable for.

        • AssociatedPricingPlanCount — (Integer)

          The pricing plans count that this pricing rule is associated with.

        • CreationTime — (Integer)

          The time the pricing rule was created.

        • LastModifiedTime — (Integer)

          The most recent time the pricing rule was modified.

      • NextToken — (String)

        The pagination token used on subsequent calls to get pricing rules.

Returns:

  • (AWS.Request)

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

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

Lists the pricing rules associated with a pricing plan.

Examples:

Calling the listPricingRulesAssociatedToPricingPlan operation

var params = {
  PricingPlanArn: 'STRING_VALUE', /* required */
  BillingPeriod: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
billingconductor.listPricingRulesAssociatedToPricingPlan(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: {})
    • BillingPeriod — (String)

      The billing period for which the pricing rule associations are to be listed.

    • PricingPlanArn — (String)

      The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed.

    • MaxResults — (Integer)

      The optional maximum number of pricing rule associations to retrieve.

    • NextToken — (String)

      The optional pagination token returned by a previous call.

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:

      • BillingPeriod — (String)

        The billing period for which the pricing rule associations are listed.

      • PricingPlanArn — (String)

        The Amazon Resource Name (ARN) of the pricing plan for which associations are listed.

      • PricingRuleArns — (Array<String>)

        A list containing pricing rules associated with the requested pricing plan.

      • NextToken — (String)

        The pagination token to be used on subsequent calls.

Returns:

  • (AWS.Request)

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

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

List the resources associated to a custom line item.

Examples:

Calling the listResourcesAssociatedToCustomLineItem operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  BillingPeriod: 'STRING_VALUE',
  Filters: {
    Relationship: PARENT | CHILD
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
billingconductor.listResourcesAssociatedToCustomLineItem(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: {})
    • BillingPeriod — (String)

      The billing period for which the resource associations will be listed.

    • Arn — (String)

      The ARN of the custom line item for which the resource associations will be listed.

    • MaxResults — (Integer)

      (Optional) The maximum number of resource associations to be retrieved.

    • NextToken — (String)

      (Optional) The pagination token returned by a previous request.

    • Filters — (map)

      (Optional) A ListResourcesAssociatedToCustomLineItemFilter that can specify the types of resources that should be retrieved.

      • Relationship — (String)

        The type of relationship between the custom line item and the associated resource.

        Possible values include:
        • "PARENT"
        • "CHILD"

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:

      • Arn — (String)

        The custom line item ARN for which the resource associations are listed.

      • AssociatedResources — (Array<map>)

        A list of ListResourcesAssociatedToCustomLineItemResponseElement for each resource association retrieved.

        • Arn — (String)

          The ARN of the associated resource.

        • Relationship — (String)

          The type of relationship between the custom line item and the associated resource.

          Possible values include:
          • "PARENT"
          • "CHILD"
      • NextToken — (String)

        The pagination token to be used in subsequent requests to retrieve additional results.

Returns:

  • (AWS.Request)

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

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

A list the tags for a resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
billingconductor.listTagsForResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) that identifies the resource to list the tags.

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:

      • Tags — (map<String>)

        The tags for the resource.

Returns:

  • (AWS.Request)

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

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

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  }
};
billingconductor.tagResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to which to add tags.

    • Tags — (map<String>)

      The tags to add to the resource as a list of key-value pairs.

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.

Returns:

  • (AWS.Request)

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

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

Deletes specified tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
billingconductor.untagResource(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: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to which to delete tags.

    • TagKeys — (Array<String>)

      The tags to delete from the resource as a list of key-value pairs.

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.

Returns:

  • (AWS.Request)

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

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

This updates an existing billing group.

Service Reference:

Examples:

Calling the updateBillingGroup operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  ComputationPreference: {
    PricingPlanArn: 'STRING_VALUE' /* required */
  },
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Status: ACTIVE | PRIMARY_ACCOUNT_MISSING
};
billingconductor.updateBillingGroup(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: {})
    • Arn — (String)

      The Amazon Resource Name (ARN) of the billing group being updated.

    • Name — (String)

      The name of the billing group. The names must be unique to each billing group.

    • Status — (String)

      The status of the billing group. Only one of the valid values can be used.

      Possible values include:
      • "ACTIVE"
      • "PRIMARY_ACCOUNT_MISSING"
    • ComputationPreference — (map)

      The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

      • PricingPlanArnrequired — (String)

        The Amazon Resource Name (ARN) of the pricing plan used to compute the Amazon Web Services charges for a billing group.

    • Description — (String)

      A description of the billing group.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the billing group that was updated.

      • Name — (String)

        The name of the billing group. The names must be unique to each billing group.

      • Description — (String)

        A description of the billing group.

      • PrimaryAccountId — (String)

        The account ID that serves as the main account in a billing group.

      • PricingPlanArn — (String)

        The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web Services charges for the billing group.

      • Size — (Integer)

        The number of accounts in the particular billing group.

      • LastModifiedTime — (Integer)

        The most recent time the billing group was modified.

      • Status — (String)

        The status of the billing group. Only one of the valid values can be used.

        Possible values include:
        • "ACTIVE"
        • "PRIMARY_ACCOUNT_MISSING"
      • StatusReason — (String)

        The reason why the billing group is in its current status.

Returns:

  • (AWS.Request)

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

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

Update an existing custom line item in the current or previous billing period.

Service Reference:

Examples:

Calling the updateCustomLineItem operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  BillingPeriodRange: {
    ExclusiveEndBillingPeriod: 'STRING_VALUE', /* required */
    InclusiveStartBillingPeriod: 'STRING_VALUE' /* required */
  },
  ChargeDetails: {
    Flat: {
      ChargeValue: 'NUMBER_VALUE' /* required */
    },
    Percentage: {
      PercentageValue: 'NUMBER_VALUE' /* required */
    }
  },
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
billingconductor.updateCustomLineItem(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: {})
    • Arn — (String)

      The ARN of the custom line item to be updated.

    • Name — (String)

      The new name for the custom line item.

    • Description — (String)

      The new line item description of the custom line item.

    • ChargeDetails — (map)

      A ListCustomLineItemChargeDetails containing the new charge details for the custom line item.

      • Flat — (map)

        An UpdateCustomLineItemFlatChargeDetails that describes the new charge details of a flat custom line item.

        • ChargeValuerequired — (Float)

          The custom line item's new fixed charge value in USD.

      • Percentage — (map)

        An UpdateCustomLineItemPercentageChargeDetails that describes the new charge details of a percentage custom line item.

        • PercentageValuerequired — (Float)

          The custom line item's new percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

    • BillingPeriodRange — (map)

      The billing period range in which the custom line item request will be applied.

      • InclusiveStartBillingPeriodrequired — (String)

        The inclusive start billing period that defines a billing period range where a custom line is applied.

      • ExclusiveEndBillingPeriodrequired — (String)

        The inclusive end billing period that defines a billing period range where a custom line is applied.

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:

      • Arn — (String)

        The ARN of the successfully updated custom line item.

      • BillingGroupArn — (String)

        The ARN of the billing group that the custom line item is applied to.

      • Name — (String)

        The name of the successfully updated custom line item.

      • Description — (String)

        The description of the successfully updated custom line item.

      • ChargeDetails — (map)

        A ListCustomLineItemChargeDetails containing the charge details of the successfully updated custom line item.

        • Flat — (map)

          A ListCustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.

          • ChargeValuerequired — (Float)

            The custom line item's fixed charge value in USD.

        • Percentage — (map)

          A ListCustomLineItemPercentageChargeDetails that describes the charge details of a percentage custom line item.

          • PercentageValuerequired — (Float)

            The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

        • Typerequired — (String)

          The type of the custom line item that indicates whether the charge is a fee or credit.

          Possible values include:
          • "CREDIT"
          • "FEE"
      • LastModifiedTime — (Integer)

        The most recent time the custom line item was modified.

      • AssociationSize — (Integer)

        The number of resources that are associated to the custom line item.

Returns:

  • (AWS.Request)

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

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

This updates an existing pricing plan.

Service Reference:

Examples:

Calling the updatePricingPlan operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE'
};
billingconductor.updatePricingPlan(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: {})
    • Arn — (String)

      The Amazon Resource Name (ARN) of the pricing plan you're updating.

    • Name — (String)

      The name of the pricing plan. The name must be unique to each pricing plan.

    • Description — (String)

      The pricing plan description.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the updated pricing plan.

      • Name — (String)

        The name of the pricing plan. The name must be unique to each pricing plan.

      • Description — (String)

        The new description for the pricing rule.

      • Size — (Integer)

        The pricing rules count currently associated with this pricing plan list.

      • LastModifiedTime — (Integer)

        The most recent time the pricing plan was modified.

Returns:

  • (AWS.Request)

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

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

Updates an existing pricing rule.

Service Reference:

Examples:

Calling the updatePricingRule operation

var params = {
  Arn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  ModifierPercentage: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  Type: MARKUP | DISCOUNT
};
billingconductor.updatePricingRule(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: {})
    • Arn — (String)

      The Amazon Resource Name (ARN) of the pricing rule to update.

    • Name — (String)

      The new name of the pricing rule. The name must be unique to each pricing rule.

    • Description — (String)

      The new description for the pricing rule.

    • Type — (String)

      The new pricing rule type.

      Possible values include:
      • "MARKUP"
      • "DISCOUNT"
    • ModifierPercentage — (Float)

      The new modifier to show pricing plan rates as a percentage.

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:

      • Arn — (String)

        The Amazon Resource Name (ARN) of the successfully updated pricing rule.

      • Name — (String)

        The new name of the pricing rule. The name must be unique to each pricing rule.

      • Description — (String)

        The new description for the pricing rule.

      • Scope — (String)

        The scope of pricing rule that indicates if it is globally applicable, or is service-specific.

        Possible values include:
        • "GLOBAL"
        • "SERVICE"
      • Type — (String)

        The new pricing rule type.

        Possible values include:
        • "MARKUP"
        • "DISCOUNT"
      • ModifierPercentage — (Float)

        The new modifier to show pricing plan rates as a percentage.

      • Service — (String)

        If the Scope attribute is set to SERVICE, the attribute indicates which service the PricingRule is applicable for.

      • AssociatedPricingPlanCount — (Integer)

        The pricing plans count that this pricing rule is associated with.

      • LastModifiedTime — (Integer)

        The most recent time the pricing rule was modified.

Returns:

  • (AWS.Request)

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

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

Waits for a given Billingconductor 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.

Parameters:

  • state (String)

    the resource state to wait for. Available states for this service are listed in "Waiter Resource States" below.

  • params (map) (defaults to: {})

    a list of parameters for the given state. See each waiter resource state for required parameters.

Callback (callback):

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

    Callback containing error and data information. See the respective resource state for the expected error or data information.

    If the waiter times out its requests, it will return a ResourceNotReady error.

Returns:

  • (AWS.Request)

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