Class: Aws::LocationService::Types::GetJobResponse

Inherits:

Struct

• Object
• Struct
• Aws::LocationService::Types::GetJobResponse

Defined in:

gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:created_at, :ended_at, :updated_at]

Instance Attribute Summary

• #action ⇒ String

  Action performed by the job.

• #action_options ⇒ Types::JobActionOptions

  Additional options for configuring job action parameters.

• #created_at ⇒ Time

  Job creation time in [ISO 8601][1] format: YYYY-MM-DDThh:mm:ss.sss.

• #ended_at ⇒ Time

  Job completion time in [ISO 8601][1] format: YYYY-MM-DDThh:mm:ss.sss.

• #error ⇒ Types::JobError

  Error information if the job failed.

• #execution_role_arn ⇒ String

  IAM role used for permissions when running the job.

• #input_options ⇒ Types::JobInputOptions

  Input configuration.

• #job_arn ⇒ String

  Amazon Resource Name (ARN) of the specified job.

• #job_id ⇒ String

  Unique job identifier.

• #name ⇒ String

  Job name (if provided during creation).

• #output_options ⇒ Types::JobOutputOptions

  Output configuration.

• #status ⇒ String

  Current job status.

• #tags ⇒ Hash<String,String>

  Tags and corresponding values associated with the specified job.

• #updated_at ⇒ Time

  Last update time in [ISO 8601][1] format: YYYY-MM-DDThh:mm:ss.sss.

Instance Attribute Details

#action ⇒ String

Action performed by the job.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#action_options ⇒ Types::JobActionOptions

Additional options for configuring job action parameters.

Returns:

• (Types::JobActionOptions)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#created_at ⇒ Time

Job creation time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.

Returns:

• (Time)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#ended_at ⇒ Time

Job completion time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss. Only returned for jobs in a terminal status: Completed | Failed | Cancelled.

Returns:

• (Time)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#error ⇒ Types::JobError

Error information if the job failed.

Returns:

• (Types::JobError)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#execution_role_arn ⇒ String

IAM role used for permissions when running the job.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#input_options ⇒ Types::JobInputOptions

Input configuration.

Returns:

• (Types::JobInputOptions)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#job_arn ⇒ String

Amazon Resource Name (ARN) of the specified job.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#job_id ⇒ String

Unique job identifier.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#name ⇒ String

Job name (if provided during creation).

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#output_options ⇒ Types::JobOutputOptions

Output configuration.

Returns:

• (Types::JobOutputOptions)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#status ⇒ String

Current job status.

Returns:

• (String)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags and corresponding values associated with the specified job.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end

#updated_at ⇒ Time

Last update time in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sss.

Returns:

• (Time)

# File 'gems/aws-sdk-locationservice/lib/aws-sdk-locationservice/types.rb', line 3752

class GetJobResponse < Struct.new(
  :action,
  :action_options,
  :created_at,
  :ended_at,
  :error,
  :execution_role_arn,
  :input_options,
  :job_arn,
  :job_id,
  :name,
  :output_options,
  :status,
  :updated_at,
  :tags)
  SENSITIVE = [:created_at, :ended_at, :updated_at]
  include Aws::Structure
end