Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Transcribe.Types.JobExecutionSettings

Description

Documentation

data JobExecutionSettings Source #

Provides information about when a transcription job should be executed.

See: newJobExecutionSettings smart constructor.

Constructors

JobExecutionSettings'

Fields

dataAccessRoleArn :: Maybe Text
The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.
allowDeferredExecution :: Maybe Bool
Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.
Note that job queuing is enabled by default for call analytics jobs.
If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

Instances

Instances details

Eq JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods (==) :: JobExecutionSettings -> JobExecutionSettings -> Bool # (/=) :: JobExecutionSettings -> JobExecutionSettings -> Bool #
Read JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods readsPrec :: Int -> ReadS JobExecutionSettings # readList :: ReadS [JobExecutionSettings] # readPrec :: ReadPrec JobExecutionSettings # readListPrec :: ReadPrec [JobExecutionSettings] #
Show JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods showsPrec :: Int -> JobExecutionSettings -> ShowS # show :: JobExecutionSettings -> String # showList :: [JobExecutionSettings] -> ShowS #
Generic JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Associated Types type Rep JobExecutionSettings :: Type -> Type # Methods from :: JobExecutionSettings -> Rep JobExecutionSettings x # to :: Rep JobExecutionSettings x -> JobExecutionSettings #
NFData JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods rnf :: JobExecutionSettings -> () #
Hashable JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods hashWithSalt :: Int -> JobExecutionSettings -> Int # hash :: JobExecutionSettings -> Int #
ToJSON JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods toJSON :: JobExecutionSettings -> Value # toEncoding :: JobExecutionSettings -> Encoding # toJSONList :: [JobExecutionSettings] -> Value # toEncodingList :: [JobExecutionSettings] -> Encoding #
FromJSON JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods parseJSON :: Value -> Parser JobExecutionSettings # parseJSONList :: Value -> Parser [JobExecutionSettings] #
type Rep JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings type Rep JobExecutionSettings = D1 ('MetaData "JobExecutionSettings" "Amazonka.Transcribe.Types.JobExecutionSettings" "libZSservicesZSamazonka-transcribeZSamazonka-transcribe" 'False) (C1 ('MetaCons "JobExecutionSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "allowDeferredExecution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))))

newJobExecutionSettings :: JobExecutionSettings Source #

Create a value of JobExecutionSettings 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:dataAccessRoleArn:JobExecutionSettings', jobExecutionSettings_dataAccessRoleArn - The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

$sel:allowDeferredExecution:JobExecutionSettings', jobExecutionSettings_allowDeferredExecution - Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.

Note that job queuing is enabled by default for call analytics jobs.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

jobExecutionSettings_dataAccessRoleArn :: Lens' JobExecutionSettings (Maybe Text) Source #

The Amazon Resource Name (ARN) of a role that has access to the S3 bucket that contains the input files. Amazon Transcribe assumes this role to read queued media files. If you have specified an output S3 bucket for the transcription results, this role should have access to the output bucket as well.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.

jobExecutionSettings_allowDeferredExecution :: Lens' JobExecutionSettings (Maybe Bool) Source #

Indicates whether a job should be queued by Amazon Transcribe when the concurrent execution limit is exceeded. When the AllowDeferredExecution field is true, jobs are queued and executed when the number of executing jobs falls below the concurrent execution limit. If the field is false, Amazon Transcribe returns a LimitExceededException exception.

Note that job queuing is enabled by default for call analytics jobs.

If you specify the AllowDeferredExecution field, you must specify the DataAccessRoleArn field.