/AWS1/CL_APS=>DESCRIBESESSIONS()

About DescribeSessions

Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.

Method Signature

IMPORTING

Required arguments:

IV_STACKNAME TYPE /AWS1/APSNAME /AWS1/APSNAME

The name of the stack. This value is case-sensitive.

IV_FLEETNAME TYPE /AWS1/APSNAME /AWS1/APSNAME

The name of the fleet. This value is case-sensitive.

Optional arguments:

IV_USERID TYPE /AWS1/APSUSERID /AWS1/APSUSERID

The user identifier (ID). If you specify a user ID, you must also specify the authentication type.

IV_NEXTTOKEN TYPE /AWS1/APSSTRING /AWS1/APSSTRING

The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.

IV_LIMIT TYPE /AWS1/APSINTEGER /AWS1/APSINTEGER

The size of each page of results. The default value is 20 and the maximum value is 50.

IV_AUTHENTICATIONTYPE TYPE /AWS1/APSAUTHENTICATIONTYPE /AWS1/APSAUTHENTICATIONTYPE

The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.

IV_INSTANCEID TYPE /AWS1/APSSTRING /AWS1/APSSTRING

The identifier for the instance hosting the session.

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_APSDESCRSESSSRESULT /AWS1/CL_APSDESCRSESSSRESULT