Class OutputDataConfig

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.OutputDataConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OutputDataConfig.Builder,OutputDataConfig>
@Generated("software.amazon.awssdk:codegen") public final class OutputDataConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OutputDataConfig.Builder,OutputDataConfig>

Provides information about how to store model training results (model artifacts).

See Also:

  • Method Details

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

      • // KMS Key ID

        "1234abcd-12ab-34cd-56ef-1234567890ab"

      • // Amazon Resource Name (ARN) of a KMS Key

        "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • // KMS Key Alias

        "alias/ExampleAlias"

      • // Amazon Resource Name (ARN) of a KMS Key Alias

        "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

      If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone

      The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

      Returns:
      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that SageMaker uses to encrypt the model artifacts at rest using Amazon S3 server-side encryption. The KmsKeyId can be any of the following formats:

      • // KMS Key ID

        "1234abcd-12ab-34cd-56ef-1234567890ab"

      • // Amazon Resource Name (ARN) of a KMS Key

        "arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab"

      • // KMS Key Alias

        "alias/ExampleAlias"

      • // Amazon Resource Name (ARN) of a KMS Key Alias

        "arn:aws:kms:us-west-2:111122223333:alias/ExampleAlias"

      If you use a KMS key ID or an alias of your KMS key, the SageMaker execution role must include permissions to call kms:Encrypt. If you don't provide a KMS key ID, SageMaker uses the default KMS key for Amazon S3 for your role's account. For more information, see KMS-Managed Encryption Keys in the Amazon Simple Storage Service Developer Guide. If the output data is stored in Amazon S3 Express One Zone, it is encrypted with server-side encryption with Amazon S3 managed keys (SSE-S3). KMS key is not supported for Amazon S3 Express One Zone

      The KMS key policy must grant permission to the IAM role that you specify in your CreateTrainingJob, CreateTransformJob, or CreateHyperParameterTuningJob requests. For more information, see Using Key Policies in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

    • s3OutputPath

      public final String s3OutputPath()

      Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

      Returns:
      Identifies the S3 path where you want SageMaker to store the model artifacts. For example, s3://bucket-name/key-name-prefix.

    • compressionType

      public final OutputCompressionType compressionType()

      The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

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

      Returns:
      The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
      See Also:

    • compressionTypeAsString

      public final String compressionTypeAsString()

      The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.

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

      Returns:
      The model output compression type. Select None to output an uncompressed model, recommended for large model outputs. Defaults to gzip.
      See Also:

    • toBuilder

      public OutputDataConfig.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<OutputDataConfig.Builder,OutputDataConfig>
      Returns:
      a builder for type T

    • builder

      public static OutputDataConfig.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.