PartnerCentralSellingAPI / Client / get_prospecting_from_engagement_task

get_prospecting_from_engagement_task

PartnerCentralSellingAPI.Client.get_prospecting_from_engagement_task(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_prospecting_from_engagement_task(
    Catalog='string',
    TaskIdentifier='string'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    Specifies the catalog associated with the task. Specify AWS for production environments and Sandbox for testing and development purposes. The value must match the catalog used when the task was created.

  • TaskIdentifier (string) –

    [REQUIRED]

    The unique identifier of the prospecting task to retrieve. This value is returned in the TaskId field of the StartProspectingFromEngagementTask response.

Return type:

dict

Returns:

Response Syntax

{
    'TaskId': 'string',
    'TaskArn': 'string',
    'TaskName': 'string',
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'Engagements': [
        {
            'EngagementIdentifier': 'string',
            'EngagementContextId': 'string',
            'Status': 'PENDING'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
            'ReasonCode': 'string',
            'Message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    Represents the response structure containing the full details of a prospecting task, including per-engagement processing results. Includes the Status field of each EngagementProspectingResult entry to determine individual outcomes.

    • TaskId (string) –

      The unique identifier of the task.

    • TaskArn (string) –

      The Amazon Resource Name (ARN) of the task.

    • TaskName (string) –

      The descriptive name of the task that you provided when you created it.

    • StartTime (datetime) –

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

    • EndTime (datetime) –

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

      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.

      • (dict) –

        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.

        • EngagementIdentifier (string) –

          The unique identifier of the engagement that was processed.

        • EngagementContextId (string) –

          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.

        • Status (string) –

          The processing status of this specific engagement. Possible values are PENDING, IN_PROGRESS, COMPLETED, and FAILED.

        • ReasonCode (string) –

          An enumerated code indicating the reason this engagement failed to process. This field is only populated when Status is FAILED.

        • Message (string) –

          A human-readable description of the failure for this engagement, including suggested recovery steps. This field is only populated when Status is FAILED.

Exceptions