Class DescribeEndpointResponse

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>

@Generated("software.amazon.awssdk:codegen") public final class DescribeEndpointResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>
  • Method Details

    • endpointName

      public final String endpointName()

      Name of the endpoint.

      Returns:
      Name of the endpoint.
    • endpointArn

      public final String endpointArn()

      The Amazon Resource Name (ARN) of the endpoint.

      Returns:
      The Amazon Resource Name (ARN) of the endpoint.
    • endpointConfigName

      public final String 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 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.
    • productionVariants

      public final List<ProductionVariantSummary> 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

      public final DataCaptureConfigSummary dataCaptureConfig()
      Returns the value of the DataCaptureConfig property for this object.
      Returns:
      The value of the DataCaptureConfig property for this object.
    • endpointStatus

      public final EndpointStatus 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 an InService 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 the FailureReason 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 to InService, see Rolling Deployments.

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

      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 an InService 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 the FailureReason 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 to InService, see Rolling Deployments.

      See Also:
    • endpointStatusAsString

      public final String 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 an InService 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 the FailureReason 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 to InService, see Rolling Deployments.

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

      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 an InService 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 the FailureReason 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 to InService, see Rolling Deployments.

      See Also:
    • failureReason

      public final String 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

      public final Instant creationTime()

      A timestamp that shows when the endpoint was created.

      Returns:
      A timestamp that shows when the endpoint was created.
    • lastModifiedTime

      public final Instant lastModifiedTime()

      A timestamp that shows when the endpoint was last modified.

      Returns:
      A timestamp that shows when the endpoint was last modified.
    • lastDeploymentConfig

      public final DeploymentConfig lastDeploymentConfig()

      The most recent deployment configuration for the endpoint.

      Returns:
      The most recent deployment configuration for the endpoint.
    • asyncInferenceConfig

      public final AsyncInferenceConfig 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

      public final PendingDeploymentSummary 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

      public final ExplainerConfig 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 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.
    • shadowProductionVariants

      public final List<ProductionVariantSummary> 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 interface ToCopyableBuilder<DescribeEndpointResponse.Builder,DescribeEndpointResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T
    • builder

      public static DescribeEndpointResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends DescribeEndpointResponse.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.