list-invoice-summaries¶

Description¶

Retrieves your invoice details programmatically, without line item details.

Synopsis¶

  list-invoice-summaries
--selector <value>
[--filter <value>]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options¶

--selector (structure)

The option to retrieve details for a specific invoice by providing its unique ID. Alternatively, access information for all invoices linked to the account by providing an account ID.

ResourceType -> (string)

The query identifier type (INVOICE_ID or ACCOUNT_ID ).

Value -> (string)

The value of the query identifier.

Shorthand Syntax:

ResourceType=string,Value=string

JSON Syntax:

{
  "ResourceType": "ACCOUNT_ID"|"INVOICE_ID",
  "Value": "string"
}

--filter (structure)

Filters you can use to customize your invoice summary.

TimeInterval -> (structure)

The date range for invoice summary retrieval.

StartDate -> (timestamp)

The beginning of the time period that you want invoice-related documents for. The start date is inclusive. For example, if start is 2019-01-01 , AWS retrieves invoices starting at 2019-01-01 up to the end date.

EndDate -> (timestamp)

The end of the time period that you want invoice-related documents for. The end date is exclusive. For example, if end is 2019-01-10 , Amazon Web Services retrieves invoice-related documents from the start date up to, but not including, 2018-01-10 .

BillingPeriod -> (structure)

The billing period associated with the invoice documents.

Month -> (integer)

The billing period month.

Year -> (integer)

The billing period year.

InvoicingEntity -> (string)

The name of the entity that issues the Amazon Web Services invoice.

Shorthand Syntax:

TimeInterval={StartDate=timestamp,EndDate=timestamp},BillingPeriod={Month=integer,Year=integer},InvoicingEntity=string

JSON Syntax:

{
  "TimeInterval": {
    "StartDate": timestamp,
    "EndDate": timestamp
  },
  "BillingPeriod": {
    "Month": integer,
    "Year": integer
  },
  "InvoicingEntity": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a NextToken is provided in the command’s output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output¶

InvoiceSummaries -> (list)

List of key (summary level) invoice details without line item details.

(structure)

The invoice that the API retrieved.

AccountId -> (string)

The Amazon Web Services account ID.

InvoiceId -> (string)

The invoice ID.

IssuedDate -> (timestamp)

The issued date of the invoice.

DueDate -> (timestamp)

The invoice due date.

Entity -> (structure)

The organization name providing Amazon Web Services services.

InvoicingEntity -> (string)

The name of the entity that issues the Amazon Web Services invoice.

BillingPeriod -> (structure)

The billing period of the invoice-related document.

Month -> (integer)

The billing period month.

Year -> (integer)

The billing period year.

InvoiceType -> (string)

The type of invoice.

OriginalInvoiceId -> (string)

The initial or original invoice ID.

PurchaseOrderNumber -> (string)

The purchase order number associated to the invoice.

BaseCurrencyAmount -> (structure)

The summary with the product and service currency.

TotalAmount -> (string)

The invoice currency amount.

TotalAmountBeforeTax -> (string)

Details about the invoice total amount before tax.

CurrencyCode -> (string)

The currency dominion of the invoice document.

AmountBreakdown -> (structure)

Details about the invoice currency amount.

SubTotalAmount -> (string)

The total of a set of the breakdown.

Discounts -> (structure)

The discounted amount.

Breakdown -> (list)

The list of discounts information.

(structure)

The discounted amount.

Description -> (string)

The list of discounts information.

Amount -> (string)

The discounted amount.

Rate -> (string)

The details for the discount rate..

TotalAmount -> (string)

The discount’s total amount.

Taxes -> (structure)

The tax amount.

Breakdown -> (list)

A list of tax information.

(structure)

The tax amount.

Description -> (string)

The details of the taxes.

Amount -> (string)

The tax amount.

Rate -> (string)

The details of the tax rate.

TotalAmount -> (string)

The total amount for your taxes.

Fees -> (structure)

The fee amount.

Breakdown -> (list)

The list of fees information.

(structure)

The fee amount.

Description -> (string)

The list of fees information.

Amount -> (string)

The fee amount.

Rate -> (string)

Details about the rate amount.

TotalAmount -> (string)

The total amount of fees.

CurrencyExchangeDetails -> (structure)

The details of currency exchange.

SourceCurrencyCode -> (string)

The exchange source currency.

TargetCurrencyCode -> (string)

The exchange target currency.

Rate -> (string)

The currency exchange rate.

TaxCurrencyAmount -> (structure)

The summary with the tax currency.

TotalAmount -> (string)

The invoice currency amount.

TotalAmountBeforeTax -> (string)

Details about the invoice total amount before tax.

CurrencyCode -> (string)

The currency dominion of the invoice document.

AmountBreakdown -> (structure)

Details about the invoice currency amount.

SubTotalAmount -> (string)

The total of a set of the breakdown.

Discounts -> (structure)

The discounted amount.

Breakdown -> (list)

The list of discounts information.

(structure)

The discounted amount.

Description -> (string)

The list of discounts information.

Amount -> (string)

The discounted amount.

Rate -> (string)

The details for the discount rate..

TotalAmount -> (string)

The discount’s total amount.

Taxes -> (structure)

The tax amount.

Breakdown -> (list)

A list of tax information.

(structure)

The tax amount.

Description -> (string)

The details of the taxes.

Amount -> (string)

The tax amount.

Rate -> (string)

The details of the tax rate.

TotalAmount -> (string)

The total amount for your taxes.

Fees -> (structure)

The fee amount.

Breakdown -> (list)

The list of fees information.

(structure)

The fee amount.

Description -> (string)

The list of fees information.

Amount -> (string)

The fee amount.

Rate -> (string)

Details about the rate amount.

TotalAmount -> (string)

The total amount of fees.

CurrencyExchangeDetails -> (structure)

The details of currency exchange.

SourceCurrencyCode -> (string)

The exchange source currency.

TargetCurrencyCode -> (string)

The exchange target currency.

Rate -> (string)

The currency exchange rate.

PaymentCurrencyAmount -> (structure)

The summary with the customer configured currency.

TotalAmount -> (string)

The invoice currency amount.

TotalAmountBeforeTax -> (string)

Details about the invoice total amount before tax.

CurrencyCode -> (string)

The currency dominion of the invoice document.

AmountBreakdown -> (structure)

Details about the invoice currency amount.

SubTotalAmount -> (string)

The total of a set of the breakdown.

Discounts -> (structure)

The discounted amount.

Breakdown -> (list)

The list of discounts information.

(structure)

The discounted amount.

Description -> (string)

The list of discounts information.

Amount -> (string)

The discounted amount.

Rate -> (string)

The details for the discount rate..

TotalAmount -> (string)

The discount’s total amount.

Taxes -> (structure)

The tax amount.

Breakdown -> (list)

A list of tax information.

(structure)

The tax amount.

Description -> (string)

The details of the taxes.

Amount -> (string)

The tax amount.

Rate -> (string)

The details of the tax rate.

TotalAmount -> (string)

The total amount for your taxes.

Fees -> (structure)

The fee amount.

Breakdown -> (list)

The list of fees information.

(structure)

The fee amount.

Description -> (string)

The list of fees information.

Amount -> (string)

The fee amount.

Rate -> (string)

Details about the rate amount.

TotalAmount -> (string)

The total amount of fees.

CurrencyExchangeDetails -> (structure)

The details of currency exchange.

SourceCurrencyCode -> (string)

The exchange source currency.

TargetCurrencyCode -> (string)

The exchange target currency.

Rate -> (string)

The currency exchange rate.

NextToken -> (string)

The token to retrieve the next set of results. Amazon Web Services provides the token when the response from a previous call has more results than the maximum page size.

Table of Contents

Feedback

User Guide