AssociateSourceViews

$result = $client->associateSourceViews([/* ... */]);
$promise = $client->associateSourceViewsAsync([/* ... */]);

Associates one or more source billing views with an existing billing view. This allows creating aggregate billing views that combine data from multiple sources.

Parameter Syntax

$result = $client->associateSourceViews([
    'arn' => '<string>', // REQUIRED
    'sourceViews' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BillingViewHealthStatusException:

Exception thrown when a billing view's health status prevents an operation from being performed. This may occur if the billing view is in a state other than HEALTHY.

ServiceQuotaExceededException:

You've reached the limit of resources you can create, or exceeded the size of an individual resource.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke AssociateSourceViews

$result = $client->associateSourceViews([
    'arn' => 'arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
    'sourceViews' => [
        'arn:aws:billing::123456789012:billingview/primary',
        'arn:aws:billing::123456789012:billingview/custom-d3f9c7e4-8b2f-4a6e-9d3b-2f7c8a1e5f6d',
    ],
]);

Result syntax:

[
    'arn' => 'arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
]

CreateBillingView

$result = $client->createBillingView([/* ... */]);
$promise = $client->createBillingViewAsync([/* ... */]);

Creates a billing view with the specified billing view attributes.

Parameter Syntax

$result = $client->createBillingView([
    'clientToken' => '<string>',
    'dataFilterExpression' => [
        'costCategories' => [
            'key' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        'dimensions' => [
            'key' => 'LINKED_ACCOUNT', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        'tags' => [
            'key' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        'timeRange' => [
            'beginDateInclusive' => <integer || string || DateTime>,
            'endDateInclusive' => <integer || string || DateTime>,
        ],
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'resourceTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'sourceViews' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
]

Result Details

Errors

BillingViewHealthStatusException:

Exception thrown when a billing view's health status prevents an operation from being performed. This may occur if the billing view is in a state other than HEALTHY.

ServiceQuotaExceededException:

You've reached the limit of resources you can create, or exceeded the size of an individual resource.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke CreateBillingView

$result = $client->createBillingView([
    'name' => 'Example Custom Billing View',
    'dataFilterExpression' => [
        'dimensions' => [
            'key' => 'LINKED_ACCOUNT',
            'values' => [
                '000000000000',
            ],
        ],
    ],
    'description' => 'Custom Billing View Example',
    'sourceViews' => [
        'arn:aws:billing::123456789101:billingview/primary',
    ],
]);

Result syntax:

[
    'arn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
    'createdAt' => ,
]

DeleteBillingView

$result = $client->deleteBillingView([/* ... */]);
$promise = $client->deleteBillingViewAsync([/* ... */]);

Deletes the specified billing view.

Parameter Syntax

$result = $client->deleteBillingView([
    'arn' => '<string>', // REQUIRED
    'force' => true || false,
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke DeleteBillingView

$result = $client->deleteBillingView([
    'arn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
]);

Result syntax:

[
    'arn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
]

DisassociateSourceViews

$result = $client->disassociateSourceViews([/* ... */]);
$promise = $client->disassociateSourceViewsAsync([/* ... */]);

Removes the association between one or more source billing views and an existing billing view. This allows modifying the composition of aggregate billing views.

Parameter Syntax

$result = $client->disassociateSourceViews([
    'arn' => '<string>', // REQUIRED
    'sourceViews' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

BillingViewHealthStatusException:

Exception thrown when a billing view's health status prevents an operation from being performed. This may occur if the billing view is in a state other than HEALTHY.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke DisassociateSourceViews

$result = $client->disassociateSourceViews([
    'arn' => 'arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
    'sourceViews' => [
        'arn:aws:billing::123456789012:billingview/primary',
        'arn:aws:billing::123456789012:billingview/custom-d3f9c7e4-8b2f-4a6e-9d3b-2f7c8a1e5f6d',
    ],
]);

Result syntax:

[
    'arn' => 'arn:aws:billing::123456789012:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
]

GetBillingPreferences

$result = $client->getBillingPreferences([/* ... */]);
$promise = $client->getBillingPreferencesAsync([/* ... */]);

Retrieves billing preferences for the specified feature. Each feature controls a distinct billing capability: which accounts can share Reserved Instances or credits, whether billing alerts are enabled, the historical record of sharing changes, and per-credit options.

Parameter Syntax

$result = $client->getBillingPreferences([
    'features' => ['<string>', ...], // REQUIRED
    'filters' => [
        [
            'name' => 'PREFERENCE_KEY',
            'value' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'billingPreferences' => [
        [
            'accountId' => '<string>',
            'accountName' => '<string>',
            'billingPeriod' => [
                'month' => <integer>,
                'year' => <integer>,
            ],
            'feature' => 'RI_SHARING|RI_SHARING_HISTORY|CREDIT_SHARING|CREDIT_SHARING_HISTORY|CREDIT_LEVEL_SHARING|BILLING_ALERTS|CREDIT_PREFERENCE_OPTIONS',
            'key' => '<string>',
            'value' => 'ENABLED|DISABLED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

GetBillingView

$result = $client->getBillingView([/* ... */]);
$promise = $client->getBillingViewAsync([/* ... */]);

Returns the metadata associated to the specified billing view ARN.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'billingView' => [
        'arn' => '<string>',
        'billingViewType' => 'PRIMARY|BILLING_GROUP|CUSTOM|BILLING_TRANSFER|BILLING_TRANSFER_SHOWBACK',
        'createdAt' => <DateTime>,
        'dataFilterExpression' => [
            'costCategories' => [
                'key' => '<string>',
                'values' => ['<string>', ...],
            ],
            'dimensions' => [
                'key' => 'LINKED_ACCOUNT',
                'values' => ['<string>', ...],
            ],
            'tags' => [
                'key' => '<string>',
                'values' => ['<string>', ...],
            ],
            'timeRange' => [
                'beginDateInclusive' => <DateTime>,
                'endDateInclusive' => <DateTime>,
            ],
        ],
        'derivedViewCount' => <integer>,
        'description' => '<string>',
        'healthStatus' => [
            'statusCode' => 'HEALTHY|UNHEALTHY|CREATING|UPDATING',
            'statusReasons' => ['<string>', ...],
        ],
        'name' => '<string>',
        'ownerAccountId' => '<string>',
        'sourceAccountId' => '<string>',
        'sourceViewCount' => <integer>,
        'updatedAt' => <DateTime>,
        'viewDefinitionLastUpdatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke GetBillingView

$result = $client->getBillingView([
    'arn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
]);

Result syntax:

[
    'billingView' => [
        'name' => 'Example Custom Billing View',
        'arn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
        'billingViewType' => 'CUSTOM',
        'dataFilterExpression' => [
            'dimensions' => [
                'key' => 'LINKED_ACCOUNT',
                'values' => [
                    '000000000000',
                ],
            ],
        ],
        'description' => 'Custom Billing View Example -- updated description',
        'ownerAccountId' => '123456789101',
    ],
]

GetCreditAllocationHistory

$result = $client->getCreditAllocationHistory([/* ... */]);
$promise = $client->getCreditAllocationHistoryAsync([/* ... */]);

Returns the per-billing-month allocation history for credits applied to an Amazon Web Services account's bills. Traverses the consolidated billing family to capture cross-account credit applications. Supports pagination and optional filtering to a single credit.

Parameter Syntax

$result = $client->getCreditAllocationHistory([
    'accountId' => '<string>', // REQUIRED
    'creditId' => <integer>,
    'endDate' => <integer || string || DateTime>, // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'startDate' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'creditAllocationHistoryList' => [
        [
            'accountId' => '<string>',
            'appliedServiceName' => '<string>',
            'billingMonth' => '<string>',
            'creditAmount' => [
                'currencyAmount' => '<string>',
                'currencyCode' => '<string>',
            ],
            'creditId' => '<string>',
            'description' => '<string>',
            'isEstimatedBill' => true || false,
        ],
        // ...
    ],
    'failedMonths' => ['<string>', ...],
    'nextToken' => '<string>',
    'partialResults' => true || false,
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

GetCredits

$result = $client->getCredits([/* ... */]);
$promise = $client->getCreditsAsync([/* ... */]);

Returns the list of Amazon Web Services account credits for the specified account. Each credit includes its identifier, type, monetary amounts, applicable products, expiration, sharing configuration, and current enabled status.

When the caller is the management account of a consolidated billing family and payerAccountFlag is true, the response aggregates credits across the entire family. Otherwise, the response includes only credits owned by the account specified in accountId.

Parameter Syntax

$result = $client->getCredits([
    'accountId' => '<string>', // REQUIRED
    'endDate' => <integer || string || DateTime>,
    'payerAccountFlag' => true || false,
    'startDate' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'credits' => [
        [
            'accountHasCreditSharingEnabled' => true || false,
            'accountId' => '<string>',
            'applicableProductNames' => ['<string>', ...],
            'applicationType' => 'BEFORE_CROSS_SERVICE_DISCOUNTS|AFTER_DISCOUNTS',
            'costCategoryArn' => '<string>',
            'creditConsoleVisibility' => '<string>',
            'creditId' => '<string>',
            'creditSharingType' => 'DEFAULT|DISABLED|CUSTOM|COST_CATEGORY_RULE',
            'creditStatus' => 'ENABLED|DISABLED',
            'creditType' => '<string>',
            'description' => '<string>',
            'endDate' => <DateTime>,
            'estimatedAmount' => [
                'currencyAmount' => '<string>',
                'currencyCode' => '<string>',
            ],
            'exhaustDate' => <DateTime>,
            'initialAmount' => [
                'currencyAmount' => '<string>',
                'currencyCode' => '<string>',
            ],
            'purchaseTypeApplications' => ['<string>', ...],
            'remainingAmount' => [
                'currencyAmount' => '<string>',
                'currencyCode' => '<string>',
            ],
            'ruleName' => '<string>',
            'shareableAccounts' => ['<string>', ...],
            'startDate' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

GetResourcePolicy

$result = $client->getResourcePolicy([/* ... */]);
$promise = $client->getResourcePolicyAsync([/* ... */]);

Returns the resource-based policy document attached to the resource in JSON format.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'policy' => '<string>',
    'resourceArn' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke GetResourcePolicy

$result = $client->getResourcePolicy([
    'resourceArn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
]);

Result syntax:

[
    'policy' => '{"Version":"2012-10-17","Id":"46f47cb2-a11d-43f3-983d-470b5708a899","Statement":[{"Sid":"ExampleStatement1","Effect":"Allow","Principal":{"AWS":"arn:aws:iam::000000000000:root"},"Action":["ce:GetDimensionValues","ce:GetCostAndUsageWithResources","ce:GetCostAndUsage","ce:GetCostForecast","ce:GetTags","ce:GetUsageForecast","ce:GetCostCategories","billing:GetBillingView"],"Resource":"arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899"}]}',
    'resourceArn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
]

ListBillingViews

$result = $client->listBillingViews([/* ... */]);
$promise = $client->listBillingViewsAsync([/* ... */]);

Lists the billing views available for a given time period.

Every Amazon Web Services account has a unique PRIMARY billing view that represents the billing data available by default. Accounts that use Billing Conductor also have BILLING_GROUP billing views representing pro forma costs associated with each created billing group.

Parameter Syntax

$result = $client->listBillingViews([
    'activeTimeRange' => [
        'activeAfterInclusive' => <integer || string || DateTime>, // REQUIRED
        'activeBeforeInclusive' => <integer || string || DateTime>, // REQUIRED
    ],
    'arns' => ['<string>', ...],
    'billingViewTypes' => ['<string>', ...],
    'maxResults' => <integer>,
    'names' => [
        [
            'searchOption' => 'STARTS_WITH', // REQUIRED
            'searchValue' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'nextToken' => '<string>',
    'ownerAccountId' => '<string>',
    'sourceAccountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'billingViews' => [
        [
            'arn' => '<string>',
            'billingViewType' => 'PRIMARY|BILLING_GROUP|CUSTOM|BILLING_TRANSFER|BILLING_TRANSFER_SHOWBACK',
            'description' => '<string>',
            'healthStatus' => [
                'statusCode' => 'HEALTHY|UNHEALTHY|CREATING|UPDATING',
                'statusReasons' => ['<string>', ...],
            ],
            'name' => '<string>',
            'ownerAccountId' => '<string>',
            'sourceAccountId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke ListBillingViews

$result = $client->listBillingViews([
    'activeTimeRange' => [
        'activeAfterInclusive' => ,
        'activeBeforeInclusive' => ,
    ],
]);

Result syntax:

[
    'billingViews' => [
        [
            'name' => 'Primary Billing View Account 123456789101',
            'arn' => 'arn:aws:billing::123456789101:billingview/primary',
            'billingViewType' => 'PRIMARY',
            'ownerAccountId' => '123456789101',
        ],
    ],
]

Example 2: Error example for ListBillingViews

$result = $client->listBillingViews([
    'activeTimeRange' => [
        'activeAfterInclusive' => ,
        'activeBeforeInclusive' => ,
    ],
]);

ListSourceViewsForBillingView

$result = $client->listSourceViewsForBillingView([/* ... */]);
$promise = $client->listSourceViewsForBillingViewAsync([/* ... */]);

Lists the source views (managed Amazon Web Services billing views) associated with the billing view.

Parameter Syntax

$result = $client->listSourceViewsForBillingView([
    'arn' => '<string>', // REQUIRED
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'sourceViews' => ['<string>', ...],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke ListSourceViewsForBillingView

$result = $client->listSourceViewsForBillingView([
    'arn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
]);

Result syntax:

[
    'sourceViews' => [
        'arn:aws:billing::123456789101:billingview/primary',
    ],
]

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists tags associated with the billing view resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'resourceTags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke ListTagsForResource

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
]);

Result syntax:

[
    'resourceTags' => [
        [
            'key' => 'ExampleTagKey',
            'value' => 'ExampleTagValue',
        ],
    ],
]

RedeemCredits

$result = $client->redeemCredits([/* ... */]);
$promise = $client->redeemCreditsAsync([/* ... */]);

Redeems an Amazon Web Services promotional credit code on behalf of the calling account. On success, a new credit is added to the account's credit ledger with the amount, validity period, and applicable products defined by the promotion. The credit is then automatically applied to subsequent bills according to the standard credit application order.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

An API operation for adding one or more tags (key-value pairs) to a resource.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'resourceTags' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke TagResource

$result = $client->tagResource([
    'resourceArn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
    'resourceTags' => [
        [
            'key' => 'ExampleTagKey',
            'value' => 'ExampleTagValue',
        ],
    ],
]);

Result syntax:

[
]

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes one or more tags from a resource. Specify only tag keys in your request. Don't specify the value.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'resourceTagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke UntagResource

$result = $client->untagResource([
    'resourceArn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
    'resourceTagKeys' => [
        'ExampleTagKey',
    ],
]);

Result syntax:

[
]

UpdateBillingPreferences

$result = $client->updateBillingPreferences([/* ... */]);
$promise = $client->updateBillingPreferencesAsync([/* ... */]);

Updates billing preferences for the specified feature. Each feature targets a distinct billing capability and has its own set of supported keys. The action sets the value for each provided key; keys not present in the request are unchanged.

Sharing keys (RI_SHARING, CREDIT_SHARING, CREDIT_LEVEL_SHARING, and sharing keys under CREDIT_PREFERENCE_OPTIONS) may only be set by the management account of a consolidated billing family. The credit/{creditId}/status key may be set by member accounts for credits they own, or by the management account for any credit in the family.

Parameter Syntax

$result = $client->updateBillingPreferences([
    'billingPreferencesPerKey' => [ // REQUIRED
        [
            'key' => '<string>', // REQUIRED
            'value' => 'ENABLED|DISABLED', // REQUIRED
        ],
        // ...
    ],
    'feature' => 'RI_SHARING|RI_SHARING_HISTORY|CREDIT_SHARING|CREDIT_SHARING_HISTORY|CREDIT_LEVEL_SHARING|BILLING_ALERTS|CREDIT_PREFERENCE_OPTIONS', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

The request was denied due to request throttling.

AccessDeniedException:

You don't have sufficient access to perform this action.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

UpdateBillingView

$result = $client->updateBillingView([/* ... */]);
$promise = $client->updateBillingViewAsync([/* ... */]);

An API to update the attributes of the billing view.

Parameter Syntax

$result = $client->updateBillingView([
    'arn' => '<string>', // REQUIRED
    'dataFilterExpression' => [
        'costCategories' => [
            'key' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        'dimensions' => [
            'key' => 'LINKED_ACCOUNT', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        'tags' => [
            'key' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        'timeRange' => [
            'beginDateInclusive' => <integer || string || DateTime>,
            'endDateInclusive' => <integer || string || DateTime>,
        ],
    ],
    'description' => '<string>',
    'name' => '<string>',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

BillingViewHealthStatusException:

Exception thrown when a billing view's health status prevents an operation from being performed. This may occur if the billing view is in a state other than HEALTHY.

ServiceQuotaExceededException:

You've reached the limit of resources you can create, or exceeded the size of an individual resource.

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The specified ARN in the request doesn't exist.

AccessDeniedException:

You don't have sufficient access to perform this action.

ConflictException:

The requested operation would cause a conflict with the current state of a service resource associated with the request. Resolve the conflict before retrying this request.

ValidationException:

The input fails to satisfy the constraints specified by an Amazon Web Services service.

InternalServerException:

The request processing failed because of an unknown error, exception, or failure.

Examples

Example 1: Invoke UpdateBillingView

$result = $client->updateBillingView([
    'name' => 'Example Custom Billing View',
    'arn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
    'dataFilterExpression' => [
        'dimensions' => [
            'key' => 'LINKED_ACCOUNT',
            'values' => [
                '000000000000',
            ],
        ],
    ],
    'description' => 'Custom Billing View Example -- updated description',
]);

Result syntax:

[
    'arn' => 'arn:aws:billing::123456789101:billingview/custom-46f47cb2-a11d-43f3-983d-470b5708a899',
    'updatedAt' => ,
]