SageMaker / Client / start_session

start_session

SageMaker.Client.start_session(**kwargs)

Initiates a remote connection session between a local integrated development environments (IDEs) and a remote SageMaker space.

See also: AWS API Documentation

Request Syntax

response = client.start_session(
    ResourceIdentifier='string'
)
Parameters:

ResourceIdentifier (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the resource to which the remote connection will be established. For example, this identifies the specific ARN space application you want to connect to from your local IDE.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • SessionId (string) –

      A unique identifier for the established remote connection session.

    • StreamUrl (string) –

      A WebSocket URL used to establish a SSH connection between the local IDE and remote SageMaker space.

    • TokenValue (string) –

      An encrypted token value containing session and caller information.

Exceptions