Class CapacityReservationEndpointsAssociation
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<CapacityReservationEndpointsAssociation.Builder,CapacityReservationEndpointsAssociation>
The association between the SageMaker AI endpoints in your account and a SageMaker Capacity Reservation, through one
ML capacity reservation. To use the reserved instances for an endpoint, specify the ML capacity reservation ARN in
the MlReservationArn field of ProductionVariantCapacityReservationConfig when you call
CreateEndpointConfig.
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface -
Method Summary
Modifier and TypeMethodDescriptionfinal InstantThe time when SageMaker AI started the current association.builder()Whether one endpoint or multiple endpoints can use the ML capacity reservation.final StringWhether one endpoint or multiple endpoints can use the ML capacity reservation.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final StringThe reason that the most recent attempt to add or remove the association failed.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()How endpoints in your account match the ML capacity reservation.final StringHow endpoints in your account match the ML capacity reservation.final StringThe Amazon Resource Name (ARN) of the ML capacity reservation.final StringThe name of the ML capacity reservation.static Class<? extends CapacityReservationEndpointsAssociation.Builder> status()The status of the association.final StringThe status of the association.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.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
mlReservationId
The name of the ML capacity reservation. The name is the last part of the ML capacity reservation ARN.
- Returns:
- The name of the ML capacity reservation. The name is the last part of the ML capacity reservation ARN.
-
status
The status of the association. Valid values:
- Pending
-
SageMaker AI is adding or removing the association.
- Active
-
The resources are associated with the SageMaker Capacity Reservation and can use its instances.
- Inactive
-
The resources are not associated with the SageMaker Capacity Reservation.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnCapacityReservationOptInStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the association. Valid values:
- Pending
-
SageMaker AI is adding or removing the association.
- Active
-
The resources are associated with the SageMaker Capacity Reservation and can use its instances.
- Inactive
-
The resources are not associated with the SageMaker Capacity Reservation.
- See Also:
-
statusAsString
The status of the association. Valid values:
- Pending
-
SageMaker AI is adding or removing the association.
- Active
-
The resources are associated with the SageMaker Capacity Reservation and can use its instances.
- Inactive
-
The resources are not associated with the SageMaker Capacity Reservation.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnCapacityReservationOptInStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the association. Valid values:
- Pending
-
SageMaker AI is adding or removing the association.
- Active
-
The resources are associated with the SageMaker Capacity Reservation and can use its instances.
- Inactive
-
The resources are not associated with the SageMaker Capacity Reservation.
- See Also:
-
matchCriteria
How endpoints in your account match the ML capacity reservation. Valid values:
- Open
-
Endpoints in your account use the ML capacity reservation automatically when their instance type matches. You don't specify the ML capacity reservation ARN when you create the endpoint.
- Targeted
-
An endpoint uses the ML capacity reservation only when you specify its ARN when you create or update the endpoint.
If the service returns an enum value that is not available in the current SDK version,
matchCriteriawill returnCapacityReservationMatchCriteria.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommatchCriteriaAsString().- Returns:
- How endpoints in your account match the ML capacity reservation. Valid values:
- Open
-
Endpoints in your account use the ML capacity reservation automatically when their instance type matches. You don't specify the ML capacity reservation ARN when you create the endpoint.
- Targeted
-
An endpoint uses the ML capacity reservation only when you specify its ARN when you create or update the endpoint.
- See Also:
-
matchCriteriaAsString
How endpoints in your account match the ML capacity reservation. Valid values:
- Open
-
Endpoints in your account use the ML capacity reservation automatically when their instance type matches. You don't specify the ML capacity reservation ARN when you create the endpoint.
- Targeted
-
An endpoint uses the ML capacity reservation only when you specify its ARN when you create or update the endpoint.
If the service returns an enum value that is not available in the current SDK version,
matchCriteriawill returnCapacityReservationMatchCriteria.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frommatchCriteriaAsString().- Returns:
- How endpoints in your account match the ML capacity reservation. Valid values:
- Open
-
Endpoints in your account use the ML capacity reservation automatically when their instance type matches. You don't specify the ML capacity reservation ARN when you create the endpoint.
- Targeted
-
An endpoint uses the ML capacity reservation only when you specify its ARN when you create or update the endpoint.
- See Also:
-
endpointSharing
Whether one endpoint or multiple endpoints can use the ML capacity reservation. Valid values:
- SingleEndpoint
-
Only one endpoint can use the ML capacity reservation.
- MultipleEndpoints
-
Multiple endpoints can use the ML capacity reservation.
If the service returns an enum value that is not available in the current SDK version,
endpointSharingwill returnCapacityReservationEndpointSharing.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromendpointSharingAsString().- Returns:
- Whether one endpoint or multiple endpoints can use the ML capacity reservation. Valid values:
- SingleEndpoint
-
Only one endpoint can use the ML capacity reservation.
- MultipleEndpoints
-
Multiple endpoints can use the ML capacity reservation.
- See Also:
-
endpointSharingAsString
Whether one endpoint or multiple endpoints can use the ML capacity reservation. Valid values:
- SingleEndpoint
-
Only one endpoint can use the ML capacity reservation.
- MultipleEndpoints
-
Multiple endpoints can use the ML capacity reservation.
If the service returns an enum value that is not available in the current SDK version,
endpointSharingwill returnCapacityReservationEndpointSharing.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromendpointSharingAsString().- Returns:
- Whether one endpoint or multiple endpoints can use the ML capacity reservation. Valid values:
- SingleEndpoint
-
Only one endpoint can use the ML capacity reservation.
- MultipleEndpoints
-
Multiple endpoints can use the ML capacity reservation.
- See Also:
-
mlReservationArn
The Amazon Resource Name (ARN) of the ML capacity reservation. Specify this ARN in
CreateEndpointConfigto use the reserved instances for an endpoint. For a new ML capacity reservation, this value is returned when the status isActive.- Returns:
- The Amazon Resource Name (ARN) of the ML capacity reservation. Specify this ARN in
CreateEndpointConfigto use the reserved instances for an endpoint. For a new ML capacity reservation, this value is returned when the status isActive.
-
failureReason
The reason that the most recent attempt to add or remove the association failed. This value is returned only when the most recent attempt failed. After a failure to add the association, the status is
Inactive. After a failure to remove the association, the status isActive.- Returns:
- The reason that the most recent attempt to add or remove the association failed. This value is returned
only when the most recent attempt failed. After a failure to add the association, the status is
Inactive. After a failure to remove the association, the status isActive.
-
associatedTime
The time when SageMaker AI started the current association. This time resets when you add the association again after it was removed or after it failed.
- Returns:
- The time when SageMaker AI started the current association. This time resets when you add the association again after it was removed or after it failed.
-
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<CapacityReservationEndpointsAssociation.Builder,CapacityReservationEndpointsAssociation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
public static Class<? extends CapacityReservationEndpointsAssociation.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.
-