Skip to content

/AWS1/CL_GMZ=>UPDATEAPPLICATION()

About UpdateApplication

Updates the mutable configuration settings for a Amazon GameLift Streams application resource. You can change the Description, ApplicationLogOutputUri, and ApplicationLogPaths.

To update application settings, specify the application ID and provide the new values. If the operation is successful, it returns the complete updated set of settings for the application.

Method Signature

IMPORTING

Required arguments:

iv_identifier TYPE /AWS1/GMZIDENTIFIER /AWS1/GMZIDENTIFIER

An Amazon Resource Name (ARN) or ID that uniquely identifies the application resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6. Example ID: a-9ZY8X7Wv6.

Optional arguments:

iv_description TYPE /AWS1/GMZDESCRIPTION /AWS1/GMZDESCRIPTION

A human-readable label for the application.

it_applicationlogpaths TYPE /AWS1/CL_GMZFILEPATHS_W=>TT_FILEPATHS TT_FILEPATHS

Locations of log files that your content generates during a stream session. Enter path values that are relative to the ApplicationSourceUri location. You can specify up to 10 log paths. Amazon GameLift Streams uploads designated log files to the Amazon S3 bucket that you specify in ApplicationLogOutputUri at the end of a stream session. To retrieve stored log files, call GetStreamSession and get the LogFileLocationUri.

iv_applicationlogoutputuri TYPE /AWS1/GMZAPPLICATIONLOGOUTURI /AWS1/GMZAPPLICATIONLOGOUTURI

An Amazon S3 URI to a bucket where you would like Amazon GameLift Streams to save application logs. Required if you specify one or more ApplicationLogPaths.

The log bucket must have permissions that give Amazon GameLift Streams access to write the log files. For more information, see Application log bucket permission policy in the Amazon GameLift Streams Developer Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_gmzupdapplicationout /AWS1/CL_GMZUPDAPPLICATIONOUT

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->/aws1/if_gmz~updateapplication(
  it_applicationlogpaths = VALUE /aws1/cl_gmzfilepaths_w=>tt_filepaths(
    ( new /aws1/cl_gmzfilepaths_w( |string| ) )
  )
  iv_applicationlogoutputuri = |string|
  iv_description = |string|
  iv_identifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_identifier = lo_result->get_arn( ).
  lv_description = lo_result->get_description( ).
  lo_runtimeenvironment = lo_result->get_runtimeenvironment( ).
  IF lo_runtimeenvironment IS NOT INITIAL.
    lv_runtimeenvironmenttype = lo_runtimeenvironment->get_type( ).
    lv_runtimeenvironmentversi = lo_runtimeenvironment->get_version( ).
  ENDIF.
  lv_executablepath = lo_result->get_executablepath( ).
  LOOP AT lo_result->get_applicationlogpaths( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_filepath = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
  lv_applicationlogoutputuri = lo_result->get_applicationlogoutputuri( ).
  lv_applicationsourceuri = lo_result->get_applicationsourceuri( ).
  lv_id = lo_result->get_id( ).
  lv_applicationstatus = lo_result->get_status( ).
  lv_applicationstatusreason = lo_result->get_statusreason( ).
  LOOP AT lo_result->get_replicationstatuses( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_locationname = lo_row_3->get_location( ).
      lv_replicationstatustype = lo_row_3->get_status( ).
    ENDIF.
  ENDLOOP.
  lv_timestamp = lo_result->get_createdat( ).
  lv_timestamp = lo_result->get_lastupdatedat( ).
  LOOP AT lo_result->get_associatedstreamgroups( ) into lo_row_4.
    lo_row_5 = lo_row_4.
    IF lo_row_5 IS NOT INITIAL.
      lv_arn = lo_row_5->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.