Class: Aws::TranscribeService::Types::JobExecutionSettings

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb

Overview

Note:

When making an API call, you may pass JobExecutionSettings data as a hash:

{
  allow_deferred_execution: false,
  data_access_role_arn: "DataAccessRoleArn",
}

Allows you 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#allow_deferred_executionBoolean

Allows you 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.

Returns:

  • (Boolean)


2026
2027
2028
2029
2030
2031
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2026

class JobExecutionSettings < Struct.new(
  :allow_deferred_execution,
  :data_access_role_arn)
  SENSITIVE = []
  include Aws::Structure
end

#data_access_role_arnString

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

Returns:

  • (String)


2026
2027
2028
2029
2030
2031
# File 'gems/aws-sdk-transcribeservice/lib/aws-sdk-transcribeservice/types.rb', line 2026

class JobExecutionSettings < Struct.new(
  :allow_deferred_execution,
  :data_access_role_arn)
  SENSITIVE = []
  include Aws::Structure
end