Client

billingconductor

R Documentation

AWSBillingConductor¶

Description¶

Amazon Web Services Billing Conductor is a fully managed service that you can use to customize a proforma 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 Billing Conductor User Guide.

Usage¶

billingconductor(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- billingconductor(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

associate_accounts: Connects an array of account IDs in a consolidated billing family to a predefined billing group
associate_pricing_rules: Connects an array of PricingRuleArns to a defined PricingPlan; Associates a batch of resources to a percentage custom line item; Disassociates a batch of resources from a percentage custom line item
create_billing_group: Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation
create_custom_line_item: 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
create_pricing_plan: Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups
create_pricing_rule: Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans
delete_billing_group: Deletes a billing group
delete_custom_line_item: Deletes the custom line item identified by the given ARN in the current, or previous billing period
delete_pricing_plan: Deletes a pricing plan
delete_pricing_rule: Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN)
disassociate_accounts: Removes the specified list of account IDs from the given billing group
disassociate_pricing_rules: Disassociates a list of pricing rules from a pricing plan
get_billing_group_cost_report: Retrieves the margin summary report, which includes the Amazon Web Services cost and charged amount (pro forma cost) by Amazon Web Service for a specific billing group
list_account_associations: This is a paginated call to list linked accounts that are linked to the payer account for the specified time period
list_billing_group_cost_reports: 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
list_billing_groups: A paginated call to retrieve a list of billing groups for the given billing period
list_custom_line_items: A paginated call to get a list of all custom line items (FFLIs) for the given billing period
list_custom_line_item_versions: A paginated call to get a list of all custom line item versions
list_pricing_plans: A paginated call to get pricing plans for the given billing period; A list of the pricing plans that are associated with a pricing rule
list_pricing_rules: Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans; Lists the pricing rules that are associated with a pricing plan; List the resources that are associated to a custom line item
list_tags_for_resource: A list the tags for a resource
tag_resource: Associates the specified tags to a resource with the specified resourceArn
untag_resource: Deletes specified tags from a resource
update_billing_group: This updates an existing billing group
update_custom_line_item: Update an existing custom line item in the current or previous billing period
update_pricing_plan: This updates an existing pricing plan
update_pricing_rule: Updates an existing pricing rule

Examples¶

## Not run: 
svc <- billingconductor()
svc$associate_accounts(
  Foo = 123
)

## End(Not run)