AWSBillingConductor 2021-07-30
- Client: Aws\BillingConductor\BillingConductorClient
- Service ID: billingconductor
- Version: 2021-07-30
This page describes the parameters and results for the operations of the AWSBillingConductor (2021-07-30), and shows how to use the Aws\BillingConductor\BillingConductorClient object to call the described operations. This documentation is specific to the 2021-07-30 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AssociateAccounts ( array $params = [] )
Connects an array of account IDs in a consolidated billing family to a predefined billing group.
- AssociatePricingRules ( array $params = [] )
Connects an array of PricingRuleArns to a defined PricingPlan.
- BatchAssociateResourcesToCustomLineItem ( array $params = [] )
Associates a batch of resources to a percentage custom line item.
- BatchDisassociateResourcesFromCustomLineItem ( array $params = [] )
Disassociates a batch of resources from a percentage custom line item.
- CreateBillingGroup ( array $params = [] )
Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.
- CreateCustomLineItem ( array $params = [] )
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.
- CreatePricingPlan ( array $params = [] )
Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.
- CreatePricingRule ( array $params = [] )
Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.
- DeleteBillingGroup ( array $params = [] )
Deletes a billing group.
- DeleteCustomLineItem ( array $params = [] )
Deletes the custom line item identified by the given ARN in the current, or previous billing period.
- DeletePricingPlan ( array $params = [] )
Deletes a pricing plan.
- DeletePricingRule ( array $params = [] )
Deletes the pricing rule identified by the input Amazon Resource Name (ARN).
- DisassociateAccounts ( array $params = [] )
Removes the specified list of account IDs from the given billing group.
- DisassociatePricingRules ( array $params = [] )
Disassociates a list of pricing rules from a pricing plan.
- ListAccountAssociations ( array $params = [] )
Amazon Web Services Billing Conductor is in beta release and is subject to change.
- ListBillingGroupCostReports ( array $params = [] )
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.
- ListBillingGroups ( array $params = [] )
A paginated call to retrieve a list of billing groups for the given billing period.
- ListCustomLineItems ( array $params = [] )
A paginated call to get a list of all custom line items (FFLIs) for the given billing period.
- ListPricingPlans ( array $params = [] )
A paginated call to get pricing plans for the given billing period.
- ListPricingPlansAssociatedWithPricingRule ( array $params = [] )
A list of the pricing plans associated with a pricing rule.
- ListPricingRules ( array $params = [] )
Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.
- ListPricingRulesAssociatedToPricingPlan ( array $params = [] )
Lists the pricing rules associated with a pricing plan.
- ListResourcesAssociatedToCustomLineItem ( array $params = [] )
List the resources associated to a custom line item.
- ListTagsForResource ( array $params = [] )
A list the tags for a resource.
- TagResource ( array $params = [] )
Associates the specified tags to a resource with the specified resourceArn.
- UntagResource ( array $params = [] )
Deletes specified tags from a resource.
- UpdateBillingGroup ( array $params = [] )
This updates an existing billing group.
- UpdateCustomLineItem ( array $params = [] )
Update an existing custom line item in the current or previous billing period.
- UpdatePricingPlan ( array $params = [] )
This updates an existing pricing plan.
- UpdatePricingRule ( array $params = [] )
Updates an existing pricing rule.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
AssociateAccounts
$result = $client->associateAccounts([/* ... */]); $promise = $client->associateAccountsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->associateAccounts([
'AccountIds' => ['<string>', ...], // REQUIRED
'Arn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Members
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
ServiceLimitExceededException:
The request would cause a service limit to exceed.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
AssociatePricingRules
$result = $client->associatePricingRules([/* ... */]); $promise = $client->associatePricingRulesAsync([/* ... */]);
Connects an array of PricingRuleArns to a defined PricingPlan. The maximum number PricingRuleArn that can be associated in one call is 30.
Parameter Syntax
$result = $client->associatePricingRules([
'Arn' => '<string>', // REQUIRED
'PricingRuleArns' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
ServiceLimitExceededException:
The request would cause a service limit to exceed.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
BatchAssociateResourcesToCustomLineItem
$result = $client->batchAssociateResourcesToCustomLineItem([/* ... */]); $promise = $client->batchAssociateResourcesToCustomLineItemAsync([/* ... */]);
Associates a batch of resources to a percentage custom line item.
Parameter Syntax
$result = $client->batchAssociateResourcesToCustomLineItem([
'BillingPeriodRange' => [
'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
],
'ResourceArns' => ['<string>', ...], // REQUIRED
'TargetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BillingPeriodRange
-
- Type: CustomLineItemBillingPeriodRange structure
The billing period range in which the custom line item request will be applied.
- ResourceArns
-
- Required: Yes
- Type: Array of strings
A list containing the ARNs of the resources to be associated.
- TargetArn
-
- Required: Yes
- Type: string
A percentage custom line item ARN to associate the resources to.
Result Syntax
[
'FailedAssociatedResources' => [
[
'Arn' => '<string>',
'Error' => [
'Message' => '<string>',
'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION',
],
],
// ...
],
'SuccessfullyAssociatedResources' => [
[
'Arn' => '<string>',
'Error' => [
'Message' => '<string>',
'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION',
],
],
// ...
],
]
Result Details
Members
- FailedAssociatedResources
-
- Type: Array of AssociateResourceResponseElement structures
A list of
AssociateResourceResponseElementfor each resource that failed association to a percentage custom line item. - SuccessfullyAssociatedResources
-
- Type: Array of AssociateResourceResponseElement structures
A list of
AssociateResourceResponseElementfor each resource that's been associated to a percentage custom line item successfully.
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
ServiceLimitExceededException:
The request would cause a service limit to exceed.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
BatchDisassociateResourcesFromCustomLineItem
$result = $client->batchDisassociateResourcesFromCustomLineItem([/* ... */]); $promise = $client->batchDisassociateResourcesFromCustomLineItemAsync([/* ... */]);
Disassociates a batch of resources from a percentage custom line item.
Parameter Syntax
$result = $client->batchDisassociateResourcesFromCustomLineItem([
'BillingPeriodRange' => [
'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
],
'ResourceArns' => ['<string>', ...], // REQUIRED
'TargetArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BillingPeriodRange
-
- Type: CustomLineItemBillingPeriodRange structure
The billing period range in which the custom line item request will be applied.
- ResourceArns
-
- Required: Yes
- Type: Array of strings
A list containing the ARNs of resources to be disassociated.
- TargetArn
-
- Required: Yes
- Type: string
A percentage custom line item ARN to disassociate the resources from.
Result Syntax
[
'FailedDisassociatedResources' => [
[
'Arn' => '<string>',
'Error' => [
'Message' => '<string>',
'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION',
],
],
// ...
],
'SuccessfullyDisassociatedResources' => [
[
'Arn' => '<string>',
'Error' => [
'Message' => '<string>',
'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION',
],
],
// ...
],
]
Result Details
Members
- FailedDisassociatedResources
-
- Type: Array of DisassociateResourceResponseElement structures
A list of
DisassociateResourceResponseElementfor each resource that failed disassociation from a percentage custom line item. - SuccessfullyDisassociatedResources
-
- Type: Array of DisassociateResourceResponseElement structures
A list of
DisassociateResourceResponseElementfor each resource that's been disassociated from a percentage custom line item successfully.
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
CreateBillingGroup
$result = $client->createBillingGroup([/* ... */]); $promise = $client->createBillingGroupAsync([/* ... */]);
Creates a billing group that resembles a consolidated billing family that Amazon Web Services charges, based off of the predefined pricing plan computation.
Parameter Syntax
$result = $client->createBillingGroup([
'AccountGrouping' => [ // REQUIRED
'LinkedAccountIds' => ['<string>', ...], // REQUIRED
],
'ClientToken' => '<string>',
'ComputationPreference' => [ // REQUIRED
'PricingPlanArn' => '<string>', // REQUIRED
],
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'PrimaryAccountId' => '<string>',
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- AccountGrouping
-
- Required: Yes
- Type: AccountGrouping structure
The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family.
- ClientToken
-
- Type: string
The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
- ComputationPreference
-
- Required: Yes
- Type: ComputationPreference structure
The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.
- Description
-
- Type: string
The billing group description.
- Name
-
- Required: Yes
- Type: string
The billing group name. The names must be unique.
- PrimaryAccountId
-
- Type: string
The account ID that serves as the main account in a billing group.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A map that contains tag keys and tag values that are attached to a billing group. This feature isn't available during the beta.
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
ServiceLimitExceededException:
The request would cause a service limit to exceed.
-
An unexpected error occurred while processing a request.
CreateCustomLineItem
$result = $client->createCustomLineItem([/* ... */]); $promise = $client->createCustomLineItemAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->createCustomLineItem([
'BillingGroupArn' => '<string>', // REQUIRED
'BillingPeriodRange' => [
'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
],
'ChargeDetails' => [ // REQUIRED
'Flat' => [
'ChargeValue' => <float>, // REQUIRED
],
'Percentage' => [
'AssociatedValues' => ['<string>', ...],
'PercentageValue' => <float>, // REQUIRED
],
'Type' => 'CREDIT|FEE', // REQUIRED
],
'ClientToken' => '<string>',
'Description' => '<string>', // REQUIRED
'Name' => '<string>', // REQUIRED
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- BillingGroupArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
- BillingPeriodRange
-
- Type: CustomLineItemBillingPeriodRange structure
A time range for which the custom line item is effective.
- ChargeDetails
-
- Required: Yes
- Type: CustomLineItemChargeDetails structure
A
CustomLineItemChargeDetailsthat describes the charge details for a custom line item. - ClientToken
-
- Type: string
The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
- Description
-
- Required: Yes
- Type: string
The description of the custom line item. This is shown on the Bills page in association with the charge value.
- Name
-
- Required: Yes
- Type: string
The name of the custom line item.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A map that contains tag keys and tag values that are attached to a custom line item.
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
ServiceLimitExceededException:
The request would cause a service limit to exceed.
-
An unexpected error occurred while processing a request.
CreatePricingPlan
$result = $client->createPricingPlan([/* ... */]); $promise = $client->createPricingPlanAsync([/* ... */]);
Creates a pricing plan that is used for computing Amazon Web Services charges for billing groups.
Parameter Syntax
$result = $client->createPricingPlan([
'ClientToken' => '<string>',
'Description' => '<string>',
'Name' => '<string>', // REQUIRED
'PricingRuleArns' => ['<string>', ...],
'Tags' => ['<string>', ...],
]);
Parameter Details
Members
- ClientToken
-
- Type: string
The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
- Description
-
- Type: string
The pricing plan description.
- Name
-
- Required: Yes
- Type: string
The pricing plan name. The names must be unique to each pricing plan.
- PricingRuleArns
-
- Type: Array of strings
A list of Amazon Resource Names (ARNs) that define the pricing plan parameters.
- Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A map that contains tag keys and tag values that are attached to a pricing plan.
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
ServiceLimitExceededException:
The request would cause a service limit to exceed.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
CreatePricingRule
$result = $client->createPricingRule([/* ... */]); $promise = $client->createPricingRuleAsync([/* ... */]);
Creates a pricing rule can be associated to a pricing plan, or a set of pricing plans.
Parameter Syntax
$result = $client->createPricingRule([
'ClientToken' => '<string>',
'Description' => '<string>',
'ModifierPercentage' => <float>, // REQUIRED
'Name' => '<string>', // REQUIRED
'Scope' => 'GLOBAL|SERVICE', // REQUIRED
'Service' => '<string>',
'Tags' => ['<string>', ...],
'Type' => 'MARKUP|DISCOUNT', // REQUIRED
]);
Parameter Details
Members
- ClientToken
-
- Type: string
The token that is needed to support idempotency. Idempotency isn't currently supported, but will be implemented in a future update.
- Description
-
- Type: string
The pricing rule description.
- ModifierPercentage
-
- Required: Yes
- Type: double
A percentage modifier applied on the public pricing rates.
- Name
-
- Required: Yes
- Type: string
The pricing rule name. The names must be unique to each pricing rule.
- Scope
-
- Required: Yes
- Type: string
The scope of pricing rule that indicates if it is globally applicable, or is service-specific.
- Service
-
- Type: string
If the
Scopeattribute is set toSERVICE, the attribute indicates which service thePricingRuleis applicable for. - Tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
A map that contains tag keys and tag values that are attached to a pricing rule.
- Type
-
- Required: Yes
- Type: string
The type of pricing rule.
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
ServiceLimitExceededException:
The request would cause a service limit to exceed.
-
An unexpected error occurred while processing a request.
DeleteBillingGroup
$result = $client->deleteBillingGroup([/* ... */]); $promise = $client->deleteBillingGroupAsync([/* ... */]);
Deletes a billing group.
Parameter Syntax
$result = $client->deleteBillingGroup([
'Arn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
DeleteCustomLineItem
$result = $client->deleteCustomLineItem([/* ... */]); $promise = $client->deleteCustomLineItemAsync([/* ... */]);
Deletes the custom line item identified by the given ARN in the current, or previous billing period.
Parameter Syntax
$result = $client->deleteCustomLineItem([
'Arn' => '<string>', // REQUIRED
'BillingPeriodRange' => [
'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
],
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the custom line item to be deleted.
- BillingPeriodRange
-
- Type: CustomLineItemBillingPeriodRange structure
The billing period range in which the custom line item request will be applied.
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
DeletePricingPlan
$result = $client->deletePricingPlan([/* ... */]); $promise = $client->deletePricingPlanAsync([/* ... */]);
Deletes a pricing plan. The pricing plan must not be associated with any billing groups to delete successfully.
Parameter Syntax
$result = $client->deletePricingPlan([
'Arn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
DeletePricingRule
$result = $client->deletePricingRule([/* ... */]); $promise = $client->deletePricingRuleAsync([/* ... */]);
Deletes the pricing rule identified by the input Amazon Resource Name (ARN).
Parameter Syntax
$result = $client->deletePricingRule([
'Arn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
DisassociateAccounts
$result = $client->disassociateAccounts([/* ... */]); $promise = $client->disassociateAccountsAsync([/* ... */]);
Removes the specified list of account IDs from the given billing group.
Parameter Syntax
$result = $client->disassociateAccounts([
'AccountIds' => ['<string>', ...], // REQUIRED
'Arn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Members
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
DisassociatePricingRules
$result = $client->disassociatePricingRules([/* ... */]); $promise = $client->disassociatePricingRulesAsync([/* ... */]);
Disassociates a list of pricing rules from a pricing plan.
Parameter Syntax
$result = $client->disassociatePricingRules([
'Arn' => '<string>', // REQUIRED
'PricingRuleArns' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
]
Result Details
Members
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
ListAccountAssociations
$result = $client->listAccountAssociations([/* ... */]); $promise = $client->listAccountAssociationsAsync([/* ... */]);
Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).
This is a paginated call to list linked accounts that are linked to the payer account for the specified time period. If no information is provided, the current billing period is used. The response will optionally include the billing group associated with the linked account.
Parameter Syntax
$result = $client->listAccountAssociations([
'BillingPeriod' => '<string>',
'Filters' => [
'AccountId' => '<string>',
'Association' => '<string>',
],
'NextToken' => '<string>',
]);
Parameter Details
Members
- BillingPeriod
-
- Type: string
The preferred billing period to get account associations.
- Filters
-
- Type: ListAccountAssociationsFilter structure
The filter on the account ID of the linked account, or any of the following:
MONITORED: linked accounts that are associated to billing groups.UNMONITORED: linked accounts that are not associated to billing groups.Billing Group Arn: linked accounts that are associated to the provided billing group Arn. - NextToken
-
- Type: string
The pagination token used on subsequent calls to retrieve accounts.
Result Syntax
[
'LinkedAccounts' => [
[
'AccountEmail' => '<string>',
'AccountId' => '<string>',
'AccountName' => '<string>',
'BillingGroupArn' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- LinkedAccounts
-
- Type: Array of AccountAssociationsListElement structures
The list of linked accounts in the payer account.
- NextToken
-
- Type: string
The pagination token used on subsequent calls to get accounts.
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
ListBillingGroupCostReports
$result = $client->listBillingGroupCostReports([/* ... */]); $promise = $client->listBillingGroupCostReportsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listBillingGroupCostReports([
'BillingPeriod' => '<string>',
'Filters' => [
'BillingGroupArns' => ['<string>', ...],
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- BillingPeriod
-
- Type: string
The preferred billing period for your report.
- Filters
-
- Type: ListBillingGroupCostReportsFilter structure
A
ListBillingGroupCostReportsFilterto specify billing groups to retrieve reports from. - MaxResults
-
- Type: int
The maximum number of reports to retrieve.
- NextToken
-
- Type: string
The pagination token used on subsequent calls to get reports.
Result Syntax
[
'BillingGroupCostReports' => [
[
'AWSCost' => '<string>',
'Arn' => '<string>',
'Currency' => '<string>',
'Margin' => '<string>',
'MarginPercentage' => '<string>',
'ProformaCost' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- BillingGroupCostReports
-
- Type: Array of BillingGroupCostReportElement structures
A list of
BillingGroupCostReportElementretrieved. - NextToken
-
- Type: string
The pagination token used on subsequent calls to get reports.
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
ListBillingGroups
$result = $client->listBillingGroups([/* ... */]); $promise = $client->listBillingGroupsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listBillingGroups([
'BillingPeriod' => '<string>',
'Filters' => [
'Arns' => ['<string>', ...],
'PricingPlan' => '<string>',
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- BillingPeriod
-
- Type: string
The preferred billing period to get billing groups.
- Filters
-
- Type: ListBillingGroupsFilter structure
A
ListBillingGroupsFilterthat specifies the billing group and pricing plan to retrieve billing group information. - MaxResults
-
- Type: int
The maximum number of billing groups to retrieve.
- NextToken
-
- Type: string
The pagination token used on subsequent calls to get billing groups.
Result Syntax
[
'BillingGroups' => [
[
'Arn' => '<string>',
'ComputationPreference' => [
'PricingPlanArn' => '<string>',
],
'CreationTime' => <integer>,
'Description' => '<string>',
'LastModifiedTime' => <integer>,
'Name' => '<string>',
'PrimaryAccountId' => '<string>',
'Size' => <integer>,
'Status' => 'ACTIVE|PRIMARY_ACCOUNT_MISSING',
'StatusReason' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- BillingGroups
-
- Type: Array of BillingGroupListElement structures
A list of
BillingGroupListElementretrieved. - NextToken
-
- Type: string
The pagination token used on subsequent calls to get billing groups.
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
ListCustomLineItems
$result = $client->listCustomLineItems([/* ... */]); $promise = $client->listCustomLineItemsAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listCustomLineItems([
'BillingPeriod' => '<string>',
'Filters' => [
'Arns' => ['<string>', ...],
'BillingGroups' => ['<string>', ...],
'Names' => ['<string>', ...],
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- BillingPeriod
-
- Type: string
The preferred billing period to get custom line items (FFLIs).
- Filters
-
- Type: ListCustomLineItemsFilter structure
A
ListCustomLineItemsFilterthat specifies the custom line item names and/or billing group Amazon Resource Names (ARNs) to retrieve FFLI information. - MaxResults
-
- Type: int
The maximum number of billing groups to retrieve.
- NextToken
-
- Type: string
The pagination token used on subsequent calls to get custom line items (FFLIs).
Result Syntax
[
'CustomLineItems' => [
[
'Arn' => '<string>',
'AssociationSize' => <integer>,
'BillingGroupArn' => '<string>',
'ChargeDetails' => [
'Flat' => [
'ChargeValue' => <float>,
],
'Percentage' => [
'PercentageValue' => <float>,
],
'Type' => 'CREDIT|FEE',
],
'CreationTime' => <integer>,
'CurrencyCode' => 'USD|CNY',
'Description' => '<string>',
'LastModifiedTime' => <integer>,
'Name' => '<string>',
'ProductCode' => '<string>',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- CustomLineItems
-
- Type: Array of CustomLineItemListElement structures
A list of
FreeFormLineItemListElementsreceived. - NextToken
-
- Type: string
The pagination token used on subsequent calls to get custom line items (FFLIs).
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
ListPricingPlans
$result = $client->listPricingPlans([/* ... */]); $promise = $client->listPricingPlansAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->listPricingPlans([
'BillingPeriod' => '<string>',
'Filters' => [
'Arns' => ['<string>', ...],
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- BillingPeriod
-
- Type: string
The preferred billing period to get pricing plan.
- Filters
-
- Type: ListPricingPlansFilter structure
A
ListPricingPlansFilterthat specifies the Amazon Resource Name (ARNs) of pricing plans to retrieve pricing plans information. - MaxResults
-
- Type: int
The maximum number of pricing plans to retrieve.
- NextToken
-
- Type: string
The pagination token used on subsequent call to get pricing plans.
Result Syntax
[
'BillingPeriod' => '<string>',
'NextToken' => '<string>',
'PricingPlans' => [
[
'Arn' => '<string>',
'CreationTime' => <integer>,
'Description' => '<string>',
'LastModifiedTime' => <integer>,
'Name' => '<string>',
'Size' => <integer>,
],
// ...
],
]
Result Details
Members
- BillingPeriod
-
- Type: string
The billing period for which the described pricing plans are applicable.
- NextToken
-
- Type: string
The pagination token used on subsequent calls to get pricing plans.
- PricingPlans
-
- Type: Array of PricingPlanListElement structures
A list of
PricingPlanListElementretrieved.
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
ListPricingPlansAssociatedWithPricingRule
$result = $client->listPricingPlansAssociatedWithPricingRule([/* ... */]); $promise = $client->listPricingPlansAssociatedWithPricingRuleAsync([/* ... */]);
A list of the pricing plans associated with a pricing rule.
Parameter Syntax
$result = $client->listPricingPlansAssociatedWithPricingRule([
'BillingPeriod' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PricingRuleArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BillingPeriod
-
- Type: string
The pricing plan billing period for which associations will be listed.
- MaxResults
-
- Type: int
The optional maximum number of pricing rule associations to retrieve.
- NextToken
-
- Type: string
The optional pagination token returned by a previous call.
- PricingRuleArn
-
- Required: Yes
- Type: string
The pricing rule Amazon Resource Name (ARN) for which associations will be listed.
Result Syntax
[
'BillingPeriod' => '<string>',
'NextToken' => '<string>',
'PricingPlanArns' => ['<string>', ...],
'PricingRuleArn' => '<string>',
]
Result Details
Members
- BillingPeriod
-
- Type: string
The pricing plan billing period for which associations will be listed.
- NextToken
-
- Type: string
The pagination token to be used on subsequent calls.
- PricingPlanArns
-
- Type: Array of strings
The list containing pricing plans associated with the requested pricing rule.
- PricingRuleArn
-
- Type: string
The pricing rule Amazon Resource Name (ARN) for which associations will be listed.
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
ListPricingRules
$result = $client->listPricingRules([/* ... */]); $promise = $client->listPricingRulesAsync([/* ... */]);
Describes a pricing rule that can be associated to a pricing plan, or set of pricing plans.
Parameter Syntax
$result = $client->listPricingRules([
'BillingPeriod' => '<string>',
'Filters' => [
'Arns' => ['<string>', ...],
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- BillingPeriod
-
- Type: string
The preferred billing period to get the pricing plan.
- Filters
-
- Type: ListPricingRulesFilter structure
A
DescribePricingRuleFilterthat specifies the Amazon Resource Name (ARNs) of pricing rules to retrieve pricing rules information. - MaxResults
-
- Type: int
The maximum number of pricing rules to retrieve.
- NextToken
-
- Type: string
The pagination token used on subsequent call to get pricing rules.
Result Syntax
[
'BillingPeriod' => '<string>',
'NextToken' => '<string>',
'PricingRules' => [
[
'Arn' => '<string>',
'AssociatedPricingPlanCount' => <integer>,
'CreationTime' => <integer>,
'Description' => '<string>',
'LastModifiedTime' => <integer>,
'ModifierPercentage' => <float>,
'Name' => '<string>',
'Scope' => 'GLOBAL|SERVICE',
'Service' => '<string>',
'Type' => 'MARKUP|DISCOUNT',
],
// ...
],
]
Result Details
Members
- BillingPeriod
-
- Type: string
The billing period for which the described pricing rules are applicable.
- NextToken
-
- Type: string
The pagination token used on subsequent calls to get pricing rules.
- PricingRules
-
- Type: Array of PricingRuleListElement structures
A list containing the described pricing rules.
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
ListPricingRulesAssociatedToPricingPlan
$result = $client->listPricingRulesAssociatedToPricingPlan([/* ... */]); $promise = $client->listPricingRulesAssociatedToPricingPlanAsync([/* ... */]);
Lists the pricing rules associated with a pricing plan.
Parameter Syntax
$result = $client->listPricingRulesAssociatedToPricingPlan([
'BillingPeriod' => '<string>',
'MaxResults' => <integer>,
'NextToken' => '<string>',
'PricingPlanArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- BillingPeriod
-
- Type: string
The billing period for which the pricing rule associations are to be listed.
- MaxResults
-
- Type: int
The optional maximum number of pricing rule associations to retrieve.
- NextToken
-
- Type: string
The optional pagination token returned by a previous call.
- PricingPlanArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the pricing plan for which associations are to be listed.
Result Syntax
[
'BillingPeriod' => '<string>',
'NextToken' => '<string>',
'PricingPlanArn' => '<string>',
'PricingRuleArns' => ['<string>', ...],
]
Result Details
Members
- BillingPeriod
-
- Type: string
The billing period for which the pricing rule associations are listed.
- NextToken
-
- Type: string
The pagination token to be used on subsequent calls.
- PricingPlanArn
-
- Type: string
The Amazon Resource Name (ARN) of the pricing plan for which associations are listed.
- PricingRuleArns
-
- Type: Array of strings
A list containing pricing rules associated with the requested pricing plan.
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
ListResourcesAssociatedToCustomLineItem
$result = $client->listResourcesAssociatedToCustomLineItem([/* ... */]); $promise = $client->listResourcesAssociatedToCustomLineItemAsync([/* ... */]);
List the resources associated to a custom line item.
Parameter Syntax
$result = $client->listResourcesAssociatedToCustomLineItem([
'Arn' => '<string>', // REQUIRED
'BillingPeriod' => '<string>',
'Filters' => [
'Relationship' => 'PARENT|CHILD',
],
'MaxResults' => <integer>,
'NextToken' => '<string>',
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the custom line item for which the resource associations will be listed.
- BillingPeriod
-
- Type: string
The billing period for which the resource associations will be listed.
- Filters
-
- Type: ListResourcesAssociatedToCustomLineItemFilter structure
(Optional) A
ListResourcesAssociatedToCustomLineItemFilterthat can specify the types of resources that should be retrieved. - MaxResults
-
- Type: int
(Optional) The maximum number of resource associations to be retrieved.
- NextToken
-
- Type: string
(Optional) The pagination token returned by a previous request.
Result Syntax
[
'Arn' => '<string>',
'AssociatedResources' => [
[
'Arn' => '<string>',
'Relationship' => 'PARENT|CHILD',
],
// ...
],
'NextToken' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The custom line item ARN for which the resource associations are listed.
- AssociatedResources
-
- Type: Array of ListResourcesAssociatedToCustomLineItemResponseElement structures
A list of
ListResourcesAssociatedToCustomLineItemResponseElementfor each resource association retrieved. - NextToken
-
- Type: string
The pagination token to be used in subsequent requests to retrieve additional results.
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
A list the tags for a resource.
Parameter Syntax
$result = $client->listTagsForResource([
'ResourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[
'Tags' => ['<string>', ...],
]
Result Details
Members
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
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.
Parameter Syntax
$result = $client->tagResource([
'ResourceArn' => '<string>', // REQUIRED
'Tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Deletes specified tags from a resource.
Parameter Syntax
$result = $client->untagResource([
'ResourceArn' => '<string>', // REQUIRED
'TagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
UpdateBillingGroup
$result = $client->updateBillingGroup([/* ... */]); $promise = $client->updateBillingGroupAsync([/* ... */]);
This updates an existing billing group.
Parameter Syntax
$result = $client->updateBillingGroup([
'Arn' => '<string>', // REQUIRED
'ComputationPreference' => [
'PricingPlanArn' => '<string>', // REQUIRED
],
'Description' => '<string>',
'Name' => '<string>',
'Status' => 'ACTIVE|PRIMARY_ACCOUNT_MISSING',
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the billing group being updated.
- ComputationPreference
-
- Type: ComputationPreference structure
The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.
- Description
-
- Type: string
A description of the billing group.
- Name
-
- Type: string
The name of the billing group. The names must be unique to each billing group.
- Status
-
- Type: string
The status of the billing group. Only one of the valid values can be used.
Result Syntax
[
'Arn' => '<string>',
'Description' => '<string>',
'LastModifiedTime' => <integer>,
'Name' => '<string>',
'PricingPlanArn' => '<string>',
'PrimaryAccountId' => '<string>',
'Size' => <integer>,
'Status' => 'ACTIVE|PRIMARY_ACCOUNT_MISSING',
'StatusReason' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the billing group that was updated.
- Description
-
- Type: string
A description of the billing group.
- LastModifiedTime
-
- Type: long (int|float)
The most recent time the billing group was modified.
- Name
-
- Type: string
The name of the billing group. The names must be unique to each billing group.
- PricingPlanArn
-
- Type: string
The Amazon Resource Name (ARN) of the pricing plan to compute Amazon Web Services charges for the billing group.
- PrimaryAccountId
-
- Type: string
The account ID that serves as the main account in a billing group.
- Size
-
- Type: long (int|float)
The number of accounts in the particular billing group.
- Status
-
- Type: string
The status of the billing group. Only one of the valid values can be used.
- StatusReason
-
- Type: string
The reason why the billing group is in its current status.
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
UpdateCustomLineItem
$result = $client->updateCustomLineItem([/* ... */]); $promise = $client->updateCustomLineItemAsync([/* ... */]);
Update an existing custom line item in the current or previous billing period.
Parameter Syntax
$result = $client->updateCustomLineItem([
'Arn' => '<string>', // REQUIRED
'BillingPeriodRange' => [
'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
],
'ChargeDetails' => [
'Flat' => [
'ChargeValue' => <float>, // REQUIRED
],
'Percentage' => [
'PercentageValue' => <float>, // REQUIRED
],
],
'Description' => '<string>',
'Name' => '<string>',
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The ARN of the custom line item to be updated.
- BillingPeriodRange
-
- Type: CustomLineItemBillingPeriodRange structure
The billing period range in which the custom line item request will be applied.
- ChargeDetails
-
- Type: UpdateCustomLineItemChargeDetails structure
A
ListCustomLineItemChargeDetailscontaining the new charge details for the custom line item. - Description
-
- Type: string
The new line item description of the custom line item.
- Name
-
- Type: string
The new name for the custom line item.
Result Syntax
[
'Arn' => '<string>',
'AssociationSize' => <integer>,
'BillingGroupArn' => '<string>',
'ChargeDetails' => [
'Flat' => [
'ChargeValue' => <float>,
],
'Percentage' => [
'PercentageValue' => <float>,
],
'Type' => 'CREDIT|FEE',
],
'Description' => '<string>',
'LastModifiedTime' => <integer>,
'Name' => '<string>',
]
Result Details
Members
- Arn
-
- Type: string
The ARN of the successfully updated custom line item.
- AssociationSize
-
- Type: long (int|float)
The number of resources that are associated to the custom line item.
- BillingGroupArn
-
- Type: string
The ARN of the billing group that the custom line item is applied to.
- ChargeDetails
-
- Type: ListCustomLineItemChargeDetails structure
A
ListCustomLineItemChargeDetailscontaining the charge details of the successfully updated custom line item. - Description
-
- Type: string
The description of the successfully updated custom line item.
- LastModifiedTime
-
- Type: long (int|float)
The most recent time the custom line item was modified.
- Name
-
- Type: string
The name of the successfully updated custom line item.
Errors
-
The request was denied due to request throttling.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
UpdatePricingPlan
$result = $client->updatePricingPlan([/* ... */]); $promise = $client->updatePricingPlanAsync([/* ... */]);
This updates an existing pricing plan.
Parameter Syntax
$result = $client->updatePricingPlan([
'Arn' => '<string>', // REQUIRED
'Description' => '<string>',
'Name' => '<string>',
]);
Parameter Details
Members
Result Syntax
[
'Arn' => '<string>',
'Description' => '<string>',
'LastModifiedTime' => <integer>,
'Name' => '<string>',
'Size' => <integer>,
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the updated pricing plan.
- Description
-
- Type: string
The new description for the pricing rule.
- LastModifiedTime
-
- Type: long (int|float)
The most recent time the pricing plan was modified.
- Name
-
- Type: string
The name of the pricing plan. The name must be unique to each pricing plan.
- Size
-
- Type: long (int|float)
The pricing rules count currently associated with this pricing plan list.
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
UpdatePricingRule
$result = $client->updatePricingRule([/* ... */]); $promise = $client->updatePricingRuleAsync([/* ... */]);
Updates an existing pricing rule.
Parameter Syntax
$result = $client->updatePricingRule([
'Arn' => '<string>', // REQUIRED
'Description' => '<string>',
'ModifierPercentage' => <float>,
'Name' => '<string>',
'Type' => 'MARKUP|DISCOUNT',
]);
Parameter Details
Members
- Arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the pricing rule to update.
- Description
-
- Type: string
The new description for the pricing rule.
- ModifierPercentage
-
- Type: double
The new modifier to show pricing plan rates as a percentage.
- Name
-
- Type: string
The new name of the pricing rule. The name must be unique to each pricing rule.
- Type
-
- Type: string
The new pricing rule type.
Result Syntax
[
'Arn' => '<string>',
'AssociatedPricingPlanCount' => <integer>,
'Description' => '<string>',
'LastModifiedTime' => <integer>,
'ModifierPercentage' => <float>,
'Name' => '<string>',
'Scope' => 'GLOBAL|SERVICE',
'Service' => '<string>',
'Type' => 'MARKUP|DISCOUNT',
]
Result Details
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of the successfully updated pricing rule.
- AssociatedPricingPlanCount
-
- Type: long (int|float)
The pricing plans count that this pricing rule is associated with.
- Description
-
- Type: string
The new description for the pricing rule.
- LastModifiedTime
-
- Type: long (int|float)
The most recent time the pricing rule was modified.
- ModifierPercentage
-
- Type: double
The new modifier to show pricing plan rates as a percentage.
- Name
-
- Type: string
The new name of the pricing rule. The name must be unique to each pricing rule.
- Scope
-
- Type: string
The scope of pricing rule that indicates if it is globally applicable, or is service-specific.
- Service
-
- Type: string
If the
Scopeattribute is set toSERVICE, the attribute indicates which service thePricingRuleis applicable for. - Type
-
- Type: string
The new pricing rule type.
Errors
-
The request was denied due to request throttling.
-
You can cause an inconsistent state by updating or deleting a resource.
-
You do not have sufficient access to perform this action.
-
The input doesn't match with the constraints specified by Amazon Web Services services.
-
An unexpected error occurred while processing a request.
-
The request references a resource that doesn't exist.
Shapes
AccessDeniedException
Description
You do not have sufficient access to perform this action.
Members
AccountAssociationsListElement
Description
Amazon Web Services Billing Conductor is in beta release and is subject to change. Your use of Amazon Web Services Billing Conductor is subject to the Beta Service Participation terms of the Amazon Web Services Service Terms (Section 1.10).
A representation of a linked account.
Members
AccountGrouping
Description
The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated family.
Members
AssociateResourceError
Description
A representation of a resource association error.
Members
AssociateResourceResponseElement
Description
A resource association result for a percentage custom line item.
Members
- Arn
-
- Type: string
The resource ARN that was associated to the custom line item.
- Error
-
- Type: AssociateResourceError structure
An
AssociateResourceErrorthat will populate if the resource association fails.
BillingGroupCostReportElement
Description
A summary report of actual Amazon Web Services charges and calculated Amazon Web Services charges, based on the associated pricing plan of a billing group.
Members
- AWSCost
-
- Type: string
The actual Amazon Web Services charges for the billing group.
- Arn
-
- Type: string
The Amazon Resource Name (ARN) of a billing group.
- Currency
-
- Type: string
The displayed currency.
- Margin
-
- Type: string
The billing group margin.
- MarginPercentage
-
- Type: string
The percentage of billing group margin.
- ProformaCost
-
- Type: string
The hypothetical Amazon Web Services charges based on the associated pricing plan of a billing group.
BillingGroupListElement
Description
A representation of a billing group.
Members
- Arn
-
- Type: string
The Amazon Resource Number (ARN) that can be used to uniquely identify the billing group.
- ComputationPreference
-
- Type: ComputationPreference structure
The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.
- CreationTime
-
- Type: long (int|float)
The time the billing group was created.
- Description
-
- Type: string
The billing group description.
- LastModifiedTime
-
- Type: long (int|float)
The most recent time the billing group was modified.
- Name
-
- Type: string
The billing group's name.
- PrimaryAccountId
-
- Type: string
The account ID that serves as the main account in a billing group.
- Size
-
- Type: long (int|float)
The number of accounts in the particular billing group.
- Status
-
- Type: string
The billing group status. Only one of the valid values can be used.
- StatusReason
-
- Type: string
The reason why the billing group is in its current status.
ComputationPreference
Description
The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.
Members
ConflictException
Description
You can cause an inconsistent state by updating or deleting a resource.
Members
CustomLineItemBillingPeriodRange
Description
The billing period range in which the custom line item request will be applied.
Members
- ExclusiveEndBillingPeriod
-
- Required: Yes
- Type: string
The inclusive end billing period that defines a billing period range where a custom line is applied.
- InclusiveStartBillingPeriod
-
- Required: Yes
- Type: string
The inclusive start billing period that defines a billing period range where a custom line is applied.
CustomLineItemChargeDetails
Description
The charge details of a custom line item. It should contain only one of Flat or Percentage.
Members
- Flat
-
- Type: CustomLineItemFlatChargeDetails structure
A
CustomLineItemFlatChargeDetailsthat describes the charge details of a flat custom line item. - Percentage
-
- Type: CustomLineItemPercentageChargeDetails structure
A
CustomLineItemPercentageChargeDetailsthat describes the charge details of a percentage custom line item. - Type
-
- Required: Yes
- Type: string
The type of the custom line item that indicates whether the charge is a fee or credit.
CustomLineItemFlatChargeDetails
Description
A representation of the charge details associated with a flat custom line item.
Members
CustomLineItemListElement
Description
A representation of a custom line item.
Members
- Arn
-
- Type: string
The Amazon Resource Names (ARNs) for custom line items.
- AssociationSize
-
- Type: long (int|float)
The number of resources that are associated to the custom line item.
- BillingGroupArn
-
- Type: string
The Amazon Resource Name (ARN) that references the billing group where the custom line item applies to.
- ChargeDetails
-
- Type: ListCustomLineItemChargeDetails structure
A
ListCustomLineItemChargeDetailsthat describes the charge details of a custom line item. - CreationTime
-
- Type: long (int|float)
The time created.
- CurrencyCode
-
- Type: string
The custom line item's charge value currency. Only one of the valid values can be used.
- Description
-
- Type: string
The custom line item's description. This is shown on the Bills page in association with the charge value.
- LastModifiedTime
-
- Type: long (int|float)
The most recent time the custom line item was modified.
- Name
-
- Type: string
The custom line item's name.
- ProductCode
-
- Type: string
The product code associated with the custom line item.
CustomLineItemPercentageChargeDetails
Description
A representation of the charge details associated with a percentage custom line item.
Members
- AssociatedValues
-
- Type: Array of strings
A list of resource ARNs to associate to the percentage custom line item.
- PercentageValue
-
- Required: Yes
- Type: double
The custom line item's percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.
DisassociateResourceResponseElement
Description
A resource disassociation result for a percentage custom line item.
Members
- Arn
-
- Type: string
The resource ARN that was disassociated from the custom line item.
- Error
-
- Type: AssociateResourceError structure
An
AssociateResourceErrorshown if the resource disassociation fails.
InternalServerException
Description
An unexpected error occurred while processing a request.
Members
ListAccountAssociationsFilter
Description
The filter on the account ID of the linked account, or any of the following:
MONITORED: linked accounts that are associated to billing groups.
UNMONITORED: linked accounts that are not associated to billing groups.
Billing Group Arn: linked accounts that are associated to the provided Billing Group Arn.
Members
- AccountId
-
- Type: string
The Amazon Web Services account ID to filter on.
- Association
-
- Type: 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.
ListBillingGroupCostReportsFilter
Description
The filter used to retrieve specific BillingGroupCostReportElements.
Members
ListBillingGroupsFilter
Description
The filter that specifies the billing groups and pricing plans to retrieve billing group information.
Members
ListCustomLineItemChargeDetails
Description
A representation of the charge details of a custom line item.
Members
- Flat
-
- Type: ListCustomLineItemFlatChargeDetails structure
A
ListCustomLineItemFlatChargeDetailsthat describes the charge details of a flat custom line item. - Percentage
-
- Type: ListCustomLineItemPercentageChargeDetails structure
A
ListCustomLineItemPercentageChargeDetailsthat describes the charge details of a percentage custom line item. - Type
-
- Required: Yes
- Type: string
The type of the custom line item that indicates whether the charge is a
feeorcredit.
ListCustomLineItemFlatChargeDetails
Description
A representation of the charge details associated with a flat custom line item.
Members
ListCustomLineItemPercentageChargeDetails
Description
A representation of the charge details associated with a percentage custom line item.
Members
ListCustomLineItemsFilter
Description
A filter that specifies the custom line items and billing groups to retrieve FFLI information.
Members
ListPricingPlansFilter
Description
The filter that specifies the Amazon Resource Names (ARNs) of pricing plans, to retrieve pricing plan information.
Members
ListPricingRulesFilter
Description
The filter that specifies criteria that the pricing rules returned by the ListPricingRules API will adhere to.
Members
ListResourcesAssociatedToCustomLineItemFilter
Description
A filter that specifies the type of resource associations that should be retrieved for a custom line item.
Members
ListResourcesAssociatedToCustomLineItemResponseElement
Description
A representation of a resource association for a custom line item.
Members
PricingPlanListElement
Description
A representation of a pricing plan.
Members
- Arn
-
- Type: string
The pricing plan Amazon Resource Names (ARN). This can be used to uniquely identify a pricing plan.
- CreationTime
-
- Type: long (int|float)
The time the pricing plan was created.
- Description
-
- Type: string
The pricing plan description.
- LastModifiedTime
-
- Type: long (int|float)
The most recent time the pricing plan was modified.
- Name
-
- Type: string
The name of a pricing plan.
- Size
-
- Type: long (int|float)
The pricing rules count currently associated with this pricing plan list element.
PricingRuleListElement
Description
A representation of a pricing rule.
Members
- Arn
-
- Type: string
The Amazon Resource Name (ARN) used to uniquely identify a pricing rule.
- AssociatedPricingPlanCount
-
- Type: long (int|float)
The pricing plans count that this pricing rule is associated with.
- CreationTime
-
- Type: long (int|float)
The time the pricing rule was created.
- Description
-
- Type: string
The pricing rule description.
- LastModifiedTime
-
- Type: long (int|float)
The most recent time the pricing rule was modified.
- ModifierPercentage
-
- Type: double
A percentage modifier applied on the public pricing rates.
- Name
-
- Type: string
The name of a pricing rule.
- Scope
-
- Type: string
The scope of pricing rule that indicates if it is globally applicable, or if it is service-specific.
- Service
-
- Type: string
If the
Scopeattribute isSERVICE, this attribute indicates which service thePricingRuleis applicable for. - Type
-
- Type: string
The type of pricing rule.
ResourceNotFoundException
Description
The request references a resource that doesn't exist.
Members
ServiceLimitExceededException
Description
The request would cause a service limit to exceed.
Members
- LimitCode
-
- Required: Yes
- Type: string
The unique code identifier of the service limit that is being exceeded.
- Message
-
- Required: Yes
- Type: string
- ResourceId
-
- Type: string
Identifier of the resource affected.
- ResourceType
-
- Type: string
Type of the resource affected.
- ServiceCode
-
- Required: Yes
- Type: string
The unique code for the service of the limit that is being exceeded.
ThrottlingException
Description
The request was denied due to request throttling.
Members
UpdateCustomLineItemChargeDetails
Description
A representation of the new charge details of a custom line item. This should contain only one of Flat or Percentage.
Members
- Flat
-
- Type: UpdateCustomLineItemFlatChargeDetails structure
An
UpdateCustomLineItemFlatChargeDetailsthat describes the new charge details of a flat custom line item. - Percentage
-
- Type: UpdateCustomLineItemPercentageChargeDetails structure
An
UpdateCustomLineItemPercentageChargeDetailsthat describes the new charge details of a percentage custom line item.
UpdateCustomLineItemFlatChargeDetails
Description
A representation of the new charge details associated with a flat custom line item.
Members
UpdateCustomLineItemPercentageChargeDetails
Description
A representation of the new charge details associated with a percentage custom line item.
Members
ValidationException
Description
The input doesn't match with the constraints specified by Amazon Web Services services.
Members
- Fields
-
- Type: Array of ValidationExceptionField structures
The fields that caused the error, if applicable.
- Message
-
- Required: Yes
- Type: string
- Reason
-
- Type: string
The reason the request's validation failed.