Class: Aws::PartnerCentralSelling::Types::ListEngagementFromOpportunityTaskSummary

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::ListEngagementFromOpportunityTaskSummary

Defined in:

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

Overview

Provides a summary of a task related to creating an engagement from an opportunity. This structure contains key information about the task's status, associated identifiers, and any failure details.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #engagement_id ⇒ String

  The unique identifier of the engagement created as a result of the task.

• #engagement_invitation_id ⇒ String

  The unique identifier of the Engagement Invitation.

• #message ⇒ String

  A detailed message providing additional information about the task, especially useful in case of failures.

• #opportunity_id ⇒ String

  The unique identifier of the original Opportunity from which the Engagement is being created.

• #reason_code ⇒ String

  A code indicating the specific reason for a task failure.

• #resource_snapshot_job_id ⇒ String

  The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.

• #start_time ⇒ Time

  The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.

• #task_arn ⇒ String

  The Amazon Resource Name (ARN) uniquely identifying this task within AWS.

• #task_id ⇒ String

  A unique identifier for a specific task.

• #task_status ⇒ String

  The current status of the task.

Instance Attribute Details

#engagement_id ⇒ String

The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end

#engagement_invitation_id ⇒ String

The unique identifier of the Engagement Invitation.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end

#opportunity_id ⇒ String

The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end

#reason_code ⇒ String

A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end

#resource_snapshot_job_id ⇒ String

The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.

Returns:

• (Time)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end

#task_arn ⇒ String

The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end

#task_id ⇒ String

A unique identifier for a specific task.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end

#task_status ⇒ String

The current status of the task.

Returns:

• (String)

# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 4191

class ListEngagementFromOpportunityTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :start_time,
  :task_status,
  :message,
  :reason_code,
  :opportunity_id,
  :resource_snapshot_job_id,
  :engagement_id,
  :engagement_invitation_id)
  SENSITIVE = []
  include Aws::Structure
end