Class: Aws::PartnerCentralSelling::Types::EngagementProspectingResult

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

Overview

Contains the result of processing a single engagement within a prospecting task. Each engagement is processed independently, so individual engagements can succeed or fail regardless of other engagements in the same task.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#engagement_context_id ⇒ String

The identifier of the prospecting context created for this engagement. This field is only populated when the engagement was processed successfully (status is COMPLETED). Use this identifier to reference the prospecting context in subsequent operations.

Returns:

  • (String) 


1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 1979

class EngagementProspectingResult < Struct.new(
  :engagement_identifier,
  :engagement_context_id,
  :status,
  :reason_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#engagement_identifier ⇒ String

The unique identifier of the engagement that was processed.

Returns:

  • (String) 


1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 1979

class EngagementProspectingResult < Struct.new(
  :engagement_identifier,
  :engagement_context_id,
  :status,
  :reason_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.

Returns:

  • (String) 


1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 1979

class EngagementProspectingResult < Struct.new(
  :engagement_identifier,
  :engagement_context_id,
  :status,
  :reason_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#reason_code ⇒ String

An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.

Returns:

  • (String) 


1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 1979

class EngagementProspectingResult < Struct.new(
  :engagement_identifier,
  :engagement_context_id,
  :status,
  :reason_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.

Returns:

  • (String) 


1979
1980
1981
1982
1983
1984
1985
1986
1987
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/types.rb', line 1979

class EngagementProspectingResult < Struct.new(
  :engagement_identifier,
  :engagement_context_id,
  :status,
  :reason_code,
  :message)
  SENSITIVE = []
  include Aws::Structure
end