Class: Aws::Batch::Types::JobDetail

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

Overview

An object representing an Batch job.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#array_propertiesTypes::ArrayPropertiesDetail

The array properties of the job, if it is an array job.



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#attemptsArray<Types::AttemptDetail>

A list of job attempts associated with this job.

Returns:



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#containerTypes::ContainerDetail

An object representing the details of the container that's associated with the job.



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#created_atInteger

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

Returns:

  • (Integer)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#depends_onArray<Types::JobDependency>

A list of job IDs that this job depends on.

Returns:



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#job_arnString

The Amazon Resource Name (ARN) of the job.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#job_definitionString

The job definition that's used by this job.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

The ID for the job.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#job_nameString

The name of the job.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#job_queueString

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#node_detailsTypes::NodeDetails

An object representing the details of a node that's associated with a multi-node parallel job.

Returns:



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#node_propertiesTypes::NodeProperties

An object representing the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#parametersHash<String,String>

Additional parameters passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

Returns:

  • (Hash<String,String>)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#platform_capabilitiesArray<String>

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

Returns:

  • (Array<String>)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#propagate_tagsBoolean

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

Returns:

  • (Boolean)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#retry_strategyTypes::RetryStrategy

The retry strategy to use for this job if an attempt fails.



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#scheduling_priorityInteger

The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

Returns:

  • (Integer)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#share_identifierString

The share identifier for the job.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#started_atInteger

The Unix timestamp (in milliseconds) for when the job was started (when the job transitioned from the STARTING state to the RUNNING state). This parameter isn't provided for child jobs of array jobs or multi-node parallel jobs.

Returns:

  • (Integer)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

The current status for the job.

If your jobs don't progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the Batch User Guide.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#status_reasonString

A short, human-readable string to provide additional details about the current status of the job.

Returns:

  • (String)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#stopped_atInteger

The Unix timestamp (in milliseconds) for when the job was stopped (when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

Returns:

  • (Integer)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

The tags applied to the job.

Returns:

  • (Hash<String,String>)


3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end

#timeoutTypes::JobTimeout

The timeout configuration for the job.

Returns:



3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 3157

class JobDetail < Struct.new(
  :job_arn,
  :job_name,
  :job_id,
  :job_queue,
  :status,
  :share_identifier,
  :scheduling_priority,
  :attempts,
  :status_reason,
  :created_at,
  :retry_strategy,
  :started_at,
  :stopped_at,
  :depends_on,
  :job_definition,
  :parameters,
  :container,
  :node_details,
  :node_properties,
  :array_properties,
  :timeout,
  :tags,
  :propagate_tags,
  :platform_capabilities)
  SENSITIVE = []
  include Aws::Structure
end