PartnerCentralSellingAPI / Paginator / ListProspectingFromEngagementTasks

ListProspectingFromEngagementTasks

class PartnerCentralSellingAPI.Paginator.ListProspectingFromEngagementTasks

paginator = client.get_paginator('list_prospecting_from_engagement_tasks')

paginate(**kwargs)

Creates an iterator that will paginate through responses from PartnerCentralSellingAPI.Client.list_prospecting_from_engagement_tasks().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Catalog='string',
    TaskIdentifier=[
        'string',
    ],
    TaskName=[
        'string',
    ],
    StartAfter=datetime(2015, 1, 1),
    StartBefore=datetime(2015, 1, 1),
    Sort={
        'SortOrder': 'ASCENDING'|'DESCENDING',
        'SortBy': 'StartTime'|'TaskName'|'FailedEngagementCount'
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  Specifies the catalog to list tasks from. Specify AWS for production environments and Sandbox for testing and development purposes.

• TaskIdentifier (list) –

  Filters the results to include only the tasks with the specified identifiers. Provide up to 10 task IDs to narrow the list to specific tasks. If omitted, tasks are not filtered by identifier.

  • (string) –

• TaskName (list) –

  Filters the results to include only tasks with the specified names. Provide up to 10 task names to narrow the list. If omitted, tasks are not filtered by name.

  • (string) –

• StartAfter (datetime) – Filters tasks to include only those that started after the specified timestamp. Use this with StartBefore to define a start-time range for your query. The format follows ISO 8601 date-time notation.

• StartBefore (datetime) – Filters tasks to include only those that started before the specified timestamp. Use this with StartAfter to define a start-time range for your query. The format follows ISO 8601 date-time notation.

• Sort (dict) –

  Specifies the field and order used to sort the returned tasks. If omitted, tasks are returned in the default sort order.

  • SortOrder (string) – [REQUIRED]

    The direction in which to sort the results. Use ASCENDING to return the smallest or earliest values first, or DESCENDING to return the largest or most recent values first.

  • SortBy (string) – [REQUIRED]

    The field by which to sort the returned tasks. Valid values: StartTime (task creation timestamp), TaskName (alphabetically by task name), and FailedEngagementCount (number of failed engagements).

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'TaskSummaries': [
        {
            'TaskId': 'string',
            'TaskArn': 'string',
            'TaskName': 'string',
            'StartTime': datetime(2015, 1, 1),
            'EndTime': datetime(2015, 1, 1),
            'TotalEngagementCount': 123,
            'CompletedEngagementCount': 123,
            'FailedEngagementCount': 123
        },
    ]
}

Response Structure

• (dict) –

  Represents the response structure containing a paginated list of prospecting task summaries matching the request filters. Indicates through NextToken when additional results are available.

  • TaskSummaries (list) –

    Prospecting task summaries matching the specified filters. Each summary includes the task identifier, name, status counters, and timing information. If no tasks match the filter criteria, the list is empty.

    • (dict) –

      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.

      • TaskId (string) –

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

      • TaskArn (string) –

        The Amazon Resource Name (ARN) of the task.

      • TaskName (string) –

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

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

      • TotalEngagementCount (integer) –

        The total number of engagements included in the task.

      • CompletedEngagementCount (integer) –

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

      • FailedEngagementCount (integer) –

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