/AWS1/CL_PTSSTRTPSPFRMENGTSK01¶
Represents the response structure returned when a prospecting task is successfully submitted. Contains the task identifier, ARN, and initial status. Uses TaskId with GetProspectingFromEngagementTask to poll for completion.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
it_identifiers TYPE /AWS1/CL_PTSENGAGEMENTIDLIST_W=>TT_ENGAGEMENTIDENTIFIERLIST TT_ENGAGEMENTIDENTIFIERLIST¶
The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.
iv_taskname TYPE /AWS1/PTSTASKNAME /AWS1/PTSTASKNAME¶
The task name from the request.
iv_starttime TYPE /AWS1/PTSDATETIME /AWS1/PTSDATETIME¶
The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
iv_taskstatus TYPE /AWS1/PTSPROSPECTINGTASKSTATUS /AWS1/PTSPROSPECTINGTASKSTATUS¶
The current status of the task. Possible values:
PENDING(waiting to run),IN_PROGRESS(actively processing),COMPLETED(successfully processed), andFAILED(unrecoverable error).
Optional arguments:¶
iv_message TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING¶
A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.
iv_reasoncode TYPE /AWS1/PTSSTRING /AWS1/PTSSTRING¶
An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding
Messagefield for a human-readable description of the failure.
iv_taskid TYPE /AWS1/PTSPROSPCTTASKIDENTIFIER /AWS1/PTSPROSPCTTASKIDENTIFIER¶
The unique identifier assigned to this task. Use this identifier with
GetProspectingFromEngagementTaskto retrieve task details and check status.
iv_taskarn TYPE /AWS1/PTSPROSPECTINGTASKARN /AWS1/PTSPROSPECTINGTASKARN¶
The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.
Queryable Attributes¶
Identifiers¶
The list of engagement identifiers that were accepted into the task queue for processing. This list matches the identifiers provided in the request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_IDENTIFIERS() |
Getter for IDENTIFIERS, with configurable default |
ASK_IDENTIFIERS() |
Getter for IDENTIFIERS w/ exceptions if field has no value |
HAS_IDENTIFIERS() |
Determine if IDENTIFIERS has a value |
TaskName¶
The task name from the request.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TASKNAME() |
Getter for TASKNAME, with configurable default |
ASK_TASKNAME() |
Getter for TASKNAME w/ exceptions if field has no value |
HAS_TASKNAME() |
Determine if TASKNAME has a value |
Message¶
A message providing additional context about the task's current state. When the task fails, this field contains a detailed description of the failure and suggested recovery steps. This field is only populated for tasks in a failed state.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_MESSAGE() |
Getter for MESSAGE, with configurable default |
ASK_MESSAGE() |
Getter for MESSAGE w/ exceptions if field has no value |
HAS_MESSAGE() |
Determine if MESSAGE has a value |
ReasonCode¶
An enumerated code identifying the reason for task failure. This field is only populated when the task has failed. Use the corresponding
Messagefield for a human-readable description of the failure.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_REASONCODE() |
Getter for REASONCODE, with configurable default |
ASK_REASONCODE() |
Getter for REASONCODE w/ exceptions if field has no value |
HAS_REASONCODE() |
Determine if REASONCODE has a value |
StartTime¶
The timestamp indicating when the task was initiated. The format follows ISO 8601 date-time notation.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_STARTTIME() |
Getter for STARTTIME, with configurable default |
ASK_STARTTIME() |
Getter for STARTTIME w/ exceptions if field has no value |
HAS_STARTTIME() |
Determine if STARTTIME has a value |
TaskId¶
The unique identifier assigned to this task. Use this identifier with
GetProspectingFromEngagementTaskto retrieve task details and check status.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TASKID() |
Getter for TASKID, with configurable default |
ASK_TASKID() |
Getter for TASKID w/ exceptions if field has no value |
HAS_TASKID() |
Determine if TASKID has a value |
TaskArn¶
The Amazon Resource Name (ARN) of the task. The ARN uniquely identifies the task across AWS and can be used for resource-level IAM policies.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TASKARN() |
Getter for TASKARN, with configurable default |
ASK_TASKARN() |
Getter for TASKARN w/ exceptions if field has no value |
HAS_TASKARN() |
Determine if TASKARN has a value |
TaskStatus¶
The current status of the task. Possible values:
PENDING(waiting to run),IN_PROGRESS(actively processing),COMPLETED(successfully processed), andFAILED(unrecoverable error).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TASKSTATUS() |
Getter for TASKSTATUS, with configurable default |
ASK_TASKSTATUS() |
Getter for TASKSTATUS w/ exceptions if field has no value |
HAS_TASKSTATUS() |
Determine if TASKSTATUS has a value |