Class: Aws::PartnerCentralSelling::Types::StartProspectingFromEngagementTaskResponse

Inherits:

Struct

• Object
• Struct
• Aws::PartnerCentralSelling::Types::StartProspectingFromEngagementTaskResponse

Defined in:

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

Overview

Represents the response structure returned when a prospecting task is successfully submitted. Contains the task identifier, ARN, and initial status. Uses TaskId with GetProspectingFromEngagementTask to poll for completion.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #identifiers ⇒ Array<String>

  The list of engagement identifiers that were accepted into the task queue for processing.

• #message ⇒ String

  A message providing additional context about the task's current state.

• #reason_code ⇒ String

  An enumerated code identifying the reason for task failure.

• #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 assigned to this task.

• #task_name ⇒ String

  The task name from the request.

• #task_status ⇒ String

  The current status of the task.

Instance Attribute Details

#identifiers ⇒ Array<String>

The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.

Returns:

• (Array<String>)

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

class StartProspectingFromEngagementTaskResponse < Struct.new(
  :identifiers,
  :task_name,
  :message,
  :reason_code,
  :start_time,
  :task_id,
  :task_arn,
  :task_status)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.

Returns:

• (String)

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

class StartProspectingFromEngagementTaskResponse < Struct.new(
  :identifiers,
  :task_name,
  :message,
  :reason_code,
  :start_time,
  :task_id,
  :task_arn,
  :task_status)
  SENSITIVE = []
  include Aws::Structure
end

#reason_code ⇒ String

An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding Message field for a human-readable description of the failure.

Returns:

• (String)

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

class StartProspectingFromEngagementTaskResponse < Struct.new(
  :identifiers,
  :task_name,
  :message,
  :reason_code,
  :start_time,
  :task_id,
  :task_arn,
  :task_status)
  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 7022

class StartProspectingFromEngagementTaskResponse < Struct.new(
  :identifiers,
  :task_name,
  :message,
  :reason_code,
  :start_time,
  :task_id,
  :task_arn,
  :task_status)
  SENSITIVE = []
  include Aws::Structure
end

#task_arn ⇒ String

The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.

Returns:

• (String)

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

class StartProspectingFromEngagementTaskResponse < Struct.new(
  :identifiers,
  :task_name,
  :message,
  :reason_code,
  :start_time,
  :task_id,
  :task_arn,
  :task_status)
  SENSITIVE = []
  include Aws::Structure
end

#task_id ⇒ String

The unique identifier assigned to this task. Use this identifier with GetProspectingFromEngagementTask to retrieve task details and check status.

Returns:

• (String)

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

class StartProspectingFromEngagementTaskResponse < Struct.new(
  :identifiers,
  :task_name,
  :message,
  :reason_code,
  :start_time,
  :task_id,
  :task_arn,
  :task_status)
  SENSITIVE = []
  include Aws::Structure
end

#task_name ⇒ String

The task name from the request.

Returns:

• (String)

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

class StartProspectingFromEngagementTaskResponse < Struct.new(
  :identifiers,
  :task_name,
  :message,
  :reason_code,
  :start_time,
  :task_id,
  :task_arn,
  :task_status)
  SENSITIVE = []
  include Aws::Structure
end

#task_status ⇒ String

The current status of the task. Possible values: PENDING (waiting to run), IN_PROGRESS (actively processing), COMPLETED (successfully processed), and FAILED (unrecoverable error).

Returns:

• (String)

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

class StartProspectingFromEngagementTaskResponse < Struct.new(
  :identifiers,
  :task_name,
  :message,
  :reason_code,
  :start_time,
  :task_id,
  :task_arn,
  :task_status)
  SENSITIVE = []
  include Aws::Structure
end