Class: Aws::BillingConductor::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::BillingConductor::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb
Overview
An API client for BillingConductor. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::BillingConductor::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#associate_accounts(params = {}) ⇒ Types::AssociateAccountsOutput
Connects an array of account IDs in a consolidated billing family to a predefined billing group.
-
#associate_pricing_rules(params = {}) ⇒ Types::AssociatePricingRulesOutput
Connects an array of
PricingRuleArns
to a definedPricingPlan
. -
#batch_associate_resources_to_custom_line_item(params = {}) ⇒ Types::BatchAssociateResourcesToCustomLineItemOutput
Associates a batch of resources to a percentage custom line item.
-
#batch_disassociate_resources_from_custom_line_item(params = {}) ⇒ Types::BatchDisassociateResourcesFromCustomLineItemOutput
Disassociates a batch of resources from a percentage custom line item.
-
#create_billing_group(params = {}) ⇒ Types::CreateBillingGroupOutput
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(params = {}) ⇒ Types::CreateCustomLineItemOutput
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(params = {}) ⇒ Types::CreatePricingPlanOutput
Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.
-
#create_pricing_rule(params = {}) ⇒ Types::CreatePricingRuleOutput
Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.
-
#delete_billing_group(params = {}) ⇒ Types::DeleteBillingGroupOutput
Deletes a billing group.
-
#delete_custom_line_item(params = {}) ⇒ Types::DeleteCustomLineItemOutput
Deletes the custom line item identified by the given ARN in the current, or previous billing period.
-
#delete_pricing_plan(params = {}) ⇒ Types::DeletePricingPlanOutput
Deletes a pricing plan.
-
#delete_pricing_rule(params = {}) ⇒ Types::DeletePricingRuleOutput
Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN).
-
#disassociate_accounts(params = {}) ⇒ Types::DisassociateAccountsOutput
Removes the specified list of account IDs from the given billing group.
-
#disassociate_pricing_rules(params = {}) ⇒ Types::DisassociatePricingRulesOutput
Disassociates a list of pricing rules from a pricing plan.
-
#get_billing_group_cost_report(params = {}) ⇒ Types::GetBillingGroupCostReportOutput
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(params = {}) ⇒ Types::ListAccountAssociationsOutput
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(params = {}) ⇒ Types::ListBillingGroupCostReportsOutput
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(params = {}) ⇒ Types::ListBillingGroupsOutput
A paginated call to retrieve a list of billing groups for the given billing period.
-
#list_custom_line_item_versions(params = {}) ⇒ Types::ListCustomLineItemVersionsOutput
A paginated call to get a list of all custom line item versions.
-
#list_custom_line_items(params = {}) ⇒ Types::ListCustomLineItemsOutput
A paginated call to get a list of all custom line items (FFLIs) for the given billing period.
-
#list_pricing_plans(params = {}) ⇒ Types::ListPricingPlansOutput
A paginated call to get pricing plans for the given billing period.
-
#list_pricing_plans_associated_with_pricing_rule(params = {}) ⇒ Types::ListPricingPlansAssociatedWithPricingRuleOutput
A list of the pricing plans that are associated with a pricing rule.
-
#list_pricing_rules(params = {}) ⇒ Types::ListPricingRulesOutput
Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.
-
#list_pricing_rules_associated_to_pricing_plan(params = {}) ⇒ Types::ListPricingRulesAssociatedToPricingPlanOutput
Lists the pricing rules that are associated with a pricing plan.
-
#list_resources_associated_to_custom_line_item(params = {}) ⇒ Types::ListResourcesAssociatedToCustomLineItemOutput
List the resources that are associated to a custom line item.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
A list the tags for a resource.
-
#tag_resource(params = {}) ⇒ Struct
Associates the specified tags to a resource with the specified
resourceArn
. -
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
-
#update_billing_group(params = {}) ⇒ Types::UpdateBillingGroupOutput
This updates an existing billing group.
-
#update_custom_line_item(params = {}) ⇒ Types::UpdateCustomLineItemOutput
Update an existing custom line item in the current or previous billing period.
-
#update_pricing_plan(params = {}) ⇒ Types::UpdatePricingPlanOutput
This updates an existing pricing plan.
-
#update_pricing_rule(params = {}) ⇒ Types::UpdatePricingRuleOutput
Updates an existing pricing rule.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
409 410 411 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 409 def initialize(*args) super end |
Instance Method Details
#associate_accounts(params = {}) ⇒ Types::AssociateAccountsOutput
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.
447 448 449 450 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 447 def associate_accounts(params = {}, = {}) req = build_request(:associate_accounts, params) req.send_request() end |
#associate_pricing_rules(params = {}) ⇒ Types::AssociatePricingRulesOutput
Connects an array of PricingRuleArns
to a defined PricingPlan
. The
maximum number PricingRuleArn
that can be associated in one call is
30.
481 482 483 484 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 481 def associate_pricing_rules(params = {}, = {}) req = build_request(:associate_pricing_rules, params) req.send_request() end |
#batch_associate_resources_to_custom_line_item(params = {}) ⇒ Types::BatchAssociateResourcesToCustomLineItemOutput
Associates a batch of resources to a percentage custom line item.
529 530 531 532 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 529 def batch_associate_resources_to_custom_line_item(params = {}, = {}) req = build_request(:batch_associate_resources_to_custom_line_item, params) req.send_request() end |
#batch_disassociate_resources_from_custom_line_item(params = {}) ⇒ Types::BatchDisassociateResourcesFromCustomLineItemOutput
Disassociates a batch of resources from a percentage custom line item.
577 578 579 580 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 577 def batch_disassociate_resources_from_custom_line_item(params = {}, = {}) req = build_request(:batch_disassociate_resources_from_custom_line_item, params) req.send_request() end |
#create_billing_group(params = {}) ⇒ Types::CreateBillingGroupOutput
Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.
646 647 648 649 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 646 def create_billing_group(params = {}, = {}) req = build_request(:create_billing_group, params) req.send_request() end |
#create_custom_line_item(params = {}) ⇒ Types::CreateCustomLineItemOutput
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.
735 736 737 738 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 735 def create_custom_line_item(params = {}, = {}) req = build_request(:create_custom_line_item, params) req.send_request() end |
#create_pricing_plan(params = {}) ⇒ Types::CreatePricingPlanOutput
Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.
789 790 791 792 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 789 def create_pricing_plan(params = {}, = {}) req = build_request(:create_pricing_plan, params) req.send_request() end |
#create_pricing_rule(params = {}) ⇒ Types::CreatePricingRuleOutput
Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.
889 890 891 892 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 889 def create_pricing_rule(params = {}, = {}) req = build_request(:create_pricing_rule, params) req.send_request() end |
#delete_billing_group(params = {}) ⇒ Types::DeleteBillingGroupOutput
Deletes a billing group.
918 919 920 921 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 918 def delete_billing_group(params = {}, = {}) req = build_request(:delete_billing_group, params) req.send_request() end |
#delete_custom_line_item(params = {}) ⇒ Types::DeleteCustomLineItemOutput
Deletes the custom line item identified by the given ARN in the current, or previous billing period.
955 956 957 958 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 955 def delete_custom_line_item(params = {}, = {}) req = build_request(:delete_custom_line_item, params) req.send_request() end |
#delete_pricing_plan(params = {}) ⇒ Types::DeletePricingPlanOutput
Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.
985 986 987 988 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 985 def delete_pricing_plan(params = {}, = {}) req = build_request(:delete_pricing_plan, params) req.send_request() end |
#delete_pricing_rule(params = {}) ⇒ Types::DeletePricingRuleOutput
Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN).
1015 1016 1017 1018 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1015 def delete_pricing_rule(params = {}, = {}) req = build_request(:delete_pricing_rule, params) req.send_request() end |
#disassociate_accounts(params = {}) ⇒ Types::DisassociateAccountsOutput
Removes the specified list of account IDs from the given billing group.
1049 1050 1051 1052 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1049 def disassociate_accounts(params = {}, = {}) req = build_request(:disassociate_accounts, params) req.send_request() end |
#disassociate_pricing_rules(params = {}) ⇒ Types::DisassociatePricingRulesOutput
Disassociates a list of pricing rules from a pricing plan.
1083 1084 1085 1086 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1083 def disassociate_pricing_rules(params = {}, = {}) req = build_request(:disassociate_pricing_rules, params) req.send_request() end |
#get_billing_group_cost_report(params = {}) ⇒ Types::GetBillingGroupCostReportOutput
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.
1148 1149 1150 1151 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1148 def get_billing_group_cost_report(params = {}, = {}) req = build_request(:get_billing_group_cost_report, params) req.send_request() end |
#list_account_associations(params = {}) ⇒ Types::ListAccountAssociationsOutput
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 that's associated with the linked account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1210 1211 1212 1213 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1210 def list_account_associations(params = {}, = {}) req = build_request(:list_account_associations, params) req.send_request() end |
#list_billing_group_cost_reports(params = {}) ⇒ Types::ListBillingGroupCostReportsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1265 1266 1267 1268 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1265 def list_billing_group_cost_reports(params = {}, = {}) req = build_request(:list_billing_group_cost_reports, params) req.send_request() end |
#list_billing_groups(params = {}) ⇒ Types::ListBillingGroupsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1329 def list_billing_groups(params = {}, = {}) req = build_request(:list_billing_groups, params) req.send_request() end |
#list_custom_line_item_versions(params = {}) ⇒ Types::ListCustomLineItemVersionsOutput
A paginated call to get a list of all custom line item versions.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1401 1402 1403 1404 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1401 def list_custom_line_item_versions(params = {}, = {}) req = build_request(:list_custom_line_item_versions, params) req.send_request() end |
#list_custom_line_items(params = {}) ⇒ Types::ListCustomLineItemsOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1473 1474 1475 1476 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1473 def list_custom_line_items(params = {}, = {}) req = build_request(:list_custom_line_items, params) req.send_request() end |
#list_pricing_plans(params = {}) ⇒ Types::ListPricingPlansOutput
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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1531 1532 1533 1534 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1531 def list_pricing_plans(params = {}, = {}) req = build_request(:list_pricing_plans, params) req.send_request() end |
#list_pricing_plans_associated_with_pricing_rule(params = {}) ⇒ Types::ListPricingPlansAssociatedWithPricingRuleOutput
A list of the pricing plans that are associated with a pricing rule.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1581 1582 1583 1584 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1581 def list_pricing_plans_associated_with_pricing_rule(params = {}, = {}) req = build_request(:list_pricing_plans_associated_with_pricing_rule, params) req.send_request() end |
#list_pricing_rules(params = {}) ⇒ Types::ListPricingRulesOutput
Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1646 1647 1648 1649 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1646 def list_pricing_rules(params = {}, = {}) req = build_request(:list_pricing_rules, params) req.send_request() end |
#list_pricing_rules_associated_to_pricing_plan(params = {}) ⇒ Types::ListPricingRulesAssociatedToPricingPlanOutput
Lists the pricing rules that are associated with a pricing plan.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1697 1698 1699 1700 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1697 def list_pricing_rules_associated_to_pricing_plan(params = {}, = {}) req = build_request(:list_pricing_rules_associated_to_pricing_plan, params) req.send_request() end |
#list_resources_associated_to_custom_line_item(params = {}) ⇒ Types::ListResourcesAssociatedToCustomLineItemOutput
List the resources that are associated to a custom line item.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1756 1757 1758 1759 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1756 def list_resources_associated_to_custom_line_item(params = {}, = {}) req = build_request(:list_resources_associated_to_custom_line_item, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
A list the tags for a resource.
1786 1787 1788 1789 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1786 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
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.
1816 1817 1818 1819 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1816 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
1843 1844 1845 1846 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1843 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_billing_group(params = {}) ⇒ Types::UpdateBillingGroupOutput
This updates an existing billing group.
1917 1918 1919 1920 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1917 def update_billing_group(params = {}, = {}) req = build_request(:update_billing_group, params) req.send_request() end |
#update_custom_line_item(params = {}) ⇒ Types::UpdateCustomLineItemOutput
Update an existing custom line item in the current or previous billing period.
2000 2001 2002 2003 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 2000 def update_custom_line_item(params = {}, = {}) req = build_request(:update_custom_line_item, params) req.send_request() end |
#update_pricing_plan(params = {}) ⇒ Types::UpdatePricingPlanOutput
This updates an existing pricing plan.
2046 2047 2048 2049 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 2046 def update_pricing_plan(params = {}, = {}) req = build_request(:update_pricing_plan, params) req.send_request() end |
#update_pricing_rule(params = {}) ⇒ Types::UpdatePricingRuleOutput
Updates an existing pricing rule.
2123 2124 2125 2126 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 2123 def update_pricing_rule(params = {}, = {}) req = build_request(:update_pricing_rule, params) req.send_request() end |