CREATECHANNELHANDSHAKE()`¶

About CreateChannelHandshake¶

Creates a new channel handshake request to establish a partnership with another AWS account.

Method Signature¶

METHODS /AWS1/IF_PTC~CREATECHANNELHANDSHAKE
  IMPORTING
    !IV_HANDSHAKETYPE TYPE /AWS1/PTCHANDSHAKETYPE OPTIONAL
    !IV_CATALOG TYPE /AWS1/PTCCATALOG OPTIONAL
    !IV_ASSOCIATEDRESOURCEID TYPE /AWS1/PTCASSOCIATEDRESOURCEID OPTIONAL
    !IO_PAYLOAD TYPE REF TO /AWS1/CL_PTCCHNLHANDSHAKEPAY00 OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/PTCCLIENTTOKEN OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_PTCTAG=>TT_TAGLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ptccrechnlhandshake01
  RAISING
    /AWS1/CX_PTCACCESSDENIEDEX
    /AWS1/CX_PTCINTERNALSERVEREX
    /AWS1/CX_PTCRESOURCENOTFOUNDEX
    /AWS1/CX_PTCTHROTTLINGEX
    /AWS1/CX_PTCVLDTNEXCEPTION
    /AWS1/CX_PTCCONFLICTEXCEPTION
    /AWS1/CX_PTCSERVICEQUOTAEXCDEX
    /AWS1/CX_PTCCLIENTEXC
    /AWS1/CX_PTCSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_handshaketype` `TYPE /AWS1/PTCHANDSHAKETYPE` `/AWS1/PTCHANDSHAKETYPE`¶

The type of handshake to create (e.g., start service period, revoke service period).

`iv_catalog` `TYPE /AWS1/PTCCATALOG` `/AWS1/PTCCATALOG`¶

The catalog identifier for the handshake request.

`iv_associatedresourceid` `TYPE /AWS1/PTCASSOCIATEDRESOURCEID` `/AWS1/PTCASSOCIATEDRESOURCEID`¶

The identifier of the resource associated with this handshake.

Optional arguments:¶

`io_payload` `TYPE REF TO /AWS1/CL_PTCCHNLHANDSHAKEPAY00` `/AWS1/CL_PTCCHNLHANDSHAKEPAY00`¶

The payload containing specific details for the handshake type.

`iv_clienttoken` `TYPE /AWS1/PTCCLIENTTOKEN` `/AWS1/PTCCLIENTTOKEN`¶

A unique, case-sensitive identifier to ensure idempotency of the request.

`it_tags` `TYPE /AWS1/CL_PTCTAG=>TT_TAGLIST` `TT_TAGLIST`¶

Key-value pairs to associate with the channel handshake.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ptccrechnlhandshake01` `/AWS1/CL_PTCCRECHNLHANDSHAKE01`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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->createchannelhandshake(
  io_payload = new /aws1/cl_ptcchnlhandshakepay00(
    io_revokesvcperiodpayload = new /aws1/cl_ptcrvkesvcperpayload(
      iv_note = |string|
      iv_programmngmtaccountid00 = |string|
    )
    io_startserviceperiodpayload = new /aws1/cl_ptcstartsvcperpayload(
      iv_enddate = '20150101000000.0000000'
      iv_minimumnoticedays = |string|
      iv_note = |string|
      iv_programmngmtaccountid00 = |string|
      iv_serviceperiodtype = |string|
    )
  )
  it_tags = VALUE /aws1/cl_ptctag=>tt_taglist(
    (
      new /aws1/cl_ptctag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  iv_associatedresourceid = |string|
  iv_catalog = |string|
  iv_clienttoken = |string|
  iv_handshaketype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_createchannelhandshaked = lo_result->get_channelhandshakedetail( ).
  IF lo_createchannelhandshaked IS NOT INITIAL.
    lv_channelhandshakeid = lo_createchannelhandshaked->get_id( ).
    lv_arn = lo_createchannelhandshaked->get_arn( ).
  ENDIF.
ENDIF.

Example for CreateChannelHandshake - START_SERVICE_PERIOD with Minimum Notice Period¶

Example for CreateChannelHandshake - START_SERVICE_PERIOD with Minimum Notice Period

DATA(lo_result) = lo_client->createchannelhandshake(
  io_payload = new /aws1/cl_ptcchnlhandshakepay00(
    io_startserviceperiodpayload = new /aws1/cl_ptcstartsvcperpayload(
      iv_minimumnoticedays = |14|
      iv_note = |Optional Note|
      iv_programmngmtaccountid00 = |pma-abcdef123456g|
      iv_serviceperiodtype = |MINIMUM_NOTICE_PERIOD|
    )
  )
  iv_associatedresourceid = |rs-abc123def456g|
  iv_catalog = |AWS|
  iv_clienttoken = |clientToken|
  iv_handshaketype = |START_SERVICE_PERIOD|
).

Example for CreateChannelHandshake - START_SERVICE_PERIOD with Fixed Commitment Period¶

Example for CreateChannelHandshake - START_SERVICE_PERIOD with Fixed Commitment Period

DATA(lo_result) = lo_client->createchannelhandshake(
  io_payload = new /aws1/cl_ptcchnlhandshakepay00(
    io_startserviceperiodpayload = new /aws1/cl_ptcstartsvcperpayload(
      iv_enddate = '20260701000000.0000000'
      iv_note = |Optional Note|
      iv_programmngmtaccountid00 = |pma-abcdef123456g|
      iv_serviceperiodtype = |FIXED_COMMITMENT_PERIOD|
    )
  )
  iv_associatedresourceid = |rs-abc123def456g|
  iv_catalog = |AWS|
  iv_clienttoken = |clientToken|
  iv_handshaketype = |START_SERVICE_PERIOD|
).

Example for CreateChannelHandshake - REVOKE_SERVICE_PERIOD¶

Example for CreateChannelHandshake - REVOKE_SERVICE_PERIOD

DATA(lo_result) = lo_client->createchannelhandshake(
  io_payload = new /aws1/cl_ptcchnlhandshakepay00(
    io_revokesvcperiodpayload = new /aws1/cl_ptcrvkesvcperpayload(
      iv_note = |Optional Note|
      iv_programmngmtaccountid00 = |pma-abcdef123456g|
    )
  )
  iv_associatedresourceid = |rs-abc123def456g|
  iv_catalog = |AWS|
  iv_clienttoken = |clientToken|
  iv_handshaketype = |REVOKE_SERVICE_PERIOD|
).

Example for CreateChannelHandshake - PROGRAM_MANAGEMENT_ACCOUNT¶

Example for CreateChannelHandshake - PROGRAM_MANAGEMENT_ACCOUNT

DATA(lo_result) = lo_client->createchannelhandshake(
  iv_associatedresourceid = |pma-123abc456def7|
  iv_catalog = |AWS|
  iv_clienttoken = |clientToken|
  iv_handshaketype = |PROGRAM_MANAGEMENT_ACCOUNT|
).

/AWS1/IF_PTC=>CREATECHANNELHANDSHAKE()¶