list_engagement_from_opportunity_tasks ¶

def list_engagement_from_opportunity_tasks(
    self,
    catalog: "capo_partnercentral_selling.types.catalog_identifier.CatalogIdentifier",
    *,
    config_overrides: Optional[PartnerCentralSellingClientConfig] = None,
    max_results: Optional[int] = None,
    next_token: Optional[str] = None,
    sort: Optional[
        "capo_partnercentral_selling.types.list_tasks_sort_base.ListTasksSortBase"
    ] = None,
    task_status: Optional[
        "capo_partnercentral_selling.types.task_statuses.TaskStatuses"
    ] = None,
    task_identifier: Optional[
        "capo_partnercentral_selling.types.task_identifiers.TaskIdentifiers"
    ] = None,
    opportunity_identifier: Optional[
        "capo_partnercentral_selling.types.opportunity_identifiers.OpportunityIdentifiers"
    ] = None,
    engagement_identifier: Optional[
        "capo_partnercentral_selling.types.engagement_identifiers.EngagementIdentifiers"
    ] = None,
) -> "capo_partnercentral_selling.types.list_engagement_from_opportunity_tasks_response.ListEngagementFromOpportunityTasksResponse":
    """<p> Lists all in-progress, completed, or failed <code>EngagementFromOpportunity</code> tasks that were initiated by the caller's account. </p>

    Args:
        max_results: <p> 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. </p>
        next_token: <p> 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. </p>
        sort: <p> Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes. </p>
        catalog: <p> Specifies the catalog related to the request. Valid values are: </p> <ul> <li> <p> AWS: Retrieves the request from the production AWS environment. </p> </li> <li> <p> Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes. </p> </li> </ul>
        task_status: <p> Filters the tasks based on their current status. This allows you to focus on tasks in specific states. </p>
        task_identifier: <p> Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks. </p>
        opportunity_identifier: <p> The identifier of the original opportunity associated with this task. </p>
        engagement_identifier: <p> Filters tasks by the identifiers of the engagements they created or are associated with. </p>

    Raises:
        capo_partnercentral_selling.errors.access_denied_exception.AccessDeniedException: <p>This error occurs when you don't have permission to perform the requested action.</p> <p>You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.</p>
        capo_partnercentral_selling.errors.internal_server_exception.InternalServerException: <p>This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.</p> <p>Suggested action: This is usually a transient error. Retry after the provided retry delay or a short interval. If the problem persists, contact AWS support.</p>
        capo_partnercentral_selling.errors.resource_not_found_exception.ResourceNotFoundException: <p>This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.</p> <p>Suggested action: Verify that the resource ID is correct and the resource is in the expected AWS region. Check IAM permissions for accessing the resource.</p>
        capo_partnercentral_selling.errors.throttling_exception.ThrottlingException: <p>This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.</p> <p>This error occurs when there are too many requests sent. Review the provided <a href="https://docs.aws.amazon.com/partner-central/latest/selling-api/quotas.html">Quotas</a> and retry after the provided delay.</p>
        capo_partnercentral_selling.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the service or business validation rules.</p> <p>Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.</p>
        capo_partnercentral_selling.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_partnercentral_selling.types.list_engagement_from_opportunity_tasks_request.ListEngagementFromOpportunityTasksRequest]",
    ) -> OperationResponse[
        "capo_partnercentral_selling.types.list_engagement_from_opportunity_tasks_response.ListEngagementFromOpportunityTasksResponse"
    ]:
        import capo_partnercentral_selling._operations.aws_partner_central_selling.list_engagement_from_opportunity_tasks

        output, http_response = (
            capo_partnercentral_selling._operations.aws_partner_central_selling.list_engagement_from_opportunity_tasks.list_engagement_from_opportunity_tasks(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListEngagementFromOpportunityTasks")
    )
    input_: capo_partnercentral_selling.types.list_engagement_from_opportunity_tasks_request.ListEngagementFromOpportunityTasksRequest = {
        "catalog": catalog
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if sort is not None:
        input_["sort"] = sort
    if task_status is not None:
        input_["task_status"] = task_status
    if task_identifier is not None:
        input_["task_identifier"] = task_identifier
    if opportunity_identifier is not None:
        input_["opportunity_identifier"] = opportunity_identifier
    if engagement_identifier is not None:
        input_["engagement_identifier"] = engagement_identifier

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output