Class InputDataConfig

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

Contains the Amazon S3 location of the training data you want to use to create a new custom language model, and permissions to access this location.

When using InputDataConfig, you must include these sub-parameters: S3Uri and DataAccessRoleArn. You can optionally include TuningDataS3Uri.

See Also:

  • Method Details

    • s3Uri

      public final String s3Uri()

      The Amazon S3 location (URI) of the text files you want to use to train your custom language model.

      Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/

      Returns:
      The Amazon S3 location (URI) of the text files you want to use to train your custom language model.

      Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-training-data/

    • tuningDataS3Uri

      public final String tuningDataS3Uri()

      The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.

      Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/

      Returns:
      The Amazon S3 location (URI) of the text files you want to use to tune your custom language model.

      Here's an example URI path: s3://DOC-EXAMPLE-BUCKET/my-model-tuning-data/

    • dataAccessRoleArn

      public final String dataAccessRoleArn()

      The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

      IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

      For more information, see IAM ARNs.

      Returns:
      The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files. If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

      IAM role ARNs have the format arn:partition:iam::account:role/role-name-with-path. For example: arn:aws:iam::111122223333:role/Admin.

      For more information, see IAM ARNs.

    • toBuilder

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

    • builder

      public static InputDataConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InputDataConfig.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.