PartnerCentralSellingAPI / Client / create_engagement

create_engagement#

PartnerCentralSellingAPI.Client.create_engagement(**kwargs)#

The CreateEngagement action allows you to create an Engagement, which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. This action automatically adds the caller’s AWS account as an active member of the newly created Engagement.

See also: AWS API Documentation

Request Syntax

response = client.create_engagement(
    Catalog='string',
    ClientToken='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'
        },
    ],
    Description='string',
    Title='string'
)
Parameters:

  • Catalog (string) –

    [REQUIRED]

    The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

  • ClientToken (string) –

    [REQUIRED]

    The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.

    This field is autopopulated if not provided.

  • Contexts (list) –

    The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.

    • (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 can be set: CustomerProject.

        • 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) – [REQUIRED]

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

            • CountryCode (string) – [REQUIRED]

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

            • Industry (string) – [REQUIRED]

              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) – [REQUIRED]

              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) – [REQUIRED]

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

            • TargetCompletionDate (string) – [REQUIRED]

              The target completion date for the customer’s project.

            • Title (string) – [REQUIRED]

              The title of the project.

      • Type (string) – [REQUIRED]

        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.

  • Description (string) –

    [REQUIRED]

    Provides a description of the Engagement.

  • Title (string) –

    [REQUIRED]

    Specifies the title of the Engagement.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The Amazon Resource Name (ARN) that identifies the engagement.

    • Id (string) –

      Unique identifier assigned to the newly created engagement.

Exceptions