Package software.amazon.awssdk.services.sagemaker.model

Class DescribeInferenceExperimentResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.sagemaker.model.SageMakerResponse
software.amazon.awssdk.services.sagemaker.model.DescribeInferenceExperimentResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeInferenceExperimentResponse.Builder,DescribeInferenceExperimentResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeInferenceExperimentResponse extends SageMakerResponse implements ToCopyableBuilder<DescribeInferenceExperimentResponse.Builder,DescribeInferenceExperimentResponse>

  • Method Details

    • arn

      public final String arn()

      The ARN of the inference experiment being described.

      Returns:
      The ARN of the inference experiment being described.

    • name

      public final String name()

      The name of the inference experiment.

      Returns:
      The name of the inference experiment.

    • type

      public final InferenceExperimentType type()

      The type of the inference experiment.

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

      Returns:
      The type of the inference experiment.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the inference experiment.

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

      Returns:
      The type of the inference experiment.
      See Also:

    • schedule

      public final InferenceExperimentSchedule schedule()

      The duration for which the inference experiment ran or will run.

      Returns:
      The duration for which the inference experiment ran or will run.

    • status

      public final InferenceExperimentStatus status()

      The status of the inference experiment. The following are the possible statuses for an inference experiment:

      • Creating - Amazon SageMaker is creating your experiment.

      • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

      • Updating - When you make changes to your experiment, your experiment shows as updating.

      • Starting - Amazon SageMaker is beginning your experiment.

      • Running - Your experiment is in progress.

      • Stopping - Amazon SageMaker is stopping your experiment.

      • Completed - Your experiment has completed.

      • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

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

      Returns:
      The status of the inference experiment. The following are the possible statuses for an inference experiment:

      • Creating - Amazon SageMaker is creating your experiment.

      • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

      • Updating - When you make changes to your experiment, your experiment shows as updating.

      • Starting - Amazon SageMaker is beginning your experiment.

      • Running - Your experiment is in progress.

      • Stopping - Amazon SageMaker is stopping your experiment.

      • Completed - Your experiment has completed.

      • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the inference experiment. The following are the possible statuses for an inference experiment:

      • Creating - Amazon SageMaker is creating your experiment.

      • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

      • Updating - When you make changes to your experiment, your experiment shows as updating.

      • Starting - Amazon SageMaker is beginning your experiment.

      • Running - Your experiment is in progress.

      • Stopping - Amazon SageMaker is stopping your experiment.

      • Completed - Your experiment has completed.

      • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

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

      Returns:
      The status of the inference experiment. The following are the possible statuses for an inference experiment:

      • Creating - Amazon SageMaker is creating your experiment.

      • Created - Amazon SageMaker has finished the creation of your experiment and will begin the experiment at the scheduled time.

      • Updating - When you make changes to your experiment, your experiment shows as updating.

      • Starting - Amazon SageMaker is beginning your experiment.

      • Running - Your experiment is in progress.

      • Stopping - Amazon SageMaker is stopping your experiment.

      • Completed - Your experiment has completed.

      • Cancelled - When you conclude your experiment early using the StopInferenceExperiment API, or if any operation fails with an unexpected error, it shows as cancelled.

      See Also:

    • statusReason

      public final String statusReason()

      The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

      Returns:
      The error message or client-specified Reason from the StopInferenceExperiment API, that explains the status of the inference experiment.

    • description

      public final String description()

      The description of the inference experiment.

      Returns:
      The description of the inference experiment.

    • creationTime

      public final Instant creationTime()

      The timestamp at which you created the inference experiment.

      Returns:
      The timestamp at which you created the inference experiment.

    • completionTime

      public final Instant completionTime()

      The timestamp at which the inference experiment was completed.

      Returns:
      The timestamp at which the inference experiment was completed.

    • lastModifiedTime

      public final Instant lastModifiedTime()

      The timestamp at which you last modified the inference experiment.

      Returns:
      The timestamp at which you last modified the inference experiment.

    • roleArn

      public final String roleArn()

      The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

      Returns:
      The ARN of the IAM role that Amazon SageMaker can assume to access model artifacts and container images, and manage Amazon SageMaker Inference endpoints for model deployment.

    • endpointMetadata

      public final EndpointMetadata endpointMetadata()

      The metadata of the endpoint on which the inference experiment ran.

      Returns:
      The metadata of the endpoint on which the inference experiment ran.

    • hasModelVariants

      public final boolean hasModelVariants()
      For responses, this returns true if the service returned a value for the ModelVariants 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.

    • modelVariants

      public final List<ModelVariantConfigSummary> modelVariants()

      An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

      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 hasModelVariants() method.

      Returns:
      An array of ModelVariantConfigSummary objects. There is one for each variant in the inference experiment. Each ModelVariantConfigSummary object in the array describes the infrastructure configuration for deploying the corresponding variant.

    • dataStorageConfig

      public final InferenceExperimentDataStorageConfig dataStorageConfig()

      The Amazon S3 location and configuration for storing inference request and response data.

      Returns:
      The Amazon S3 location and configuration for storing inference request and response data.

    • shadowModeConfig

      public final ShadowModeConfig shadowModeConfig()

      The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

      Returns:
      The configuration of ShadowMode inference experiment type, which shows the production variant that takes all the inference requests, and the shadow variant to which Amazon SageMaker replicates a percentage of the inference requests. For the shadow variant it also shows the percentage of requests that Amazon SageMaker replicates.

    • kmsKey

      public final String kmsKey()

      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

      Returns:
      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume attached to the ML compute instance that hosts the endpoint. For more information, see CreateInferenceExperiment.

    • toBuilder

      public DescribeInferenceExperimentResponse.Builder 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<DescribeInferenceExperimentResponse.Builder,DescribeInferenceExperimentResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeInferenceExperimentResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeInferenceExperimentResponse.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.