GameLiftStreams / Client / terminate_stream_session
terminate_stream_session¶
- GameLiftStreams.Client.terminate_stream_session(**kwargs)¶
Permanently terminates an active stream session. When called, the stream session status changes to
TERMINATING
. You can terminate a stream session in any status exceptACTIVATING
. If the stream session is inACTIVATING
status, an exception is thrown.See also: AWS API Documentation
Request Syntax
response = client.terminate_stream_session( Identifier='string', StreamSessionIdentifier='string' )
- Parameters:
Identifier (string) –
[REQUIRED]
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
.The stream group that runs this stream session.
StreamSessionIdentifier (string) –
[REQUIRED]
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
.
- Returns:
None
Exceptions