Struct aws_sdk_ssm::client::fluent_builders::StartSession

pub struct StartSession { /* private fields */ }

Fluent builder constructing a request to StartSession.

Initiates a connection to a target (for example, a managed node) for a Session Manager session. Returns a URL and token that can be used to open a WebSocket connection for sending input and receiving outputs.

Amazon Web Services CLI usage: start-session is an interactive command that requires the Session Manager plugin to be installed on the client machine making the call. For information, see Install the Session Manager plugin for the Amazon Web Services CLI in the Amazon Web Services Systems Manager User Guide.

Amazon Web Services Tools for PowerShell usage: Start-SSMSession isn't currently supported by Amazon Web Services Tools for PowerShell on Windows local machines.

Implementations

impl StartSession

pub async fn send(
    self
) -> Result<StartSessionOutput, SdkError<StartSessionError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn target(self, input: impl Into<String>) -> Self

The managed node to connect to for the session.

pub fn set_target(self, input: Option<String>) -> Self

The managed node to connect to for the session.

pub fn document_name(self, input: impl Into<String>) -> Self

The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.

pub fn set_document_name(self, input: Option<String>) -> Self

The name of the SSM document you want to use to define the type of session, input parameters, or preferences for the session. For example, SSM-SessionManagerRunShell. You can call the GetDocument API to verify the document exists before attempting to start a session. If no document name is provided, a shell to the managed node is launched by default. For more information, see Start a session in the Amazon Web Services Systems Manager User Guide.

pub fn reason(self, input: impl Into<String>) -> Self

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

pub fn set_reason(self, input: Option<String>) -> Self

The reason for connecting to the instance. This value is included in the details for the Amazon CloudWatch Events event created when you start the session.

pub fn parameters(self, k: impl Into<String>, v: Vec<String>) -> Self

Adds a key-value pair to Parameters.

To override the contents of this collection use set_parameters.

The values you want to specify for the parameters defined in the Session document.

pub fn set_parameters(self, input: Option<HashMap<String, Vec<String>>>) -> Self

The values you want to specify for the parameters defined in the Session document.

Trait Implementations

impl Clone for StartSession

fn clone(&self) -> StartSession

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartSession

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.