PartnerCentralSellingAPI / Client / start_prospecting_from_engagement_task

start_prospecting_from_engagement_task

PartnerCentralSellingAPI.Client.start_prospecting_from_engagement_task(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.start_prospecting_from_engagement_task(
    Catalog='string',
    Identifiers=[
        'string',
    ],
    TaskName='string',
    ClientToken='string'
)

Parameters:

• Catalog (string) –

  [REQUIRED]

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

• Identifiers (list) –

  [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.

  • (string) –

• TaskName (string) –

  [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.

• ClientToken (string) –

  [REQUIRED]

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

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'Identifiers': [
        'string',
    ],
    'TaskName': 'string',
    'Message': 'string',
    'ReasonCode': 'string',
    'StartTime': datetime(2015, 1, 1),
    'TaskId': 'string',
    'TaskArn': 'string',
    'TaskStatus': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED'
}

Response Structure

• (dict) –

  Represents the response structure returned when a prospecting task is successfully submitted. Contains the task identifier, ARN, and initial status. Uses TaskId with GetProspectingFromEngagementTask to poll for completion.

  • Identifiers (list) –

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

    • (string) –

  • TaskName (string) –

    The task name from the request.

  • Message (string) –

    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.

  • ReasonCode (string) –

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

  • StartTime (datetime) –

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

  • TaskId (string) –

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

  • TaskArn (string) –

    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 (string) –

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

Exceptions

• PartnerCentralSellingAPI.Client.exceptions.ConflictException

• PartnerCentralSellingAPI.Client.exceptions.ThrottlingException

• PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException

• PartnerCentralSellingAPI.Client.exceptions.InternalServerException

• PartnerCentralSellingAPI.Client.exceptions.ValidationException

• PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException