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

You can retrieve the Reservation utilization for your account. Master accounts in an organization have access to their associated member accounts. You can filter data by dimensions in a time period. You can use get-dimension-values 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 reserve 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 SubscriptionId . Metadata is included.

Shorthand Syntax:

Type=string,Key=string ...

JSON Syntax:

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

--granularity (string)

Sets the AWS cost granularity to MONTHLY or DAILY . If both GroupBy and granularity are not set, get-reservation-utilization defaults to DAILY . If GroupBy is set, granularity can't be set, and the response object doesn't include MONTHLY or DAILY granularity.

Possible values:

  • DAILY
  • MONTHLY

--filter (structure)

Filters utilization data by using different dimensions. get-reservation-utilization uses the same filter 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",
        "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",
        "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",
      "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",
    "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.

--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 , then the cost and usage data is retrieved 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 the end is 2017-05-01 , then the cost and usage data is retrieved from the start date but not including 2017-05-01 .

Groups -> (list)

The groups that are included in this utilization result.

(structure)

A group of 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 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.

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

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

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.