software.amazon.awssdk.services.sagemaker.model

Class DescribeCompilationJobResponse

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.DescribeCompilationJobResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCompilationJobResponse.Builder,DescribeCompilationJobResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeCompilationJobResponse
extends SageMakerResponse
implements ToCopyableBuilder<DescribeCompilationJobResponse.Builder,DescribeCompilationJobResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCompilationJobResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCompilationJobResponse.Builder	builder()
Instant	compilationEndTime() The time when the model compilation job on a compilation job instance ended.
String	compilationJobArn() The Amazon Resource Name (ARN) of the model compilation job.
String	compilationJobName() The name of the model compilation job.
CompilationJobStatus	compilationJobStatus() The status of the model compilation job.
String	compilationJobStatusAsString() The status of the model compilation job.
Instant	compilationStartTime() The time when the model compilation job started the CompilationJob instances.
Instant	creationTime() The time that the model compilation job was created.
DerivedInformation	derivedInformation() Information that SageMaker Neo automatically derived about the model.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() If a model compilation job failed, the reason it failed.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	inferenceImage() The inference image to use when compiling a model.
InputConfig	inputConfig() Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
Instant	lastModifiedTime() The time that the status of the model compilation job was last modified.
ModelArtifacts	modelArtifacts() Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.
ModelDigests	modelDigests() Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.
String	modelPackageVersionArn() The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.
OutputConfig	outputConfig() Information about the output location for the compiled model and the target device that the model runs on.
String	roleArn() The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCompilationJobResponse.Builder>	serializableBuilderClass()
StoppingCondition	stoppingCondition() Specifies a limit to how long a model compilation job can run.
DescribeCompilationJobResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
NeoVpcConfig	vpcConfig() A VpcConfig object that specifies the VPC that you want your compilation job to connect to.

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 class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

compilationJobName

public final String compilationJobName()

The name of the model compilation job.

Returns:

The name of the model compilation job.

compilationJobArn

public final String compilationJobArn()

The Amazon Resource Name (ARN) of the model compilation job.

Returns:

The Amazon Resource Name (ARN) of the model compilation job.

compilationJobStatus

public final CompilationJobStatus compilationJobStatus()

The status of the model compilation job.

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

Returns:

The status of the model compilation job.

See Also:

CompilationJobStatus

compilationJobStatusAsString

public final String compilationJobStatusAsString()

The status of the model compilation job.

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

Returns:

The status of the model compilation job.

See Also:

CompilationJobStatus

compilationStartTime

public final Instant compilationStartTime()

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

Returns:

The time when the model compilation job started the CompilationJob instances.

You are billed for the time between this timestamp and the timestamp in the CompilationEndTime field. In Amazon CloudWatch Logs, the start time might be later than this time. That's because it takes time to download the compilation job, which depends on the size of the compilation job container.

compilationEndTime

public final Instant compilationEndTime()

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

Returns:

The time when the model compilation job on a compilation job instance ended. For a successful or stopped job, this is when the job's model artifacts have finished uploading. For a failed job, this is when Amazon SageMaker detected that the job failed.

stoppingCondition

public final StoppingCondition stoppingCondition()

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

Returns:

Specifies a limit to how long a model compilation job can run. When the job reaches the time limit, Amazon SageMaker ends the compilation job. Use this API to cap model training costs.

inferenceImage

public final String inferenceImage()

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

Returns:

The inference image to use when compiling a model. Specify an image only if the target device is a cloud instance.

modelPackageVersionArn

public final String modelPackageVersionArn()

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

Returns:

The Amazon Resource Name (ARN) of the versioned model package that was provided to SageMaker Neo when you initiated a compilation job.

creationTime

public final Instant creationTime()

The time that the model compilation job was created.

Returns:

The time that the model compilation job was created.

lastModifiedTime

public final Instant lastModifiedTime()

The time that the status of the model compilation job was last modified.

Returns:

The time that the status of the model compilation job was last modified.

failureReason

public final String failureReason()

If a model compilation job failed, the reason it failed.

Returns:

If a model compilation job failed, the reason it failed.

modelArtifacts

public final ModelArtifacts modelArtifacts()

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

Returns:

Information about the location in Amazon S3 that has been configured for storing the model artifacts used in the compilation job.

modelDigests

public final ModelDigests modelDigests()

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

Returns:

Provides a BLAKE2 hash value that identifies the compiled model artifacts in Amazon S3.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

Returns:

The Amazon Resource Name (ARN) of an IAM role that Amazon SageMaker assumes to perform the model compilation job.

inputConfig

public final InputConfig inputConfig()

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

Returns:

Information about the location in Amazon S3 of the input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.

outputConfig

public final OutputConfig outputConfig()

Information about the output location for the compiled model and the target device that the model runs on.

Returns:

Information about the output location for the compiled model and the target device that the model runs on.

vpcConfig

public final NeoVpcConfig vpcConfig()

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

Returns:

A VpcConfig object that specifies the VPC that you want your compilation job to connect to. Control access to your models by configuring the VPC. For more information, see Protect Compilation Jobs by Using an Amazon Virtual Private Cloud.

derivedInformation

public final DerivedInformation derivedInformation()

Information that SageMaker Neo automatically derived about the model.

Returns:

Information that SageMaker Neo automatically derived about the model.

toBuilder

public DescribeCompilationJobResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCompilationJobResponse.Builder,DescribeCompilationJobResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeCompilationJobResponse.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo