Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartSession

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

Request Syntax


{
   "ResourceIdentifier": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ResourceIdentifier

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:.*\/.*

Required: Yes

Response Syntax


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

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

SessionId

A unique identifier for the established remote connection session.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

StreamUrl

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

Type: String

TokenValue

An encrypted token value containing session and caller information.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400