GameLiftStreams / Client / revoke_stream_url

revoke_stream_url

GameLiftStreams.Client.revoke_stream_url(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.revoke_stream_url(
    Identifier='string',
    StreamUrlIdentifier='string',
    RevocationMode='REVOKE_URL'|'REVOKE_AND_TERMINATE_SESSIONS'
)
Parameters:

  • Identifier (string) –

    [REQUIRED]

    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.

  • StreamUrlIdentifier (string) –

    [REQUIRED]

    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.

  • RevocationMode (string) –

    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.

Returns:

None

Exceptions

  • GameLiftStreams.Client.exceptions.AccessDeniedException

  • GameLiftStreams.Client.exceptions.ResourceNotFoundException

  • GameLiftStreams.Client.exceptions.ThrottlingException

  • GameLiftStreams.Client.exceptions.InternalServerException

  • GameLiftStreams.Client.exceptions.ValidationException