Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445428373.9 KB

Starts a task to convert one or more engagement contexts into new prospecting leads. The task runs asynchronously. To poll for status, use <code>GetProspectingFromEngagementTask</code>, or use <code>ListProspectingFromEngagementTasks</code> to monitor multiple tasks.

post/#X-Amz-Target=AWSPartnerCentralSelling.StartProspectingFromEngagementTask

Headers

X-Amz-Target'AWSPartnerCentralSelling.StartProspectingFromEngagementTask' required

Request body

Catalogstring required

Specifies the catalog in which the task is initiated. Specify <code>AWS</code> for production environments and <code>Sandbox</code> for testing and development purposes.

IdentifiersEngagementIdentifier[] required

The list of engagement identifiers to include in this prospecting task. Each identifier must correspond to an existing engagement in the specified catalog. Maximum of 100 identifiers per task.

TaskNamestring required

A descriptive name for the task. This name helps identify the task in list and get operations. The name must contain 1 to 128 characters.

ClientTokenstring required

A unique, case-sensitive identifier provided by the client to ensure idempotency. Making the same request with the same <code>ClientToken</code> returns the same response without creating a duplicate task.

Response

Success

IdentifiersEngagementIdentifier[] required

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

TaskNamestring required

The task name from the request.

Messagestring

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.

ReasonCodestring

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

StartTimestring date-time required

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

TaskIdstring

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

TaskArnstring

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.

TaskStatus'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

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