AWS SDK for PHP 3.x

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 that's 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.
GetBillingGroupCostReport ( array $params = [] ): 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.
ListAccountAssociations ( array $params = [] ): This is a paginated call to list linked accounts that are linked to the payer account for the specified time period.
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.
ListCustomLineItemVersions ( array $params = [] ): A paginated call to get a list of all custom line item versions.
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 that are 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 that are associated with a pricing plan.
ListResourcesAssociatedToCustomLineItem ( array $params = [] ): List the resources that are 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:

ListAccountAssociations
ListBillingGroupCostReports
ListBillingGroups
ListCustomLineItems
ListCustomLineItemVersions
ListPricingPlans
ListPricingPlansAssociatedWithPricingRule
ListPricingRules
ListPricingRulesAssociatedToPricingPlan
ListResourcesAssociatedToCustomLineItem

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

AccountIds

: Required: Yes
: Type: Array of strings

The associating array of account IDs.

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the billing group that associates the array of account IDs.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
ServiceLimitExceededException:: The request would cause a service limit to exceed.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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

Arn

: Required: Yes
: Type: string

The PricingPlanArn that the PricingRuleArns are associated with.

PricingRuleArns

: Required: Yes
: Type: Array of strings

The PricingRuleArns that are associated with the Pricing Plan.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members

Arn

: Type: string

The PricingPlanArn that the PricingRuleArns are associated with.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
ServiceLimitExceededException:: The request would cause a service limit to exceed.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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>',
        '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|INVALID_BILLING_PERIOD_RANGE',
            ],
        ],
        // ...
    ],
    'SuccessfullyAssociatedResources' => [
        [
            'Arn' => '<string>',
            'Error' => [
                'Message' => '<string>',
                'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION|INVALID_BILLING_PERIOD_RANGE',
            ],
        ],
        // ...
    ],
]

Result Details

Members

FailedAssociatedResources

: Type: Array of AssociateResourceResponseElement structures

A list of AssociateResourceResponseElement for each resource that failed association to a percentage custom line item.

SuccessfullyAssociatedResources

: Type: Array of AssociateResourceResponseElement structures

A list of AssociateResourceResponseElement for each resource that's been associated to a percentage custom line item successfully.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
ServiceLimitExceededException:: The request would cause a service limit to exceed.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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>',
        '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|INVALID_BILLING_PERIOD_RANGE',
            ],
        ],
        // ...
    ],
    'SuccessfullyDisassociatedResources' => [
        [
            'Arn' => '<string>',
            'Error' => [
                'Message' => '<string>',
                'Reason' => 'INVALID_ARN|SERVICE_LIMIT_EXCEEDED|ILLEGAL_CUSTOMLINEITEM|INTERNAL_SERVER_EXCEPTION|INVALID_BILLING_PERIOD_RANGE',
            ],
        ],
        // ...
    ],
]

Result Details

Members

FailedDisassociatedResources

: Type: Array of DisassociateResourceResponseElement structures

A list of DisassociateResourceResponseElement for each resource that failed disassociation from a percentage custom line item.

SuccessfullyDisassociatedResources

: Type: Array of DisassociateResourceResponseElement structures

A list of DisassociateResourceResponseElement for each resource that's been disassociated from a percentage custom line item successfully.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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
        'AutoAssociate' => true || false,
        '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 billing 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 description of the billing group.

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

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the created billing group.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
ServiceLimitExceededException:: The request would cause a service limit to exceed.
InternalServerException:: 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([
    'AccountId' => '<string>',
    'BillingGroupArn' => '<string>', // REQUIRED
    'BillingPeriodRange' => [
        'ExclusiveEndBillingPeriod' => '<string>',
        'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
    ],
    'ChargeDetails' => [ // REQUIRED
        'Flat' => [
            'ChargeValue' => <float>, // REQUIRED
        ],
        'LineItemFilters' => [
            [
                'Attribute' => 'LINE_ITEM_TYPE', // REQUIRED
                'MatchOption' => 'NOT_EQUAL', // REQUIRED
                'Values' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
        'Percentage' => [
            'AssociatedValues' => ['<string>', ...],
            'PercentageValue' => <float>, // REQUIRED
        ],
        'Type' => 'CREDIT|FEE', // REQUIRED
    ],
    'ClientToken' => '<string>',
    'Description' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

AccountId

: Type: string

The Amazon Web Services account in which this custom line item will be applied to.

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

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the created custom line item.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
ServiceLimitExceededException:: The request would cause a service limit to exceed.
InternalServerException:: 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 description of the pricing plan.

Name

: Required: Yes
: Type: string

The name of the pricing plan. 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

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the created pricing plan.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
ServiceLimitExceededException:: The request would cause a service limit to exceed.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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([
    'BillingEntity' => '<string>',
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'ModifierPercentage' => <float>,
    'Name' => '<string>', // REQUIRED
    'Operation' => '<string>',
    'Scope' => 'GLOBAL|SERVICE|BILLING_ENTITY|SKU', // REQUIRED
    'Service' => '<string>',
    'Tags' => ['<string>', ...],
    'Tiering' => [
        'FreeTier' => [ // REQUIRED
            'Activated' => true || false, // REQUIRED
        ],
    ],
    'Type' => 'MARKUP|DISCOUNT|TIERING', // REQUIRED
    'UsageType' => '<string>',
]);

Parameter Details

Members

BillingEntity

: Type: string

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

ClientToken

: Type: string

The token that's 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

: Type: double

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

Name

: Required: Yes
: Type: string

The pricing rule name. The names must be unique to each pricing rule.

Operation

: Type: string

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

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

Scope

: Required: Yes
: Type: string

The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.

Service

: Type: string

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

Tiering

: Type: CreateTieringInput structure

The set of tiering configurations for the pricing rule.

Type

: Required: Yes
: Type: string

The type of pricing rule.

UsageType

: Type: string

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

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

</p>

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the created pricing rule.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
ServiceLimitExceededException:: The request would cause a service limit to exceed.
InternalServerException:: 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

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the billing group that you're deleting.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the deleted billing group.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: 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>',
        '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

Members

Arn

: Type: string

The ARN of the deleted custom line item.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: 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

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the pricing plan that you're deleting.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the deleted pricing plan.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.

DeletePricingRule

$result = $client->deletePricingRule([/* ... */]);
$promise = $client->deletePricingRuleAsync([/* ... */]);

Deletes the pricing rule that's identified by the input Amazon Resource Name (ARN).

Parameter Syntax

$result = $client->deletePricingRule([
    'Arn' => '<string>', // REQUIRED
]);

Parameter Details

Members

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the pricing rule that you are deleting.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the deleted pricing rule.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: 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

AccountIds

: Required: Yes
: Type: Array of strings

The array of account IDs to disassociate.

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the billing group that the array of account IDs will disassociate from.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the billing group that the array of account IDs is disassociated from.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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

Arn

: Required: Yes
: Type: string

The pricing plan Amazon Resource Name (ARN) to disassociate pricing rules from.

PricingRuleArns

: Required: Yes
: Type: Array of strings

A list containing the Amazon Resource Name (ARN) of the pricing rules that will be disassociated.

Result Syntax

[
    'Arn' => '<string>',
]

Result Details

Members

Arn

: Type: string

The Amazon Resource Name (ARN) of the pricing plan that the pricing rules successfully disassociated from.

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: The request references a resource that doesn't exist.

GetBillingGroupCostReport

$result = $client->getBillingGroupCostReport([/* ... */]);
$promise = $client->getBillingGroupCostReportAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->getBillingGroupCostReport([
    'Arn' => '<string>', // REQUIRED
    'BillingPeriodRange' => [
        'ExclusiveEndBillingPeriod' => '<string>', // REQUIRED
        'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
    ],
    'GroupBy' => ['<string>', ...],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Arn

: Required: Yes
: Type: string

The Amazon Resource Number (ARN) that uniquely identifies the billing group.

BillingPeriodRange

: Type: BillingPeriodRange structure

A time range for which the margin summary is effective. You can specify up to 12 months.

GroupBy

: Type: Array of strings

A list of strings that specify the attributes that are used to break down costs in the margin summary reports for the billing group. For example, you can view your costs by the Amazon Web Service name or the billing period.

MaxResults

: Type: int

The maximum number of margin summary reports to retrieve.

NextToken

: Type: string

The pagination token used on subsequent calls to get reports.

Result Syntax

[
    'BillingGroupCostReportResults' => [
        [
            'AWSCost' => '<string>',
            'Arn' => '<string>',
            'Attributes' => [
                [
                    'Key' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'Currency' => '<string>',
            'Margin' => '<string>',
            'MarginPercentage' => '<string>',
            'ProformaCost' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

BillingGroupCostReportResults

: Type: Array of BillingGroupCostReportResultElement structures

The list of margin summary reports.

NextToken

: Type: string

The pagination token used on subsequent calls to get reports.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: The request references a resource that doesn't exist.

ListAccountAssociations

$result = $client->listAccountAssociations([/* ... */]);
$promise = $client->listAccountAssociationsAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->listAccountAssociations([
    'BillingPeriod' => '<string>',
    'Filters' => [
        'AccountId' => '<string>',
        'AccountIds' => ['<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 aren't associated to billing groups.

Billing Group Arn: linked accounts that are associated to the provided billing group Arn.

NextToken

: Type: string

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

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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 ListBillingGroupCostReportsFilter to specify billing groups to retrieve reports from.

MaxResults

: Type: int

The maximum number of reports to retrieve.

NextToken

: Type: string

The pagination token that's 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 BillingGroupCostReportElement retrieved.

NextToken

: Type: string

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

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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>', ...],
        'AutoAssociate' => true || false,
        'PricingPlan' => '<string>',
        'Statuses' => ['<string>', ...],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

BillingPeriod

: Type: string

The preferred billing period to get billing groups.

Filters

: Type: ListBillingGroupsFilter structure

A ListBillingGroupsFilter that 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 that's used on subsequent calls to get billing groups.

Result Syntax

[
    'BillingGroups' => [
        [
            'AccountGrouping' => [
                'AutoAssociate' => true || false,
            ],
            '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 BillingGroupListElement retrieved.

NextToken

: Type: string

The pagination token that's used on subsequent calls to get billing groups.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: The request references a resource that doesn't exist.

ListCustomLineItemVersions

$result = $client->listCustomLineItemVersions([/* ... */]);
$promise = $client->listCustomLineItemVersionsAsync([/* ... */]);

A paginated call to get a list of all custom line item versions.

Parameter Syntax

$result = $client->listCustomLineItemVersions([
    'Arn' => '<string>', // REQUIRED
    'Filters' => [
        'BillingPeriodRange' => [
            'EndBillingPeriod' => '<string>',
            'StartBillingPeriod' => '<string>',
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) for the custom line item.

Filters

: Type: ListCustomLineItemVersionsFilter structure

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

MaxResults

: Type: int

The maximum number of custom line item versions to retrieve.

NextToken

: Type: string

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

Result Syntax

[
    'CustomLineItemVersions' => [
        [
            'AccountId' => '<string>',
            'Arn' => '<string>',
            'AssociationSize' => <integer>,
            'BillingGroupArn' => '<string>',
            'ChargeDetails' => [
                'Flat' => [
                    'ChargeValue' => <float>,
                ],
                'LineItemFilters' => [
                    [
                        'Attribute' => 'LINE_ITEM_TYPE',
                        'MatchOption' => 'NOT_EQUAL',
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
                'Percentage' => [
                    'PercentageValue' => <float>,
                ],
                'Type' => 'CREDIT|FEE',
            ],
            'CreationTime' => <integer>,
            'CurrencyCode' => 'USD|CNY',
            'Description' => '<string>',
            'EndBillingPeriod' => '<string>',
            'LastModifiedTime' => <integer>,
            'Name' => '<string>',
            'ProductCode' => '<string>',
            'StartBillingPeriod' => '<string>',
            'StartTime' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

CustomLineItemVersions

: Type: Array of CustomLineItemVersionListElement structures

A list of CustomLineItemVersionListElements that are received.

NextToken

: Type: string

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

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.

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' => [
        'AccountIds' => ['<string>', ...],
        '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 ListCustomLineItemsFilter that 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 that's used on subsequent calls to get custom line items (FFLIs).

Result Syntax

[
    'CustomLineItems' => [
        [
            'AccountId' => '<string>',
            'Arn' => '<string>',
            'AssociationSize' => <integer>,
            'BillingGroupArn' => '<string>',
            'ChargeDetails' => [
                'Flat' => [
                    'ChargeValue' => <float>,
                ],
                'LineItemFilters' => [
                    [
                        'Attribute' => 'LINE_ITEM_TYPE',
                        'MatchOption' => 'NOT_EQUAL',
                        'Values' => ['<string>', ...],
                    ],
                    // ...
                ],
                '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 FreeFormLineItemListElements received.

NextToken

: Type: string

The pagination token that's used on subsequent calls to get custom line items (FFLIs).

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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 ListPricingPlansFilter that 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 that's 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 that's used on subsequent calls to get pricing plans.

PricingPlans

: Type: Array of PricingPlanListElement structures

A list of PricingPlanListElement retrieved.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.

ListPricingPlansAssociatedWithPricingRule

$result = $client->listPricingPlansAssociatedWithPricingRule([/* ... */]);
$promise = $client->listPricingPlansAssociatedWithPricingRuleAsync([/* ... */]);

A list of the pricing plans that are 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 that are associated with the requested pricing rule.

PricingRuleArn

: Type: string

The pricing rule Amazon Resource Name (ARN) for which associations will be listed.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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 DescribePricingRuleFilter that 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 that's used on subsequent call to get pricing rules.

Result Syntax

[
    'BillingPeriod' => '<string>',
    'NextToken' => '<string>',
    'PricingRules' => [
        [
            'Arn' => '<string>',
            'AssociatedPricingPlanCount' => <integer>,
            'BillingEntity' => '<string>',
            'CreationTime' => <integer>,
            'Description' => '<string>',
            'LastModifiedTime' => <integer>,
            'ModifierPercentage' => <float>,
            'Name' => '<string>',
            'Operation' => '<string>',
            'Scope' => 'GLOBAL|SERVICE|BILLING_ENTITY|SKU',
            'Service' => '<string>',
            'Tiering' => [
                'FreeTier' => [
                    'Activated' => true || false,
                ],
            ],
            'Type' => 'MARKUP|DISCOUNT|TIERING',
            'UsageType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

BillingPeriod

: Type: string

The billing period for which the described pricing rules are applicable.

NextToken

: Type: string

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

PricingRules

: Type: Array of PricingRuleListElement structures

A list containing the described pricing rules.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.

ListPricingRulesAssociatedToPricingPlan

$result = $client->listPricingRulesAssociatedToPricingPlan([/* ... */]);
$promise = $client->listPricingRulesAssociatedToPricingPlanAsync([/* ... */]);

Lists the pricing rules that are 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 that are associated with the requested pricing plan.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: The request references a resource that doesn't exist.

ListResourcesAssociatedToCustomLineItem

$result = $client->listResourcesAssociatedToCustomLineItem([/* ... */]);
$promise = $client->listResourcesAssociatedToCustomLineItemAsync([/* ... */]);

List the resources that are 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 ListResourcesAssociatedToCustomLineItemFilter that 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 that's returned by a previous request.

Result Syntax

[
    'Arn' => '<string>',
    'AssociatedResources' => [
        [
            'Arn' => '<string>',
            'EndBillingPeriod' => '<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 ListResourcesAssociatedToCustomLineItemResponseElement for each resource association retrieved.

NextToken

: Type: string

The pagination token to be used in subsequent requests to retrieve additional results.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) that identifies the resource to list the tags.

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

: Type: Associative array of custom strings keys (TagKey) to strings

The tags for the resource.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to which to add tags.

Tags

: Required: Yes
: Type: Associative array of custom strings keys (TagKey) to strings

The tags to add to the resource as a list of key-value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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

ResourceArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the resource to which to delete tags.

TagKeys

: Required: Yes
: Type: Array of strings

The tags to delete from the resource as a list of key-value pairs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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([
    'AccountGrouping' => [
        'AutoAssociate' => true || false,
    ],
    'Arn' => '<string>', // REQUIRED
    'ComputationPreference' => [
        'PricingPlanArn' => '<string>', // REQUIRED
    ],
    'Description' => '<string>',
    'Name' => '<string>',
    'Status' => 'ACTIVE|PRIMARY_ACCOUNT_MISSING',
]);

Parameter Details

Members

AccountGrouping

: Type: UpdateBillingGroupAccountGrouping structure

Specifies if the billing group has automatic account association (AutoAssociate) enabled.

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

[
    'AccountGrouping' => [
        'AutoAssociate' => true || false,
    ],
    'Arn' => '<string>',
    'Description' => '<string>',
    'LastModifiedTime' => <integer>,
    'Name' => '<string>',
    'PricingPlanArn' => '<string>',
    'PrimaryAccountId' => '<string>',
    'Size' => <integer>,
    'Status' => 'ACTIVE|PRIMARY_ACCOUNT_MISSING',
    'StatusReason' => '<string>',
]

Result Details

Members

AccountGrouping

: Type: UpdateBillingGroupAccountGrouping structure

Specifies if the billing group has automatic account association (AutoAssociate) enabled.

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 when 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

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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>',
        'InclusiveStartBillingPeriod' => '<string>', // REQUIRED
    ],
    'ChargeDetails' => [
        'Flat' => [
            'ChargeValue' => <float>, // REQUIRED
        ],
        'LineItemFilters' => [
            [
                'Attribute' => 'LINE_ITEM_TYPE', // REQUIRED
                'MatchOption' => 'NOT_EQUAL', // REQUIRED
                'Values' => ['<string>', ...], // 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 ListCustomLineItemChargeDetails containing 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>,
        ],
        'LineItemFilters' => [
            [
                'Attribute' => 'LINE_ITEM_TYPE',
                'MatchOption' => 'NOT_EQUAL',
                'Values' => ['<string>', ...],
            ],
            // ...
        ],
        '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 ListCustomLineItemChargeDetails containing 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 when the custom line item was modified.

Name

: Type: string

The name of the successfully updated custom line item.

Errors

ThrottlingException:: The request was denied due to request throttling.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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

Arn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the pricing plan that you're updating.

Description

: Type: string

The description of the pricing plan.

Name

: Type: string

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

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

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: 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>',
    'Tiering' => [
        'FreeTier' => [ // REQUIRED
            'Activated' => true || false, // REQUIRED
        ],
    ],
    'Type' => 'MARKUP|DISCOUNT|TIERING',
]);

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.

Tiering

: Type: UpdateTieringInput structure

The set of tiering configurations for the pricing rule.

Type

: Type: string

The new pricing rule type.

Result Syntax

[
    'Arn' => '<string>',
    'AssociatedPricingPlanCount' => <integer>,
    'BillingEntity' => '<string>',
    'Description' => '<string>',
    'LastModifiedTime' => <integer>,
    'ModifierPercentage' => <float>,
    'Name' => '<string>',
    'Operation' => '<string>',
    'Scope' => 'GLOBAL|SERVICE|BILLING_ENTITY|SKU',
    'Service' => '<string>',
    'Tiering' => [
        'FreeTier' => [
            'Activated' => true || false,
        ],
    ],
    'Type' => 'MARKUP|DISCOUNT|TIERING',
    'UsageType' => '<string>',
]

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.

BillingEntity

: Type: string

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

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.

Operation

: Type: string

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

Scope

: Type: string

The scope of pricing rule that indicates if it's globally applicable, or it's service-specific.

Service

: Type: string

If the Scope attribute is set to SERVICE, the attribute indicates which service the PricingRule is applicable for.

Tiering

: Type: UpdateTieringInput structure

The set of tiering configurations for the pricing rule.

Type

: Type: string

The new pricing rule type.

UsageType

: Type: string

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

Errors

ThrottlingException:: The request was denied due to request throttling.
ConflictException:: You can cause an inconsistent state by updating or deleting a resource.
AccessDeniedException:: You do not have sufficient access to perform this action.
ValidationException:: The input doesn't match with the constraints specified by Amazon Web Services.
InternalServerException:: An unexpected error occurred while processing a request.
ResourceNotFoundException:: The request references a resource that doesn't exist.

Shapes

AccessDeniedException

Description

You do not have sufficient access to perform this action.

Members

Message

: Required: Yes
: Type: string

AccountAssociationsListElement

Description

A representation of a linked account.

Members

AccountEmail

: Type: string

The Amazon Web Services account email.

AccountId

: Type: string

The associating array of account IDs.

AccountName

: Type: string

The Amazon Web Services account name.

BillingGroupArn

: Type: string

The Billing Group Arn that the linked account is associated to.

AccountGrouping

Description

The set of accounts that will be under the billing group. The set of accounts resemble the linked accounts in a consolidated billing family.

Members

AutoAssociate

: Type: boolean

Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.

LinkedAccountIds

: Required: Yes
: Type: Array of strings

The account IDs that make up the billing group. Account IDs must be a part of the consolidated billing family, and not associated with another billing group.

AssociateResourceError

Description

A representation of a resource association error.

Members

Message

: Type: string

The reason why the resource association failed.

Reason

: Type: string

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

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 AssociateResourceError that will populate if the resource association fails.

Attribute

Description

The key-value pair that represents the attribute by which the BillingGroupCostReportResults are grouped. For example, if you want a service-level breakdown for Amazon Simple Storage Service (Amazon S3) of the billing group, the attribute will be a key-value pair of "PRODUCT_NAME" and "S3".

Members

Key

: Type: string

The key in a key-value pair that describes the margin summary.

Value

: Type: string

The value in a key-value pair that describes the margin summary.

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.

BillingGroupCostReportResultElement

Description

A paginated call to retrieve a list of summary reports of actual Amazon Web Services charges and the calculated Amazon Web Services charges, broken down by attributes.

Members

AWSCost

: Type: string

The actual Amazon Web Services charges for the billing group.

Arn

: Type: string

The Amazon Resource Number (ARN) that uniquely identifies the billing group.

Attributes

: Type: Array of Attribute structures

The list of key-value pairs that represent the attributes by which the BillingGroupCostReportResults are grouped. For example, if you want the Amazon S3 service-level breakdown of a billing group for November 2023, the attributes list will contain a key-value pair of "PRODUCT_NAME" and "S3" and a key-value pair of "BILLING_PERIOD" and "Nov 2023".

Currency

: Type: string

The displayed currency.

Margin

: Type: string

The billing group margin.

MarginPercentage

: Type: string

The percentage of the 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

AccountGrouping

: Type: ListBillingGroupAccountGrouping structure

Specifies if the billing group has automatic account association (AutoAssociate) enabled.

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 when the billing group was created.

Description

: Type: string

The description of the billing group.

LastModifiedTime

: Type: long (int|float)

The most recent time when the billing group was modified.

Name

: Type: string

The name of 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 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.

BillingPeriodRange

Description

A time range for which the margin summary is effective. The time range can be up to 12 months.

Members

ExclusiveEndBillingPeriod

: Required: Yes
: Type: string

The exclusive end billing period that defines a billing period range for the margin summary. For example, if you choose a billing period that starts in October 2023 and ends in December 2023, the margin summary will only include data from October 2023 and November 2023.

InclusiveStartBillingPeriod

: Required: Yes
: Type: string

The inclusive start billing period that defines a billing period range for the margin summary.

ComputationPreference

Description

The preferences and settings that will be used to compute the Amazon Web Services charges for a billing group.

Members

PricingPlanArn

: Required: Yes
: Type: string

The Amazon Resource Name (ARN) of the pricing plan that's used to compute the Amazon Web Services charges for a billing group.

ConflictException

Description

You can cause an inconsistent state by updating or deleting a resource.

Members

Message

: Required: Yes
: Type: string

Reason

: Type: string

Reason for the inconsistent state.

ResourceId

: Required: Yes
: Type: string

Identifier of the resource in use.

ResourceType

: Required: Yes
: Type: string

Type of the resource in use.

CreateFreeTierConfig

Description

The possible Amazon Web Services Free Tier configurations.

Members

Activated

: Required: Yes
: Type: boolean

Activate or deactivate Amazon Web Services Free Tier.

CreateTieringInput

Description

The set of tiering configurations for the pricing rule.

Members

FreeTier

: Required: Yes
: Type: CreateFreeTierConfig structure

The possible Amazon Web Services Free Tier configurations.

CustomLineItemBillingPeriodRange

Description

The billing period range in which the custom line item request will be applied.

Members

ExclusiveEndBillingPeriod

: 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 CustomLineItemFlatChargeDetails that describes the charge details of a flat custom line item.

LineItemFilters

: Type: Array of LineItemFilter structures

A representation of the line item filter.

Percentage

: Type: CustomLineItemPercentageChargeDetails structure

A CustomLineItemPercentageChargeDetails that 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 that are associated with a flat custom line item.

Members

ChargeValue

: Required: Yes
: Type: double

The custom line item's fixed charge value in USD.

CustomLineItemListElement

Description

A representation of a custom line item.

Members

AccountId

: Type: string

The Amazon Web Services account in which this custom line item will be applied to.

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 ListCustomLineItemChargeDetails that 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 when the custom line item was modified.

Name

: Type: string

The custom line item's name.

ProductCode

: Type: string

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

CustomLineItemPercentageChargeDetails

Description

A representation of the charge details that are 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.

CustomLineItemVersionListElement

Description

A representation of a custom line item version.

Members

AccountId

: Type: string

The Amazon Web Services account in which this custom line item will be applied to.

Arn

: Type: string

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

AssociationSize

: Type: long (int|float)

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

BillingGroupArn

: Type: string

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

ChargeDetails

: Type: ListCustomLineItemChargeDetails structure

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

CreationTime

: Type: long (int|float)

The time when the custom line item version was created.

CurrencyCode

: Type: string

The charge value currency of the custom line item.

Description

: Type: string

The description of the custom line item.

EndBillingPeriod

: Type: string

The end billing period of the custom line item version.

LastModifiedTime

: Type: long (int|float)

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

Name

: Type: string

The name of the custom line item.

ProductCode

: Type: string

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

StartBillingPeriod

: Type: string

The start billing period of the custom line item version.

StartTime

: Type: long (int|float)

The inclusive start time.

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 AssociateResourceError that's shown if the resource disassociation fails.

FreeTierConfig

Description

The possible Amazon Web Services Free Tier configurations.

Members

Activated

: Required: Yes
: Type: boolean

Activate or deactivate Amazon Web Services Free Tier application.

InternalServerException

Description

An unexpected error occurred while processing a request.

Members

Message

: Required: Yes
: Type: string

RetryAfterSeconds

: Type: int

Number of seconds you can retry after the call.

LineItemFilter

Description

A representation of the line item filter for your custom line item. You can use line item filters to include or exclude specific resource values from the billing group's total cost. For example, if you create a custom line item and you want to filter out a value, such as Savings Plan discounts, you can update LineItemFilter to exclude it.

Members

Attribute

: Required: Yes
: Type: string

The attribute of the line item filter. This specifies what attribute that you can filter on.

MatchOption

: Required: Yes
: Type: string

The match criteria of the line item filter. This parameter specifies whether not to include the resource value from the billing group total cost.

Values

: Required: Yes
: Type: Array of strings

The values of the line item filter. This specifies the values to filter on. Currently, you can only exclude Savings Plan discounts.

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.

AccountIds

: Type: Array of strings

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

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.

ListBillingGroupAccountGrouping

Description

Specifies if the billing group has the following features enabled.

Members

AutoAssociate

: Type: boolean

Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.

ListBillingGroupCostReportsFilter

Description

The filter used to retrieve specific BillingGroupCostReportElements.

Members

BillingGroupArns

: Type: Array of strings

The list of Amazon Resource Names (ARNs) used to filter billing groups to retrieve reports.

ListBillingGroupsFilter

Description

The filter that specifies the billing groups and pricing plans to retrieve billing group information.

Members

Arns

: Type: Array of strings

The list of billing group Amazon Resource Names (ARNs) to retrieve information.

AutoAssociate

: Type: boolean

Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.

PricingPlan

: Type: string

The pricing plan Amazon Resource Names (ARNs) to retrieve information.

Statuses

: Type: Array of strings

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

ListCustomLineItemChargeDetails

Description

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

Members

Flat

: Type: ListCustomLineItemFlatChargeDetails structure

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

LineItemFilters

: Type: Array of LineItemFilter structures

A representation of the line item filter.

Percentage

: Type: ListCustomLineItemPercentageChargeDetails structure

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

ListCustomLineItemFlatChargeDetails

Description

A representation of the charge details that are associated with a flat custom line item.

Members

ChargeValue

: Required: Yes
: Type: double

The custom line item's fixed charge value in USD.

ListCustomLineItemPercentageChargeDetails

Description

A representation of the charge details that are associated with a percentage custom line item.

Members

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.

ListCustomLineItemVersionsBillingPeriodRangeFilter

Description

A billing period filter that specifies the custom line item versions to retrieve.

Members

EndBillingPeriod

: Type: string

The exclusive end billing period that defines a billing period range where a custom line item version is applied.

StartBillingPeriod

: Type: string

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

ListCustomLineItemVersionsFilter

Description

A filter that specifies the billing period range where the custom line item versions reside.

Members

BillingPeriodRange

: Type: ListCustomLineItemVersionsBillingPeriodRangeFilter structure

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

ListCustomLineItemsFilter

Description

A filter that specifies the custom line items and billing groups to retrieve FFLI information.

Members

AccountIds

: Type: Array of strings

The Amazon Web Services accounts in which this custom line item will be applied to.

Arns

: Type: Array of strings

A list of custom line item ARNs to retrieve information.

BillingGroups

: Type: Array of strings

The billing group Amazon Resource Names (ARNs) to retrieve information.

Names

: Type: Array of strings

A list of custom line items to retrieve information.

ListPricingPlansFilter

Description

The filter that specifies the Amazon Resource Names (ARNs) of pricing plans, to retrieve pricing plan information.

Members

Arns

: Type: Array of strings

A list of pricing plan Amazon Resource Names (ARNs) to retrieve information.

ListPricingRulesFilter

Description

The filter that specifies criteria that the pricing rules returned by the ListPricingRules API will adhere to.

Members

Arns

: Type: Array of strings

A list containing the pricing rule Amazon Resource Names (ARNs) to include in the API response.

ListResourcesAssociatedToCustomLineItemFilter

Description

A filter that specifies the type of resource associations that should be retrieved for a custom line item.

Members

Relationship

: Type: string

The type of relationship between the custom line item and the associated resource.

ListResourcesAssociatedToCustomLineItemResponseElement

Description

A representation of a resource association for a custom line item.

Members

Arn

: Type: string

The ARN of the associated resource.

EndBillingPeriod

: Type: string

The end billing period of the associated resource.

Relationship

: Type: string

The type of relationship between the custom line item and the associated resource.

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 when the pricing plan was created.

Description

: Type: string

The pricing plan description.

LastModifiedTime

: Type: long (int|float)

The most recent time when the pricing plan was modified.

Name

: Type: string

The name of a pricing plan.

Size

: Type: long (int|float)

The pricing rules count that's 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.

BillingEntity

: Type: string

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

CreationTime

: Type: long (int|float)

The time when the pricing rule was created.

Description

: Type: string

The pricing rule description.

LastModifiedTime

: Type: long (int|float)

The most recent time when 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.

Operation

: Type: string

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

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 Scope attribute is SERVICE, this attribute indicates which service the PricingRule is applicable for.

Tiering

: Type: Tiering structure

The set of tiering configurations for the pricing rule.

Type

: Type: string

The type of pricing rule.

UsageType

: Type: string

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

</p>

ResourceNotFoundException

Description

The request references a resource that doesn't exist.

Members

Message

: Required: Yes
: Type: string

ResourceId

: Required: Yes
: Type: string

Resource identifier that was not found.

ResourceType

: Required: Yes
: Type: string

Resource type that was not found.

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

Message

: Required: Yes
: Type: string

RetryAfterSeconds

: Type: int

Number of seconds you can safely retry after the call.

Tiering

Description

The set of tiering configurations for the pricing rule.

Members

FreeTier

: Required: Yes
: Type: FreeTierConfig structure

The possible Amazon Web Services Free Tier configurations.

UpdateBillingGroupAccountGrouping

Description

Specifies if the billing group has the following features enabled.

Members

AutoAssociate

: Type: boolean

Specifies if this billing group will automatically associate newly added Amazon Web Services accounts that join your consolidated billing family.

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 UpdateCustomLineItemFlatChargeDetails that describes the new charge details of a flat custom line item.

LineItemFilters

: Type: Array of LineItemFilter structures

A representation of the line item filter.

Percentage

: Type: UpdateCustomLineItemPercentageChargeDetails structure

An UpdateCustomLineItemPercentageChargeDetails that describes the new charge details of a percentage custom line item.

UpdateCustomLineItemFlatChargeDetails

Description

A representation of the new charge details that are associated with a flat custom line item.

Members

ChargeValue

: Required: Yes
: Type: double

The custom line item's new fixed charge value in USD.

UpdateCustomLineItemPercentageChargeDetails

Description

A representation of the new charge details that are associated with a percentage custom line item.

Members

PercentageValue

: Required: Yes
: Type: double

The custom line item's new percentage value. This will be multiplied against the combined value of its associated resources to determine its charge value.

UpdateFreeTierConfig

Description

The possible Amazon Web Services Free Tier configurations.

Members

Activated

: Required: Yes
: Type: boolean

Activate or deactivate application of Amazon Web Services Free Tier.

UpdateTieringInput

Description

The set of tiering configurations for the pricing rule.

Members

FreeTier

: Required: Yes
: Type: UpdateFreeTierConfig structure

The possible Amazon Web Services Free Tier configurations.

ValidationException

Description

The input doesn't match with the constraints specified by Amazon Web 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.

ValidationExceptionField

Description

The field's information of a request that resulted in an exception.

Members

Message

: Required: Yes
: Type: string

The message describing why the field failed validation.

Name

: Required: Yes
: Type: string

The field name.

AWSBillingConductor 2021-07-30

Operation Summary

Paginators

Operations

AssociateAccounts

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

AssociatePricingRules

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchAssociateResourcesToCustomLineItem

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchDisassociateResourcesFromCustomLineItem

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateBillingGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateCustomLineItem

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePricingPlan

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreatePricingRule

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteBillingGroup

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteCustomLineItem

Parameter Syntax

Parameter Details

Members