Skip to content

Retrieves the available dimension values for capacity metrics within a specified time range

Description

Retrieves the available dimension values for capacity metrics within a specified time range. This is useful for discovering what accounts, regions, instance families, and other dimensions have data available for filtering and grouping.

Usage

ec2_get_capacity_manager_metric_dimensions(GroupBy, FilterBy, StartTime,
  EndTime, MetricNames, MaxResults, NextToken, DryRun)

Arguments

  • GroupBy

    [required] The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter.

  • FilterBy

    Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against.

  • StartTime

    [required] The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

  • EndTime

    [required] The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned.

  • MetricNames

    [required] The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1.

  • MaxResults

    The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination.

  • NextToken

    The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values.

  • DryRun

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Value

A list with the following syntax:

list(
  MetricDimensionResults = list(
    list(
      ResourceRegion = "string",
      AvailabilityZoneId = "string",
      AccountId = "string",
      AccountName = "string",
      InstanceFamily = "string",
      InstanceType = "string",
      InstancePlatform = "string",
      ReservationArn = "string",
      ReservationId = "string",
      ReservationType = "capacity-block"|"odcr",
      ReservationCreateTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ReservationStartTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ReservationEndTimestamp = as.POSIXct(
        "2015-01-01"
      ),
      ReservationEndDateType = "limited"|"unlimited",
      Tenancy = "default"|"dedicated",
      ReservationState = "active"|"expired"|"cancelled"|"scheduled"|"pending"|"failed"|"delayed"|"unsupported"|"payment-pending"|"payment-failed"|"retired",
      ReservationInstanceMatchCriteria = "string",
      ReservationUnusedFinancialOwner = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$get_capacity_manager_metric_dimensions(
  GroupBy = list(
    "resource-region"|"availability-zone-id"|"account-id"|"account-name"|"instance-family"|"instance-type"|"instance-platform"|"reservation-arn"|"reservation-id"|"reservation-type"|"reservation-create-timestamp"|"reservation-start-timestamp"|"reservation-end-timestamp"|"reservation-end-date-type"|"tenancy"|"reservation-state"|"reservation-instance-match-criteria"|"reservation-unused-financial-owner"
  ),
  FilterBy = list(
    list(
      DimensionCondition = list(
        Dimension = "resource-region"|"availability-zone-id"|"account-id"|"account-name"|"instance-family"|"instance-type"|"instance-platform"|"reservation-arn"|"reservation-id"|"reservation-type"|"reservation-create-timestamp"|"reservation-start-timestamp"|"reservation-end-timestamp"|"reservation-end-date-type"|"tenancy"|"reservation-state"|"reservation-instance-match-criteria"|"reservation-unused-financial-owner",
        Comparison = "equals"|"in",
        Values = list(
          "string"
        )
      )
    )
  ),
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  MetricNames = list(
    "reservation-total-capacity-hrs-vcpu"|"reservation-total-capacity-hrs-inst"|"reservation-max-size-vcpu"|"reservation-max-size-inst"|"reservation-min-size-vcpu"|"reservation-min-size-inst"|"reservation-unused-total-capacity-hrs-vcpu"|"reservation-unused-total-capacity-hrs-inst"|"reservation-unused-total-estimated-cost"|"reservation-max-unused-size-vcpu"|"reservation-max-unused-size-inst"|"reservation-min-unused-size-vcpu"|"reservation-min-unused-size-inst"|"reservation-max-utilization"|"reservation-min-utilization"|"reservation-avg-utilization-vcpu"|"reservation-avg-utilization-inst"|"reservation-total-count"|"reservation-total-estimated-cost"|"reservation-avg-future-size-vcpu"|"reservation-avg-future-size-inst"|"reservation-min-future-size-vcpu"|"reservation-min-future-size-inst"|"reservation-max-future-size-vcpu"|"reservation-max-future-size-inst"|"reservation-avg-committed-size-vcpu"|"reservation-avg-committed-size-inst"|"reservation-max-committed-size-vcpu"|"reservation-max-committed-size-inst"|"reservation-min-committed-size-vcpu"|"reservation-min-committed-size-inst"|"reserved-total-usage-hrs-vcpu"|"reserved-total-usage-hrs-inst"|"reserved-total-estimated-cost"|"unreserved-total-usage-hrs-vcpu"|"unreserved-total-usage-hrs-inst"|"unreserved-total-estimated-cost"|"spot-total-usage-hrs-vcpu"|"spot-total-usage-hrs-inst"|"spot-total-estimated-cost"|"spot-avg-run-time-before-interruption-inst"|"spot-max-run-time-before-interruption-inst"|"spot-min-run-time-before-interruption-inst"|"spot-total-interruptions-inst"|"spot-total-interruptions-vcpu"|"spot-total-count-inst"|"spot-total-count-vcpu"|"spot-interruption-rate-inst"|"spot-interruption-rate-vcpu"
  ),
  MaxResults = 123,
  NextToken = "string",
  DryRun = TRUE|FALSE
)