PartnerCentralSellingAPI / Paginator / ListOpportunityFromEngagementTasks

ListOpportunityFromEngagementTasks

class PartnerCentralSellingAPI.Paginator.ListOpportunityFromEngagementTasks

paginator = client.get_paginator('list_opportunity_from_engagement_tasks')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Sort={
        'SortOrder': 'ASCENDING'|'DESCENDING',
        'SortBy': 'StartTime'
    },
    Catalog='string',
    TaskStatus=[
        'IN_PROGRESS'|'COMPLETE'|'FAILED',
    ],
    TaskIdentifier=[
        'string',
    ],
    OpportunityIdentifier=[
        'string',
    ],
    EngagementIdentifier=[
        'string',
    ],
    ContextIdentifier=[
        'string',
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Sort (dict) –

  Defines the sorting parameters for listing tasks. This structure allows for specifying the field to sort by and the order of sorting.

  • SortOrder (string) – [REQUIRED]

    Determines the order in which the sorted results are presented.

  • SortBy (string) – [REQUIRED]

    Specifies the field by which the task list should be sorted.

• Catalog (string) –

  [REQUIRED]

  Specifies the catalog related to the request. Valid values are AWS for production environments and Sandbox for testing or development purposes. The catalog determines which environment the task data is retrieved from.

• TaskStatus (list) –

  Filters the tasks based on their current status. This allows you to focus on tasks in specific states. Valid values are COMPLETE for tasks that have finished successfully, INPROGRESS for tasks that are currently running, and FAILED for tasks that have encountered an error and failed to complete.

  • (string) –

• TaskIdentifier (list) –

  Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. Provide the task ID to get details about a particular opportunity creation task.

  • (string) –

• OpportunityIdentifier (list) –

  Filters tasks by the identifiers of the opportunities they created or are associated with. Use this to find tasks related to specific opportunity creation processes.

  • (string) –

• EngagementIdentifier (list) –

  Filters tasks by the identifiers of the engagements from which opportunities are being created. Use this to find all opportunity creation tasks associated with a specific engagement.

  • (string) –

• ContextIdentifier (list) –

  Filters tasks by the identifiers of the engagement contexts associated with the opportunity creation. Use this to find tasks related to specific contextual information within engagements that are being converted to opportunities.

  • (string) –

• 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',
            'StartTime': datetime(2015, 1, 1),
            'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED',
            'Message': 'string',
            'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled'|'ContextNotFound'|'CustomerProjectContextNotPermitted'|'DisqualifiedLeadNotPermitted',
            'OpportunityId': 'string',
            'ResourceSnapshotJobId': 'string',
            'EngagementId': 'string',
            'ContextId': 'string'
        },
    ],

}

Response Structure

• (dict) –

  • TaskSummaries (list) –

    An array of ListOpportunityFromEngagementTaskSummary objects, each representing a task that matches the specified filters. The array may be empty if no tasks match the criteria.

    • (dict) –

      Provides a summary of a task related to creating an opportunity from an engagement. This structure contains key information about the task’s status, associated identifiers, and any failure details for opportunity creation processes.

      • TaskId (string) –

        The unique identifier of the task for creating an opportunity from an engagement.

      • TaskArn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies the task within AWS. This ARN can be used for referencing the task in other AWS services or APIs.

      • StartTime (datetime) –

        The timestamp indicating when the task was initiated, in RFC 3339 format.

      • TaskStatus (string) –

        The current status of the task. Valid values are COMPLETE, INPROGRESS, or FAILED.

      • Message (string) –

        A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task’s execution.

      • ReasonCode (string) –

        A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure.

      • OpportunityId (string) –

        The unique identifier of the opportunity created as a result of the task. This field is populated when the task is completed successfully.

      • ResourceSnapshotJobId (string) –

        The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the opportunity creation process.

      • EngagementId (string) –

        The unique identifier of the engagement from which the opportunity is being created. This field helps track the source of the opportunity creation task.

      • ContextId (string) –

        The unique identifier of the engagement context associated with the opportunity creation task. This links the task to specific contextual information within the engagement.