STARTATTACHMENTUPLOAD()`¶

About StartAttachmentUpload¶

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

For security recommendations, see Amazon Connect Chat security best practices.

ConnectionToken is used for invoking this API instead of ParticipantToken.

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Method Signature¶

METHODS /AWS1/IF_CNP~STARTATTACHMENTUPLOAD
  IMPORTING
    !IV_CONTENTTYPE TYPE /AWS1/CNPCONTENTTYPE OPTIONAL
    !IV_ATTACHMENTSIZEINBYTES TYPE /AWS1/CNPATTACHMENTSIZEINBYTES OPTIONAL
    !IV_ATTACHMENTNAME TYPE /AWS1/CNPATTACHMENTNAME OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/CNPNONEMPTYCLIENTTOKEN OPTIONAL
    !IV_CONNECTIONTOKEN TYPE /AWS1/CNPPARTICIPANTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cnpstrtattachmentup01
  RAISING
    /AWS1/CX_CNPACCESSDENIEDEX
    /AWS1/CX_CNPINTERNALSERVEREX
    /AWS1/CX_CNPSERVICEQUOTAEXCDEX
    /AWS1/CX_CNPTHROTTLINGEX
    /AWS1/CX_CNPVALIDATIONEX
    /AWS1/CX_CNPCLIENTEXC
    /AWS1/CX_CNPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_contenttype` `TYPE /AWS1/CNPCONTENTTYPE` `/AWS1/CNPCONTENTTYPE`¶

Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.

`iv_attachmentsizeinbytes` `TYPE /AWS1/CNPATTACHMENTSIZEINBYTES` `/AWS1/CNPATTACHMENTSIZEINBYTES`¶

The size of the attachment in bytes.

`iv_attachmentname` `TYPE /AWS1/CNPATTACHMENTNAME` `/AWS1/CNPATTACHMENTNAME`¶

A case-sensitive name of the attachment being uploaded.

`iv_clienttoken` `TYPE /AWS1/CNPNONEMPTYCLIENTTOKEN` `/AWS1/CNPNONEMPTYCLIENTTOKEN`¶

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_connectiontoken` `TYPE /AWS1/CNPPARTICIPANTTOKEN` `/AWS1/CNPPARTICIPANTTOKEN`¶

The authentication token associated with the participant's connection.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cnpstrtattachmentup01` `/AWS1/CL_CNPSTRTATTACHMENTUP01`¶

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->startattachmentupload(
  iv_attachmentname = |string|
  iv_attachmentsizeinbytes = 123
  iv_clienttoken = |string|
  iv_connectiontoken = |string|
  iv_contenttype = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_artifactid = lo_result->get_attachmentid( ).
  lo_uploadmetadata = lo_result->get_uploadmetadata( ).
  IF lo_uploadmetadata IS NOT INITIAL.
    lv_uploadmetadataurl = lo_uploadmetadata->get_url( ).
    lv_iso8601datetime = lo_uploadmetadata->get_urlexpiry( ).
    LOOP AT lo_uploadmetadata->get_headerstoinclude( ) into ls_row.
      lv_key = ls_row-key.
      lo_value = ls_row-value.
      IF lo_value IS NOT INITIAL.
        lv_uploadmetadatasignedhea = lo_value->get_value( ).
      ENDIF.
    ENDLOOP.
  ENDIF.
ENDIF.

/AWS1/IF_CNP=>STARTATTACHMENTUPLOAD()¶