PartnerCentralSellingAPI / Client / list_engagement_by_accepting_invitation_tasks

list_engagement_by_accepting_invitation_tasks

PartnerCentralSellingAPI.Client.list_engagement_by_accepting_invitation_tasks(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.list_engagement_by_accepting_invitation_tasks(
    Catalog='string',
    EngagementInvitationIdentifier=[
        '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.

• EngagementInvitationIdentifier (list) –

  Filters tasks by the identifiers of the engagement invitations they are processing.

  • (string) –

• MaxResults (integer) – 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) – Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.

• OpportunityIdentifier (list) –

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

  • (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': [
        {
            '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) –

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

    • (dict) –

      Specifies a subset of fields associated with tasks related to accepting an engagement invitation.

      • EngagementInvitationId (string) –

        The unique identifier of the engagement invitation that was accepted.

      • Message (string) –

        Detailed message describing the failure and possible recovery steps.

      • OpportunityId (string) –

        Unique identifier of opportunity that was created.

      • ReasonCode (string) –

        A code pointing to the specific reason for the failure.

      • ResourceSnapshotJobId (string) –

        Unique identifier of the resource snapshot job that was created.

      • StartTime (datetime) –

        Task start timestamp.

      • TaskArn (string) –

        The Amazon Resource Name (ARN) that uniquely identifies the task.

      • TaskId (string) –

        Unique identifier of the task.

      • TaskStatus (string) –

        Status of the task.

Exceptions

• PartnerCentralSellingAPI.Client.exceptions.ThrottlingException

• PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException

• PartnerCentralSellingAPI.Client.exceptions.ValidationException

• PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException