Class DescribeEndpointResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeEndpointResponse.Builder,
DescribeEndpointResponse>
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal AsyncInferenceConfig
Returns the description of an endpoint configuration created using theCreateEndpointConfig
API.builder()
final Instant
A timestamp that shows when the endpoint was created.final DataCaptureConfigSummary
Returns the value of the DataCaptureConfig property for this object.final String
The Amazon Resource Name (ARN) of the endpoint.final String
The name of the endpoint configuration associated with this endpoint.final String
Name of the endpoint.final EndpointStatus
The status of the endpoint.final String
The status of the endpoint.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExplainerConfig
The configuration parameters for an explainer.final String
If the status of the endpoint isFailed
, the reason why it failed.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ProductionVariants property.final boolean
For responses, this returns true if the service returned a value for the ShadowProductionVariants property.final DeploymentConfig
The most recent deployment configuration for the endpoint.final Instant
A timestamp that shows when the endpoint was last modified.final PendingDeploymentSummary
Returns the summary of an in-progress deployment.final List
<ProductionVariantSummary> An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.static Class
<? extends DescribeEndpointResponse.Builder> final List
<ProductionVariantSummary> An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified onProductionVariants
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
endpointName
-
endpointArn
The Amazon Resource Name (ARN) of the endpoint.
- Returns:
- The Amazon Resource Name (ARN) of the endpoint.
-
endpointConfigName
The name of the endpoint configuration associated with this endpoint.
- Returns:
- The name of the endpoint configuration associated with this endpoint.
-
hasProductionVariants
public final boolean hasProductionVariants()For responses, this returns true if the service returned a value for the ProductionVariants property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
productionVariants
An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
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
hasProductionVariants()
method.- Returns:
- An array of ProductionVariantSummary objects, one for each model hosted behind this endpoint.
-
dataCaptureConfig
Returns the value of the DataCaptureConfig property for this object.- Returns:
- The value of the DataCaptureConfig property for this object.
-
endpointStatus
The status of the endpoint.
-
OutOfService
: Endpoint is not available to take incoming requests. -
Creating
: CreateEndpoint is executing. -
Updating
: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating
: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack
: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInService
status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService
: Endpoint is available to process incoming requests. -
Deleting
: DeleteEndpoint is executing. -
Failed
: Endpoint could not be created, updated, or re-scaled. Use theFailureReason
value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint. -
UpdateRollbackFailed
: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status toInService
, see Rolling Deployments.
If the service returns an enum value that is not available in the current SDK version,
endpointStatus
will returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointStatusAsString()
.- Returns:
- The status of the endpoint.
-
OutOfService
: Endpoint is not available to take incoming requests. -
Creating
: CreateEndpoint is executing. -
Updating
: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating
: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack
: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInService
status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService
: Endpoint is available to process incoming requests. -
Deleting
: DeleteEndpoint is executing. -
Failed
: Endpoint could not be created, updated, or re-scaled. Use theFailureReason
value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint. -
UpdateRollbackFailed
: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status toInService
, see Rolling Deployments.
-
- See Also:
-
-
endpointStatusAsString
The status of the endpoint.
-
OutOfService
: Endpoint is not available to take incoming requests. -
Creating
: CreateEndpoint is executing. -
Updating
: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating
: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack
: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInService
status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService
: Endpoint is available to process incoming requests. -
Deleting
: DeleteEndpoint is executing. -
Failed
: Endpoint could not be created, updated, or re-scaled. Use theFailureReason
value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint. -
UpdateRollbackFailed
: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status toInService
, see Rolling Deployments.
If the service returns an enum value that is not available in the current SDK version,
endpointStatus
will returnEndpointStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromendpointStatusAsString()
.- Returns:
- The status of the endpoint.
-
OutOfService
: Endpoint is not available to take incoming requests. -
Creating
: CreateEndpoint is executing. -
Updating
: UpdateEndpoint or UpdateEndpointWeightsAndCapacities is executing. -
SystemUpdating
: Endpoint is undergoing maintenance and cannot be updated or deleted or re-scaled until it has completed. This maintenance operation does not change any customer-specified values such as VPC config, KMS encryption, model, instance type, or instance count. -
RollingBack
: Endpoint fails to scale up or down or change its variant weight and is in the process of rolling back to its previous configuration. Once the rollback completes, endpoint returns to anInService
status. This transitional status only applies to an endpoint that has autoscaling enabled and is undergoing variant weight or capacity changes as part of an UpdateEndpointWeightsAndCapacities call or when the UpdateEndpointWeightsAndCapacities operation is called explicitly. -
InService
: Endpoint is available to process incoming requests. -
Deleting
: DeleteEndpoint is executing. -
Failed
: Endpoint could not be created, updated, or re-scaled. Use theFailureReason
value returned by DescribeEndpoint for information about the failure. DeleteEndpoint is the only operation that can be performed on a failed endpoint. -
UpdateRollbackFailed
: Both the rolling deployment and auto-rollback failed. Your endpoint is in service with a mix of the old and new endpoint configurations. For information about how to remedy this issue and restore the endpoint's status toInService
, see Rolling Deployments.
-
- See Also:
-
-
failureReason
If the status of the endpoint is
Failed
, the reason why it failed.- Returns:
- If the status of the endpoint is
Failed
, the reason why it failed.
-
creationTime
A timestamp that shows when the endpoint was created.
- Returns:
- A timestamp that shows when the endpoint was created.
-
lastModifiedTime
A timestamp that shows when the endpoint was last modified.
- Returns:
- A timestamp that shows when the endpoint was last modified.
-
lastDeploymentConfig
The most recent deployment configuration for the endpoint.
- Returns:
- The most recent deployment configuration for the endpoint.
-
asyncInferenceConfig
Returns the description of an endpoint configuration created using the
CreateEndpointConfig
API.- Returns:
- Returns the description of an endpoint configuration created using the
CreateEndpointConfig
API.
-
pendingDeploymentSummary
Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.
- Returns:
- Returns the summary of an in-progress deployment. This field is only returned when the endpoint is creating or updating with a new endpoint configuration.
-
explainerConfig
The configuration parameters for an explainer.
- Returns:
- The configuration parameters for an explainer.
-
hasShadowProductionVariants
public final boolean hasShadowProductionVariants()For responses, this returns true if the service returned a value for the ShadowProductionVariants property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
shadowProductionVariants
An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in shadow mode with production traffic replicated from the model specified on
ProductionVariants
.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
hasShadowProductionVariants()
method.- Returns:
- An array of ProductionVariantSummary objects, one for each model that you want to host at this endpoint in
shadow mode with production traffic replicated from the model specified on
ProductionVariants
.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<DescribeEndpointResponse.Builder,
DescribeEndpointResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in 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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-