amazonka-lexv2-models-2.0: Amazon Lex Model Building V2 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.LexV2Models.Types.S3BucketTranscriptSource

Description

 
Synopsis

Documentation

data S3BucketTranscriptSource Source #

The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.

See: newS3BucketTranscriptSource smart constructor.

Constructors

S3BucketTranscriptSource' 

Fields

  • kmsKeyArn :: Maybe Text

    The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.

  • pathFormat :: Maybe PathFormat

    The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

  • transcriptFilter :: Maybe TranscriptFilter

    The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.

  • s3BucketName :: Text

    The name of the bucket containing the transcript and the associated metadata.

  • transcriptFormat :: TranscriptFormat

    The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.

Instances

Instances details
FromJSON S3BucketTranscriptSource Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.S3BucketTranscriptSource

ToJSON S3BucketTranscriptSource Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.S3BucketTranscriptSource

Generic S3BucketTranscriptSource Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.S3BucketTranscriptSource

Associated Types

type Rep S3BucketTranscriptSource :: Type -> Type #

Read S3BucketTranscriptSource Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.S3BucketTranscriptSource

Show S3BucketTranscriptSource Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.S3BucketTranscriptSource

NFData S3BucketTranscriptSource Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.S3BucketTranscriptSource

Eq S3BucketTranscriptSource Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.S3BucketTranscriptSource

Hashable S3BucketTranscriptSource Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.S3BucketTranscriptSource

type Rep S3BucketTranscriptSource Source # 
Instance details

Defined in Amazonka.LexV2Models.Types.S3BucketTranscriptSource

type Rep S3BucketTranscriptSource = D1 ('MetaData "S3BucketTranscriptSource" "Amazonka.LexV2Models.Types.S3BucketTranscriptSource" "amazonka-lexv2-models-2.0-5mExjJXBfuO6j0ascNcayE" 'False) (C1 ('MetaCons "S3BucketTranscriptSource'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "kmsKeyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "pathFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PathFormat))) :*: (S1 ('MetaSel ('Just "transcriptFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TranscriptFilter)) :*: (S1 ('MetaSel ('Just "s3BucketName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "transcriptFormat") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TranscriptFormat)))))

newS3BucketTranscriptSource Source #

Create a value of S3BucketTranscriptSource 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:kmsKeyArn:S3BucketTranscriptSource', s3BucketTranscriptSource_kmsKeyArn - The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.

$sel:pathFormat:S3BucketTranscriptSource', s3BucketTranscriptSource_pathFormat - The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

$sel:transcriptFilter:S3BucketTranscriptSource', s3BucketTranscriptSource_transcriptFilter - The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.

$sel:s3BucketName:S3BucketTranscriptSource', s3BucketTranscriptSource_s3BucketName - The name of the bucket containing the transcript and the associated metadata.

$sel:transcriptFormat:S3BucketTranscriptSource', s3BucketTranscriptSource_transcriptFormat - The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.

s3BucketTranscriptSource_kmsKeyArn :: Lens' S3BucketTranscriptSource (Maybe Text) Source #

The ARN of the KMS key that customer use to encrypt their Amazon S3 bucket. Only use this field if your bucket is encrypted using a customer managed KMS key.

s3BucketTranscriptSource_pathFormat :: Lens' S3BucketTranscriptSource (Maybe PathFormat) Source #

The object that contains a path format that will be applied when Amazon Lex reads the transcript file in the bucket you provide. Specify this object if you only want Lex to read a subset of files in your Amazon S3 bucket.

s3BucketTranscriptSource_transcriptFilter :: Lens' S3BucketTranscriptSource (Maybe TranscriptFilter) Source #

The object that contains the filter which will be applied when Amazon Lex reads through the Amazon S3 bucket. Specify this object if you want Amazon Lex to read only a subset of the Amazon S3 bucket based on the filter you provide.

s3BucketTranscriptSource_s3BucketName :: Lens' S3BucketTranscriptSource Text Source #

The name of the bucket containing the transcript and the associated metadata.

s3BucketTranscriptSource_transcriptFormat :: Lens' S3BucketTranscriptSource TranscriptFormat Source #

The format of the transcript content. Currently, Genie only supports the Amazon Lex transcript format.