CodeBuild / Client / start_sandbox_connection

start_sandbox_connection¶

CodeBuild.Client.start_sandbox_connection(**kwargs)¶

Starts a sandbox connection.

See also: AWS API Documentation

Request Syntax

response = client.start_sandbox_connection(
    sandboxId='string'
)

Parameters:

sandboxId (string) –

[REQUIRED]

A sandboxId or sandboxArn.

Return type:

dict

Returns:

Response Syntax

{
    'ssmSession': {
        'sessionId': 'string',
        'tokenValue': 'string',
        'streamUrl': 'string'
    }
}

Response Structure

(dict) –
- ssmSession (dict) –
  
  Information about the Session Manager session.
  - sessionId (string) –
    
    The ID of the session.
  - tokenValue (string) –
    
    An encrypted token value containing session and caller information.
  - streamUrl (string) –
    
    A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the node.

Exceptions