Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445428373.9 KB

Lists all in-progress, completed, or failed opportunity creation tasks from engagements that were initiated by the caller's account.

post/#X-Amz-Target=AWSPartnerCentralSelling.ListOpportunityFromEngagementTasks

Headers

X-Amz-Target'AWSPartnerCentralSelling.ListOpportunityFromEngagementTasks' required

Request body

MaxResultsinteger

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.

NextTokenstring

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.

Catalogstring required

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

TaskStatusTaskStatus[]

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

TaskIdentifierTaskArnOrIdentifier[]

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.

OpportunityIdentifierOpportunityIdentifier[]

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.

EngagementIdentifierEngagementArnOrIdentifier[]

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.

ContextIdentifierContextIdentifier[]

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.

Response

Success

NextTokenstring

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.