Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445428373.9 KB

Similar to <code>StartEngagementByAcceptingInvitationTask</code>, this action is asynchronous and performs multiple steps before completion. This action orchestrates a comprehensive workflow that combines multiple API operations into a single task to create and initiate an engagement from an existing opportunity. It automatically executes a sequence of operations including <code>GetOpportunity</code>, <code>CreateEngagement</code> (if it doesn't exist), <code>CreateResourceSnapshot</code>, <code>CreateResourceSnapshotJob</code>, <code>CreateEngagementInvitation</code> (if not already invited/accepted), and <code>SubmitOpportunity</code>.

post/#X-Amz-Target=AWSPartnerCentralSelling.StartEngagementFromOpportunityTask

Headers

X-Amz-Target'AWSPartnerCentralSelling.StartEngagementFromOpportunityTask' required

Request body

Catalogstring required

Specifies the catalog in which the engagement is tracked. Acceptable values include <code>AWS</code> for production and <code>Sandbox</code> for testing environments.

ClientTokenstring required

A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.

Identifierstring required

The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.

Response

Success

TaskIdstring

The unique identifier of the task, used to track the task’s progress. This value follows a specific pattern: <code>^oit-[0-9a-z]{13}$</code>.

TaskArnstring

The Amazon Resource Name (ARN) of the task, used for tracking and managing the task within AWS.

StartTimestring date-time

The timestamp indicating when the task was initiated. The format follows RFC 3339 section 5.6.

TaskStatus'IN_PROGRESS' | 'COMPLETE' | 'FAILED'

Indicates the current status of the task. Valid values include <code>IN_PROGRESS</code>, <code>COMPLETE</code>, and <code>FAILED</code>.

Messagestring

If the task fails, this field contains a detailed message describing the failure and possible recovery steps.

ReasonCode'InvitationAccessDenied' | 'InvitationValidationFailed' | 'EngagementAccessDenied' | 'OpportunityAccessDenied' | 'ResourceSnapshotJobAccessDenied' | 'ResourceSnapshotJobValidationFailed' | 'ResourceSnapshotJobConflict' | 'EngagementValidationFailed' | 'EngagementConflict' | 'OpportunitySubmissionFailed' | 'EngagementInvitationConflict' | 'InternalError' | 'OpportunityValidationFailed' | 'OpportunityConflict' | 'ResourceSnapshotAccessDenied' | 'ResourceSnapshotValidationFailed' | 'ResourceSnapshotConflict' | 'ServiceQuotaExceeded' | 'RequestThrottled' | 'ContextNotFound' | 'CustomerProjectContextNotPermitted' | 'DisqualifiedLeadNotPermitted'

Indicates the reason for task failure using an enumerated code.

OpportunityIdstring

Returns the original opportunity identifier passed in the request, which is the unique identifier for the opportunity created in the partner’s system.

ResourceSnapshotJobIdstring

The identifier of the resource snapshot job created to add the opportunity resource snapshot to the Engagement. Only populated if TaskStatus is COMPLETE

EngagementIdstring

The identifier of the newly created Engagement. Only populated if TaskStatus is COMPLETE.

EngagementInvitationIdstring

The identifier of the new Engagement invitation. Only populated if TaskStatus is COMPLETE.