AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::SSM::Model::StartSessionRequest Class Reference

#include <StartSessionRequest.h>

+ Inheritance diagram for Aws::SSM::Model::StartSessionRequest:

Public Member Functions

 StartSessionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetTarget () const
 
bool TargetHasBeenSet () const
 
void SetTarget (const Aws::String &value)
 
void SetTarget (Aws::String &&value)
 
void SetTarget (const char *value)
 
StartSessionRequestWithTarget (const Aws::String &value)
 
StartSessionRequestWithTarget (Aws::String &&value)
 
StartSessionRequestWithTarget (const char *value)
 
const Aws::StringGetDocumentName () const
 
bool DocumentNameHasBeenSet () const
 
void SetDocumentName (const Aws::String &value)
 
void SetDocumentName (Aws::String &&value)
 
void SetDocumentName (const char *value)
 
StartSessionRequestWithDocumentName (const Aws::String &value)
 
StartSessionRequestWithDocumentName (Aws::String &&value)
 
StartSessionRequestWithDocumentName (const char *value)
 
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
void SetParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
StartSessionRequestWithParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
StartSessionRequestWithParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
StartSessionRequestAddParameters (const Aws::String &key, const Aws::Vector< Aws::String > &value)
 
StartSessionRequestAddParameters (Aws::String &&key, const Aws::Vector< Aws::String > &value)
 
StartSessionRequestAddParameters (const Aws::String &key, Aws::Vector< Aws::String > &&value)
 
StartSessionRequestAddParameters (Aws::String &&key, Aws::Vector< Aws::String > &&value)
 
StartSessionRequestAddParameters (const char *key, Aws::Vector< Aws::String > &&value)
 
StartSessionRequestAddParameters (const char *key, const Aws::Vector< Aws::String > &value)
 
- Public Member Functions inherited from Aws::SSM::SSMRequest
virtual ~SSMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 23 of file StartSessionRequest.h.

Constructor & Destructor Documentation

◆ StartSessionRequest()

Aws::SSM::Model::StartSessionRequest::StartSessionRequest ( )

Member Function Documentation

◆ AddParameters() [1/6]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::AddParameters ( const Aws::String key,
const Aws::Vector< Aws::String > &  value 
)
inline

Reserved for future use.

Definition at line 186 of file StartSessionRequest.h.

◆ AddParameters() [2/6]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::AddParameters ( Aws::String &&  key,
const Aws::Vector< Aws::String > &  value 
)
inline

Reserved for future use.

Definition at line 191 of file StartSessionRequest.h.

◆ AddParameters() [3/6]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::AddParameters ( const Aws::String key,
Aws::Vector< Aws::String > &&  value 
)
inline

Reserved for future use.

Definition at line 196 of file StartSessionRequest.h.

◆ AddParameters() [4/6]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::AddParameters ( Aws::String &&  key,
Aws::Vector< Aws::String > &&  value 
)
inline

Reserved for future use.

Definition at line 201 of file StartSessionRequest.h.

◆ AddParameters() [5/6]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::AddParameters ( const char *  key,
Aws::Vector< Aws::String > &&  value 
)
inline

Reserved for future use.

Definition at line 206 of file StartSessionRequest.h.

◆ AddParameters() [6/6]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::AddParameters ( const char *  key,
const Aws::Vector< Aws::String > &  value 
)
inline

Reserved for future use.

Definition at line 211 of file StartSessionRequest.h.

◆ DocumentNameHasBeenSet()

bool Aws::SSM::Model::StartSessionRequest::DocumentNameHasBeenSet ( ) const
inline

The name of the SSM document to define the parameters and plugin settings 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 instance is launched by default.

Definition at line 96 of file StartSessionRequest.h.

◆ GetDocumentName()

const Aws::String& Aws::SSM::Model::StartSessionRequest::GetDocumentName ( ) const
inline

The name of the SSM document to define the parameters and plugin settings 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 instance is launched by default.

Definition at line 87 of file StartSessionRequest.h.

◆ GetParameters()

const Aws::Map<Aws::String, Aws::Vector<Aws::String> >& Aws::SSM::Model::StartSessionRequest::GetParameters ( ) const
inline

Reserved for future use.

Definition at line 156 of file StartSessionRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SSM::Model::StartSessionRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SSM::Model::StartSessionRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file StartSessionRequest.h.

◆ GetTarget()

const Aws::String& Aws::SSM::Model::StartSessionRequest::GetTarget ( ) const
inline

The instance to connect to for the session.

Definition at line 42 of file StartSessionRequest.h.

◆ ParametersHasBeenSet()

bool Aws::SSM::Model::StartSessionRequest::ParametersHasBeenSet ( ) const
inline

Reserved for future use.

Definition at line 161 of file StartSessionRequest.h.

◆ SerializePayload()

Aws::String Aws::SSM::Model::StartSessionRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDocumentName() [1/3]

void Aws::SSM::Model::StartSessionRequest::SetDocumentName ( const Aws::String value)
inline

The name of the SSM document to define the parameters and plugin settings 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 instance is launched by default.

Definition at line 105 of file StartSessionRequest.h.

◆ SetDocumentName() [2/3]

void Aws::SSM::Model::StartSessionRequest::SetDocumentName ( Aws::String &&  value)
inline

The name of the SSM document to define the parameters and plugin settings 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 instance is launched by default.

Definition at line 114 of file StartSessionRequest.h.

◆ SetDocumentName() [3/3]

void Aws::SSM::Model::StartSessionRequest::SetDocumentName ( const char *  value)
inline

The name of the SSM document to define the parameters and plugin settings 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 instance is launched by default.

Definition at line 123 of file StartSessionRequest.h.

◆ SetParameters() [1/2]

void Aws::SSM::Model::StartSessionRequest::SetParameters ( const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &  value)
inline

Reserved for future use.

Definition at line 166 of file StartSessionRequest.h.

◆ SetParameters() [2/2]

void Aws::SSM::Model::StartSessionRequest::SetParameters ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value)
inline

Reserved for future use.

Definition at line 171 of file StartSessionRequest.h.

◆ SetTarget() [1/3]

void Aws::SSM::Model::StartSessionRequest::SetTarget ( const Aws::String value)
inline

The instance to connect to for the session.

Definition at line 52 of file StartSessionRequest.h.

◆ SetTarget() [2/3]

void Aws::SSM::Model::StartSessionRequest::SetTarget ( Aws::String &&  value)
inline

The instance to connect to for the session.

Definition at line 57 of file StartSessionRequest.h.

◆ SetTarget() [3/3]

void Aws::SSM::Model::StartSessionRequest::SetTarget ( const char *  value)
inline

The instance to connect to for the session.

Definition at line 62 of file StartSessionRequest.h.

◆ TargetHasBeenSet()

bool Aws::SSM::Model::StartSessionRequest::TargetHasBeenSet ( ) const
inline

The instance to connect to for the session.

Definition at line 47 of file StartSessionRequest.h.

◆ WithDocumentName() [1/3]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::WithDocumentName ( const Aws::String value)
inline

The name of the SSM document to define the parameters and plugin settings 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 instance is launched by default.

Definition at line 132 of file StartSessionRequest.h.

◆ WithDocumentName() [2/3]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::WithDocumentName ( Aws::String &&  value)
inline

The name of the SSM document to define the parameters and plugin settings 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 instance is launched by default.

Definition at line 141 of file StartSessionRequest.h.

◆ WithDocumentName() [3/3]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::WithDocumentName ( const char *  value)
inline

The name of the SSM document to define the parameters and plugin settings 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 instance is launched by default.

Definition at line 150 of file StartSessionRequest.h.

◆ WithParameters() [1/2]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::WithParameters ( const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &  value)
inline

Reserved for future use.

Definition at line 176 of file StartSessionRequest.h.

◆ WithParameters() [2/2]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::WithParameters ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value)
inline

Reserved for future use.

Definition at line 181 of file StartSessionRequest.h.

◆ WithTarget() [1/3]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::WithTarget ( const Aws::String value)
inline

The instance to connect to for the session.

Definition at line 67 of file StartSessionRequest.h.

◆ WithTarget() [2/3]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::WithTarget ( Aws::String &&  value)
inline

The instance to connect to for the session.

Definition at line 72 of file StartSessionRequest.h.

◆ WithTarget() [3/3]

StartSessionRequest& Aws::SSM::Model::StartSessionRequest::WithTarget ( const char *  value)
inline

The instance to connect to for the session.

Definition at line 77 of file StartSessionRequest.h.


The documentation for this class was generated from the following file: