PartnerCentralSellingAPI / Client / get_engagement

get_engagement#

PartnerCentralSellingAPI.Client.get_engagement(**kwargs)#

Use this action to retrieve the engagement record for a given EngagementIdentifier.

See also: AWS API Documentation

Request Syntax

response = client.get_engagement(
    Catalog='string',
    Identifier='string'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.

  • Identifier (string) –

    [REQUIRED]

    Specifies the identifier of the Engagement record to retrieve.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Contexts': [
        {
            'Payload': {
                'CustomerProject': {
                    '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',
                        'TargetCompletionDate': 'string',
                        'Title': 'string'
                    }
                }
            },
            'Type': 'CustomerProject'
        },
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'CreatedBy': 'string',
    'Description': 'string',
    'Id': 'string',
    'MemberCount': 123,
    'Title': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) of the engagement retrieved.

    • Contexts (list) –

      A list of context objects associated with the engagement. Each context provides additional information related to the Engagement, such as customer projects or documents.

      • (dict) –

        Provides detailed context information for an Engagement. This structure allows for specifying the type of context and its associated payload.

        • Payload (dict) –

          Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.

          Note

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

          • CustomerProject (dict) –

            Contains detailed information about a customer project when the context type is “CustomerProject”. This field is present only when the Type in EngagementContextDetails is set to “CustomerProject”.

            • Customer (dict) –

              Contains details about the customer associated with the Engagement Invitation, including company information and industry.

              • 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) –

              Information about the customer project associated with the Engagement.

              • BusinessProblem (string) –

                A description of the business problem the project aims to solve.

              • TargetCompletionDate (string) –

                The target completion date for the customer’s project.

              • Title (string) –

                The title of the project.

        • Type (string) –

          Specifies the type of Engagement context. Valid values are “CustomerProject” or “Document”, indicating whether the context relates to a customer project or a document respectively.

    • CreatedAt (datetime) –

      The date and time when the Engagement was created, presented in ISO 8601 format (UTC). For example: “2023-05-01T20:37:46Z”. This timestamp helps track the lifecycle of the Engagement.

    • CreatedBy (string) –

      The AWS account ID of the user who originally created the engagement. This field helps in tracking the origin of the engagement.

    • Description (string) –

      A more detailed description of the engagement. This provides additional context or information about the engagement’s purpose or scope.

    • Id (string) –

      The unique resource identifier of the engagement retrieved.

    • MemberCount (integer) –

      Specifies the current count of members participating in the Engagement. This count includes all active members regardless of their roles or permissions within the Engagement.

    • Title (string) –

      The title of the engagement. It provides a brief, descriptive name for the engagement that is meaningful and easily recognizable.

Exceptions