get-reservation-utilization¶

Description¶

Retrieves the reservation utilization for your account. Management account in an organization have access to member accounts. You can filter data by dimensions in a time period. You can use GetDimensionValues to determine the possible dimension values. Currently, you can group only by SUBSCRIPTION_ID .

Synopsis¶

  get-reservation-utilization
--time-period <value>
[--group-by <value>]
[--granularity <value>]
[--filter <value>]
[--sort-by <value>]
[--next-page-token <value>]
[--max-results <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--time-period (structure)

Sets the start and end dates for retrieving RI utilization. The start date is inclusive, but the end date is exclusive. For example, if start is 2017-01-01 and end is 2017-05-01 , then the cost and usage data is retrieved from 2017-01-01 up to and including 2017-04-30 but not including 2017-05-01 .

Start -> (string)

The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01 , Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

End -> (string)

The end of the time period. The end date is exclusive. For example, if end is 2017-05-01 , Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01 .

Shorthand Syntax:

Start=string,End=string

JSON Syntax:

{
  "Start": "string",
  "End": "string"
}

--group-by (list)

Groups only by SUBSCRIPTION_ID . Metadata is included.

(structure)

Represents a group when you specify a group by criteria or in the response to a query with a specific grouping.

Type -> (string)

The string that represents the type of group.

Key -> (string)

The string that represents a key for a specified group.

Shorthand Syntax:

Type=string,Key=string ...

JSON Syntax:

[
  {
    "Type": "DIMENSION"|"TAG"|"COST_CATEGORY",
    "Key": "string"
  }
  ...
]

--granularity (string)

If GroupBy is set, Granularity can’t be set. If Granularity isn’t set, the response object doesn’t include Granularity , either MONTHLY or DAILY . If both GroupBy and Granularity aren’t set, GetReservationUtilization defaults to DAILY .

The GetReservationUtilization operation supports only DAILY and MONTHLY granularities.

Possible values:

DAILY

MONTHLY

HOURLY

--filter (structure)

Filters utilization data by dimensions. You can filter by the following dimensions:

AZ

CACHE_ENGINE

DEPLOYMENT_OPTION

INSTANCE_TYPE

LINKED_ACCOUNT

OPERATING_SYSTEM

PLATFORM

REGION

SERVICE

SCOPE

TENANCY

GetReservationUtilization uses the same Expression object as the other operations, but only AND is supported among each dimension, and nesting is supported up to only one level deep. If there are multiple values for a dimension, they are OR’d together.

Or -> (list)

Return results that match either Dimension object.

(structure)

Use Expression to filter by cost or by usage. There are two patterns:

Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For GetRightsizingRecommendation , the Region is a full name (for example, REGION==US East (N. Virginia) . The Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR’d together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.

Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

Note

Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.

{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

Note

For the GetRightsizingRecommendation action, a combination of OR and NOT isn’t supported. OR isn’t supported between different dimensions, or dimensions and tags. NOT operators aren’t supported. Dimensions are also limited to LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE .

For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited to LINKED_ACCOUNT .

Or -> (list)

Return results that match either Dimension object.

( … recursive … )

And -> (list)

Return results that match both Dimension objects.

( … recursive … )

( … recursive … )Dimensions -> (structure)

The specific Dimension to use for Expression .

Key -> (string)

The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

Values -> (list)

The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .

(string)

Tags -> (structure)

The specific Tag to use for Expression .

Key -> (string)

The key for the tag.

Values -> (list)

The specific value of the tag.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .

(string)

CostCategories -> (structure)

The filter that’s based on CostCategory values.

Key -> (string)

The unique name of the Cost Category.

Values -> (list)

The specific value of the Cost Category.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE .

(string)

And -> (list)

Return results that match both Dimension objects.

(structure)

Use Expression to filter by cost or by usage. There are two patterns:

Simple dimension values - You can set the dimension name and values for the filters that you plan to use. For example, you can filter for REGION==us-east-1 OR REGION==us-west-1 . For GetRightsizingRecommendation , the Region is a full name (for example, REGION==US East (N. Virginia) . The Expression example is as follows: { "Dimensions": { "Key": "REGION", "Values": [ "us-east-1", “us-west-1” ] } } The list of dimension values are OR’d together to retrieve cost or usage data. You can create Expression and DimensionValues objects using either with* methods or set* methods in multiple lines.

Compound dimension values with logical operations - You can use multiple Expression types and the logical operators AND/OR/NOT to create a list of one or more Expression objects. By doing this, you can filter on more advanced options. For example, you can filter on ((REGION == us-east-1 OR REGION == us-west-1) OR (TAG.Type == Type1)) AND (USAGE_TYPE != DataTransfer) . The Expression for that is as follows: { "And": [ {"Or": [ {"Dimensions": { "Key": "REGION", "Values": [ "us-east-1", "us-west-1" ] }}, {"Tags": { "Key": "TagName", "Values": ["Value1"] } } ]}, {"Not": {"Dimensions": { "Key": "USAGE_TYPE", "Values": ["DataTransfer"] }}} ] }

Note

Because each Expression can have only one operator, the service returns an error if more than one is specified. The following example shows an Expression object that creates an error.

{ "And": [ ... ], "DimensionValues": { "Dimension": "USAGE_TYPE", "Values": [ "DataTransfer" ] } }

Note

For the GetRightsizingRecommendation action, a combination of OR and NOT isn’t supported. OR isn’t supported between different dimensions, or dimensions and tags. NOT operators aren’t supported. Dimensions are also limited to LINKED_ACCOUNT , REGION , or RIGHTSIZING_TYPE .

For the GetReservationPurchaseRecommendation action, only NOT is supported. AND and OR aren’t supported. Dimensions are limited to LINKED_ACCOUNT .

Or -> (list)

Return results that match either Dimension object.

( … recursive … )

And -> (list)

Return results that match both Dimension objects.

( … recursive … )

( … recursive … )Dimensions -> (structure)

The specific Dimension to use for Expression .

Key -> (string)

The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

Values -> (list)

The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .

(string)

Tags -> (structure)

The specific Tag to use for Expression .

Key -> (string)

The key for the tag.

Values -> (list)

The specific value of the tag.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .

(string)

CostCategories -> (structure)

The filter that’s based on CostCategory values.

Key -> (string)

The unique name of the Cost Category.

Values -> (list)

The specific value of the Cost Category.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE .

(string)

Not -> (structure)

Return results that don’t match a Dimension object.

Or -> (list)

Return results that match either Dimension object.

( … recursive … )

And -> (list)

Return results that match both Dimension objects.

( … recursive … )

( … recursive … )Dimensions -> (structure)

The specific Dimension to use for Expression .

Key -> (string)

The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

Values -> (list)

The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .

(string)

Tags -> (structure)

The specific Tag to use for Expression .

Key -> (string)

The key for the tag.

Values -> (list)

The specific value of the tag.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .

(string)

CostCategories -> (structure)

The filter that’s based on CostCategory values.

Key -> (string)

The unique name of the Cost Category.

Values -> (list)

The specific value of the Cost Category.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE .

(string)

Dimensions -> (structure)

The specific Dimension to use for Expression .

Key -> (string)

The names of the metadata types that you can use to filter and group your results. For example, AZ returns a list of Availability Zones.

Values -> (list)

The metadata values that you can use to filter and group your results. You can use GetDimensionValues to find specific values.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .

(string)

Tags -> (structure)

The specific Tag to use for Expression .

Key -> (string)

The key for the tag.

Values -> (list)

The specific value of the tag.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to Cost Category. The default values for MatchOptions are EQUALS and CASE_SENSITIVE .

(string)

CostCategories -> (structure)

The filter that’s based on CostCategory values.

Key -> (string)

The unique name of the Cost Category.

Values -> (list)

The specific value of the Cost Category.

(string)

MatchOptions -> (list)

The match options that you can use to filter your results. MatchOptions is only applicable for actions related to cost category. The default values for MatchOptions is EQUALS and CASE_SENSITIVE .

(string)

JSON Syntax:

{
  "Or": [
    {
      "Or": [
        { ... recursive ... }
        ...
      ],
      "And": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Dimensions": {
        "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
      },
      "Tags": {
        "Key": "string",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
      },
      "CostCategories": {
        "Key": "string",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
      }
    }
    ...
  ],
  "And": [
    {
      "Or": [
        { ... recursive ... }
        ...
      ],
      "And": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Dimensions": {
        "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
      },
      "Tags": {
        "Key": "string",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
      },
      "CostCategories": {
        "Key": "string",
        "Values": ["string", ...],
        "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
      }
    }
    ...
  ],
  "Not": {
    "Or": [
      { ... recursive ... }
      ...
    ],
    "And": [
      { ... recursive ... }
      ...
    ],
    "Not": { ... recursive ... },
    "Dimensions": {
      "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY",
      "Values": ["string", ...],
      "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
    },
    "Tags": {
      "Key": "string",
      "Values": ["string", ...],
      "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
    },
    "CostCategories": {
      "Key": "string",
      "Values": ["string", ...],
      "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
    }
  },
  "Dimensions": {
    "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"LINKED_ACCOUNT_NAME"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"SERVICE_CODE"|"USAGE_TYPE"|"USAGE_TYPE_GROUP"|"RECORD_TYPE"|"OPERATING_SYSTEM"|"TENANCY"|"SCOPE"|"PLATFORM"|"SUBSCRIPTION_ID"|"LEGAL_ENTITY_NAME"|"DEPLOYMENT_OPTION"|"DATABASE_ENGINE"|"CACHE_ENGINE"|"INSTANCE_TYPE_FAMILY"|"BILLING_ENTITY"|"RESERVATION_ID"|"RESOURCE_ID"|"RIGHTSIZING_TYPE"|"SAVINGS_PLANS_TYPE"|"SAVINGS_PLAN_ARN"|"PAYMENT_OPTION"|"AGREEMENT_END_DATE_TIME_AFTER"|"AGREEMENT_END_DATE_TIME_BEFORE"|"INVOICING_ENTITY",
    "Values": ["string", ...],
    "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
  },
  "Tags": {
    "Key": "string",
    "Values": ["string", ...],
    "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
  },
  "CostCategories": {
    "Key": "string",
    "Values": ["string", ...],
    "MatchOptions": ["EQUALS"|"ABSENT"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CASE_SENSITIVE"|"CASE_INSENSITIVE", ...]
  }
}

--sort-by (structure)

The value by which you want to sort the data.

The following values are supported for Key :

UtilizationPercentage

UtilizationPercentageInUnits

PurchasedHours

PurchasedUnits

TotalActualHours

TotalActualUnits

UnusedHours

UnusedUnits

OnDemandCostOfRIHoursUsed

NetRISavings

TotalPotentialRISavings

AmortizedUpfrontFee

AmortizedRecurringFee

TotalAmortizedFee

RICostForUnusedHours

RealizedSavings

UnrealizedSavings

Supported values for SortOrder are ASCENDING or DESCENDING .

Key -> (string)

The key that’s used to sort the data.

SortOrder -> (string)

The order that’s used to sort the data.

Shorthand Syntax:

Key=string,SortOrder=string

JSON Syntax:

{
  "Key": "string",
  "SortOrder": "ASCENDING"|"DESCENDING"
}

--next-page-token (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.

--max-results (integer)

The maximum number of objects that you returned for this request. If more objects are available, in the response, Amazon Web Services provides a NextPageToken value that you can use in a subsequent call to get the next batch of objects.

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

See ‘aws help’ for descriptions of global parameters.

Examples¶

To retrieve the reservation utilization for your account

The following get-reservation-utilization example retrieves the RI utilization for all t2.nano instance types from 2018-03-01 to 2018-08-01 for the account.

aws ce get-reservation-utilization \
    --time-period Start=2018-03-01,End=2018-08-01 \
    --filter file://filters.json

Contents of filters.json:

{
    "Dimensions": {
        "Key": "INSTANCE_TYPE",
        "Values": [
            "t2.nano"
        ]
    }
}

Output:

{
    "Total": {
        "TotalAmortizedFee": "0",
        "UtilizationPercentage": "0",
        "PurchasedHours": "0",
        "NetRISavings": "0",
        "TotalActualHours": "0",
        "AmortizedRecurringFee": "0",
        "UnusedHours": "0",
        "TotalPotentialRISavings": "0",
        "OnDemandCostOfRIHoursUsed": "0",
        "AmortizedUpfrontFee": "0"
    },
    "UtilizationsByTime": []
}

Output¶

UtilizationsByTime -> (list)

The amount of time that you used your RIs.

(structure)

The amount of utilization, in hours.

TimePeriod -> (structure)

The period of time that this utilization was used for.

Start -> (string)

The beginning of the time period. The start date is inclusive. For example, if start is 2017-01-01 , Amazon Web Services retrieves cost and usage data starting at 2017-01-01 up to the end date. The start date must be equal to or no later than the current date to avoid a validation error.

End -> (string)

The end of the time period. The end date is exclusive. For example, if end is 2017-05-01 , Amazon Web Services retrieves cost and usage data from the start date up to, but not including, 2017-05-01 .

Groups -> (list)

The groups that this utilization result uses.

(structure)

A group of reservations that share a set of attributes.

Key -> (string)

The key for a specific reservation attribute.

Value -> (string)

The value of a specific reservation attribute.

Attributes -> (map)

The attributes for this group of reservations.

key -> (string)

value -> (string)

Utilization -> (structure)

How much you used this group of reservations.

UtilizationPercentage -> (string)

The percentage of reservation time that you used.

UtilizationPercentageInUnits -> (string)

The percentage of Amazon EC2 reservation time that you used. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

PurchasedHours -> (string)

How many reservation hours that you purchased.

PurchasedUnits -> (string)

The number of Amazon EC2 reservation hours that you purchased. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

TotalActualHours -> (string)

The total number of reservation hours that you used.

TotalActualUnits -> (string)

The total number of Amazon EC2 reservation hours that you used. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

UnusedHours -> (string)

The number of reservation hours that you didn’t use.

UnusedUnits -> (string)

The number of Amazon EC2 reservation hours that you didn’t use. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

OnDemandCostOfRIHoursUsed -> (string)

How much your reservation costs if charged On-Demand rates.

NetRISavings -> (string)

How much you saved due to purchasing and utilizing reservation. Amazon Web Services calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .

TotalPotentialRISavings -> (string)

How much you might save if you use your entire reservation.

AmortizedUpfrontFee -> (string)

The upfront cost of your reservation. It’s amortized over the reservation period.

AmortizedRecurringFee -> (string)

The monthly cost of your reservation. It’s amortized over the reservation period.

TotalAmortizedFee -> (string)

The total cost of your reservation. It’s amortized over the reservation period.

RICostForUnusedHours -> (string)

The cost of unused hours for your reservation.

RealizedSavings -> (string)

The realized savings because of purchasing and using a reservation.

UnrealizedSavings -> (string)

The unrealized savings because of purchasing and using a reservation.

Total -> (structure)

The total number of reservation hours that were used.

UtilizationPercentage -> (string)

The percentage of reservation time that you used.

UtilizationPercentageInUnits -> (string)

The percentage of Amazon EC2 reservation time that you used. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

PurchasedHours -> (string)

How many reservation hours that you purchased.

PurchasedUnits -> (string)

The number of Amazon EC2 reservation hours that you purchased. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

TotalActualHours -> (string)

The total number of reservation hours that you used.

TotalActualUnits -> (string)

The total number of Amazon EC2 reservation hours that you used. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

UnusedHours -> (string)

The number of reservation hours that you didn’t use.

UnusedUnits -> (string)

The number of Amazon EC2 reservation hours that you didn’t use. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

OnDemandCostOfRIHoursUsed -> (string)

How much your reservation costs if charged On-Demand rates.

NetRISavings -> (string)

How much you saved due to purchasing and utilizing reservation. Amazon Web Services calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .

TotalPotentialRISavings -> (string)

How much you might save if you use your entire reservation.

AmortizedUpfrontFee -> (string)

The upfront cost of your reservation. It’s amortized over the reservation period.

AmortizedRecurringFee -> (string)

The monthly cost of your reservation. It’s amortized over the reservation period.

TotalAmortizedFee -> (string)

The total cost of your reservation. It’s amortized over the reservation period.

RICostForUnusedHours -> (string)

The cost of unused hours for your reservation.

RealizedSavings -> (string)

The realized savings because of purchasing and using a reservation.

UnrealizedSavings -> (string)

The unrealized savings because of purchasing and using a reservation.

Total -> (structure)

The total amount of time that you used your RIs.

UtilizationPercentage -> (string)

The percentage of reservation time that you used.

UtilizationPercentageInUnits -> (string)

The percentage of Amazon EC2 reservation time that you used. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

PurchasedHours -> (string)

How many reservation hours that you purchased.

PurchasedUnits -> (string)

The number of Amazon EC2 reservation hours that you purchased. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

TotalActualHours -> (string)

The total number of reservation hours that you used.

TotalActualUnits -> (string)

The total number of Amazon EC2 reservation hours that you used. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

UnusedHours -> (string)

The number of reservation hours that you didn’t use.

UnusedUnits -> (string)

The number of Amazon EC2 reservation hours that you didn’t use. It’s converted to normalized units. Normalized units are available only for Amazon EC2 usage after November 11, 2017.

OnDemandCostOfRIHoursUsed -> (string)

How much your reservation costs if charged On-Demand rates.

NetRISavings -> (string)

How much you saved due to purchasing and utilizing reservation. Amazon Web Services calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .

TotalPotentialRISavings -> (string)

How much you might save if you use your entire reservation.

AmortizedUpfrontFee -> (string)

The upfront cost of your reservation. It’s amortized over the reservation period.

AmortizedRecurringFee -> (string)

The monthly cost of your reservation. It’s amortized over the reservation period.

TotalAmortizedFee -> (string)

The total cost of your reservation. It’s amortized over the reservation period.

RICostForUnusedHours -> (string)

The cost of unused hours for your reservation.

RealizedSavings -> (string)

The realized savings because of purchasing and using a reservation.

UnrealizedSavings -> (string)

The unrealized savings because of purchasing and using a reservation.

NextPageToken -> (string)

The token for the next set of retrievable 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

get-reservation-utilization¶

Description¶

Synopsis¶

Options¶

Examples¶

Output¶