GameLiftStreams / Client / create_stream_session_admin_shell

create_stream_session_admin_shell

GameLiftStreams.Client.create_stream_session_admin_shell(**kwargs)

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.

Warning

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.

See also: AWS API Documentation

Request Syntax

response = client.create_stream_session_admin_shell(
    Identifier='string',
    StreamSessionIdentifier='string'
)

Parameters:

• Identifier (string) –

  [REQUIRED]

  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.

• StreamSessionIdentifier (string) –

  [REQUIRED]

  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.

Return type:

dict

Returns:

Response Syntax

{
    'SessionId': 'string',
    'StreamUrl': 'string',
    'TokenValue': 'string'
}

Response Structure

• (dict) –

  • SessionId (string) –

    An Amazon Web Services Systems Manager session identifier that uniquely identifies the requested terminal session. Use this value with the Amazon Web Services Systems Manager Session Manager plugin.

  • StreamUrl (string) –

    An Amazon Web Services Systems Manager WebSocket connection endpoint for the requested terminal session.

  • TokenValue (string) –

    An Amazon Web Services Systems Manager authentication token that authenticates your access to the session ID and WebSocket URL. This token must be treated with the same level of security as other user credentials. The token value is only valid for establishing a new connection within 60 seconds of generation.

Exceptions

• GameLiftStreams.Client.exceptions.AccessDeniedException

• GameLiftStreams.Client.exceptions.ResourceNotFoundException

• GameLiftStreams.Client.exceptions.ThrottlingException

• GameLiftStreams.Client.exceptions.InternalServerException

• GameLiftStreams.Client.exceptions.ValidationException

• GameLiftStreams.Client.exceptions.StreamSessionAccessNotReadyException