prospecting_from_engagement_tasks

Creates, updates, deletes, gets or lists a prospecting_from_engagement_tasks resource.

Overview

Name	prospecting_from_engagement_tasks
Type	Resource
Id	aws.partnercentral_selling.prospecting_from_engagement_tasks

Fields

The following fields are returned by SELECT queries:

get_prospecting_from_engagement_task

Name	Datatype	Description
end_time	string (date-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.
engagements	array	An array of EngagementProspectingResult entries for each engagement in the task. Each entry contains the processing status. For successfully completed engagements, includes the prospecting context identifier. For failed engagements, includes an error code and message.
start_time	string (date-time)	The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
task_arn	string	The Amazon Resource Name (ARN) of the task. (pattern: <code>arn:aws:partnercentral-selling:.:.:catalog/.*/prospecting-from-engagement-task/task-[0-9a-z]{14}</code>)
task_id	string	The unique identifier of the task. (pattern: <code>task-[0-9a-z]{14}</code>)
task_name	string	The descriptive name of the task that you provided when you created it.

list_prospecting_from_engagement_tasks

Name	Datatype	Description
completed_engagement_count	integer	The number of engagements that have been successfully converted into prospecting leads.
end_time	string (date-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.
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.
start_time	string (date-time)	The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
task_arn	string	The Amazon Resource Name (ARN) of the task. (pattern: <code>arn:aws:partnercentral-selling:.:.:catalog/.*/prospecting-from-engagement-task/task-[0-9a-z]{14}</code>)
task_id	string	The unique identifier of the task. Use this value with GetProspectingFromEngagementTask to retrieve full task details. (pattern: <code>task-[0-9a-z]{14}</code>)
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.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_prospecting_from_engagement_task	select	region		Retrieves the details and current status of a prospecting task previously started with StartProspectingFromEngagementTask to enable polling for completion and access to per-engagement processing results.
list_prospecting_from_engagement_tasks	select	region		Lists all prospecting tasks initiated by the caller's account. Supports optional filters by task identifier, task name, or start time range. Results can be sorted using configurable options. The response is paginated. Use the NextToken value from each response to retrieve subsequent pages.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

get_prospecting_from_engagement_task

Retrieves the details and current status of a prospecting task previously started with StartProspectingFromEngagementTask to enable polling for completion and access to per-engagement processing results.

SELECT
end_time,
engagements,
start_time,
task_arn,
task_id,
task_name
FROM aws.partnercentral_selling.prospecting_from_engagement_tasks
WHERE region = '{{ region }}' -- required
;

list_prospecting_from_engagement_tasks

Lists all prospecting tasks initiated by the caller's account. Supports optional filters by task identifier, task name, or start time range. Results can be sorted using configurable options. The response is paginated. Use the NextToken value from each response to retrieve subsequent pages.

SELECT
completed_engagement_count,
end_time,
failed_engagement_count,
start_time,
task_arn,
task_id,
task_name,
total_engagement_count
FROM aws.partnercentral_selling.prospecting_from_engagement_tasks
WHERE region = '{{ region }}' -- required
;