Class CreateCompilationJobRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateCompilationJobRequest.Builder,
CreateCompilationJobRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
A name for the model compilation job.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final 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.final String
The Amazon Resource Name (ARN) of a versioned model package.final OutputConfig
Provides information about the output location for the compiled model and the target device the model runs on.final String
roleArn()
The Amazon Resource Name (ARN) of an IAM role that enables Amazon SageMaker to perform tasks on your behalf.static Class
<? extends CreateCompilationJobRequest.Builder> final StoppingCondition
Specifies a limit to how long a model compilation job can run.tags()
An array of key-value pairs.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final NeoVpcConfig
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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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
The Amazon Resource Name (ARN) of a versioned model package. Provide either a
ModelPackageVersionArn
or anInputConfig
object in the request syntax. The presence of both objects in theCreateCompilationJob
request will return an exception.- Returns:
- The Amazon Resource Name (ARN) of a versioned model package. Provide either a
ModelPackageVersionArn
or anInputConfig
object in the request syntax. The presence of both objects in theCreateCompilationJob
request will return an exception.
-
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
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<CreateCompilationJobRequest.Builder,
CreateCompilationJobRequest> - Specified by:
toBuilder
in classSageMakerRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-