v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445428373.9 KB

This action starts the engagement by accepting an <code>EngagementInvitation</code>. The task is asynchronous and involves the following steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS opportunity, and copying details for tracking. When completed, an <code>Opportunity Created</code> event is generated, indicating that the opportunity has been successfully created in the partner's account.

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

Headers

X-Amz-Target'AWSPartnerCentralSelling.StartEngagementByAcceptingInvitationTask' required

Request body

Catalogstring required

Specifies the catalog related to the task. Use <code>AWS</code> for production engagements and <code>Sandbox</code> for testing scenarios.

ClientTokenstring required

A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.

Identifierstring required

Specifies the unique identifier of the <code>EngagementInvitation</code> to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.

Response

Success

TaskIdstring

The unique identifier of the task, used to track the task’s progress.

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.

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. This is the unique identifier for the opportunity.

ResourceSnapshotJobIdstring

The identifier of the Resource Snapshot Job created as part of this task.

EngagementInvitationIdstring

Returns the identifier of the engagement invitation that was accepted and used to create the opportunity.