Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetProspectingFromEngagementTask

Retrieves the details and current status of a prospecting task previously started with StartProspectingFromEngagementTask to enable polling for completion and access to per-engagement processing results.

Request Syntax


{
   "Catalog": "string",
   "TaskIdentifier": "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 associated with the task. Specify AWS for production environments and Sandbox for testing and development purposes. The value must match the catalog used when the task was created.

Type: String

Pattern: [a-zA-Z]+

Required: Yes

TaskIdentifier

The unique identifier of the prospecting task to retrieve. This value is returned in the TaskId field of the StartProspectingFromEngagementTask response.

Type: String

Pattern: task-[0-9a-z]{14}

Required: Yes

Response Syntax


{
   "EndTime": "string",
   "Engagements": [ 
      { 
         "EngagementContextId": "string",
         "EngagementIdentifier": "string",
         "Message": "string",
         "ReasonCode": "string",
         "Status": "string"
      }
   ],
   "StartTime": "string",
   "TaskArn": "string",
   "TaskId": "string",
   "TaskName": "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.

Engagements

An array of EngagementProspectingResult entries for each engagement in the task. Each entry contains the processing status. For successfully completed engagements, includes the prospecting context identifier. For failed engagements, includes an error code and message.

Type: Array of EngagementProspectingResult objects

StartTime

The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.

Type: Timestamp

TaskArn

The Amazon Resource Name (ARN) of the task.

Type: String

Pattern: arn:aws:partnercentral-selling:.*:.*:catalog/.*/prospecting-from-engagement-task/task-[0-9a-z]{14}

TaskId

The unique identifier of the task.

Type: String

Pattern: task-[0-9a-z]{14}

TaskName

The descriptive name of the task that you provided when you created it.

Type: String

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

EndTime

The timestamp indicating when the task finished processing. This field is absent if the task is still in progress. The format follows ISO 8601 date-time notation.

Type: Timestamp

Errors

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

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.

Reason: The reason why access was denied for the requested operation.

HTTP Status Code: 400

InternalServerException

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

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.

ErrorList

A list of issues that were discovered in the submitted request or the resource state.

Reason

The primary reason for this validation exception to occur.

REQUEST_VALIDATION_FAILED: The request format is not valid.

Fix: Verify your request payload includes all required fields, uses correct data types and string formats.
BUSINESS_VALIDATION_FAILED: The requested change doesn't pass the business validation rules.

Fix: Check that your change aligns with the business rules defined by AWS Partner Central.

HTTP Status Code: 400