software.amazon.awssdk.services.sagemaker.model

Class CreateCompilationJobRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateCompilationJobRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateCompilationJobRequest.Builder,CreateCompilationJobRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateCompilationJobRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateCompilationJobRequest.Builder	builder()
String	compilationJobName() A name for the model compilation job.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
InputConfig	inputConfig() Provides information about the location of input model artifacts, the name and shape of the expected data inputs, and the framework in which the model was trained.
String	modelPackageVersionArn() The Amazon Resource Name (ARN) of a versioned model package.
OutputConfig	outputConfig() Provides information about the output location for the compiled model and the target device the model runs on.
String	roleArn() The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCompilationJobRequest.Builder>	serializableBuilderClass()
StoppingCondition	stoppingCondition() Specifies a limit to how long a model compilation job can run.
List<Tag>	tags() An array of key-value pairs.
CreateCompilationJobRequest.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.awscore.AwsRequest

overrideConfiguration

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()

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

Returns:

A name for the model compilation job. The name must be unique within the Amazon Web Services Region and within your Amazon Web Services account.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

• Read input data from an S3 bucket

• Write model artifacts to an S3 bucket

• Write logs to Amazon CloudWatch Logs

• Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

Returns:

The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.

During model compilation, Amazon SageMaker needs your permission to:

• Read input data from an S3 bucket

• Write model artifacts to an S3 bucket

• Write logs to Amazon CloudWatch Logs

• Publish metrics to Amazon CloudWatch

You grant permissions for all of these tasks to an IAM role. To pass this role to Amazon SageMaker, the caller of this API must have the iam:PassRole permission. For more information, see Amazon SageMaker Roles.

modelPackageVersionArn

public final String modelPackageVersionArn()

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

Returns:

The Amazon Resource Name (ARN) of a versioned model package. Provide either a ModelPackageVersionArn or an InputConfig object in the request syntax. The presence of both objects in the CreateCompilationJob request will return an exception.

inputConfig

public final InputConfig inputConfig()

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

Returns:

Provides information about the location of 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()

Provides information about the output location for the compiled model and the target device the model runs on.

Returns:

Provides information about the output location for the compiled model and the target device 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.

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

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

Returns:

An array of key-value pairs. You can use tags to categorize your Amazon Web Services resources in different ways, for example, by purpose, owner, or environment. For more information, see Tagging Amazon Web Services Resources.

toBuilder

public CreateCompilationJobRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateCompilationJobRequest.Builder,CreateCompilationJobRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateCompilationJobRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateCompilationJobRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo