/AWS1/IF_CNT=>STARTATTACHEDFILEUPLOAD()

About StartAttachedFileUpload

Provides a pre-signed Amazon S3 URL in response for uploading your content.

You may only use this API to upload attachments to an Amazon Connect Case or Amazon Connect Email.

Method Signature

METHODS /AWS1/IF_CNT~STARTATTACHEDFILEUPLOAD
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/CNTCLIENTTOKEN OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_FILENAME TYPE /AWS1/CNTFILENAME OPTIONAL
    !IV_FILESIZEINBYTES TYPE /AWS1/CNTFILESIZEINBYTES OPTIONAL
    !IV_URLEXPIRYINSECONDS TYPE /AWS1/CNTURLEXPIRYINSECONDS OPTIONAL
    !IV_FILEUSECASETYPE TYPE /AWS1/CNTFILEUSECASETYPE OPTIONAL
    !IV_ASSOCIATEDRESOURCEARN TYPE /AWS1/CNTARN OPTIONAL
    !IO_CREATEDBY TYPE REF TO /AWS1/CL_CNTCREATEDBYINFO OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntstrtattfileuploa01
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDREQUESTEX
    /AWS1/CX_CNTRESOURCECONFLICTEX
    /AWS1/CX_CNTSERVICEQUOTAEXCDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_instanceid TYPE /AWS1/CNTINSTANCEID /AWS1/CNTINSTANCEID

The unique identifier of the Amazon Connect instance.

iv_filename TYPE /AWS1/CNTFILENAME /AWS1/CNTFILENAME

A case-sensitive name of the attached file being uploaded.

iv_filesizeinbytes TYPE /AWS1/CNTFILESIZEINBYTES /AWS1/CNTFILESIZEINBYTES

The size of the attached file in bytes.

iv_fileusecasetype TYPE /AWS1/CNTFILEUSECASETYPE /AWS1/CNTFILEUSECASETYPE

The use case for the file.

Only ATTACHMENTS are supported.

iv_associatedresourcearn TYPE /AWS1/CNTARN /AWS1/CNTARN

The resource to which the attached file is (being) uploaded to. The supported resources are Cases and Email.

This value must be a valid ARN.

Optional arguments:

iv_clienttoken TYPE /AWS1/CNTCLIENTTOKEN /AWS1/CNTCLIENTTOKEN

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

iv_urlexpiryinseconds TYPE /AWS1/CNTURLEXPIRYINSECONDS /AWS1/CNTURLEXPIRYINSECONDS

Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.

io_createdby TYPE REF TO /AWS1/CL_CNTCREATEDBYINFO /AWS1/CL_CNTCREATEDBYINFO

Represents the identity that created the file.

it_tags TYPE /AWS1/CL_CNTTAGMAP_W=>TT_TAGMAP TT_TAGMAP

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

RETURNING

oo_output TYPE REF TO /aws1/cl_cntstrtattfileuploa01 /AWS1/CL_CNTSTRTATTFILEUPLOA01

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->startattachedfileupload(
  io_createdby = new /aws1/cl_cntcreatedbyinfo(
    iv_awsidentityarn = |string|
    iv_connectuserarn = |string|
  )
  it_tags = VALUE /aws1/cl_cnttagmap_w=>tt_tagmap(
    (
      VALUE /aws1/cl_cnttagmap_w=>ts_tagmap_maprow(
        key = |string|
        value = new /aws1/cl_cnttagmap_w( |string| )
      )
    )
  )
  iv_associatedresourcearn = |string|
  iv_clienttoken = |string|
  iv_filename = |string|
  iv_filesizeinbytes = 123
  iv_fileusecasetype = |string|
  iv_instanceid = |string|
  iv_urlexpiryinseconds = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_arn = lo_result->get_filearn( ).
  lv_fileid = lo_result->get_fileid( ).
  lv_iso8601datetime = lo_result->get_creationtime( ).
  lv_filestatustype = lo_result->get_filestatus( ).
  lo_createdbyinfo = lo_result->get_createdby( ).
  IF lo_createdbyinfo IS NOT INITIAL.
    lv_arn = lo_createdbyinfo->get_connectuserarn( ).
    lv_arn = lo_createdbyinfo->get_awsidentityarn( ).
  ENDIF.
  lo_uploadurlmetadata = lo_result->get_uploadurlmetadata( ).
  IF lo_uploadurlmetadata IS NOT INITIAL.
    lv_metadataurl = lo_uploadurlmetadata->get_url( ).
    lv_iso8601datetime = lo_uploadurlmetadata->get_urlexpiry( ).
    LOOP AT lo_uploadurlmetadata->get_headerstoinclude( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_urlmetadatasignedheader = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.