Class: Aws::EndUserMessaging::Types::Job

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

Overview

Information about an async job tracked by the service. GetJob returns the full Job, which may grow detail-only fields that are not part of the JobSummary list view.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#brand_profile_id ⇒ String

The brand profile that the job operates on. This value is absent for operations that create a brand profile.

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 902

class Job < Struct.new(
  :job_id,
  :status,
  :operation_type,
  :created_at,
  :updated_at,
  :brand_profile_id,
  :error_code,
  :error_message,
  :resources)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

The time when the resource was created, in Unix epoch time.

Returns:

  • (Time) 


902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 902

class Job < Struct.new(
  :job_id,
  :status,
  :operation_type,
  :created_at,
  :updated_at,
  :brand_profile_id,
  :error_code,
  :error_message,
  :resources)
  SENSITIVE = []
  include Aws::Structure
end

#error_code ⇒ String

A machine-readable code that identifies why the job failed. This value is present only when the job status is FAILED.

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 902

class Job < Struct.new(
  :job_id,
  :status,
  :operation_type,
  :created_at,
  :updated_at,
  :brand_profile_id,
  :error_code,
  :error_message,
  :resources)
  SENSITIVE = []
  include Aws::Structure
end

#error_message ⇒ String

A human-readable description of why the job failed. This value is present only when the job status is FAILED.

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 902

class Job < Struct.new(
  :job_id,
  :status,
  :operation_type,
  :created_at,
  :updated_at,
  :brand_profile_id,
  :error_code,
  :error_message,
  :resources)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The unique identifier of the asynchronous job. Use the GetJob operation to check the status of the job and to retrieve its results.

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 902

class Job < Struct.new(
  :job_id,
  :status,
  :operation_type,
  :created_at,
  :updated_at,
  :brand_profile_id,
  :error_code,
  :error_message,
  :resources)
  SENSITIVE = []
  include Aws::Structure
end

#operation_type ⇒ String

The type of mutating operation that created the job.

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 902

class Job < Struct.new(
  :job_id,
  :status,
  :operation_type,
  :created_at,
  :updated_at,
  :brand_profile_id,
  :error_code,
  :error_message,
  :resources)
  SENSITIVE = []
  include Aws::Structure
end

#resources ⇒ Array<Types::JobResource>

The resources that were created or updated by the job.

Returns:



902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 902

class Job < Struct.new(
  :job_id,
  :status,
  :operation_type,
  :created_at,
  :updated_at,
  :brand_profile_id,
  :error_code,
  :error_message,
  :resources)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current lifecycle status of the job.

Returns:

  • (String) 


902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 902

class Job < Struct.new(
  :job_id,
  :status,
  :operation_type,
  :created_at,
  :updated_at,
  :brand_profile_id,
  :error_code,
  :error_message,
  :resources)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The time when the resource was last updated, in Unix epoch time.

Returns:

  • (Time) 


902
903
904
905
906
907
908
909
910
911
912
913
914
 
# File 'gems/aws-sdk-endusermessaging/lib/aws-sdk-endusermessaging/types.rb', line 902

class Job < Struct.new(
  :job_id,
  :status,
  :operation_type,
  :created_at,
  :updated_at,
  :brand_profile_id,
  :error_code,
  :error_message,
  :resources)
  SENSITIVE = []
  include Aws::Structure
end