Class: Aws::PartnerCentralSelling::Types::ProspectingTaskSummary

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::ProspectingTaskSummary

Defined in:

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

Overview

A summary of a single prospecting task, returned by ListProspectingFromEngagementTasks. Contains key metrics and status information without the full per-engagement detail available from GetProspectingFromEngagementTask.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #completed_engagement_count ⇒ Integer

  The number of engagements that have been successfully converted into prospecting leads.

• #end_time ⇒ Time

  The timestamp indicating when the task finished processing.

• #failed_engagement_count ⇒ Integer

  The number of engagements that failed to be converted.

• #start_time ⇒ Time

  The timestamp indicating when the task was initiated.

• #task_arn ⇒ String

  The Amazon Resource Name (ARN) of the task.

• #task_id ⇒ String

  The unique identifier of the task.

• #task_name ⇒ String

  The descriptive name of the task provided when it was created.

• #total_engagement_count ⇒ Integer

  The total number of engagements included in the task.

Instance Attribute Details

#completed_engagement_count ⇒ Integer

The number of engagements that have been successfully converted into prospecting leads.

Returns:

• (Integer)

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

class ProspectingTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :task_name,
  :start_time,
  :end_time,
  :total_engagement_count,
  :completed_engagement_count,
  :failed_engagement_count)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.

Returns:

• (Time)

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

class ProspectingTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :task_name,
  :start_time,
  :end_time,
  :total_engagement_count,
  :completed_engagement_count,
  :failed_engagement_count)
  SENSITIVE = []
  include Aws::Structure
end

#failed_engagement_count ⇒ Integer

The number of engagements that failed to be converted. Retrieve the full task details using GetProspectingFromEngagementTask for per-engagement error information.

Returns:

• (Integer)

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

class ProspectingTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :task_name,
  :start_time,
  :end_time,
  :total_engagement_count,
  :completed_engagement_count,
  :failed_engagement_count)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.

Returns:

• (Time)

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

class ProspectingTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :task_name,
  :start_time,
  :end_time,
  :total_engagement_count,
  :completed_engagement_count,
  :failed_engagement_count)
  SENSITIVE = []
  include Aws::Structure
end

#task_arn ⇒ String

The Amazon Resource Name (ARN) of the task.

Returns:

• (String)

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

class ProspectingTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :task_name,
  :start_time,
  :end_time,
  :total_engagement_count,
  :completed_engagement_count,
  :failed_engagement_count)
  SENSITIVE = []
  include Aws::Structure
end

#task_id ⇒ String

The unique identifier of the task. Use this value with GetProspectingFromEngagementTask to retrieve full task details.

Returns:

• (String)

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

class ProspectingTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :task_name,
  :start_time,
  :end_time,
  :total_engagement_count,
  :completed_engagement_count,
  :failed_engagement_count)
  SENSITIVE = []
  include Aws::Structure
end

#task_name ⇒ String

The descriptive name of the task provided when it was created.

Returns:

• (String)

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

class ProspectingTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :task_name,
  :start_time,
  :end_time,
  :total_engagement_count,
  :completed_engagement_count,
  :failed_engagement_count)
  SENSITIVE = []
  include Aws::Structure
end

#total_engagement_count ⇒ Integer

The total number of engagements included in the task.

Returns:

• (Integer)

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

class ProspectingTaskSummary < Struct.new(
  :task_id,
  :task_arn,
  :task_name,
  :start_time,
  :end_time,
  :total_engagement_count,
  :completed_engagement_count,
  :failed_engagement_count)
  SENSITIVE = []
  include Aws::Structure
end