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)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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.
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 IIAMAM role that enables Amazon SageMaker to perform tasks on your behalf.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateCompilationJobRequest.Builder>	serializableBuilderClass()
StoppingCondition	stoppingCondition() The duration allowed for model compilation.
CreateCompilationJobRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

compilationJobName

public String compilationJobName()

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

Returns:

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

roleArn

public String roleArn()

The Amazon Resource Name (ARN) of an IIAMAM 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 IIAMAM 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.

inputConfig

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

stoppingCondition

public StoppingCondition stoppingCondition()

The duration allowed for model compilation.

Returns:

The duration allowed for model compilation.

toBuilder

public CreateCompilationJobRequest.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<CreateCompilationJobRequest.Builder,CreateCompilationJobRequest>

Specified by:

toBuilder in class SageMakerRequest

Returns:

a builder for type T

builder

public static CreateCompilationJobRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

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