PartnerCentralSellingAPI / Client / list_engagement_invitations

list_engagement_invitations#

PartnerCentralSellingAPI.Client.list_engagement_invitations(**kwargs)#

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.

Request Syntax

response = client.list_engagement_invitations(
    Catalog='string',
    MaxResults=123,
    NextToken='string',
    ParticipantType='RECEIVER',
    PayloadType=[
        'OpportunityInvitation',
    ],
    Sort={
        'SortBy': 'InvitationDate',
        'SortOrder': 'ASCENDING'|'DESCENDING'
    }
)

Parameters:

Catalog (string) –
[REQUIRED]

Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.
MaxResults (integer) – Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.
NextToken (string) – A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.
ParticipantType (string) –
[REQUIRED]

Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.
PayloadType (list) –
Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.
- (string) –
Sort (dict) –
Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.
- SortBy (string) – [REQUIRED]
  
  Specifies the field by which the Engagement Invitations are sorted. Common values include InvitationDate and Status.
- SortOrder (string) – [REQUIRED]
  
  Defines the order in which the Engagement Invitations are sorted. The values can be ASC (ascending) or DESC (descending).

Return type:

dict

Returns:

Response Syntax

{
    'EngagementInvitationSummaries': [
        {
            'Arn': 'string',
            'Catalog': 'string',
            'EngagementTitle': 'string',
            'ExpirationDate': datetime(2015, 1, 1),
            'Id': 'string',
            'InvitationDate': datetime(2015, 1, 1),
            'PayloadType': 'OpportunityInvitation',
            'Receiver': {
                'Account': {
                    'Alias': 'string',
                    'AwsAccountId': 'string'
                }
            },
            'SenderAwsAccountId': 'string',
            'SenderCompanyName': 'string',
            'Status': 'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- EngagementInvitationSummaries (list) –
  
  An array containing summaries of engagement invitations. Each summary includes information such as the invitation title, invitation date, and the current status of the invitation.
  - (dict) –
    
    Provides a summarized view of the Engagement Invitation, including details like the identifier, status, and sender. This summary helps partners track and manage AWS originated opportunities.
    - 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.
    - EngagementTitle (string) –
      
      Provides a short title or description of the Engagement Invitation. This title helps partners quickly identify and differentiate between multiple engagement opportunities.
    - ExpirationDate (datetime) –
      
      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.
    - InvitationDate (datetime) –
      
      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.
    - PayloadType (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.
    - Receiver (dict) –
      
      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.
      Note
      This is a Tagged Union structure. Only one of the following top level keys will be set: Account. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
      
      'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
      - Account (dict) –
        
        Specifies the AWS account of the partner who received the Engagement Invitation. This field is used to track the invitation recipient within the AWS ecosystem.
        
        Alias (string) –
        
        Represents the alias of the partner account receiving the Engagement Invitation, making it easier to identify and track the recipient in reports or logs.
        
        AwsAccountId (string) –
        
        Indicates the AWS account ID of the partner who received the Engagement Invitation. This is a unique identifier for managing engagements with specific AWS accounts.
    - SenderAwsAccountId (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.
    - SenderCompanyName (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.
    - 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.
- NextToken (string) –
  
  A pagination token returned when there are more results available than can be returned in a single call. Use this token to retrieve additional pages of engagement invitation summaries.

Exceptions

PartnerCentralSellingAPI.Client.exceptions.ThrottlingException
PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException
PartnerCentralSellingAPI.Client.exceptions.InternalServerException
PartnerCentralSellingAPI.Client.exceptions.ValidationException
PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException