Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . wafv2 ]

get-revenue-statistics-summary

Description

Retrieves a summary of monetization revenue for the specified time window. Returns total revenue, revenue by verification tier, total settlements, and total HTTP 402 responses served. This operation is only available for CLOUDFRONT scope. The maximum supported time window is 90 days. When no CurrencyMode filter is provided, results default to REAL . To retrieve test data, include a CurrencyMode filter with the value TEST .

See also: AWS API Documentation

Synopsis

  get-revenue-statistics-summary
--time-window <value>
--scope <value>
--currency <value>
[--filters <value>]
[--cli-input-json <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>]
[--v2-debug]

Options

--time-window (structure)

The time range for the revenue summary query. Specify start and end timestamps.

StartTime -> (timestamp)

The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z . For example, "2016-09-27T14:50Z" . You can specify any time range in the previous three hours.

EndTime -> (timestamp)

The end of the time range from which you want GetSampledRequests to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z . For example, "2016-09-27T14:50Z" . You can specify any time range in the previous three hours.

Shorthand Syntax:

StartTime=timestamp,EndTime=timestamp

JSON Syntax:

{
  "StartTime": timestamp,
  "EndTime": timestamp
}

--scope (string)

Specifies whether this is for a Amazon CloudFront distribution (CLOUDFRONT ) or for a regional application (REGIONAL ). AI bot monetization is only available for CLOUDFRONT scope.

Possible values:

• CLOUDFRONT
• REGIONAL

--currency (string)

The currency for the revenue amounts in the response. Currently only USDC is supported.

Possible values:

• USDC

--filters (list)

Optional filters to narrow the results. You can filter by source name, category, organization, intent, verified status, content path, web ACL ARN, or currency mode.

(structure)

A filter for narrowing monetization statistics and settlement record results. Specify a filter name and one or more values to match.

Filter behavior:

• Multiple values within one filter: OR (match any)
• Multiple filters: AND (all must match)
• No duplicate filter names allowed (rejected with error)
• Duplicate values within a filter are silently deduplicated
• If no CurrencyMode filter is specified, defaults to REAL

Name -> (string)

The filter name. Format: Key is a string, Value is a list of strings.

Enum-restricted (invalid values rejected):

• CurrencyMode : REAL , TEST
• ChainName : BASE , SOLANA , BASE_SEPOLIA , SOLANA_DEVNET
• SettlementStatus : SETTLED , PENDING , FAILED , SERVICE_ERROR , SKIPPED_ORIGIN_ERROR , DUPLICATE
• HttpSourceName : CF , ALB , APIGW , APPRUNNER , COGNITO , VERIFIED_ACCESS

ARN-validated:

• WebACLArn : valid WAFv2 web ACL ARN

Free-text (any string up to 256 chars):

• SourceName : The name of the bot. Populated from Bot Control verified bot labels.
• SourceCategory : The category classification of the bot. From Bot Control categorization.
• Intent : The declared intent of the bot request.
• Organization : The organization operating the bot.
• UriPathPrefix : The URI path of the request that was monetized.
• RequestId : The WAF request ID associated with the transaction. Matches the requestId in WAF logs. Pattern: ^[a-zA-Z0-9:._\-=+/]+$
• TransactionId : The blockchain transaction identifier. Pattern: ^[a-zA-Z0-9:._\-=+/]+$
• TerminatingRuleName : The name of the WAF rule that triggered the Monetize action.
• PayerAddress : The blockchain wallet address of the paying client. Pattern: ^[a-zA-Z0-9:._\-=+/]+$
• HttpSourceId : The identifier of the Amazon Web Services resource associated with the web ACL (for example, CloudFront distribution ID).

Values -> (list)

The values to filter on. Specify as a list of strings. Results match any of the specified values (OR logic). Duplicate values are silently deduplicated. Maximum: 20 values per filter.

(string)

Shorthand Syntax:

Name=string,Values=string,string ...

JSON Syntax:

[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

RevenueBreakdown -> (structure)

The revenue breakdown summary for the specified time window and filters.

TotalAmount -> (string)

The total revenue amount in the specified currency.

VerifiedAmount -> (string)

The revenue amount from verified AI bots.

UnverifiedAmount -> (string)

The revenue amount from unverified AI bots.

Currency -> (string)

The currency of the revenue amounts.

TotalSettled -> (long)

The total number of successfully settled payment transactions.

TotalMonetizeServed -> (long)

The total number of HTTP 402 Payment Required responses served to AI agents.