CREATEENGAGEMENT()`¶

About CreateEngagement¶

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.

Method Signature¶

METHODS /AWS1/IF_PTS~CREATEENGAGEMENT
  IMPORTING
    !IV_CATALOG TYPE /AWS1/PTSCATALOGIDENTIFIER OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/PTSCLIENTTOKEN OPTIONAL
    !IV_TITLE TYPE /AWS1/PTSENGAGEMENTTITLE OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/PTSENGAGEMENTDESCRIPTION OPTIONAL
    !IT_CONTEXTS TYPE /AWS1/CL_PTSENGAGEMENTCTXDETS=>TT_ENGAGEMENTCONTEXTS OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptscreengagementrsp
  RAISING
    /AWS1/CX_PTSACCESSDENIEDEX
    /AWS1/CX_PTSCONFLICTEXCEPTION
    /AWS1/CX_PTSINTERNALSERVEREX
    /AWS1/CX_PTSRESOURCENOTFOUNDEX
    /AWS1/CX_PTSSERVICEQUOTAEXCDEX
    /AWS1/CX_PTSTHROTTLINGEX
    /AWS1/CX_PTSVALIDATIONEX
    /AWS1/CX_PTSCLIENTEXC
    /AWS1/CX_PTSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_catalog` `TYPE /AWS1/PTSCATALOGIDENTIFIER` `/AWS1/PTSCATALOGIDENTIFIER`¶

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.

`iv_clienttoken` `TYPE /AWS1/PTSCLIENTTOKEN` `/AWS1/PTSCLIENTTOKEN`¶

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.

`iv_title` `TYPE /AWS1/PTSENGAGEMENTTITLE` `/AWS1/PTSENGAGEMENTTITLE`¶

Specifies the title of the Engagement.

`iv_description` `TYPE /AWS1/PTSENGAGEMENTDESCRIPTION` `/AWS1/PTSENGAGEMENTDESCRIPTION`¶

Provides a description of the Engagement.

Optional arguments:¶

`it_contexts` `TYPE /AWS1/CL_PTSENGAGEMENTCTXDETS=>TT_ENGAGEMENTCONTEXTS` `TT_ENGAGEMENTCONTEXTS`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ptscreengagementrsp` `/AWS1/CL_PTSCREENGAGEMENTRSP`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->createengagement(
  it_contexts = VALUE /aws1/cl_ptsengagementctxdets=>tt_engagementcontexts(
    (
      new /aws1/cl_ptsengagementctxdets(
        io_payload = new /aws1/cl_ptsengagementctxpay00(
          io_customerproject = new /aws1/cl_ptscusprojectscontext(
            io_customer = new /aws1/cl_ptsengagementcustomer(
              iv_companyname = |string|
              iv_countrycode = |string|
              iv_industry = |string|
              iv_websiteurl = |string|
            )
            io_project = new /aws1/cl_ptsengagementcuspro00(
              iv_businessproblem = |string|
              iv_targetcompletiondate = |string|
              iv_title = |string|
            )
          )
          io_lead = new /aws1/cl_ptsleadcontext(
            io_customer = new /aws1/cl_ptsleadcustomer(
              io_address = new /aws1/cl_ptsaddresssummary(
                iv_city = |string|
                iv_countrycode = |string|
                iv_postalcode = |string|
                iv_stateorregion = |string|
              )
              iv_awsmaturity = |string|
              iv_companyname = |string|
              iv_industry = |string|
              iv_marketsegment = |string|
              iv_websiteurl = |string|
            )
            it_interactions = VALUE /aws1/cl_ptsleadinteraction=>tt_leadinteractionlist(
              (
                new /aws1/cl_ptsleadinteraction(
                  io_contact = new /aws1/cl_ptsleadcontact(
                    iv_businesstitle = |string|
                    iv_email = |string|
                    iv_firstname = |string|
                    iv_lastname = |string|
                    iv_phone = |string|
                  )
                  iv_businessproblem = |string|
                  iv_customeraction = |string|
                  iv_interactiondate = '20150101000000.0000000'
                  iv_sourceid = |string|
                  iv_sourcename = |string|
                  iv_sourcetype = |string|
                  iv_usecase = |string|
                )
              )
            )
            iv_qualificationstatus = |string|
          )
        )
        iv_id = |string|
        iv_type = |string|
      )
    )
  )
  iv_catalog = |string|
  iv_clienttoken = |string|
  iv_description = |string|
  iv_title = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_engagementidentifier = lo_result->get_id( ).
  lv_engagementarn = lo_result->get_arn( ).
  lv_datetime = lo_result->get_modifiedat( ).
ENDIF.

/AWS1/IF_PTS=>CREATEENGAGEMENT()¶