EngagementInvitationSummary
Provides a summarized view of the Engagement Invitation, including key details like the identifier, status, and sender information. This summary helps partners track and manage AWS originated opportunities.
Contents
Note
In the following list, the required parameters are described first.
- Catalog
-
Specifies the catalog in which the Engagement Invitation resides. This can be either the
AWS
orSandbox
catalog, indicating whether the opportunity is live or being tested.Type: String
Pattern:
^[a-zA-Z]+$
Required: Yes
- Id
-
Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
^(arn:.*|engi-[0-9a-z]{13})$
Required: Yes
- Arn
-
The Amazon Resource Name (ARN) of the Engagement Invitation. The ARN is a unique identifier that allows partners to reference the invitation in their system and manage its lifecycle.
Type: String
Required: No
- EngagementTitle
-
Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Required: No
- ExpirationDate
-
Indicates the date and time when the Engagement Invitation will expire. After this date, the invitation can no longer be accepted, and the opportunity will no longer be available for the partner to engage.
Type: Timestamp
Required: No
- InvitationDate
-
Indicates the date when the Engagement Invitation was sent to the partner. This provides context for when the opportunity was shared and helps in tracking the timeline for engagement.
Type: Timestamp
Required: No
- PayloadType
-
Describes the type of payload associated with the Engagement Invitation, such as
Opportunity
orMarketplaceOffer
. This helps partners understand the nature of the engagement request from AWS.Type: String
Valid Values:
OpportunityInvitation
Required: No
- Receiver
-
Specifies the partner company or individual that received the Engagement Invitation. This field is important for tracking who the invitation was sent to within the partner organization.
Type: Receiver object
Note: This object is a Union. Only one member of this object can be specified or returned.
Required: No
- SenderAwsAccountId
-
Specifies the AWS account ID of the sender who initiated the Engagement Invitation. This allows the partner to identify the AWS entity or representative responsible for sharing the opportunity.
Type: String
Pattern:
^(aws|[0-9]{12})$
Required: No
- SenderCompanyName
-
Indicates the name of the company or AWS division that sent the Engagement Invitation. This information is useful for partners to know which part of AWS is requesting engagement.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 120.
Required: No
- Status
-
Represents the current status of the Engagement Invitation, such as
Pending
,Accepted
, orRejected
. The status helps track the progress and response to the invitation.Type: String
Valid Values:
ACCEPTED | PENDING | REJECTED | EXPIRED
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: