Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ce ]

get-reservation-utilization

Description

Retrieves the reservation utilization for your account. Master accounts 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 .

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--time-period (structure)

Sets the start and end dates for retrieving Reserved Instance (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 .

Shorthand Syntax:

Start=string,End=string

JSON Syntax:

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

--group-by (list)

Groups only by SUBSCRIPTION_ID . Metadata is included.

Shorthand Syntax:

Type=string,Key=string ...

JSON Syntax:

[
  {
    "Type": "DIMENSION"|"TAG",
    "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 .

Possible values:

  • DAILY
  • MONTHLY
  • HOURLY

--filter (structure)

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

  • AZ
  • CACHE_ENGINE
  • DATABASE_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.

JSON Syntax:

{
  "Or": [
    {
      "Or": [
        { ... recursive ... }
        ...
      ],
      "And": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Dimensions": {
        "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"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",
        "Values": ["string", ...]
      },
      "Tags": {
        "Key": "string",
        "Values": ["string", ...]
      }
    }
    ...
  ],
  "And": [
    {
      "Or": [
        { ... recursive ... }
        ...
      ],
      "And": [
        { ... recursive ... }
        ...
      ],
      "Not": { ... recursive ... },
      "Dimensions": {
        "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"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",
        "Values": ["string", ...]
      },
      "Tags": {
        "Key": "string",
        "Values": ["string", ...]
      }
    }
    ...
  ],
  "Not": {
    "Or": [
      { ... recursive ... }
      ...
    ],
    "And": [
      { ... recursive ... }
      ...
    ],
    "Not": { ... recursive ... },
    "Dimensions": {
      "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"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",
      "Values": ["string", ...]
    },
    "Tags": {
      "Key": "string",
      "Values": ["string", ...]
    }
  },
  "Dimensions": {
    "Key": "AZ"|"INSTANCE_TYPE"|"LINKED_ACCOUNT"|"OPERATION"|"PURCHASE_TYPE"|"REGION"|"SERVICE"|"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",
    "Values": ["string", ...]
  },
  "Tags": {
    "Key": "string",
    "Values": ["string", ...]
  }
}

--next-page-token (string)

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

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

See 'aws help' for descriptions of global parameters.

Output

UtilizationsByTime -> (list)

The amount of time that you utilized your RIs.

(structure)

The amount of utilization, in hours.

TimePeriod -> (structure)

The period of time over which this utilization was used.

Start -> (string)

The beginning of the time period that you want the usage and costs for. The start date is inclusive. For example, if start is 2017-01-01 , AWS retrieves cost and usage data starting at 2017-01-01 up to the end date.

End -> (string)

The end of the time period that you want the usage and costs for. The end date is exclusive. For example, if end is 2017-05-01 , AWS retrieves cost and usage data from the start date up to, but not including, 2017-05-01 .

Groups -> (list)

The groups that are included in this utilization result.

(structure)

A group of Reserved Instances (RIs) that share a set of attributes.

Key -> (string)

The key for a specific RI attribute.

Value -> (string)

The value of a specific RI attribute.

Attributes -> (map)

The attributes for this group of RIs.

key -> (string)

value -> (string)

Utilization -> (structure)

How much you used this group of RIs.

UtilizationPercentage -> (string)

The percentage of RI time that you used.

PurchasedHours -> (string)

How many RI hours that you purchased.

TotalActualHours -> (string)

The total number of RI hours that you used.

UnusedHours -> (string)

The number of RI hours that you didn't use.

OnDemandCostOfRIHoursUsed -> (string)

How much your RIs would cost if charged On-Demand rates.

NetRISavings -> (string)

How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .

TotalPotentialRISavings -> (string)

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

AmortizedUpfrontFee -> (string)

The upfront cost of your RI, amortized over the RI period.

AmortizedRecurringFee -> (string)

The monthly cost of your RI, amortized over the RI period.

TotalAmortizedFee -> (string)

The total cost of your RI, amortized over the RI period.

Total -> (structure)

The total number of RI hours that were used.

UtilizationPercentage -> (string)

The percentage of RI time that you used.

PurchasedHours -> (string)

How many RI hours that you purchased.

TotalActualHours -> (string)

The total number of RI hours that you used.

UnusedHours -> (string)

The number of RI hours that you didn't use.

OnDemandCostOfRIHoursUsed -> (string)

How much your RIs would cost if charged On-Demand rates.

NetRISavings -> (string)

How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .

TotalPotentialRISavings -> (string)

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

AmortizedUpfrontFee -> (string)

The upfront cost of your RI, amortized over the RI period.

AmortizedRecurringFee -> (string)

The monthly cost of your RI, amortized over the RI period.

TotalAmortizedFee -> (string)

The total cost of your RI, amortized over the RI period.

Total -> (structure)

The total amount of time that you utilized your RIs.

UtilizationPercentage -> (string)

The percentage of RI time that you used.

PurchasedHours -> (string)

How many RI hours that you purchased.

TotalActualHours -> (string)

The total number of RI hours that you used.

UnusedHours -> (string)

The number of RI hours that you didn't use.

OnDemandCostOfRIHoursUsed -> (string)

How much your RIs would cost if charged On-Demand rates.

NetRISavings -> (string)

How much you saved due to purchasing and utilizing RIs. AWS calculates this by subtracting TotalAmortizedFee from OnDemandCostOfRIHoursUsed .

TotalPotentialRISavings -> (string)

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

AmortizedUpfrontFee -> (string)

The upfront cost of your RI, amortized over the RI period.

AmortizedRecurringFee -> (string)

The monthly cost of your RI, amortized over the RI period.

TotalAmortizedFee -> (string)

The total cost of your RI, amortized over the RI period.

NextPageToken -> (string)

The token for the next set of retrievable results. AWS provides the token when the response from a previous call has more results than the maximum page size.