ListOpportunityFromEngagementTasks

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.

Type: String

Pattern: [a-zA-Z]+

Required: Yes

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: [1-9][0-9]*

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: (arn:.*|eng-[0-9a-z]{14})

Required: No

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

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.

Type: String

Pattern: (?s).{1,2048}

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: O[0-9]{1,19}

Required: No

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

Type: ListTasksSortBase object

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Pattern: (arn:.*|task-[0-9a-z]{13})

Required: No

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.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 3 items.

Valid Values: IN_PROGRESS | COMPLETE | FAILED

Required: No

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.

Type: String

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.

Type: Array of ListOpportunityFromEngagementTaskSummary objects

This error occurs when you don't have permission to perform the requested action.

You don’t have access to this action or resource. Review IAM policies or contact your AWS administrator for assistance.

HTTP Status Code: 400

This error occurs when the specified resource can’t be found or doesn't exist. Resource ID and type might be incorrect.

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.

HTTP Status Code: 500

This error occurs when the specified resource can't be found. The resource might not exist, or isn't visible with the current credentials.

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.

HTTP Status Code: 400

This error occurs when there are too many requests sent. Review the provided quotas and adapt your usage to avoid throttling.

This error occurs when there are too many requests sent. Review the provided Quotas and retry after the provided delay.

HTTP Status Code: 400

The input fails to satisfy the constraints specified by the service or business validation rules.

Suggested action: Review the error message, including the failed fields and reasons, to correct the request payload.

HTTP Status Code: 400