aws_sdk_ssm/client/
resume_session.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ResumeSession`](crate::operation::resume_session::builders::ResumeSessionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`session_id(impl Into<String>)`](crate::operation::resume_session::builders::ResumeSessionFluentBuilder::session_id) / [`set_session_id(Option<String>)`](crate::operation::resume_session::builders::ResumeSessionFluentBuilder::set_session_id):<br>required: **true**<br><p>The ID of the disconnected session to resume.</p><br>
    /// - On success, responds with [`ResumeSessionOutput`](crate::operation::resume_session::ResumeSessionOutput) with field(s):
    ///   - [`session_id(Option<String>)`](crate::operation::resume_session::ResumeSessionOutput::session_id): <p>The ID of the session.</p>
    ///   - [`token_value(Option<String>)`](crate::operation::resume_session::ResumeSessionOutput::token_value): <p>An encrypted token value containing session and caller information. Used to authenticate the connection to the managed node.</p>
    ///   - [`stream_url(Option<String>)`](crate::operation::resume_session::ResumeSessionOutput::stream_url): <p>A URL back to SSM Agent on the managed node that the Session Manager client uses to send commands and receive output from the managed node. Format: <code>wss://ssmmessages.<b>region</b>.amazonaws.com/v1/data-channel/<b>session-id</b>?stream=(input|output)</code>.</p> <p><b>region</b> represents the Region identifier for an Amazon Web Services Region supported by Amazon Web Services Systems Manager, such as <code>us-east-2</code> for the US East (Ohio) Region. For a list of supported <b>region</b> values, see the <b>Region</b> column in <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#ssm_region">Systems Manager service endpoints</a> in the <i>Amazon Web Services General Reference</i>.</p> <p><b>session-id</b> represents the ID of a Session Manager session, such as <code>1a2b3c4dEXAMPLE</code>.</p>
    /// - On failure, responds with [`SdkError<ResumeSessionError>`](crate::operation::resume_session::ResumeSessionError)
    pub fn resume_session(&self) -> crate::operation::resume_session::builders::ResumeSessionFluentBuilder {
        crate::operation::resume_session::builders::ResumeSessionFluentBuilder::new(self.handle.clone())
    }
}