amazonka-transcribe-2.0: Amazon Transcribe Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Transcribe.Types.InputDataConfig

Description

 
Synopsis

Documentation

data InputDataConfig Source #

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: newInputDataConfig smart constructor.

Constructors

InputDataConfig' 

Fields

  • tuningDataS3Uri :: Maybe Text

    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/

  • s3Uri :: Text

    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/

  • dataAccessRoleArn :: Text

    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.

Instances

Instances details
FromJSON InputDataConfig Source # 
Instance details

Defined in Amazonka.Transcribe.Types.InputDataConfig

ToJSON InputDataConfig Source # 
Instance details

Defined in Amazonka.Transcribe.Types.InputDataConfig

Generic InputDataConfig Source # 
Instance details

Defined in Amazonka.Transcribe.Types.InputDataConfig

Associated Types

type Rep InputDataConfig :: Type -> Type #

Read InputDataConfig Source # 
Instance details

Defined in Amazonka.Transcribe.Types.InputDataConfig

Show InputDataConfig Source # 
Instance details

Defined in Amazonka.Transcribe.Types.InputDataConfig

NFData InputDataConfig Source # 
Instance details

Defined in Amazonka.Transcribe.Types.InputDataConfig

Methods

rnf :: InputDataConfig -> () #

Eq InputDataConfig Source # 
Instance details

Defined in Amazonka.Transcribe.Types.InputDataConfig

Hashable InputDataConfig Source # 
Instance details

Defined in Amazonka.Transcribe.Types.InputDataConfig

type Rep InputDataConfig Source # 
Instance details

Defined in Amazonka.Transcribe.Types.InputDataConfig

type Rep InputDataConfig = D1 ('MetaData "InputDataConfig" "Amazonka.Transcribe.Types.InputDataConfig" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "InputDataConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tuningDataS3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "s3Uri") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newInputDataConfig Source #

Create a value of InputDataConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:tuningDataS3Uri:InputDataConfig', inputDataConfig_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/

$sel:s3Uri:InputDataConfig', inputDataConfig_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/

$sel:dataAccessRoleArn:InputDataConfig', inputDataConfig_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.

inputDataConfig_tuningDataS3Uri :: Lens' InputDataConfig (Maybe Text) Source #

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/

inputDataConfig_s3Uri :: Lens' InputDataConfig Text Source #

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/

inputDataConfig_dataAccessRoleArn :: Lens' InputDataConfig Text Source #

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.