Package software.amazon.awssdk.services.ec2.model

Class GetCapacityReservationUsageResponse

    • Method Detail

      • nextToken

        public final String nextToken()

        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

        Returns:
        The token to use to retrieve the next page of results. This value is null when there are no more results to return.

      • capacityReservationId

        public final String capacityReservationId()

        The ID of the Capacity Reservation.

        Returns:
        The ID of the Capacity Reservation.

      • instanceType

        public final String instanceType()

        The type of instance for which the Capacity Reservation reserves capacity.

        Returns:
        The type of instance for which the Capacity Reservation reserves capacity.

      • totalInstanceCount

        public final Integer totalInstanceCount()

        The number of instances for which the Capacity Reservation reserves capacity.

        Returns:
        The number of instances for which the Capacity Reservation reserves capacity.

      • availableInstanceCount

        public final Integer availableInstanceCount()

        The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

        Returns:
        The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.

      • state

        public final CapacityReservationState state()

        The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

        • active - The capacity is available for use.

        • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.

        • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.

        • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

        • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.

        • scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.

        • payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.

        • payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.

        • assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.

        • delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.

        • unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

        If the service returns an enum value that is not available in the current SDK version, state will return CapacityReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

        Returns:
        The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

        • active - The capacity is available for use.

        • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.

        • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.

        • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

        • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.

        • scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.

        • payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.

        • payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.

        • assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.

        • delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.

        • unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

        See Also:
        CapacityReservationState

      • stateAsString

        public final String stateAsString()

        The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

        • active - The capacity is available for use.

        • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.

        • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.

        • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

        • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.

        • scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.

        • payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.

        • payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.

        • assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.

        • delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.

        • unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

        If the service returns an enum value that is not available in the current SDK version, state will return CapacityReservationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

        Returns:
        The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:

        • active - The capacity is available for use.

        • expired - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use.

        • cancelled - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use.

        • pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.

        • failed - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes.

        • scheduled - (Future-dated Capacity Reservations) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date.

        • payment-pending - (Capacity Blocks) The upfront payment has not been processed yet.

        • payment-failed - (Capacity Blocks) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released.

        • assessing - (Future-dated Capacity Reservations) Amazon EC2 is assessing your request for a future-dated Capacity Reservation.

        • delayed - (Future-dated Capacity Reservations) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time.

        • unsupported - (Future-dated Capacity Reservations) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered.

        See Also:
        CapacityReservationState

      • hasInstanceUsages

        public final boolean hasInstanceUsages()
        For responses, this returns true if the service returned a value for the InstanceUsages property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

      • instanceUsages

        public final List<InstanceUsage> instanceUsages()

        Information about the Capacity Reservation usage.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasInstanceUsages() method.

        Returns:
        Information about the Capacity Reservation usage.

      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object