This gets the invoice profile associated with a set of accounts. The accounts must be linked accounts under the requester management account organization.
" }, "CreateInvoiceUnit":{ "name":"CreateInvoiceUnit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"CreateInvoiceUnitRequest"}, "output":{"shape":"CreateInvoiceUnitResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"This creates a new invoice unit with the provided definition.
" }, "DeleteInvoiceUnit":{ "name":"DeleteInvoiceUnit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"DeleteInvoiceUnitRequest"}, "output":{"shape":"DeleteInvoiceUnitResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"This deletes an invoice unit with the provided invoice unit ARN.
" }, "GetInvoiceUnit":{ "name":"GetInvoiceUnit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"GetInvoiceUnitRequest"}, "output":{"shape":"GetInvoiceUnitResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"This retrieves the invoice unit definition.
" }, "ListInvoiceUnits":{ "name":"ListInvoiceUnits", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"ListInvoiceUnitsRequest"}, "output":{"shape":"ListInvoiceUnitsResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"} ], "documentation":"This fetches a list of all invoice unit definitions for a given account, as of the provided AsOf date.
Lists the tags for a resource.
" }, "TagResource":{ "name":"TagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"TagResourceRequest"}, "output":{"shape":"TagResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ServiceQuotaExceededException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Adds a tag to a resource.
" }, "UntagResource":{ "name":"UntagResource", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UntagResourceRequest"}, "output":{"shape":"UntagResourceResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"Removes a tag from a resource.
" }, "UpdateInvoiceUnit":{ "name":"UpdateInvoiceUnit", "http":{ "method":"POST", "requestUri":"/" }, "input":{"shape":"UpdateInvoiceUnitRequest"}, "output":{"shape":"UpdateInvoiceUnitResponse"}, "errors":[ {"shape":"ThrottlingException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, {"shape":"ValidationException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"You can update the invoice unit configuration at any time, and Amazon Web Services will use the latest configuration at the end of the month.
" } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"BasicString"}, "resourceName":{ "shape":"InvoiceUnitArnString", "documentation":"You don't have sufficient access to perform this action.
" } }, "documentation":"You don't have sufficient access to perform this action.
", "exception":true }, "AccountIdList":{ "type":"list", "member":{"shape":"AccountIdString"}, "max":1000, "min":1 }, "AccountIdString":{ "type":"string", "pattern":"\\d{12}" }, "AsOfTimestamp":{"type":"timestamp"}, "BasicString":{ "type":"string", "max":1024, "min":0, "pattern":"\\S+" }, "BatchGetInvoiceProfileRequest":{ "type":"structure", "required":["AccountIds"], "members":{ "AccountIds":{ "shape":"AccountIdList", "documentation":"Retrieves the corresponding invoice profile data for these account IDs.
" } } }, "BatchGetInvoiceProfileResponse":{ "type":"structure", "members":{ "Profiles":{ "shape":"ProfileList", "documentation":"A list of invoice profiles corresponding to the requested accounts.
" } } }, "CreateInvoiceUnitRequest":{ "type":"structure", "required":[ "Name", "InvoiceReceiver", "Rule" ], "members":{ "Name":{ "shape":"InvoiceUnitName", "documentation":"The unique name of the invoice unit that is shown on the generated invoice. This can't be changed once it is set. To change this name, you must delete the invoice unit recreate.
" }, "InvoiceReceiver":{ "shape":"AccountIdString", "documentation":"The Amazon Web Services 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.
" }, "Description":{ "shape":"DescriptionString", "documentation":"The invoice unit's description. This can be changed at a later time.
" }, "TaxInheritanceDisabled":{ "shape":"TaxInheritanceDisabledFlag", "documentation":"Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
" }, "Rule":{ "shape":"InvoiceUnitRule", "documentation":"The InvoiceUnitRule object used to create invoice units.
The tag structure that contains a tag key and value.
" } } }, "CreateInvoiceUnitResponse":{ "type":"structure", "members":{ "InvoiceUnitArn":{ "shape":"InvoiceUnitArnString", "documentation":"The ARN to identify an invoice unit. This information can't be modified or deleted.
" } } }, "DeleteInvoiceUnitRequest":{ "type":"structure", "required":["InvoiceUnitArn"], "members":{ "InvoiceUnitArn":{ "shape":"InvoiceUnitArnString", "documentation":"The ARN to identify an invoice unit. This information can't be modified or deleted.
" } } }, "DeleteInvoiceUnitResponse":{ "type":"structure", "members":{ "InvoiceUnitArn":{ "shape":"InvoiceUnitArnString", "documentation":"The ARN to identify an invoice unit. This information can't be modified or deleted.
" } } }, "DescriptionString":{ "type":"string", "max":500, "min":0, "pattern":"[\\S\\s]*" }, "Filters":{ "type":"structure", "members":{ "Names":{ "shape":"InvoiceUnitNames", "documentation":" An optional input to the list API. You can specify a list of invoice unit names inside filters to return invoice units that match only the specified invoice unit names. If multiple names are provided, the result is an OR condition (match any) of the specified invoice unit names.
You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR condition (match any) of the specified accounts. This filter only matches the specified accounts on the invoice receivers of the invoice units.
You can specify a list of Amazon Web Services account IDs inside filters to return invoice units that match only the specified accounts. If multiple accounts are provided, the result is an OR condition (match any) of the specified accounts. The specified account IDs are matched with either the receiver or the linked accounts in the rules.
An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers, Names, and Accounts.
The ARN to identify an invoice unit. This information can't be modified or deleted.
" }, "AsOf":{ "shape":"AsOfTimestamp", "documentation":" 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.
The ARN to identify an invoice unit. This information can't be modified or deleted.
" }, "InvoiceReceiver":{ "shape":"AccountIdString", "documentation":"The Amazon Web Services 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.
" }, "Name":{ "shape":"InvoiceUnitName", "documentation":"The unique name of the invoice unit that is shown on the generated invoice.
" }, "Description":{ "shape":"DescriptionString", "documentation":"The assigned description for an invoice unit.
" }, "TaxInheritanceDisabled":{ "shape":"TaxInheritanceDisabledFlag", "documentation":"Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
", "box":true }, "Rule":{"shape":"InvoiceUnitRule"}, "LastModified":{ "shape":"LastModifiedTimestamp", "documentation":"The most recent date the invoice unit response was updated.
" } } }, "Integer":{ "type":"integer", "box":true }, "InternalServerException":{ "type":"structure", "members":{ "retryAfterSeconds":{ "shape":"Integer", "documentation":"The processing request failed because of an unknown error, exception, or failure.
" }, "message":{"shape":"BasicString"} }, "documentation":"The processing request failed because of an unknown error, exception, or failure.
", "exception":true, "fault":true }, "InvoiceProfile":{ "type":"structure", "members":{ "AccountId":{ "shape":"AccountIdString", "documentation":"The account ID the invoice profile is generated for.
" }, "ReceiverName":{ "shape":"BasicString", "documentation":"The name of the person receiving the invoice profile.
" }, "ReceiverAddress":{ "shape":"ReceiverAddress", "documentation":"The address of the receiver that will be printed on the invoice.
" }, "ReceiverEmail":{ "shape":"SensitiveBasicString", "documentation":"The email address for the invoice profile receiver.
" }, "Issuer":{ "shape":"BasicString", "documentation":"This specifies the issuing entity of the invoice.
" }, "TaxRegistrationNumber":{ "shape":"SensitiveBasicString", "documentation":"Your Tax Registration Number (TRN) information.
" } }, "documentation":"Contains high-level information about the invoice receiver.
" }, "InvoiceUnit":{ "type":"structure", "members":{ "InvoiceUnitArn":{ "shape":"InvoiceUnitArnString", "documentation":"ARN to identify an invoice unit. This information can't be modified or deleted.
" }, "InvoiceReceiver":{ "shape":"AccountIdString", "documentation":"The account that receives invoices related to the invoice unit.
" }, "Name":{ "shape":"InvoiceUnitName", "documentation":"A unique name that is distinctive within your Amazon Web Services.
" }, "Description":{ "shape":"DescriptionString", "documentation":"The assigned description for an invoice unit. This information can't be modified or deleted.
" }, "TaxInheritanceDisabled":{ "shape":"TaxInheritanceDisabledFlag", "documentation":"Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
", "box":true }, "Rule":{ "shape":"InvoiceUnitRule", "documentation":" An InvoiceUnitRule object used the categorize invoice units.
The last time the invoice unit was updated. This is important to determine the version of invoice unit configuration used to create the invoices. Any invoice created after this modified time will use this invoice unit configuration.
" } }, "documentation":"An invoice unit is a set of mutually exclusive accounts that correspond to your business entity. Invoice units allow you separate Amazon Web Services account costs and configures your invoice for each business entity going forward.
" }, "InvoiceUnitArnString":{ "type":"string", "max":256, "min":1, "pattern":"arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+" }, "InvoiceUnitName":{ "type":"string", "max":50, "min":1, "pattern":"(?! )[\\p{L}\\p{N}\\p{Z}-_]*(?The list ofLINKED_ACCOUNT IDs where charges are included within the invoice unit. "
}
},
"documentation":" This is used to categorize the invoice unit. Values are Amazon Web Services account IDs. Currently, the only supported rule is LINKED_ACCOUNT.
An optional input to the list API. If multiple filters are specified, the returned list will be a configuration that match all of the provided filters. Supported filter types are InvoiceReceivers, Names, and Accounts.
The next token used to indicate where the returned list should start from.
" }, "MaxResults":{ "shape":"MaxResultsInteger", "documentation":"The maximum number of invoice units that can be returned.
" }, "AsOf":{ "shape":"AsOfTimestamp", "documentation":" 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.
An invoice unit is a set of mutually exclusive accounts that correspond to your business entity.
" }, "NextToken":{ "shape":"NextTokenString", "documentation":"The next token used to indicate where the returned list should start from.
" } } }, "ListTagsForResourceRequest":{ "type":"structure", "required":["ResourceArn"], "members":{ "ResourceArn":{ "shape":"TagrisArn", "documentation":"The Amazon Resource Name (ARN) of tags to list.
" } } }, "ListTagsForResourceResponse":{ "type":"structure", "members":{ "ResourceTags":{ "shape":"ResourceTagList", "documentation":"Adds a tag to a resource.
" } } }, "MaxResultsInteger":{ "type":"integer", "box":true, "max":500, "min":1 }, "NextTokenString":{ "type":"string", "max":2048, "min":1, "pattern":"[\\S\\s]*" }, "ProfileList":{ "type":"list", "member":{"shape":"InvoiceProfile"} }, "ReceiverAddress":{ "type":"structure", "members":{ "AddressLine1":{ "shape":"BasicString", "documentation":"The first line of the address.
" }, "AddressLine2":{ "shape":"BasicString", "documentation":"The second line of the address, if applicable.
" }, "AddressLine3":{ "shape":"BasicString", "documentation":"The third line of the address, if applicable.
" }, "DistrictOrCounty":{ "shape":"BasicString", "documentation":"The district or country the address is located in.
" }, "City":{ "shape":"BasicString", "documentation":"The city that the address is in.
" }, "StateOrRegion":{ "shape":"BasicString", "documentation":"The state, region, or province the address is located.
" }, "CountryCode":{ "shape":"BasicString", "documentation":"The country code for the country the address is in.
" }, "CompanyName":{ "shape":"BasicString", "documentation":"A unique company name.
" }, "PostalCode":{ "shape":"BasicString", "documentation":"The postal code associated with the address.
" } }, "documentation":"The details of the address associated with the receiver.
", "sensitive":true }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"BasicString"}, "resourceName":{ "shape":"InvoiceUnitArnString", "documentation":"The resource could not be found.
" } }, "documentation":"The resource could not be found.
", "exception":true }, "ResourceTag":{ "type":"structure", "required":[ "Key", "Value" ], "members":{ "Key":{ "shape":"ResourceTagKey", "documentation":"The object key of your of your resource tag.
" }, "Value":{ "shape":"ResourceTagValue", "documentation":"The specific value of the resource tag.
" } }, "documentation":"The tag structure that contains a tag key and value.
" }, "ResourceTagKey":{ "type":"string", "max":128, "min":1 }, "ResourceTagKeyList":{ "type":"list", "member":{"shape":"ResourceTagKey"}, "max":200, "min":0 }, "ResourceTagList":{ "type":"list", "member":{"shape":"ResourceTag"}, "max":200, "min":0 }, "ResourceTagValue":{ "type":"string", "max":256, "min":0 }, "SensitiveBasicString":{ "type":"string", "max":1024, "min":0, "pattern":"\\S+", "sensitive":true }, "ServiceQuotaExceededException":{ "type":"structure", "required":["message"], "members":{ "message":{"shape":"BasicString"} }, "documentation":"The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.
", "exception":true }, "TagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "ResourceTags" ], "members":{ "ResourceArn":{ "shape":"TagrisArn", "documentation":"The Amazon Resource Name (ARN) of the tags.
" }, "ResourceTags":{ "shape":"ResourceTagList", "documentation":"Adds a tag to a resource.
" } } }, "TagResourceResponse":{ "type":"structure", "members":{ } }, "TagrisArn":{ "type":"string", "max":2048, "min":20, "pattern":"arn:aws[-a-z0-9]*:[a-z0-9]+:[-a-z0-9]*:[0-9]{12}:[-a-zA-Z0-9/:_]+" }, "TaxInheritanceDisabledFlag":{"type":"boolean"}, "ThrottlingException":{ "type":"structure", "members":{ "message":{"shape":"BasicString"} }, "documentation":"The request was denied due to request throttling.
", "exception":true }, "UntagResourceRequest":{ "type":"structure", "required":[ "ResourceArn", "ResourceTagKeys" ], "members":{ "ResourceArn":{ "shape":"TagrisArn", "documentation":"The Amazon Resource Name (ARN) to untag.
" }, "ResourceTagKeys":{ "shape":"ResourceTagKeyList", "documentation":"Keys for the tags to be removed.
" } } }, "UntagResourceResponse":{ "type":"structure", "members":{ } }, "UpdateInvoiceUnitRequest":{ "type":"structure", "required":["InvoiceUnitArn"], "members":{ "InvoiceUnitArn":{ "shape":"InvoiceUnitArnString", "documentation":"The ARN to identify an invoice unit. This information can't be modified or deleted.
" }, "Description":{ "shape":"DescriptionString", "documentation":"The assigned description for an invoice unit. This information can't be modified or deleted.
" }, "TaxInheritanceDisabled":{ "shape":"TaxInheritanceDisabledFlag", "documentation":"Whether the invoice unit based tax inheritance is/ should be enabled or disabled.
", "box":true }, "Rule":{ "shape":"InvoiceUnitRule", "documentation":"The InvoiceUnitRule object used to update invoice units.
The ARN to identify an invoice unit. This information can't be modified or deleted.
" } } }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"BasicString"}, "resourceName":{ "shape":"InvoiceUnitArnString", "documentation":"You don't have sufficient access to perform this action.
" }, "reason":{ "shape":"ValidationExceptionReason", "documentation":"You don't have sufficient access to perform this action.
" }, "fieldList":{ "shape":"ValidationExceptionFieldList", "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } }, "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
", "exception":true }, "ValidationExceptionField":{ "type":"structure", "required":[ "name", "message" ], "members":{ "name":{ "shape":"BasicString", "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
" }, "message":{ "shape":"BasicString", "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
" } }, "documentation":"The input fails to satisfy the constraints specified by an Amazon Web Services service.
" }, "ValidationExceptionFieldList":{ "type":"list", "member":{"shape":"ValidationExceptionField"} }, "ValidationExceptionReason":{ "type":"string", "enum":[ "nonMemberPresent", "maxAccountsExceeded", "maxInvoiceUnitsExceeded", "duplicateInvoiceUnit", "mutualExclusionError", "accountMembershipError", "taxSettingsError", "expiredNextToken", "invalidNextToken", "invalidInput", "fieldValidationFailed", "cannotParse", "unknownOperation", "other" ] } }, "documentation":"Amazon Web Services Invoice Configuration
You can use Amazon Web Services Invoice Configuration APIs to programmatically create, update, delete, get, and list invoice units. You can also programmatically fetch the information of the invoice receiver. For example, business legal name, address, and invoicing contacts.
You can use Amazon Web Services Invoice Configuration to receive separate Amazon Web Services invoices based your organizational needs. By using Amazon Web Services Invoice Configuration, you can configure invoice units that are groups of Amazon Web Services accounts that represent your business entities, and receive separate invoices for each business entity. You can also assign a unique member or payer account as the invoice receiver for each invoice unit. As you create new accounts within your Organizations using Amazon Web Services Invoice Configuration APIs, you can automate the creation of new invoice units and subsequently automate the addition of new accounts to your invoice units.
Service endpoint
You can use the following endpoints for Amazon Web Services Invoice Configuration:
https://invoicing.us-east-1.api.aws