GetInvoiceUnit - AWS Billing and Cost Management
Request SyntaxRequest ParametersResponse SyntaxResponse ElementsErrorsSee Also

GetInvoiceUnit

This retrieves the invoice unit definition.

Request Syntax

{
   "AsOf": number,
   "InvoiceUnitArn": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

AsOf

The state of an invoice unit at a specified time. You can see legacy invoice units that are currently deleted if the AsOf time is set to before it was deleted. If an AsOf is not provided, the default value is the current time.

Type: Timestamp

Required: No

InvoiceUnitArn

The ARN to identify an invoice unit. This information can't be modified or deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+

Required: Yes

Response Syntax

{
   "Description": "string",
   "InvoiceReceiver": "string",
   "InvoiceUnitArn": "string",
   "LastModified": number,
   "Name": "string",
   "Rule": { 
      "LinkedAccounts": [ "string" ]
   },
   "TaxInheritanceDisabled": boolean
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Description

The assigned description for an invoice unit.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Pattern: [\S\s]*

InvoiceReceiver

The AWS account ID chosen to be the receiver of an invoice unit. All invoices generated for that invoice unit will be sent to this account ID.

Type: String

Pattern: \d{12}

InvoiceUnitArn

The ARN to identify an invoice unit. This information can't be modified or deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+

LastModified

The most recent date the invoice unit response was updated.

Type: Timestamp

Name

The unique name of the invoice unit that is shown on the generated invoice.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: (?! )[\p{L}\p{N}\p{Z}-_]*(?<! )

Rule

This is used to categorize the invoice unit. Values are AWS account IDs. Currently, the only supported rule is LINKED_ACCOUNT.

Type: InvoiceUnitRule object

TaxInheritanceDisabled

Whether the invoice unit based tax inheritance is/ should be enabled or disabled.

Type: Boolean

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

HTTP Status Code: 400

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

The resource could not be found.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: