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.Media

Description

 
Synopsis

Documentation

data Media Source #

Describes the Amazon S3 location of the media file you want to use in your request.

For information on supported media formats, refer to the MediaFormat parameter or the Media formats section in the Amazon S3 Developer Guide.

See: newMedia smart constructor.

Constructors

Media' 

Fields

  • mediaFileUri :: Maybe Text

    The Amazon S3 location of the media file you want to transcribe. For example:

    • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
    • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

    Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

  • redactedMediaFileUri :: Maybe Text

    The Amazon S3 location of the media file you want to redact. For example:

    • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
    • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

    Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

    RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.

Instances

Instances details
FromJSON Media Source # 
Instance details

Defined in Amazonka.Transcribe.Types.Media

ToJSON Media Source # 
Instance details

Defined in Amazonka.Transcribe.Types.Media

Generic Media Source # 
Instance details

Defined in Amazonka.Transcribe.Types.Media

Associated Types

type Rep Media :: Type -> Type #

Methods

from :: Media -> Rep Media x #

to :: Rep Media x -> Media #

Read Media Source # 
Instance details

Defined in Amazonka.Transcribe.Types.Media

Show Media Source # 
Instance details

Defined in Amazonka.Transcribe.Types.Media

Methods

showsPrec :: Int -> Media -> ShowS #

show :: Media -> String #

showList :: [Media] -> ShowS #

NFData Media Source # 
Instance details

Defined in Amazonka.Transcribe.Types.Media

Methods

rnf :: Media -> () #

Eq Media Source # 
Instance details

Defined in Amazonka.Transcribe.Types.Media

Methods

(==) :: Media -> Media -> Bool #

(/=) :: Media -> Media -> Bool #

Hashable Media Source # 
Instance details

Defined in Amazonka.Transcribe.Types.Media

Methods

hashWithSalt :: Int -> Media -> Int #

hash :: Media -> Int #

type Rep Media Source # 
Instance details

Defined in Amazonka.Transcribe.Types.Media

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

newMedia :: Media Source #

Create a value of Media 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:mediaFileUri:Media', media_mediaFileUri - The Amazon S3 location of the media file you want to transcribe. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

$sel:redactedMediaFileUri:Media', media_redactedMediaFileUri - The Amazon S3 location of the media file you want to redact. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.

media_mediaFileUri :: Lens' Media (Maybe Text) Source #

The Amazon S3 location of the media file you want to transcribe. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

media_redactedMediaFileUri :: Lens' Media (Maybe Text) Source #

The Amazon S3 location of the media file you want to redact. For example:

  • s3://DOC-EXAMPLE-BUCKET/my-media-file.flac
  • s3://DOC-EXAMPLE-BUCKET/media-files/my-media-file.flac

Note that the Amazon S3 bucket that contains your input media must be located in the same Amazon Web Services Region where you're making your transcription request.

RedactedMediaFileUri produces a redacted audio file in addition to a redacted transcript. It is only supported for Call Analytics (StartCallAnalyticsJob) transcription requests.