CREATESTREAMSESSADMINSHELL()`¶

About CreateStreamSessionAdminShell¶

Creates an administrative terminal session with full access to the live runtime environment of the Amazon GameLift Streams stream session. Use the returned credentials (SessionId, StreamUrl and TokenValue) with the Amazon Web Services Systems Manager Session Manager plugin for the CLI to access the terminal session.

The stream session must be in one of the following statuses: ACTIVE, CONNECTED, PENDING_CLIENT_RECONNECTION, or RECONNECTING.

The StreamUrl is valid for 60 seconds. After it expires, call this operation again to get a new URL.

The returned credentials grant full access to the live runtime environment of the Amazon GameLift Streams stream session. The operator who connects to the terminal session has the same level of access that your Amazon GameLift Streams applications have, including potentially user input, screen images, and application data files. Grant permissions to call this operation only to trusted IAM identities that require live runtime environment access.

Method Signature¶

METHODS /AWS1/IF_GMZ~CREATESTREAMSESSADMINSHELL
  IMPORTING
    !IV_IDENTIFIER TYPE /AWS1/GMZIDENTIFIER OPTIONAL
    !IV_STREAMSESSIONIDENTIFIER TYPE /AWS1/GMZIDENTIFIER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmzcrestrmsessadmnh01
  RAISING
    /AWS1/CX_GMZACCESSDENIEDEX
    /AWS1/CX_GMZINTERNALSERVEREX
    /AWS1/CX_GMZRESOURCENOTFOUNDEX
    /AWS1/CX_GMZSTRMSESSACCNOTRE00
    /AWS1/CX_GMZTHROTTLINGEX
    /AWS1/CX_GMZVALIDATIONEX
    /AWS1/CX_GMZCLIENTEXC
    /AWS1/CX_GMZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_identifier` `TYPE /AWS1/GMZIDENTIFIER` `/AWS1/GMZIDENTIFIER`¶

The stream group that runs this stream session.

This value is an Amazon Resource Name (ARN) or ID that uniquely identifies the stream group resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4. Example ID: sg-1AB2C3De4.

`iv_streamsessionidentifier` `TYPE /AWS1/GMZIDENTIFIER` `/AWS1/GMZIDENTIFIER`¶

An Amazon Resource Name (ARN) or ID that uniquely identifies the stream session resource. Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamsession/sg-1AB2C3De4/ABC123def4567. Example ID: ABC123def4567.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmzcrestrmsessadmnh01` `/AWS1/CL_GMZCRESTRMSESSADMNH01`¶

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->createstreamsessadminshell(
  iv_identifier = |string|
  iv_streamsessionidentifier = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_sessionid = lo_result->get_sessionid( ).
  lv_streamurl = lo_result->get_streamurl( ).
  lv_tokenvalue = lo_result->get_tokenvalue( ).
ENDIF.

/AWS1/IF_GMZ=>CREATESTREAMSESSADMINSHELL()¶