CapacityManagerDimension
Represents dimension values for capacity metrics, including resource identifiers, geographic information, and reservation details used for grouping and filtering capacity data.
Contents
- accountId
-
The AWS account ID that owns the capacity resource.
Type: String
Required: No
- availabilityZoneId
-
The unique identifier of the Availability Zone where the capacity resource is located.
Type: String
Required: No
- instanceFamily
-
The EC2 instance family of the capacity resource.
Type: String
Required: No
- instancePlatform
-
The platform or operating system of the instance.
Type: String
Required: No
- instanceType
-
The specific EC2 instance type of the capacity resource.
Type: String
Required: No
- reservationArn
-
The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across AWS services to reference the specific reservation.
Type: String
Required: No
- reservationCreateTimestamp
-
The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.
Type: Timestamp
Required: No
- reservationEndDateType
-
The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.
Type: String
Valid Values:
limited | unlimitedRequired: No
- reservationEndTimestamp
-
The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.
Type: Timestamp
Required: No
- reservationId
-
The unique identifier of the capacity reservation.
Type: String
Required: No
- reservationInstanceMatchCriteria
-
The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.
Type: String
Required: No
- reservationStartTimestamp
-
The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.
Type: Timestamp
Required: No
- reservationState
-
The current state of the capacity reservation.
Type: String
Valid Values:
active | expired | cancelled | scheduled | pending | failed | delayed | unsupported | payment-pending | payment-failed | retiredRequired: No
- reservationType
-
The type of capacity reservation.
Type: String
Valid Values:
capacity-block | odcrRequired: No
- reservationUnusedFinancialOwner
-
The AWS account ID that is financially responsible for unused capacity reservation costs.
Type: String
Required: No
- resourceRegion
-
The AWS Region where the capacity resource is located.
Type: String
Required: No
- tenancy
-
The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.
Type: String
Valid Values:
default | dedicatedRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
