SDK for PHP 3.x

Client: Aws\Billing\BillingClient
Service ID: billing
Version: 2023-09-07

This page describes the parameters and results for the operations of the AWS Billing (2023-09-07), and shows how to use the Aws\Billing\BillingClient object to call the described operations. This documentation is specific to the 2023-09-07 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 */).

CreateBillingView ( array $params = [] )
Creates a billing view with the specified billing view attributes.
DeleteBillingView ( array $params = [] )
Deletes the specified billing view.
GetBillingView ( array $params = [] )
Returns the metadata associated to the specified billing view ARN.
GetResourcePolicy ( array $params = [] )
Returns the resource-based policy document attached to the resource in JSON format.
ListBillingViews ( array $params = [] )
Lists the billing views available for a given time period.
ListSourceViewsForBillingView ( array $params = [] )
Lists the source views (managed Amazon Web Services billing views) associated with the billing view.
ListTagsForResource ( array $params = [] )
Lists tags associated with the billing view resource.
TagResource ( array $params = [] )
An API operation for adding one or more tags (key-value pairs) to a resource.
UntagResource ( array $params = [] )
Removes one or more tags from a resource.
UpdateBillingView ( array $params = [] )
An API to update the attributes of the billing view.

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:

ListBillingViews
ListSourceViewsForBillingView

Operations

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' => [
        'dimensions' => [
            'key' => 'LINKED_ACCOUNT', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        'tags' => [
            'key' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'resourceTags' => [
        [
            'key' => '<string>', // REQUIRED
            'value' => '<string>',
        ],
        // ...
    ],
    'sourceViews' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
clientToken
Type: string

A unique, case-sensitive identifier you specify to ensure idempotency of the request. Idempotency ensures that an API request completes no more than one time. If the original request completes successfully, any subsequent retries complete successfully without performing any further actions with an idempotent request.

dataFilterExpression
Type: Expression structure

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

description
Type: string

The description of the billing view.

name
Required: Yes
Type: string

The name of the billing view.

resourceTags
Type: Array of ResourceTag structures

A list of key value map specifying tags associated to the billing view being created.

sourceViews
Required: Yes
Type: Array of strings

A list of billing views used as the data source for the custom billing view.

Result Syntax

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

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the billing view was created.

Errors

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.

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
]);

Parameter Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

Result Syntax

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

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

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',
]

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

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

Result Syntax

[
    'billingView' => [
        'arn' => '<string>',
        'billingViewType' => 'PRIMARY|BILLING_GROUP|CUSTOM',
        'createdAt' => <DateTime>,
        'dataFilterExpression' => [
            'dimensions' => [
                'key' => 'LINKED_ACCOUNT',
                'values' => ['<string>', ...],
            ],
            'tags' => [
                'key' => '<string>',
                'values' => ['<string>', ...],
            ],
        ],
        'description' => '<string>',
        'name' => '<string>',
        'ownerAccountId' => '<string>',
        'updatedAt' => <DateTime>,
    ],
]

Result Details

Members
billingView
Required: Yes
Type: BillingViewElement structure

The billing view element associated with the specified ARN.

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',
    ],
]

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.

Result Syntax

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

Result Details

Members
policy
Type: string

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

resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the billing view resource to which the policy is attached to.

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>,
    'nextToken' => '<string>',
    'ownerAccountId' => '<string>',
]);

Parameter Details

Members
activeTimeRange
Type: ActiveTimeRange structure

The time range for the billing views listed. PRIMARY billing view is always listed. BILLING_GROUP billing views are listed for time ranges when the associated billing group resource in Billing Conductor is active. The time range must be within one calendar month.

arns
Type: Array of strings

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

billingViewTypes
Type: Array of strings

The type of billing view.

maxResults
Type: int

The maximum number of billing views to retrieve. Default is 100.

nextToken
Type: string

The pagination token that is used on subsequent calls to list billing views.

ownerAccountId
Type: string

The list of owners of the billing view.

Result Syntax

[
    'billingViews' => [
        [
            'arn' => '<string>',
            'billingViewType' => 'PRIMARY|BILLING_GROUP|CUSTOM',
            'description' => '<string>',
            'name' => '<string>',
            'ownerAccountId' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
billingViews
Required: Yes
Type: Array of BillingViewListElement structures

A list of BillingViewListElement retrieved.

nextToken
Type: string

The pagination token to use on subsequent calls to list billing views.

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

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

maxResults
Type: int

The number of entries a paginated response contains.

nextToken
Type: string

The pagination token that is used on subsequent calls to list billing views.

Result Syntax

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

Result Details

Members
nextToken
Type: string

The pagination token that is used on subsequent calls to list billing views.

sourceViews
Required: Yes
Type: Array of strings

A list of billing views used as the data source for the custom billing view.

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

Result Syntax

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

Result Details

Members
resourceTags
Type: Array of ResourceTag structures

A list of tag key value pairs that are associated with the resource.

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',
        ],
    ],
]

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

resourceTags
Required: Yes
Type: Array of ResourceTag structures

A list of tag key value pairs that are associated with the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource.

resourceTagKeys
Required: Yes
Type: Array of strings

A list of tag key value pairs that are associated with the resource.

Result Syntax

[]

Result Details

The results for this operation are always empty.

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:

[
]

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' => [
        'dimensions' => [
            'key' => 'LINKED_ACCOUNT', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
        'tags' => [
            'key' => '<string>', // REQUIRED
            'values' => ['<string>', ...], // REQUIRED
        ],
    ],
    'description' => '<string>',
    'name' => '<string>',
]);

Parameter Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

dataFilterExpression
Type: Expression structure

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

description
Type: string

The description of the billing view.

name
Type: string

The name of the billing view.

Result Syntax

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

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the billing view was last updated.

Errors

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' => ,
]

Shapes

AccessDeniedException

Description

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

Members
message
Required: Yes
Type: string

ActiveTimeRange

Description

A time range with a start and end time.

Members
activeAfterInclusive
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The inclusive time range start date.

activeBeforeInclusive
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The inclusive time range end date.

BillingViewElement

Description

The metadata associated to the billing view.

Members
arn
Type: string

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

billingViewType
Type: string

The type of billing group.

createdAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the billing view was created.

dataFilterExpression
Type: Expression structure

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

description
Type: string

The description of the billing view.

name
Type: string

A list of names of the billing view.

ownerAccountId
Type: string

The list of owners of the billing view.

updatedAt
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time when the billing view was last updated.

BillingViewListElement

Description

A representation of a billing view.

Members
arn
Type: string

The Amazon Resource Name (ARN) that can be used to uniquely identify the billing view.

billingViewType
Type: string

The type of billing view.

description
Type: string

The description of the billing view.

name
Type: string

A list of names of the Billing view.

ownerAccountId
Type: string

The list of owners of the Billing view.

ConflictException

Description

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.

Members
message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

The identifier for the service resource associated with the request.

resourceType
Required: Yes
Type: string

The type of resource associated with the request.

DimensionValues

Description

The metadata that you can use to filter and group your results.

Members
key
Required: Yes
Type: string

The names of the metadata types that you can use to filter and group your results.

values
Required: Yes
Type: Array of strings

The metadata values that you can use to filter and group your results.

Expression

Description

See Expression. Billing view only supports LINKED_ACCOUNT and Tags.

Members
dimensions
Type: DimensionValues structure

The specific Dimension to use for Expression.

tags
Type: TagValues structure

The specific Tag to use for Expression.

InternalServerException

Description

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

Members
message
Required: Yes
Type: string

ResourceNotFoundException

Description

The specified ARN in the request doesn't exist.

Members
message
Required: Yes
Type: string
resourceId
Required: Yes
Type: string

Value is a list of resource IDs that were not found.

resourceType
Required: Yes
Type: string

Value is the type of resource that was not found.

ResourceTag

Description

The tag structure that contains a tag key and value.

Members
key
Required: Yes
Type: string

The key that's associated with the tag.

value
Type: string

The value that's associated with the tag.

ServiceQuotaExceededException

Description

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

Members
message
Required: Yes
Type: string
quotaCode
Required: Yes
Type: string

The container for the quotaCode.

resourceId
Required: Yes
Type: string

The ID of the resource.

resourceType
Required: Yes
Type: string

The type of Amazon Web Services resource.

serviceCode
Required: Yes
Type: string

The container for the serviceCode.

TagValues

Description

The values that are available for a tag.

Members
key
Required: Yes
Type: string

The key for the tag.

values
Required: Yes
Type: Array of strings

The specific value of the tag.

ThrottlingException

Description

The request was denied due to request throttling.

Members
message
Required: Yes
Type: string

ValidationException

Description

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

Members
fieldList
Type: Array of ValidationExceptionField structures

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

message
Required: Yes
Type: string
reason
Required: Yes
Type: string

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

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 name of the field.