View a markdown version of this page

ProspectingTaskSummary - AWS Partner Central

ProspectingTaskSummary

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.

Contents

Note

In the following list, the required parameters are described first.

CompletedEngagementCount

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

Type: Integer

Required: Yes

FailedEngagementCount

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

Type: Integer

Required: Yes

StartTime

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

Type: Timestamp

Required: Yes

TaskArn

The Amazon Resource Name (ARN) of the task.

Type: String

Pattern: arn:aws:partnercentral-selling:.*:.*:catalog/.*/prospecting-from-engagement-task/task-[0-9a-z]{14}

Required: Yes

TaskId

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

Type: String

Pattern: task-[0-9a-z]{14}

Required: Yes

TaskName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

TotalEngagementCount

The total number of engagements included in the task.

Type: Integer

Required: Yes

EndTime

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.

Type: Timestamp

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: