Skip to content

/AWS1/IF_CHM=>CREATEMEETING()

About CreateMeeting

Creates a new Amazon Chime SDK meeting in the specified media Region with no initial attendees. For more information about specifying media Regions, see Available Regions and Using meeting Regions, both in the Amazon Chime SDK Developer Guide. For more information about the Amazon Chime SDK, see Using the Amazon Chime SDK in the Amazon Chime SDK Developer Guide.

If you use this API in conjuction with the and APIs, and you don't specify the MeetingFeatures.Content.MaxResolution or MeetingFeatures.Video.MaxResolution parameters, the following defaults are used:

  • Content.MaxResolution: FHD

  • Video.MaxResolution: HD

Method Signature

METHODS /AWS1/IF_CHM~CREATEMEETING
  IMPORTING
    !IV_CLIENTREQUESTTOKEN TYPE /AWS1/CHMCLIENTREQUESTTOKEN OPTIONAL
    !IV_MEDIAREGION TYPE /AWS1/CHMMEDIAREGION OPTIONAL
    !IV_MEETINGHOSTID TYPE /AWS1/CHMEXTERNALUSERID OPTIONAL
    !IV_EXTERNALMEETINGID TYPE /AWS1/CHMEXTERNALMEETINGID OPTIONAL
    !IO_NOTIFICATIONSCONF TYPE REF TO /AWS1/CL_CHMNOTIFICATIONSCONF OPTIONAL
    !IO_MEETINGFEATURES TYPE REF TO /AWS1/CL_CHMMEETINGFEATSCONF OPTIONAL
    !IV_PRIMARYMEETINGID TYPE /AWS1/CHMPRIMARYMEETINGID OPTIONAL
    !IT_TENANTIDS TYPE /AWS1/CL_CHMTENANTIDLIST_W=>TT_TENANTIDLIST OPTIONAL
    !IT_TAGS TYPE /AWS1/CL_CHMTAG=>TT_TAGLIST OPTIONAL
    !IV_MEDIAPLACEMENTNETWORKTYPE TYPE /AWS1/CHMMEDIAPLCMTNETWORKTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_chmcreatemeetingrsp
  RAISING
    /AWS1/CX_CHMBADREQUESTEX
    /AWS1/CX_CHMCONFLICTEXCEPTION
    /AWS1/CX_CHMFORBIDDENEXCEPTION
    /AWS1/CX_CHMLIMITEXCEEDEDEX
    /AWS1/CX_CHMSERVICEFAILUREEX
    /AWS1/CX_CHMSERVICEUNAVAILEX
    /AWS1/CX_CHMTHROTTLINGEX
    /AWS1/CX_CHMUNAUTHORIZEDEX
    /AWS1/CX_CHMCLIENTEXC
    /AWS1/CX_CHMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_clientrequesttoken TYPE /AWS1/CHMCLIENTREQUESTTOKEN /AWS1/CHMCLIENTREQUESTTOKEN

The unique identifier for the client request. Use a different token for different meetings.

iv_mediaregion TYPE /AWS1/CHMMEDIAREGION /AWS1/CHMMEDIAREGION

The Region in which to create the meeting.

Available values: af-south-1, ap-northeast-1, ap-northeast-2, ap-south-1, ap-southeast-1, ap-southeast-2,
ca-central-1, eu-central-1, eu-north-1, eu-south-1, eu-west-1, eu-west-2, eu-west-3,
sa-east-1, us-east-1, us-east-2, us-west-1, us-west-2.

Available values in Amazon Web Services GovCloud (US) Regions: us-gov-east-1, us-gov-west-1.

iv_externalmeetingid TYPE /AWS1/CHMEXTERNALMEETINGID /AWS1/CHMEXTERNALMEETINGID

The external meeting ID.

Pattern: [-_&@+=,(){}[]\/«».:|'"#a-zA-Z0-9À-ÿ\s]*

Values that begin with aws: are reserved. You can't configure a value that uses this prefix. Case insensitive.

Optional arguments:

iv_meetinghostid TYPE /AWS1/CHMEXTERNALUSERID /AWS1/CHMEXTERNALUSERID

Reserved.

io_notificationsconf TYPE REF TO /AWS1/CL_CHMNOTIFICATIONSCONF /AWS1/CL_CHMNOTIFICATIONSCONF

The configuration for resource targets to receive notifications when meeting and attendee events occur.

io_meetingfeatures TYPE REF TO /AWS1/CL_CHMMEETINGFEATSCONF /AWS1/CL_CHMMEETINGFEATSCONF

Lists the audio and video features enabled for a meeting, such as echo reduction.

iv_primarymeetingid TYPE /AWS1/CHMPRIMARYMEETINGID /AWS1/CHMPRIMARYMEETINGID

When specified, replicates the media from the primary meeting to the new meeting.

it_tenantids TYPE /AWS1/CL_CHMTENANTIDLIST_W=>TT_TENANTIDLIST TT_TENANTIDLIST

A consistent and opaque identifier, created and maintained by the builder to represent a segment of their users.

it_tags TYPE /AWS1/CL_CHMTAG=>TT_TAGLIST TT_TAGLIST

Applies one or more tags to an Amazon Chime SDK meeting. Note the following:

  • Not all resources have tags. For a list of services with resources that support tagging using this operation, see Services that support the Resource Groups Tagging API. If the resource doesn't yet support this operation, the resource's service might support tagging using its own API operations. For more information, refer to the documentation for that service.

  • Each resource can have up to 50 tags. For other limits, see Tag Naming and Usage Conventions in the AWS General Reference.

  • You can only tag resources that are located in the specified Amazon Web Services Region for the Amazon Web Services account.

  • To add tags to a resource, you need the necessary permissions for the service that the resource belongs to as well as permissions for adding tags. For more information, see the documentation for each service.

Do not store personally identifiable information (PII) or other confidential or sensitive information in tags. We use tags to provide you with billing and administration services. Tags are not intended to be used for private or sensitive data.

Minimum permissions

In addition to the tag:TagResources permission required by this operation, you must also have the tagging permission defined by the service that created the resource. For example, to tag a ChimeSDKMeetings instance using the TagResources operation, you must have both of the following permissions:

tag:TagResources

ChimeSDKMeetings:CreateTags

Some services might have specific requirements for tagging some resources. For example, to tag an Amazon S3 bucket, you must also have the s3:GetBucketTagging permission. If the expected minimum permissions don't work, check the documentation for that service's tagging APIs for more information.

iv_mediaplacementnetworktype TYPE /AWS1/CHMMEDIAPLCMTNETWORKTYPE /AWS1/CHMMEDIAPLCMTNETWORKTYPE

The type of network for the media placement. Either IPv4 only or dual-stack (IPv4 and IPv6).

RETURNING

oo_output TYPE REF TO /aws1/cl_chmcreatemeetingrsp /AWS1/CL_CHMCREATEMEETINGRSP

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->createmeeting(
  io_meetingfeatures = new /aws1/cl_chmmeetingfeatsconf(
    io_attendee = new /aws1/cl_chmattendeefeatures( 123 )
    io_audio = new /aws1/cl_chmaudiofeatures( |string| )
    io_content = new /aws1/cl_chmcontentfeatures( |string| )
    io_video = new /aws1/cl_chmvideofeatures( |string| )
  )
  io_notificationsconf = new /aws1/cl_chmnotificationsconf(
    iv_lambdafunctionarn = |string|
    iv_snstopicarn = |string|
    iv_sqsqueuearn = |string|
  )
  it_tags = VALUE /aws1/cl_chmtag=>tt_taglist(
    (
      new /aws1/cl_chmtag(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  it_tenantids = VALUE /aws1/cl_chmtenantidlist_w=>tt_tenantidlist(
    ( new /aws1/cl_chmtenantidlist_w( |string| ) )
  )
  iv_clientrequesttoken = |string|
  iv_externalmeetingid = |string|
  iv_mediaplacementnetworktype = |string|
  iv_mediaregion = |string|
  iv_meetinghostid = |string|
  iv_primarymeetingid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_meeting = lo_result->get_meeting( ).
  IF lo_meeting IS NOT INITIAL.
    lv_guidstring = lo_meeting->get_meetingid( ).
    lv_externaluserid = lo_meeting->get_meetinghostid( ).
    lv_externalmeetingid = lo_meeting->get_externalmeetingid( ).
    lv_mediaregion = lo_meeting->get_mediaregion( ).
    lo_mediaplacement = lo_meeting->get_mediaplacement( ).
    IF lo_mediaplacement IS NOT INITIAL.
      lv_string = lo_mediaplacement->get_audiohosturl( ).
      lv_string = lo_mediaplacement->get_audiofallbackurl( ).
      lv_string = lo_mediaplacement->get_signalingurl( ).
      lv_string = lo_mediaplacement->get_turncontrolurl( ).
      lv_string = lo_mediaplacement->get_screendataurl( ).
      lv_string = lo_mediaplacement->get_screenviewingurl( ).
      lv_string = lo_mediaplacement->get_screensharingurl( ).
      lv_string = lo_mediaplacement->get_eventingestionurl( ).
    ENDIF.
    lo_meetingfeaturesconfigur = lo_meeting->get_meetingfeatures( ).
    IF lo_meetingfeaturesconfigur IS NOT INITIAL.
      lo_audiofeatures = lo_meetingfeaturesconfigur->get_audio( ).
      IF lo_audiofeatures IS NOT INITIAL.
        lv_meetingfeaturestatus = lo_audiofeatures->get_echoreduction( ).
      ENDIF.
      lo_videofeatures = lo_meetingfeaturesconfigur->get_video( ).
      IF lo_videofeatures IS NOT INITIAL.
        lv_videoresolution = lo_videofeatures->get_maxresolution( ).
      ENDIF.
      lo_contentfeatures = lo_meetingfeaturesconfigur->get_content( ).
      IF lo_contentfeatures IS NOT INITIAL.
        lv_contentresolution = lo_contentfeatures->get_maxresolution( ).
      ENDIF.
      lo_attendeefeatures = lo_meetingfeaturesconfigur->get_attendee( ).
      IF lo_attendeefeatures IS NOT INITIAL.
        lv_attendeemax = lo_attendeefeatures->get_maxcount( ).
      ENDIF.
    ENDIF.
    lv_primarymeetingid = lo_meeting->get_primarymeetingid( ).
    LOOP AT lo_meeting->get_tenantids( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_tenantid = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_amazonresourcename = lo_meeting->get_meetingarn( ).
  ENDIF.
ENDIF.