PartnerCentralSellingAPI / Client / get_engagement_invitation

get_engagement_invitation

PartnerCentralSellingAPI.Client.get_engagement_invitation(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.get_engagement_invitation(
    Catalog='string',
    Identifier='string'
)

Parameters:

• Catalog (string) –

  [REQUIRED]

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

• Identifier (string) –

  [REQUIRED]

  Specifies the unique identifier for the retrieved engagement invitation.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Catalog': 'string',
    'EngagementTitle': 'string',
    'ExpirationDate': datetime(2015, 1, 1),
    'Id': 'string',
    'InvitationDate': datetime(2015, 1, 1),
    'Payload': {
        'OpportunityInvitation': {
            'Customer': {
                'CompanyName': 'string',
                'CountryCode': 'US'|'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'CD'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'AN'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
                'Industry': 'Aerospace'|'Agriculture'|'Automotive'|'Computers and Electronics'|'Consumer Goods'|'Education'|'Energy - Oil and Gas'|'Energy - Power and Utilities'|'Financial Services'|'Gaming'|'Government'|'Healthcare'|'Hospitality'|'Life Sciences'|'Manufacturing'|'Marketing and Advertising'|'Media and Entertainment'|'Mining'|'Non-Profit Organization'|'Professional Services'|'Real Estate and Construction'|'Retail'|'Software and Internet'|'Telecommunications'|'Transportation and Logistics'|'Travel'|'Wholesale and Distribution'|'Other',
                'WebsiteUrl': 'string'
            },
            'Project': {
                'BusinessProblem': 'string',
                'ExpectedCustomerSpend': [
                    {
                        'Amount': 'string',
                        'CurrencyCode': 'USD'|'EUR'|'GBP'|'AUD'|'CAD'|'CNY'|'NZD'|'INR'|'JPY'|'CHF'|'SEK'|'AED'|'AFN'|'ALL'|'AMD'|'ANG'|'AOA'|'ARS'|'AWG'|'AZN'|'BAM'|'BBD'|'BDT'|'BGN'|'BHD'|'BIF'|'BMD'|'BND'|'BOB'|'BOV'|'BRL'|'BSD'|'BTN'|'BWP'|'BYN'|'BZD'|'CDF'|'CHE'|'CHW'|'CLF'|'CLP'|'COP'|'COU'|'CRC'|'CUC'|'CUP'|'CVE'|'CZK'|'DJF'|'DKK'|'DOP'|'DZD'|'EGP'|'ERN'|'ETB'|'FJD'|'FKP'|'GEL'|'GHS'|'GIP'|'GMD'|'GNF'|'GTQ'|'GYD'|'HKD'|'HNL'|'HRK'|'HTG'|'HUF'|'IDR'|'ILS'|'IQD'|'IRR'|'ISK'|'JMD'|'JOD'|'KES'|'KGS'|'KHR'|'KMF'|'KPW'|'KRW'|'KWD'|'KYD'|'KZT'|'LAK'|'LBP'|'LKR'|'LRD'|'LSL'|'LYD'|'MAD'|'MDL'|'MGA'|'MKD'|'MMK'|'MNT'|'MOP'|'MRU'|'MUR'|'MVR'|'MWK'|'MXN'|'MXV'|'MYR'|'MZN'|'NAD'|'NGN'|'NIO'|'NOK'|'NPR'|'OMR'|'PAB'|'PEN'|'PGK'|'PHP'|'PKR'|'PLN'|'PYG'|'QAR'|'RON'|'RSD'|'RUB'|'RWF'|'SAR'|'SBD'|'SCR'|'SDG'|'SGD'|'SHP'|'SLL'|'SOS'|'SRD'|'SSP'|'STN'|'SVC'|'SYP'|'SZL'|'THB'|'TJS'|'TMT'|'TND'|'TOP'|'TRY'|'TTD'|'TWD'|'TZS'|'UAH'|'UGX'|'USN'|'UYI'|'UYU'|'UZS'|'VEF'|'VND'|'VUV'|'WST'|'XAF'|'XCD'|'XDR'|'XOF'|'XPF'|'XSU'|'XUA'|'YER'|'ZAR'|'ZMW'|'ZWL',
                        'Frequency': 'Monthly',
                        'TargetCompany': 'string'
                    },
                ],
                'TargetCompletionDate': 'string',
                'Title': 'string'
            },
            'ReceiverResponsibilities': [
                'Distributor'|'Reseller'|'Hardware Partner'|'Managed Service Provider'|'Software Partner'|'Services Partner'|'Training Partner'|'Co-Sell Facilitator'|'Facilitator',
            ],
            'SenderContacts': [
                {
                    'BusinessTitle': 'string',
                    'Email': 'string',
                    'FirstName': 'string',
                    'LastName': 'string',
                    'Phone': 'string'
                },
            ]
        }
    },
    'PayloadType': 'OpportunityInvitation',
    'Receiver': {
        'Account': {
            'Alias': 'string',
            'AwsAccountId': 'string'
        }
    },
    'RejectionReason': 'string',
    'SenderAwsAccountId': 'string',
    'SenderCompanyName': 'string',
    'Status': 'ACCEPTED'|'PENDING'|'REJECTED'|'EXPIRED'
}

Response Structure

• (dict) –

  • 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.

  • EngagementTitle (string) –

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

  • ExpirationDate (datetime) –

    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.

  • InvitationDate (datetime) –

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

  • Payload (dict) –

    Details of the engagement invitation payload, including specific data relevant to the invitation’s contents, such as customer information and opportunity insights.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: OpportunityInvitation. 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'}
    

    • OpportunityInvitation (dict) –

      Specifies the details of the opportunity invitation within the Engagement Invitation payload. This data helps partners understand the context, scope, and expected involvement for the opportunity from AWS.

      • Customer (dict) –

        Contains information about the customer related to the opportunity in the Engagement Invitation. This data helps partners understand the customer’s profile and requirements.

        • CompanyName (string) –

          Represents the name of the customer’s company associated with the Engagement Invitation. This field is used to identify the customer.

        • CountryCode (string) –

          Indicates the country in which the customer’s company operates. This field is useful for understanding regional requirements or compliance needs.

        • Industry (string) –

          Specifies the industry to which the customer’s company belongs. This field helps categorize the opportunity based on the customer’s business sector.

        • WebsiteUrl (string) –

          Provides the website URL of the customer’s company. This field helps partners verify the legitimacy and size of the customer organization.

      • Project (dict) –

        Describes the project details associated with the opportunity, including the customer’s needs and the scope of work expected to be performed.

        • BusinessProblem (string) –

          Describes the business problem that the project aims to solve. This information is crucial for understanding the project’s goals and objectives.

        • ExpectedCustomerSpend (list) –

          Contains revenue estimates for the partner related to the project. This field provides an idea of the financial potential of the opportunity for the partner.

          • (dict) –

            Provides an estimate of the revenue that the partner is expected to generate from the opportunity. This information helps partners assess the financial value of the project.

            • Amount (string) –

              Represents the estimated monthly revenue that the partner expects to earn from the opportunity. This helps in forecasting financial returns.

            • CurrencyCode (string) –

              Indicates the currency in which the revenue estimate is provided. This helps in understanding the financial impact across different markets.

            • Frequency (string) –

              Indicates how frequently the customer is expected to spend the projected amount. This can include values such as Monthly, Quarterly, or Annually. The default value is Monthly, representing recurring monthly spend.

            • TargetCompany (string) –

              Specifies the name of the partner company that is expected to generate revenue from the opportunity. This field helps track the partner’s involvement in the opportunity.

        • TargetCompletionDate (string) –

          Specifies the estimated date of project completion. This field helps track the project timeline and manage expectations.

        • Title (string) –

          Specifies the title of the project. This title helps partners quickly identify and understand the focus of the project.

      • ReceiverResponsibilities (list) –

        Outlines the responsibilities or expectations of the receiver in the context of the invitation.

        • (string) –

      • SenderContacts (list) –

        Represents the contact details of the AWS representatives involved in sending the Engagement Invitation. These contacts are opportunity stakeholders.

        • (dict) –

          An object that contains the details of the sender-provided contact person for the EngagementInvitation.

          • BusinessTitle (string) –

            The sender-provided contact’s title (job title or role) associated with the EngagementInvitation.

          • Email (string) –

            The sender-provided contact’s email address associated with the EngagementInvitation.

          • FirstName (string) –

            The sender-provided contact’s last name associated with the EngagementInvitation.

          • LastName (string) –

            The sender-provided contact’s first name associated with the EngagementInvitation.

          • Phone (string) –

            The sender-provided contact’s phone number associated with the EngagementInvitation.

  • PayloadType (string) –

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

  • Receiver (dict) –

    Information about the partner organization or team that received the engagement invitation, including contact details and identifiers.

    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.

  • RejectionReason (string) –

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

  • SenderAwsAccountId (string) –

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

  • SenderCompanyName (string) –

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

  • Status (string) –

    The current status of the engagement invitation.

Exceptions

• PartnerCentralSellingAPI.Client.exceptions.ThrottlingException

• PartnerCentralSellingAPI.Client.exceptions.AccessDeniedException

• PartnerCentralSellingAPI.Client.exceptions.InternalServerException

• PartnerCentralSellingAPI.Client.exceptions.ValidationException

• PartnerCentralSellingAPI.Client.exceptions.ResourceNotFoundException