Class CapacityReservationSummary
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CapacityReservationSummary.Builder,CapacityReservationSummary>
Summary information about a SageMaker Capacity Reservation.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe name of the Availability Zone of the reserved instances, for exampleus-east-1a.final StringThe ID of the Availability Zone of the reserved instances, for exampleuse1-az1.builder()final InstantThe time when the SageMaker Capacity Reservation was created.final InstantendTime()The time when the SageMaker Capacity Reservation ends.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final StringThe SageMaker AI instance type of the reserved instances, for exampleml.p5.48xlarge.final Stringowner()The ID of the Amazon Web Services account that owns the SageMaker Capacity Reservation.static Class<? extends CapacityReservationSummary.Builder> final StringThe Amazon Resource Name (ARN) of the SageMaker Capacity Reservation.final StringThe ID of the SageMaker Capacity Reservation.final InstantThe time when the reserved instances become available.status()The status of the SageMaker Capacity Reservation.final StringThe status of the SageMaker Capacity Reservation.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final IntegerThe number of instances in the SageMaker Capacity Reservation.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
smCapacityReservationArn
The Amazon Resource Name (ARN) of the SageMaker Capacity Reservation.
- Returns:
- The Amazon Resource Name (ARN) of the SageMaker Capacity Reservation.
-
smCapacityReservationId
The ID of the SageMaker Capacity Reservation. The ID is the last part of the ARN and starts with
smcr-.- Returns:
- The ID of the SageMaker Capacity Reservation. The ID is the last part of the ARN and starts with
smcr-.
-
owner
The ID of the Amazon Web Services account that owns the SageMaker Capacity Reservation.
- Returns:
- The ID of the Amazon Web Services account that owns the SageMaker Capacity Reservation.
-
status
The status of the SageMaker Capacity Reservation. SageMaker AI sets the status from the start and end times of the reservation. Valid values:
- Scheduled
-
The current time is before
StartTime. - Active
-
The current time is between
StartTimeandEndTime. You can use the reserved instances. - Expired
-
The current time is at or after
EndTime.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnCapacityReservationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the SageMaker Capacity Reservation. SageMaker AI sets the status from the start and end
times of the reservation. Valid values:
- Scheduled
-
The current time is before
StartTime. - Active
-
The current time is between
StartTimeandEndTime. You can use the reserved instances. - Expired
-
The current time is at or after
EndTime.
- See Also:
-
statusAsString
The status of the SageMaker Capacity Reservation. SageMaker AI sets the status from the start and end times of the reservation. Valid values:
- Scheduled
-
The current time is before
StartTime. - Active
-
The current time is between
StartTimeandEndTime. You can use the reserved instances. - Expired
-
The current time is at or after
EndTime.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnCapacityReservationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the SageMaker Capacity Reservation. SageMaker AI sets the status from the start and end
times of the reservation. Valid values:
- Scheduled
-
The current time is before
StartTime. - Active
-
The current time is between
StartTimeandEndTime. You can use the reserved instances. - Expired
-
The current time is at or after
EndTime.
- See Also:
-
instanceType
The SageMaker AI instance type of the reserved instances, for example
ml.p5.48xlarge.- Returns:
- The SageMaker AI instance type of the reserved instances, for example
ml.p5.48xlarge.
-
availabilityZone
The name of the Availability Zone of the reserved instances, for example
us-east-1a. Availability Zone names can map to different physical zones in different accounts. To identify the same zone across accounts, useAvailabilityZoneId.- Returns:
- The name of the Availability Zone of the reserved instances, for example
us-east-1a. Availability Zone names can map to different physical zones in different accounts. To identify the same zone across accounts, useAvailabilityZoneId.
-
availabilityZoneId
The ID of the Availability Zone of the reserved instances, for example
use1-az1. An Availability Zone ID identifies the same physical zone in every account.- Returns:
- The ID of the Availability Zone of the reserved instances, for example
use1-az1. An Availability Zone ID identifies the same physical zone in every account.
-
totalInstanceCount
The number of instances in the SageMaker Capacity Reservation.
- Returns:
- The number of instances in the SageMaker Capacity Reservation.
-
startTime
The time when the reserved instances become available.
- Returns:
- The time when the reserved instances become available.
-
endTime
The time when the SageMaker Capacity Reservation ends. This value is not returned if the reservation has no end time.
- Returns:
- The time when the SageMaker Capacity Reservation ends. This value is not returned if the reservation has no end time.
-
creationTime
The time when the SageMaker Capacity Reservation was created.
- Returns:
- The time when the SageMaker Capacity Reservation was created.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<CapacityReservationSummary.Builder,CapacityReservationSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-