engagement_from_opportunity_tasks

Creates, updates, deletes, gets or lists an engagement_from_opportunity_tasks resource.

Overview

Name	engagement_from_opportunity_tasks
Type	Resource
Id	aws.partnercentral_selling.engagement_from_opportunity_tasks

Fields

The following fields are returned by SELECT queries:

list_engagement_from_opportunity_tasks

Name	Datatype	Description
engagement_id	string	The unique identifier of the engagement created as a result of the task. This field is populated when the task is completed successfully. (pattern: <code>eng-[0-9a-z]{14}</code>)
engagement_invitation_id	string	The unique identifier of the Engagement Invitation. (pattern: <code>engi-[0-9,a-z]{13}</code>)
message	string	A detailed message providing additional information about the task, especially useful in case of failures. This field may contain error details or other relevant information about the task's execution
opportunity_id	string	The unique identifier of the original Opportunity from which the Engagement is being created. This field helps track the source of the Engagement creation task. (pattern: <code>O[0-9]{1,19}</code>)
reason_code	string	A code indicating the specific reason for a task failure. This field is populated when the task status is FAILED and provides a categorized reason for the failure. (InvitationAccessDenied, InvitationValidationFailed, EngagementAccessDenied, OpportunityAccessDenied, ResourceSnapshotJobAccessDenied, ResourceSnapshotJobValidationFailed, ResourceSnapshotJobConflict, EngagementValidationFailed, EngagementConflict, OpportunitySubmissionFailed, EngagementInvitationConflict, InternalError, OpportunityValidationFailed, OpportunityConflict, ResourceSnapshotAccessDenied, ResourceSnapshotValidationFailed, ResourceSnapshotConflict, ServiceQuotaExceeded, RequestThrottled, ContextNotFound, CustomerProjectContextNotPermitted, DisqualifiedLeadNotPermitted)
resource_snapshot_job_id	string	The identifier of the resource snapshot job associated with this task, if a snapshot was created as part of the Engagement creation process. (pattern: <code>job-[0-9a-z]{13}</code>)
start_time	string (date-time)	The timestamp indicating when the task was initiated, in RFC 3339 5.6 date-time format.
task_arn	string	The Amazon Resource Name (ARN) uniquely identifying this task within AWS. This ARN can be used for referencing the task in other AWS services or APIs. (pattern: <code>arn:.*</code>)
task_id	string	A unique identifier for a specific task. (pattern: <code>.*task-[0-9a-z]{13}</code>)
task_status	string	The current status of the task. (IN_PROGRESS, COMPLETE, FAILED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_engagement_from_opportunity_tasks	select	region		Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

list_engagement_from_opportunity_tasks

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

SELECT
engagement_id,
engagement_invitation_id,
message,
opportunity_id,
reason_code,
resource_snapshot_job_id,
start_time,
task_arn,
task_id,
task_status
FROM aws.partnercentral_selling.engagement_from_opportunity_tasks
WHERE region = '{{ region }}' -- required
;