get-estimated-water-allocation¶

Description¶

Returns estimated water allocation values based on customer grouping and filtering parameters. We recommend using pagination to ensure that the operation returns quickly and successfully.

Synopsis¶

  get-estimated-water-allocation
--time-period <value>
[--group-by <value>]
[--filter-by <value>]
[--allocation-types <value>]
[--granularity <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--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]
[--cli-error-format <value>]

Options¶

--time-period (structure) [required]

The date range for fetching estimated water allocation. The range must include the start date of a year for that year’s data to be included in the response.

Start -> (timestamp) [required]

The start (inclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ

End -> (timestamp) [required]

The end (exclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ

Shorthand Syntax:

Start=timestamp,End=timestamp

JSON Syntax:

{
  "Start": timestamp,
  "End": timestamp
}

--group-by (list)

The dimensions available for grouping estimated water allocation.

(string)

Specifies the dimensions available for grouping and filtering environmental impact data.

Possible values:

USAGE_ACCOUNT_ID

REGION

SERVICE

Syntax:

"string" "string" ...

--filter-by (structure)

The criteria for filtering estimated water allocation. To determine which dimensions are available to be filtered by, you can first call GetEstimatedWaterAllocationDimensionValues

Dimensions -> (map)

Filters environmental impact values by specific dimension values.

key -> (string)

Specifies the dimensions available for grouping and filtering environmental impact data.

Possible values:

USAGE_ACCOUNT_ID

REGION

SERVICE

value -> (list)

(string)

Constraints:

min: 0

max: 256

Shorthand Syntax:

Dimensions={KeyName1=[string,string],KeyName2=[string,string]}

JSON Syntax:

{
  "Dimensions": {"USAGE_ACCOUNT_ID"|"REGION"|"SERVICE": ["string", ...]
    ...}
}

--allocation-types (list)

The allocation types to include in the results. If absent, returns TOTAL_WATER_WITHDRAWALS allocation types.

(string)

Specifies the types of water allocation calculations available.

Possible values:

TOTAL_WATER_WITHDRAWALS

Syntax:

"string" "string" ...

--granularity (string)

The time granularity for the results. Only YEARLY_CALENDAR time granularity is currently supported for water allocation. Defaults to YEARLY_CALENDAR if absent.

If requesting partial time periods, data will be returned based on the smallest supported granularity. For example, requesting 2025-04-01T00:00:00Z to 2026-04-01T00:00:00Z with YEARLY_CALENDAR will return all the data for 2026 only.

Possible values:

YEARLY_CALENDAR

YEARLY_FISCAL

QUARTERLY_CALENDAR

QUARTERLY_FISCAL

MONTHLY

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

Constraints:

min: 1

max: 5000

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

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

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

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

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

Results -> (list)

The result of the requested inputs.

(structure)

Contains estimated water allocation data for a specific time period and dimension grouping.

TimePeriod -> (structure) [required]

The reporting period for water allocation values.

Start -> (timestamp) [required]

The start (inclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ

End -> (timestamp) [required]

The end (exclusive) of the time period. ISO-8601 formatted timestamp, for example: YYYY-MM-DDThh:mm:ss.sssZ

DimensionsValues -> (map) [required]

The dimensions used to group water allocation values.

key -> (string)

Specifies the dimensions available for grouping and filtering environmental impact data.

Possible values:

USAGE_ACCOUNT_ID

REGION

SERVICE

value -> (string)

Constraints:

min: 0

max: 256

ModelVersion -> (string) [required]

The semantic version-formatted string that indicates the methodology version used to calculate the water allocation values.

Note
The AWS Sustainability service reflects the most recent model version for every month. You will not see two entries for the same month with different ModelVersion values.

Constraints:

pattern: v(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?

AllocationValues -> (map) [required]

The allocation values for the requested water allocation types.

key -> (string)

Specifies the types of water allocation calculations available.

Possible values:

TOTAL_WATER_WITHDRAWALS

value -> (structure)

Represents a water allocation quantity with its value and unit of measurement.

Value -> (double) [required]

The numeric value of the allocation quantity.

Unit -> (string) [required]

The unit of measurement for the allocation value.

Possible values:

m3

NextToken -> (string)

The pagination token indicating there are additional pages available. You can use the token in a following request to fetch the next set of results.

Constraints:

min: 1

max: 2000

Table of Contents

Feedback

User Guide