Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListEngagementFromOpportunityTasks

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

Request Syntax


{
   "Catalog": "string",
   "EngagementIdentifier": [ "string" ],
   "MaxResults": number,
   "NextToken": "string",
   "OpportunityIdentifier": [ "string" ],
   "Sort": { 
      "SortBy": "string",
      "SortOrder": "string"
   },
   "TaskIdentifier": [ "string" ],
   "TaskStatus": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

Catalog

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.

Type: String

Pattern: ^[a-zA-Z]+$

Required: Yes

EngagementIdentifier

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

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

MaxResults

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

NextToken

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

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

OpportunityIdentifier

The identifier of the original opportunity associated with this task.

Type: Array of strings

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

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

Required: No

Sort

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

Type: ListTasksSortBase object

Required: No

TaskIdentifier

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

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

TaskStatus

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

Type: Array of strings

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

Valid Values: IN_PROGRESS | COMPLETE | FAILED

Required: No

Response Syntax


{
   "NextToken": "string",
   "TaskSummaries": [ 
      { 
         "EngagementId": "string",
         "EngagementInvitationId": "string",
         "Message": "string",
         "OpportunityId": "string",
         "ReasonCode": "string",
         "ResourceSnapshotJobId": "string",
         "StartTime": "string",
         "TaskArn": "string",
         "TaskId": "string",
         "TaskStatus": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

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

TaskSummaries

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

Type: Array of ListEngagementFromOpportunityTaskSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

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

ResourceNotFoundException

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

ThrottlingException

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

ValidationException

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