@Generated(value="software.amazon.awssdk:codegen") public final class CreateModelPackageRequest extends SageMakerRequest implements ToCopyableBuilder<CreateModelPackageRequest.Builder,CreateModelPackageRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateModelPackageRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
List<AdditionalInferenceSpecificationDefinition> |
additionalInferenceSpecifications()
An array of additional Inference Specification objects.
|
static CreateModelPackageRequest.Builder |
builder() |
Boolean |
certifyForMarketplace()
Whether to certify the model package for listing on Amazon Web Services Marketplace.
|
String |
clientToken()
A unique token that guarantees that the call to this API is idempotent.
|
Map<String,String> |
customerMetadataProperties()
The metadata properties associated with the model package versions.
|
String |
domain()
The machine learning domain of your model package and its components.
|
DriftCheckBaselines |
driftCheckBaselines()
Represents the drift check baselines that can be used when the model monitor is set using the model package.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasAdditionalInferenceSpecifications()
For responses, this returns true if the service returned a value for the AdditionalInferenceSpecifications
property.
|
boolean |
hasCustomerMetadataProperties()
For responses, this returns true if the service returned a value for the CustomerMetadataProperties property.
|
int |
hashCode() |
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
InferenceSpecification |
inferenceSpecification()
Specifies details about inference jobs that can be run with models based on this model package, including the
following:
|
MetadataProperties |
metadataProperties()
Returns the value of the MetadataProperties property for this object.
|
ModelApprovalStatus |
modelApprovalStatus()
Whether the model is approved for deployment.
|
String |
modelApprovalStatusAsString()
Whether the model is approved for deployment.
|
ModelMetrics |
modelMetrics()
A structure that contains model metrics reports.
|
String |
modelPackageDescription()
A description of the model package.
|
String |
modelPackageGroupName()
The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
|
String |
modelPackageName()
The name of the model package.
|
String |
samplePayloadUrl()
The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateModelPackageRequest.Builder> |
serializableBuilderClass() |
SourceAlgorithmSpecification |
sourceAlgorithmSpecification()
Details about the algorithm that was used to create the model package.
|
List<Tag> |
tags()
A list of key value pairs associated with the model.
|
String |
task()
The machine learning task your model package accomplishes.
|
CreateModelPackageRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
ModelPackageValidationSpecification |
validationSpecification()
Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String modelPackageName()
The name of the model package. The name must have 1 to 63 characters. Valid characters are a-z, A-Z, 0-9, and - (hyphen).
This parameter is required for unversioned models. It is not applicable to versioned models.
This parameter is required for unversioned models. It is not applicable to versioned models.
public final String modelPackageGroupName()
The name or Amazon Resource Name (ARN) of the model package group that this model version belongs to.
This parameter is required for versioned models, and does not apply to unversioned models.
This parameter is required for versioned models, and does not apply to unversioned models.
public final String modelPackageDescription()
A description of the model package.
public final InferenceSpecification inferenceSpecification()
Specifies details about inference jobs that can be run with models based on this model package, including the following:
The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the model package supports for inference.
The Amazon ECR paths of containers that contain the inference code and model artifacts.
The instance types that the model package supports for transform jobs and real-time endpoints used for inference.
The input and output content formats that the model package supports for inference.
public final ModelPackageValidationSpecification validationSpecification()
Specifies configurations for one or more transform jobs that Amazon SageMaker runs to test the model package.
public final SourceAlgorithmSpecification sourceAlgorithmSpecification()
Details about the algorithm that was used to create the model package.
public final Boolean certifyForMarketplace()
Whether to certify the model package for listing on Amazon Web Services Marketplace.
This parameter is optional for unversioned models, and does not apply to versioned models.
This parameter is optional for unversioned models, and does not apply to versioned models.
public final boolean hasTags()
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.public final List<Tag> tags()
A list of key value pairs associated with the model. For more information, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.
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.
public final ModelApprovalStatus modelApprovalStatus()
Whether the model is approved for deployment.
This parameter is optional for versioned models, and does not apply to unversioned models.
For versioned models, the value of this parameter must be set to Approved to deploy the model.
If the service returns an enum value that is not available in the current SDK version,
modelApprovalStatus will return ModelApprovalStatus.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from modelApprovalStatusAsString().
This parameter is optional for versioned models, and does not apply to unversioned models.
For versioned models, the value of this parameter must be set to Approved to deploy the
model.
ModelApprovalStatuspublic final String modelApprovalStatusAsString()
Whether the model is approved for deployment.
This parameter is optional for versioned models, and does not apply to unversioned models.
For versioned models, the value of this parameter must be set to Approved to deploy the model.
If the service returns an enum value that is not available in the current SDK version,
modelApprovalStatus will return ModelApprovalStatus.UNKNOWN_TO_SDK_VERSION. The raw value
returned by the service is available from modelApprovalStatusAsString().
This parameter is optional for versioned models, and does not apply to unversioned models.
For versioned models, the value of this parameter must be set to Approved to deploy the
model.
ModelApprovalStatuspublic final MetadataProperties metadataProperties()
public final ModelMetrics modelMetrics()
A structure that contains model metrics reports.
public final String clientToken()
A unique token that guarantees that the call to this API is idempotent.
public final boolean hasCustomerMetadataProperties()
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.public final Map<String,String> customerMetadataProperties()
The metadata properties associated with the model package versions.
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 hasCustomerMetadataProperties() method.
public final DriftCheckBaselines driftCheckBaselines()
Represents the drift check baselines that can be used when the model monitor is set using the model package. For more information, see the topic on Drift Detection against Previous Baselines in SageMaker Pipelines in the Amazon SageMaker Developer Guide.
public final String domain()
The machine learning domain of your model package and its components. Common machine learning domains include computer vision and natural language processing.
public final String task()
The machine learning task your model package accomplishes. Common machine learning tasks include object detection and image classification.
public final String samplePayloadUrl()
The Amazon Simple Storage Service (Amazon S3) path where the sample payload are stored. This path must point to a single gzip compressed tar archive (.tar.gz suffix).
public final boolean hasAdditionalInferenceSpecifications()
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.public final List<AdditionalInferenceSpecificationDefinition> additionalInferenceSpecifications()
An array of additional Inference Specification objects. Each additional Inference Specification specifies artifacts based on this model package that can be used on inference endpoints. Generally used with SageMaker Neo to store the compiled artifacts.
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 hasAdditionalInferenceSpecifications()
method.
public CreateModelPackageRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateModelPackageRequest.Builder,CreateModelPackageRequest>toBuilder in class SageMakerRequestpublic static CreateModelPackageRequest.Builder builder()
public static Class<? extends CreateModelPackageRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2022. All rights reserved.