Class: AWS.Billingconductor

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.

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

    • InclusiveStartBillingPeriod — required — (String)

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

    • ExclusiveEndBillingPeriod — (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 why the resource association failed.

        • Reason — (String)

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

          Possible values include:
          • "INVALID_ARN"
          • "SERVICE_LIMIT_EXCEEDED"
          • "ILLEGAL_CUSTOMLINEITEM"
          • "INTERNAL_SERVER_EXCEPTION"
          • "INVALID_BILLING_PERIOD_RANGE"
    • 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 why the resource association failed.

        • Reason — (String)

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

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

Returns:

• (AWS.Request) —

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

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

    • InclusiveStartBillingPeriod — required — (String)

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

    • ExclusiveEndBillingPeriod — (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 that's shown if the resource disassociation fails.

        • Message — (String)

          The reason why the resource association failed.

        • Reason — (String)

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

          Possible values include:
          • "INVALID_ARN"
          • "SERVICE_LIMIT_EXCEEDED"
          • "ILLEGAL_CUSTOMLINEITEM"
          • "INTERNAL_SERVER_EXCEPTION"
          • "INVALID_BILLING_PERIOD_RANGE"
    • 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 that's shown if the resource disassociation fails.

        • Message — (String)

          The reason why the resource association failed.

        • Reason — (String)

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

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

Returns:

• (AWS.Request) —

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

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.

    • LinkedAccountIds — required — (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.

    • PricingPlanArn — required — (String)

      The Amazon Resource Name (ARN) of the pricing plan that's 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 description of the billing group.

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

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: {
    InclusiveStartBillingPeriod: 'STRING_VALUE', /* required */
    ExclusiveEndBillingPeriod: 'STRING_VALUE'
  },
  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.

    • InclusiveStartBillingPeriod — required — (String)

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

    • ExclusiveEndBillingPeriod — (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.

      • ChargeValue — required — (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.

      • PercentageValue — required — (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.

    • Type — required — (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.

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 name of the pricing plan. The names must be unique to each pricing plan.

  • Description — (String)

    The description of the pricing plan.

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

var params = {
  Name: 'STRING_VALUE', /* required */
  Scope: GLOBAL | SERVICE | BILLING_ENTITY | SKU, /* required */
  Type: MARKUP | DISCOUNT | TIERING, /* required */
  BillingEntity: 'STRING_VALUE',
  ClientToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  ModifierPercentage: 'NUMBER_VALUE',
  Operation: 'STRING_VALUE',
  Service: 'STRING_VALUE',
  Tags: {
    '<TagKey>': 'STRING_VALUE',
    /* '<TagKey>': ... */
  },
  Tiering: {
    FreeTier: { /* required */
      Activated: true || false /* required */
    }
  },
  UsageType: 'STRING_VALUE'
};
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's 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's globally applicable, or it's service-specific.

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

    The type of pricing rule.

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

    A percentage modifier that's applied on the public pricing rates.

  • Service — (String)

    If the Scope attribute is set to SERVICE or SKU, 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.

  • BillingEntity — (String)

    The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.

  • Tiering — (map)

    The set of tiering configurations for the pricing rule.

    • FreeTier — required — (map)

      The possible Amazon Web Services Free Tier configurations.

      • Activated — required — (Boolean)

        Activate or deactivate Amazon Web Services Free Tier.

  • UsageType — (String)

    Usage type is the unit that each service uses to measure the usage of a specific type of resource.

    If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.

    </p> 

  • Operation — (String)

    Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item.

    If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.

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.

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

var params = {
  Arn: 'STRING_VALUE', /* required */
  BillingPeriodRange: {
    InclusiveStartBillingPeriod: 'STRING_VALUE', /* required */
    ExclusiveEndBillingPeriod: 'STRING_VALUE'
  }
};
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.

    • InclusiveStartBillingPeriod — required — (String)

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

    • ExclusiveEndBillingPeriod — (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.

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

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

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.

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.

var params = {
  BillingPeriod: 'STRING_VALUE',
  Filters: {
    AccountId: 'STRING_VALUE',
    AccountIds: [
      'STRING_VALUE',
      /* more items */
    ],
    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 aren't 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.

    • AccountIds — (Array<String>)

      The list of Amazon Web Services IDs to retrieve their associated billing group for a given time range.

  • NextToken — (String)

    The pagination token that's 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 that's used on subsequent calls to get accounts.

Returns:

• (AWS.Request) —

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

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 that's 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 that's used on subsequent calls to get reports.

Returns:

• (AWS.Request) —

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

var params = {
  BillingPeriod: 'STRING_VALUE',
  Filters: {
    Arns: [
      'STRING_VALUE',
      /* more items */
    ],
    PricingPlan: 'STRING_VALUE',
    Statuses: [
      ACTIVE | PRIMARY_ACCOUNT_MISSING,
      /* more items */
    ]
  },
  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 that's 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.

    • Statuses — (Array<String>)

      A list of billing groups to retrieve their current status for a specific time range

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 name of the billing group.

      • Arn — (String)

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

      • Description — (String)

        The description of the billing group.

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

        • PricingPlanArn — required — (String)

          The Amazon Resource Name (ARN) of the pricing plan that's 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 when the billing group was created.

      • LastModifiedTime — (Integer)

        The most recent time when 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 that's used on subsequent calls to get billing groups.

Returns:

• (AWS.Request) —

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

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 that's 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.

          • ChargeValue — required — (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.

          • PercentageValue — required — (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.

        • Type — required — (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 that's 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 when 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 that's used on subsequent calls to get custom line items (FFLIs).

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE', /* required */
  Filters: {
    BillingPeriodRange: {
      EndBillingPeriod: 'STRING_VALUE',
      StartBillingPeriod: 'STRING_VALUE'
    }
  },
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
billingconductor.listCustomLineItemVersions(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) for the custom line item.

  • MaxResults — (Integer)

    The maximum number of custom line item versions to retrieve.

  • NextToken — (String)

    The pagination token that's used on subsequent calls to retrieve custom line item versions.

  • Filters — (map)

    A ListCustomLineItemVersionsFilter that specifies the billing period range in which the custom line item versions are applied.

    • BillingPeriodRange — (map)

      The billing period range in which the custom line item version is applied.

      • StartBillingPeriod — (String)

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

      • EndBillingPeriod — (String)

        The exclusive end billing period that defines a billing period range where a custom line item version 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:

    • CustomLineItemVersions — (Array<map>)

      A list of CustomLineItemVersionListElements that are received.

      • Name — (String)

        The name of the custom line item.

      • ChargeDetails — (map)

        A representation of the charge details of a custom line item.

        • Flat — (map)

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

          • ChargeValue — required — (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.

          • PercentageValue — required — (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.

        • Type — required — (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 charge value currency of the custom line item.

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

        The description of the custom line item.

      • ProductCode — (String)

        The product code that’s associated with the custom line item.

      • BillingGroupArn — (String)

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

      • CreationTime — (Integer)

        The time when the custom line item version was created.

      • LastModifiedTime — (Integer)

        The most recent time that the custom line item version was modified.

      • AssociationSize — (Integer)

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

      • StartBillingPeriod — (String)

        The start billing period of the custom line item version.

      • EndBillingPeriod — (String)

        The end billing period of the custom line item version.

      • Arn — (String)

        A list of custom line item Amazon Resource Names (ARNs) to retrieve information.

      • StartTime — (Integer)

        The inclusive start time.

    • NextToken — (String)

      The pagination token that's used on subsequent calls to retrieve custom line item versions.

Returns:

• (AWS.Request) —

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

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 that's 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 that's currently associated with this pricing plan list element.

      • CreationTime — (Integer)

        The time when the pricing plan was created.

      • LastModifiedTime — (Integer)

        The most recent time when the pricing plan was modified.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

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 that are 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.

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 that's 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"
        • "BILLING_ENTITY"
        • "SKU"
      • Type — (String)

        The type of pricing rule.

        Possible values include:
        • "MARKUP"
        • "DISCOUNT"
        • "TIERING"
      • 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 when the pricing rule was created.

      • LastModifiedTime — (Integer)

        The most recent time when the pricing rule was modified.

      • BillingEntity — (String)

        The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.

      • Tiering — (map)

        The set of tiering configurations for the pricing rule.

        • FreeTier — required — (map)

          The possible Amazon Web Services Free Tier configurations.

          • Activated — required — (Boolean)

            Activate or deactivate Amazon Web Services Free Tier application.

      • UsageType — (String)

        Usage type is the unit that each service uses to measure the usage of a specific type of resource.

        If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.

        </p> 

      • Operation — (String)

        Operation is the specific Amazon Web Services action covered by this line item. This describes the specific usage of the line item.

        If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.

    • NextToken — (String)

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

Returns:

• (AWS.Request) —

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

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 that are 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.

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 that's 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"
      • EndBillingPeriod — (String)

        The end billing period of the associated resource.

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

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.

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.

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.

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.

    • PricingPlanArn — required — (String)

      The Amazon Resource Name (ARN) of the pricing plan that's 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 when 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.

var params = {
  Arn: 'STRING_VALUE', /* required */
  BillingPeriodRange: {
    InclusiveStartBillingPeriod: 'STRING_VALUE', /* required */
    ExclusiveEndBillingPeriod: 'STRING_VALUE'
  },
  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.

      • ChargeValue — required — (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.

      • PercentageValue — required — (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.

    • InclusiveStartBillingPeriod — required — (String)

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

    • ExclusiveEndBillingPeriod — (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.

        • ChargeValue — required — (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.

        • PercentageValue — required — (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.

      • Type — required — (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 when 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.

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 that you're updating.

  • Name — (String)

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

  • Description — (String)

    The description of 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 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 that's currently associated with this pricing plan list.

    • LastModifiedTime — (Integer)

      The most recent time when the pricing plan was modified.

Returns:

• (AWS.Request) —

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

var params = {
  Arn: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  ModifierPercentage: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  Tiering: {
    FreeTier: { /* required */
      Activated: true || false /* required */
    }
  },
  Type: MARKUP | DISCOUNT | TIERING
};
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"
    • "TIERING"
  • ModifierPercentage — (Float)

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

  • Tiering — (map)

    The set of tiering configurations for the pricing rule.

    • FreeTier — required — (map)

      The possible Amazon Web Services Free Tier configurations.

      • Activated — required — (Boolean)

        Activate or deactivate application of Amazon Web Services Free Tier.

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's globally applicable, or it's service-specific.

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

      The new pricing rule type.

      Possible values include:
      • "MARKUP"
      • "DISCOUNT"
      • "TIERING"
    • 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.

    • BillingEntity — (String)

      The seller of services provided by Amazon Web Services, their affiliates, or third-party providers selling services via Amazon Web Services Marketplace.

    • Tiering — (map)

      The set of tiering configurations for the pricing rule.

      • FreeTier — required — (map)

        The possible Amazon Web Services Free Tier configurations.

        • Activated — required — (Boolean)

          Activate or deactivate application of Amazon Web Services Free Tier.

    • UsageType — (String)

      Usage type is the unit that each service uses to measure the usage of a specific type of resource.

      If the Scope attribute is set to SKU, this attribute indicates which usage type the PricingRule is modifying. For example, USW2-BoxUsage:m2.2xlarge describes an M2 High Memory Double Extra Large instance in the US West (Oregon) Region.

    • Operation — (String)

      Operation refers to the specific Amazon Web Services covered by this line item. This describes the specific usage of the line item.

      If the Scope attribute is set to SKU, this attribute indicates which operation the PricingRule is modifying. For example, a value of RunInstances:0202 indicates the operation of running an Amazon EC2 instance.

Returns:

• (AWS.Request) —

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

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.