REVOKESTREAMURL()`¶

About RevokeStreamUrl¶

Revokes a stream URL so that it can no longer start new stream sessions. By default, stream sessions that are already running continue until they end on their own. To also end running sessions, set RevocationMode to REVOKE_AND_TERMINATE_SESSIONS.

Revoking a stream URL is permanent. The status of the stream URL changes to REVOKED.

Method Signature¶

METHODS /AWS1/IF_GMZ~REVOKESTREAMURL
  IMPORTING
    !IV_IDENTIFIER TYPE /AWS1/GMZIDENTIFIER OPTIONAL
    !IV_STREAMURLIDENTIFIER TYPE /AWS1/GMZIDENTIFIER OPTIONAL
    !IV_REVOCATIONMODE TYPE /AWS1/GMZREVOCATIONMODE OPTIONAL
  RAISING
    /AWS1/CX_GMZACCESSDENIEDEX
    /AWS1/CX_GMZINTERNALSERVEREX
    /AWS1/CX_GMZRESOURCENOTFOUNDEX
    /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`¶

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.

This is the stream group that owns the stream URL.

`iv_streamurlidentifier` `TYPE /AWS1/GMZIDENTIFIER` `/AWS1/GMZIDENTIFIER`¶

The unique identifier of the stream URL to revoke. Specify a stream URL ID or Amazon Resource Name (ARN). Example ARN: arn:aws:gameliftstreams:us-west-2:111122223333:streamurl/sg-1AB2C3De4/su-1AB2C3De4. Example ID: su-1AB2C3De4.

Optional arguments:¶

`iv_revocationmode` `TYPE /AWS1/GMZREVOCATIONMODE` `/AWS1/GMZREVOCATIONMODE`¶

Controls what happens to running stream sessions when you revoke the stream URL. If you do not specify a value, the default is REVOKE_URL. Possible values include the following:

REVOKE_URL: Stops the stream URL from starting new stream sessions. Running sessions continue until they end.

REVOKE_AND_TERMINATE_SESSIONS: Stops new stream sessions and ends any running stream sessions.

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.

lo_client->revokestreamurl(
  iv_identifier = |string|
  iv_revocationmode = |string|
  iv_streamurlidentifier = |string|
).

/AWS1/IF_GMZ=>REVOKESTREAMURL()¶