Skip to content

CapacityManagerDimension

Source code in docs_src/capo_ec2/types/capacity_manager_dimension.py
class CapacityManagerDimension(TypedDict, closed=True):
    resource_region: NotRequired["capo_ec2.types.string.String"]
    """<p> The Amazon Web Services Region where the capacity resource is located. </p>"""
    availability_zone_id: NotRequired["capo_ec2.types.string.String"]
    """<p> The unique identifier of the Availability Zone where the capacity resource is located. </p>"""
    account_id: NotRequired["capo_ec2.types.string.String"]
    """<p> The Amazon Web Services account ID that owns the capacity resource. </p>"""
    account_name: NotRequired["capo_ec2.types.string.String"]
    """<p> The name of the Amazon Web Services account that owns the capacity resource. This dimension is only available when Organizations access is enabled for Capacity Manager. </p>"""
    instance_family: NotRequired["capo_ec2.types.string.String"]
    """<p> The EC2 instance family of the capacity resource. </p>"""
    instance_type: NotRequired["capo_ec2.types.string.String"]
    """<p> The specific EC2 instance type of the capacity resource. </p>"""
    instance_platform: NotRequired["capo_ec2.types.string.String"]
    """<p> The platform or operating system of the instance. </p>"""
    reservation_arn: NotRequired["capo_ec2.types.string.String"]
    """<p> The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation. </p>"""
    reservation_id: NotRequired["capo_ec2.types.string.String"]
    """<p> The unique identifier of the capacity reservation. </p>"""
    reservation_type: NotRequired["capo_ec2.types.reservation_type.ReservationType"]
    """<p> The type of capacity reservation. </p>"""
    reservation_create_timestamp: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p> 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. </p>"""
    reservation_start_timestamp: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p> The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity. </p>"""
    reservation_end_timestamp: NotRequired[
        "capo_ec2.types.millisecond_date_time.MillisecondDateTime"
    ]
    """<p> 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. </p>"""
    reservation_end_date_type: NotRequired[
        "capo_ec2.types.reservation_end_date_type.ReservationEndDateType"
    ]
    """<p> 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. </p>"""
    tenancy: NotRequired["capo_ec2.types.capacity_tenancy.CapacityTenancy"]
    """<p> 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. </p>"""
    reservation_state: NotRequired["capo_ec2.types.reservation_state.ReservationState"]
    """<p> The current state of the capacity reservation. </p>"""
    reservation_instance_match_criteria: NotRequired["capo_ec2.types.string.String"]
    """<p> The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation. </p>"""
    reservation_unused_financial_owner: NotRequired["capo_ec2.types.string.String"]
    """<p> The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs. </p>"""
    tags: NotRequired[
        "capo_ec2.types.capacity_manager_tag_dimension_set.CapacityManagerTagDimensionSet"
    ]
    """<p> The tags associated with the capacity resource, represented as key-value pairs. Only tags that have been activated for monitoring via <code>UpdateCapacityManagerMonitoredTagKeys</code> are included. </p>"""

account_id instance-attribute

account_id: NotRequired[String]

The Amazon Web Services account ID that owns the capacity resource.

account_name instance-attribute

account_name: NotRequired[String]

The name of the Amazon Web Services account that owns the capacity resource. This dimension is only available when Organizations access is enabled for Capacity Manager.

availability_zone_id instance-attribute

availability_zone_id: NotRequired[String]

The unique identifier of the Availability Zone where the capacity resource is located.

instance_family instance-attribute

instance_family: NotRequired[String]

The EC2 instance family of the capacity resource.

instance_platform instance-attribute

instance_platform: NotRequired[String]

The platform or operating system of the instance.

instance_type instance-attribute

instance_type: NotRequired[String]

The specific EC2 instance type of the capacity resource.

reservation_arn instance-attribute

reservation_arn: NotRequired[String]

The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across Amazon Web Services services to reference the specific reservation.

reservation_create_timestamp instance-attribute

reservation_create_timestamp: NotRequired[MillisecondDateTime]

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.

reservation_end_date_type instance-attribute

reservation_end_date_type: NotRequired[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.

reservation_end_timestamp instance-attribute

reservation_end_timestamp: NotRequired[MillisecondDateTime]

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.

reservation_id instance-attribute

reservation_id: NotRequired[String]

The unique identifier of the capacity reservation.

reservation_instance_match_criteria instance-attribute

reservation_instance_match_criteria: NotRequired[String]

The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.

reservation_start_timestamp instance-attribute

reservation_start_timestamp: NotRequired[MillisecondDateTime]

The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.

reservation_state instance-attribute

reservation_state: NotRequired[ReservationState]

The current state of the capacity reservation.

reservation_type instance-attribute

reservation_type: NotRequired[ReservationType]

The type of capacity reservation.

reservation_unused_financial_owner instance-attribute

reservation_unused_financial_owner: NotRequired[String]

The Amazon Web Services account ID that is financially responsible for unused capacity reservation costs.

resource_region instance-attribute

resource_region: NotRequired[String]

The Amazon Web Services Region where the capacity resource is located.

tags instance-attribute

tags: NotRequired[CapacityManagerTagDimensionSet]

The tags associated with the capacity resource, represented as key-value pairs. Only tags that have been activated for monitoring via UpdateCapacityManagerMonitoredTagKeys are included.

tenancy instance-attribute

tenancy: NotRequired[CapacityTenancy]

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.