Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1445428373.9 KB

Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s <code>Payload.Project.Title</code> with opportunity <code>Project.Title</code>.

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

Headers

X-Amz-Target'AWSPartnerCentralSelling.GetEngagementInvitation' required

Request body

Catalogstring required

Specifies the catalog associated with the request. The field accepts values from the predefined set: <code>AWS</code> for live operations or <code>Sandbox</code> for testing environments.

Identifierstring required

Specifies the unique identifier for the retrieved engagement invitation.

Response

Success

Arnstring

The Amazon Resource Name (ARN) that identifies the engagement invitation.

PayloadType'OpportunityInvitation' | 'LeadInvitation'

The type of payload contained in the engagement invitation, indicating what data or context the payload covers.

Idstring required

Unique identifier assigned to the engagement invitation being retrieved.

EngagementIdstring

The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement.

EngagementTitlestring

The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS.

Status'ACCEPTED' | 'PENDING' | 'REJECTED' | 'EXPIRED'

The current status of the engagement invitation.

InvitationDatestring date-time

The date when the engagement invitation was sent to the partner.

ExpirationDatestring date-time

Indicates the date on which the engagement invitation will expire if not accepted by the partner.

SenderAwsAccountIdstring password

Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation.

SenderCompanyNamestring

The name of the AWS organization or team that sent the engagement invitation.

Catalogstring required

Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., <code>AWS</code> or <code>Sandbox</code>) used in the request.

RejectionReasonstring

If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection.

InvitationMessagestring password

The message sent to the invited partner when the invitation was created.

EngagementDescriptionstring

The description of the engagement associated with this invitation.