engagement_invitations

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

Overview

Name	engagement_invitations
Type	Resource
Id	aws.partnercentral_selling.engagement_invitations

Fields

The following fields are returned by SELECT queries:

get_engagement_invitation

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) that identifies the engagement invitation.
catalog	string	Indicates the catalog from which the engagement invitation details are retrieved. This field helps in identifying the appropriate catalog (e.g., AWS or Sandbox) used in the request. (pattern: <code>[a-zA-Z]+</code>)
engagement_description	string	The description of the engagement associated with this invitation. (pattern: <code>(?s).{0,255}</code>)
engagement_id	string	The identifier of the engagement associated with this invitation.This ID links the invitation to its corresponding engagement. (pattern: <code>eng-[0-9a-z]{14}</code>)
engagement_title	string	The title of the engagement invitation, summarizing the purpose or objectives of the opportunity shared by AWS. (pattern: <code>(?s).{0,40}</code>)
enrichment_context	object	The enrichment data for the engagement associated with this invitation. You can view propensity scores, program eligibility, and lead readiness assessments before taking action on the invitation.
existing_members	array	A list of active members currently part of the Engagement. This array contains a maximum of 10 members, each represented by an object with the following properties. CompanyName: The name of the member's company. WebsiteUrl: The website URL of the member's company.
expiration_date	string (date-time)	Indicates the date on which the engagement invitation will expire if not accepted by the partner.
id	string	Unique identifier assigned to the engagement invitation being retrieved. (pattern: <code>(?=.{1,255}$)(arn:.*|engi-[0-9a-z]{13})</code>)
invitation_date	string (date-time)	The date when the engagement invitation was sent to the partner.
invitation_message	string	The message sent to the invited partner when the invitation was created. (pattern: <code>(?s).{1,255}</code>)
payload	object	Contains the data payload associated with the Engagement Invitation. This payload includes essential details related to the AWS opportunity and is used by partners to evaluate whether to accept or reject the engagement.
payload_type	string	The type of payload contained in the engagement invitation, indicating what data or context the payload covers. (OpportunityInvitation, LeadInvitation)
receiver	object	Represents the entity that received the Engagement Invitation, including account and company details. This field is essential for tracking the partner who is being invited to collaborate.
rejection_reason	string	If the engagement invitation was rejected, this field specifies the reason provided by the partner for the rejection. (pattern: <code>[\u0020-\u007E\u00A0-\uD7FF\uE000-\uFFFD]{1,80}</code>)
sender_aws_account_id	string	Specifies the AWS Account ID of the sender, which identifies the AWS team responsible for sharing the engagement invitation. (pattern: <code>([0-9]{12}|\w{1,12})</code>)
sender_company_name	string	The name of the AWS organization or team that sent the engagement invitation. (pattern: <code>(?s).{0,120}</code>)
status	string	The current status of the engagement invitation. (ACCEPTED, PENDING, REJECTED, EXPIRED)

list_engagement_invitations

Name	Datatype	Description
arn	string	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.
catalog	string	Specifies the catalog in which the Engagement Invitation resides. This can be either the AWS or Sandbox catalog, indicating whether the opportunity is live or being tested. (pattern: <code>[a-zA-Z]+</code>)
engagement_id	string	The identifier of the Engagement associated with this invitation. This links the invitation to its parent Engagement. (pattern: <code>eng-[0-9a-z]{14}</code>)
engagement_title	string	Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities. (pattern: <code>(?s).{0,40}</code>)
expiration_date	string (date-time)	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 be unavailable to the partner.
id	string	Represents the unique identifier of the Engagement Invitation. This identifier is used to track the invitation and to manage responses like acceptance or rejection. (pattern: <code>(?=.{1,255}$)(arn:.*|engi-[0-9a-z]{13})</code>)
invitation_date	string (date-time)	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.
participant_type	string	Identifies the role of the caller in the engagement invitation. (SENDER, RECEIVER)
payload_type	string	Describes the type of payload associated with the Engagement Invitation, such as Opportunity or MarketplaceOffer. This helps partners understand the nature of the engagement request from AWS. (OpportunityInvitation, LeadInvitation)
receiver	object	Represents the entity that received the Engagement Invitation, including account and company details. This field is essential for tracking the partner who is being invited to collaborate.
sender_aws_account_id	string	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. (pattern: <code>([0-9]{12}|\w{1,12})</code>)
sender_company_name	string	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. (pattern: <code>(?s).{0,120}</code>)
status	string	Represents the current status of the Engagement Invitation, such as Pending, Accepted, or Rejected. The status helps track the progress and response to the invitation. (ACCEPTED, PENDING, REJECTED, EXPIRED)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_engagement_invitation	select	region		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 Payload.Project.Title with opportunity Project.Title.
list_engagement_invitations	select	region		Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.
create_engagement_invitation	insert	region, ClientToken, EngagementIdentifier, Invitation		This action creates an invitation from a sender to a single receiver to join an engagement.

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

get_engagement_invitation

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 Payload.Project.Title with opportunity Project.Title.

SELECT
arn,
catalog,
engagement_description,
engagement_id,
engagement_title,
enrichment_context,
existing_members,
expiration_date,
id,
invitation_date,
invitation_message,
payload,
payload_type,
receiver,
rejection_reason,
sender_aws_account_id,
sender_company_name,
status
FROM aws.partnercentral_selling.engagement_invitations
WHERE region = '{{ region }}' -- required
;

list_engagement_invitations

Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.

SELECT
arn,
catalog,
engagement_id,
engagement_title,
expiration_date,
id,
invitation_date,
participant_type,
payload_type,
receiver,
sender_aws_account_id,
sender_company_name,
status
FROM aws.partnercentral_selling.engagement_invitations
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_engagement_invitation

This action creates an invitation from a sender to a single receiver to join an engagement.

INSERT INTO aws.partnercentral_selling.engagement_invitations (
Catalog,
ClientToken,
EngagementIdentifier,
Invitation,
region
)
SELECT 
'{{ Catalog }}',
'{{ ClientToken }}' /* required */,
'{{ EngagementIdentifier }}' /* required */,
'{{ Invitation }}' /* required */,
'{{ region }}'
RETURNING
arn,
id
;

Manifest

# Description fields are for documentation purposes
- name: engagement_invitations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the engagement_invitations resource.
  - name: Catalog
    value: "{{ Catalog }}"
    description: |
      Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
  - name: ClientToken
    value: "{{ ClientToken }}"
    description: |
      Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.
  - name: EngagementIdentifier
    value: "{{ EngagementIdentifier }}"
    description: |
      The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.
  - name: Invitation
    description: |
      The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details, or LeadInvitation, which includes structures for customer information and interaction details.
    value:
      Message: "{{ Message }}"
      Receiver:
        Account:
          Alias: "{{ Alias }}"
          AwsAccountId: "{{ AwsAccountId }}"
      Payload:
        OpportunityInvitation:
          SenderContacts:
            - Email: "{{ Email }}"
              FirstName: "{{ FirstName }}"
              LastName: "{{ LastName }}"
              BusinessTitle: "{{ BusinessTitle }}"
              Phone: "{{ Phone }}"
          ReceiverResponsibilities:
            - "{{ ReceiverResponsibilities }}"
          Customer:
            Industry: "{{ Industry }}"
            CompanyName: "{{ CompanyName }}"
            WebsiteUrl: "{{ WebsiteUrl }}"
            CountryCode: "{{ CountryCode }}"
          Project:
            BusinessProblem: "{{ BusinessProblem }}"
            Title: "{{ Title }}"
            TargetCompletionDate: "{{ TargetCompletionDate }}"
            ExpectedCustomerSpend:
              - Amount: "{{ Amount }}"
                CurrencyCode: "{{ CurrencyCode }}"
                Frequency: "{{ Frequency }}"
                TargetCompany: "{{ TargetCompany }}"
                EstimationUrl: "{{ EstimationUrl }}"
        LeadInvitation:
          Customer:
            Industry: "{{ Industry }}"
            CompanyName: "{{ CompanyName }}"
            WebsiteUrl: "{{ WebsiteUrl }}"
            CountryCode: "{{ CountryCode }}"
            AwsMaturity: "{{ AwsMaturity }}"
            MarketSegment: "{{ MarketSegment }}"
          Interaction:
            SourceType: "{{ SourceType }}"
            SourceId: "{{ SourceId }}"
            SourceName: "{{ SourceName }}"
            Usecase: "{{ Usecase }}"
            ContactBusinessTitle: "{{ ContactBusinessTitle }}"