PartnerCentralSellingAPI / Client / list_engagement_from_opportunity_tasks

list_engagement_from_opportunity_tasks

PartnerCentralSellingAPI.Client.list_engagement_from_opportunity_tasks(**kwargs)

Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller’s account.

See also: AWS API Documentation

Request Syntax

response = client.list_engagement_from_opportunity_tasks(
    Catalog='string',
    EngagementIdentifier=[
        'string',
    ],
    MaxResults=123,
    NextToken='string',
    OpportunityIdentifier=[
        'string',
    ],
    Sort={
        'SortBy': 'StartTime',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    },
    TaskIdentifier=[
        'string',
    ],
    TaskStatus=[
        'IN_PROGRESS'|'COMPLETE'|'FAILED',
    ]
)

Parameters:

• Catalog (string) –

  [REQUIRED]

  Specifies the catalog related to the request. Valid values are:

  • AWS: Retrieves the request from the production AWS environment.

  • Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.

• EngagementIdentifier (list) –

  Filters tasks by the identifiers of the engagements they created or are associated with.

  • (string) –

• MaxResults (integer) – Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

• NextToken (string) – The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.

• OpportunityIdentifier (list) –

  The identifier of the original opportunity associated with this task.

  • (string) –

• Sort (dict) –

  Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

  • SortBy (string) – [REQUIRED]

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

  • SortOrder (string) – [REQUIRED]

    Determines the order in which the sorted results are presented.

• TaskIdentifier (list) –

  Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

  • (string) –

• TaskStatus (list) –

  Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'TaskSummaries': [
        {
            'EngagementId': 'string',
            'EngagementInvitationId': 'string',
            'Message': 'string',
            'OpportunityId': 'string',
            'ReasonCode': 'InvitationAccessDenied'|'InvitationValidationFailed'|'EngagementAccessDenied'|'OpportunityAccessDenied'|'ResourceSnapshotJobAccessDenied'|'ResourceSnapshotJobValidationFailed'|'ResourceSnapshotJobConflict'|'EngagementValidationFailed'|'EngagementConflict'|'OpportunitySubmissionFailed'|'EngagementInvitationConflict'|'InternalError'|'OpportunityValidationFailed'|'OpportunityConflict'|'ResourceSnapshotAccessDenied'|'ResourceSnapshotValidationFailed'|'ResourceSnapshotConflict'|'ServiceQuotaExceeded'|'RequestThrottled',
            'ResourceSnapshotJobId': 'string',
            'StartTime': datetime(2015, 1, 1),
            'TaskArn': 'string',
            'TaskId': 'string',
            'TaskStatus': 'IN_PROGRESS'|'COMPLETE'|'FAILED'
        },
    ]
}

Response Structure

• (dict) –

  • NextToken (string) –

    A token used for pagination to retrieve the next page of results. If there are more results available, this field will contain a token that can be used in a subsequent API call to retrieve the next page. If there are no more results, this field will be null or an empty string.

  • TaskSummaries (list) –

    TaskSummaries An array of TaskSummary objects containing details about each task.

    • (dict) –

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

      • EngagementId (string) –

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

      • EngagementInvitationId (string) –

        The unique identifier of the Engagement Invitation.

      • 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

      • OpportunityId (string) –

        The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task.

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

      • ResourceSnapshotJobId (string) –

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

      • StartTime (datetime) –

        The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.

      • TaskArn (string) –

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

      • TaskId (string) –

        A unique identifier for a specific task.

      • TaskStatus (string) –

        The current status of the task.

Exceptions

• PartnerCentralSellingAPI.Client.exceptions.ThrottlingException

• PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException

• PartnerCentralSellingAPI.Client.exceptions.ValidationException

• PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException