Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Transcribe.Types.JobExecutionSettings

Description

Documentation

data JobExecutionSettings Source #

Makes it possible to control how your transcription job is processed. Currently, the only JobExecutionSettings modification you can choose is enabling job queueing using the AllowDeferredExecution sub-parameter.

If you include JobExecutionSettings in your request, you must also include the sub-parameters: AllowDeferredExecution and DataAccessRoleArn.

See: newJobExecutionSettings smart constructor.

Constructors

JobExecutionSettings'

Fields

allowDeferredExecution :: Maybe Bool
Makes it possible to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error.
Note that job queuing is enabled by default for Call Analytics jobs.
If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn.
dataAccessRoleArn :: Maybe 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.
Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution.

Instances

Instances details

FromJSON JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods parseJSON :: Value -> Parser JobExecutionSettings # parseJSONList :: Value -> Parser [JobExecutionSettings] #
ToJSON JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods toJSON :: JobExecutionSettings -> Value # toEncoding :: JobExecutionSettings -> Encoding # toJSONList :: [JobExecutionSettings] -> Value # toEncodingList :: [JobExecutionSettings] -> Encoding #
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 #
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 #
NFData JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods rnf :: JobExecutionSettings -> () #
Eq JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods (==) :: JobExecutionSettings -> JobExecutionSettings -> Bool # (/=) :: JobExecutionSettings -> JobExecutionSettings -> Bool #
Hashable JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings Methods hashWithSalt :: Int -> JobExecutionSettings -> Int # hash :: JobExecutionSettings -> Int #
type Rep JobExecutionSettings Source #
Instance details Defined in Amazonka.Transcribe.Types.JobExecutionSettings type Rep JobExecutionSettings = D1 ('MetaData "JobExecutionSettings" "Amazonka.Transcribe.Types.JobExecutionSettings" "amazonka-transcribe-2.0-4BjJqzwmm0K94bsEMe1tnF" 'False) (C1 ('MetaCons "JobExecutionSettings'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowDeferredExecution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dataAccessRoleArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))

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:allowDeferredExecution:JobExecutionSettings', jobExecutionSettings_allowDeferredExecution - Makes it possible to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error.

Note that job queuing is enabled by default for Call Analytics jobs.

If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn.

$sel:dataAccessRoleArn:JobExecutionSettings', jobExecutionSettings_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.

Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution.

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

Makes it possible to enable job queuing when your concurrent request limit is exceeded. When AllowDeferredExecution is set to true, transcription job requests are placed in a queue until the number of jobs falls below the concurrent request limit. If AllowDeferredExecution is set to false and the number of transcription job requests exceed the concurrent request limit, you get a LimitExceededException error.

Note that job queuing is enabled by default for Call Analytics jobs.

If you include AllowDeferredExecution in your request, you must also include DataAccessRoleArn.

jobExecutionSettings_dataAccessRoleArn :: Lens' JobExecutionSettings (Maybe 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.

Note that if you include DataAccessRoleArn in your request, you must also include AllowDeferredExecution.