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.
473 474 475 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 473 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.
511 512 513 514 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 511 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.
545 546 547 548 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 545 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.
593 594 595 596 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 593 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.
641 642 643 644 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 641 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.
710 711 712 713 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 710 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.
799 800 801 802 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 799 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.
853 854 855 856 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 853 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.
953 954 955 956 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 953 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.
982 983 984 985 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 982 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.
1019 1020 1021 1022 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1019 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.
1049 1050 1051 1052 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1049 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).
1079 1080 1081 1082 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1079 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.
1113 1114 1115 1116 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1113 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.
1147 1148 1149 1150 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1147 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.
1212 1213 1214 1215 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1212 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.
1274 1275 1276 1277 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1274 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.
1329 1330 1331 1332 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1329 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.
1393 1394 1395 1396 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1393 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.
1465 1466 1467 1468 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1465 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.
1537 1538 1539 1540 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1537 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.
1595 1596 1597 1598 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1595 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.
1645 1646 1647 1648 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1645 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.
1710 1711 1712 1713 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1710 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.
1761 1762 1763 1764 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1761 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.
1820 1821 1822 1823 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1820 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.
1850 1851 1852 1853 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1850 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.
1880 1881 1882 1883 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1880 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Deletes specified tags from a resource.
1907 1908 1909 1910 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1907 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.
1981 1982 1983 1984 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 1981 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.
2064 2065 2066 2067 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 2064 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.
2110 2111 2112 2113 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 2110 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.
2187 2188 2189 2190 |
# File 'gems/aws-sdk-billingconductor/lib/aws-sdk-billingconductor/client.rb', line 2187 def update_pricing_rule(params = {}, = {}) req = build_request(:update_pricing_rule, params) req.send_request() end |