EngagementProspectingResult
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.
Contents
Note
In the following list, the required parameters are described first.
- EngagementIdentifier
-
The unique identifier of the engagement that was processed.
Type: String
Pattern:
eng-[0-9a-z]{14}Required: Yes
- Status
-
The processing status of this specific engagement. Possible values are
PENDING,IN_PROGRESS,COMPLETED, andFAILED.Type: String
Valid Values:
PENDING | IN_PROGRESS | COMPLETED | FAILEDRequired: Yes
- EngagementContextId
-
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.Type: String
Pattern:
ctx-[0-9a-z]{14}Required: No
- Message
-
A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when
StatusisFAILED.Type: String
Required: No
- ReasonCode
-
An enumerated code indicating the reason this engagement failed to process. This field is only populated when
StatusisFAILED.Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
