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

#include <SendAutomationSignalRequest.h>

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

Public Member Functions

 SendAutomationSignalRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetAutomationExecutionId () const
 
bool AutomationExecutionIdHasBeenSet () const
 
void SetAutomationExecutionId (const Aws::String &value)
 
void SetAutomationExecutionId (Aws::String &&value)
 
void SetAutomationExecutionId (const char *value)
 
SendAutomationSignalRequestWithAutomationExecutionId (const Aws::String &value)
 
SendAutomationSignalRequestWithAutomationExecutionId (Aws::String &&value)
 
SendAutomationSignalRequestWithAutomationExecutionId (const char *value)
 
const SignalTypeGetSignalType () const
 
bool SignalTypeHasBeenSet () const
 
void SetSignalType (const SignalType &value)
 
void SetSignalType (SignalType &&value)
 
SendAutomationSignalRequestWithSignalType (const SignalType &value)
 
SendAutomationSignalRequestWithSignalType (SignalType &&value)
 
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetPayload () const
 
bool PayloadHasBeenSet () const
 
void SetPayload (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
void SetPayload (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
SendAutomationSignalRequestWithPayload (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
SendAutomationSignalRequestWithPayload (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
SendAutomationSignalRequestAddPayload (const Aws::String &key, const Aws::Vector< Aws::String > &value)
 
SendAutomationSignalRequestAddPayload (Aws::String &&key, const Aws::Vector< Aws::String > &value)
 
SendAutomationSignalRequestAddPayload (const Aws::String &key, Aws::Vector< Aws::String > &&value)
 
SendAutomationSignalRequestAddPayload (Aws::String &&key, Aws::Vector< Aws::String > &&value)
 
SendAutomationSignalRequestAddPayload (const char *key, Aws::Vector< Aws::String > &&value)
 
SendAutomationSignalRequestAddPayload (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 24 of file SendAutomationSignalRequest.h.

Constructor & Destructor Documentation

◆ SendAutomationSignalRequest()

Aws::SSM::Model::SendAutomationSignalRequest::SendAutomationSignalRequest ( )

Member Function Documentation

◆ AddPayload() [1/6]

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

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 209 of file SendAutomationSignalRequest.h.

◆ AddPayload() [2/6]

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

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 222 of file SendAutomationSignalRequest.h.

◆ AddPayload() [3/6]

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

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 235 of file SendAutomationSignalRequest.h.

◆ AddPayload() [4/6]

SendAutomationSignalRequest& Aws::SSM::Model::SendAutomationSignalRequest::AddPayload ( Aws::String &&  key,
Aws::Vector< Aws::String > &&  value 
)
inline

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 248 of file SendAutomationSignalRequest.h.

◆ AddPayload() [5/6]

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

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 261 of file SendAutomationSignalRequest.h.

◆ AddPayload() [6/6]

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

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 274 of file SendAutomationSignalRequest.h.

◆ AutomationExecutionIdHasBeenSet()

bool Aws::SSM::Model::SendAutomationSignalRequest::AutomationExecutionIdHasBeenSet ( ) const
inline

The unique identifier for an existing Automation execution that you want to send the signal to.

Definition at line 50 of file SendAutomationSignalRequest.h.

◆ GetAutomationExecutionId()

const Aws::String& Aws::SSM::Model::SendAutomationSignalRequest::GetAutomationExecutionId ( ) const
inline

The unique identifier for an existing Automation execution that you want to send the signal to.

Definition at line 44 of file SendAutomationSignalRequest.h.

◆ GetPayload()

const Aws::Map<Aws::String, Aws::Vector<Aws::String> >& Aws::SSM::Model::SendAutomationSignalRequest::GetPayload ( ) const
inline

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 131 of file SendAutomationSignalRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file SendAutomationSignalRequest.h.

◆ GetSignalType()

const SignalType& Aws::SSM::Model::SendAutomationSignalRequest::GetSignalType ( ) const
inline

The type of signal to send to an Automation execution.

Definition at line 92 of file SendAutomationSignalRequest.h.

◆ PayloadHasBeenSet()

bool Aws::SSM::Model::SendAutomationSignalRequest::PayloadHasBeenSet ( ) const
inline

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 144 of file SendAutomationSignalRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAutomationExecutionId() [1/3]

void Aws::SSM::Model::SendAutomationSignalRequest::SetAutomationExecutionId ( const Aws::String value)
inline

The unique identifier for an existing Automation execution that you want to send the signal to.

Definition at line 56 of file SendAutomationSignalRequest.h.

◆ SetAutomationExecutionId() [2/3]

void Aws::SSM::Model::SendAutomationSignalRequest::SetAutomationExecutionId ( Aws::String &&  value)
inline

The unique identifier for an existing Automation execution that you want to send the signal to.

Definition at line 62 of file SendAutomationSignalRequest.h.

◆ SetAutomationExecutionId() [3/3]

void Aws::SSM::Model::SendAutomationSignalRequest::SetAutomationExecutionId ( const char *  value)
inline

The unique identifier for an existing Automation execution that you want to send the signal to.

Definition at line 68 of file SendAutomationSignalRequest.h.

◆ SetPayload() [1/2]

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

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 157 of file SendAutomationSignalRequest.h.

◆ SetPayload() [2/2]

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

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 170 of file SendAutomationSignalRequest.h.

◆ SetSignalType() [1/2]

void Aws::SSM::Model::SendAutomationSignalRequest::SetSignalType ( const SignalType value)
inline

The type of signal to send to an Automation execution.

Definition at line 102 of file SendAutomationSignalRequest.h.

◆ SetSignalType() [2/2]

void Aws::SSM::Model::SendAutomationSignalRequest::SetSignalType ( SignalType &&  value)
inline

The type of signal to send to an Automation execution.

Definition at line 107 of file SendAutomationSignalRequest.h.

◆ SignalTypeHasBeenSet()

bool Aws::SSM::Model::SendAutomationSignalRequest::SignalTypeHasBeenSet ( ) const
inline

The type of signal to send to an Automation execution.

Definition at line 97 of file SendAutomationSignalRequest.h.

◆ WithAutomationExecutionId() [1/3]

SendAutomationSignalRequest& Aws::SSM::Model::SendAutomationSignalRequest::WithAutomationExecutionId ( const Aws::String value)
inline

The unique identifier for an existing Automation execution that you want to send the signal to.

Definition at line 74 of file SendAutomationSignalRequest.h.

◆ WithAutomationExecutionId() [2/3]

SendAutomationSignalRequest& Aws::SSM::Model::SendAutomationSignalRequest::WithAutomationExecutionId ( Aws::String &&  value)
inline

The unique identifier for an existing Automation execution that you want to send the signal to.

Definition at line 80 of file SendAutomationSignalRequest.h.

◆ WithAutomationExecutionId() [3/3]

SendAutomationSignalRequest& Aws::SSM::Model::SendAutomationSignalRequest::WithAutomationExecutionId ( const char *  value)
inline

The unique identifier for an existing Automation execution that you want to send the signal to.

Definition at line 86 of file SendAutomationSignalRequest.h.

◆ WithPayload() [1/2]

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

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 183 of file SendAutomationSignalRequest.h.

◆ WithPayload() [2/2]

SendAutomationSignalRequest& Aws::SSM::Model::SendAutomationSignalRequest::WithPayload ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value)
inline

The data sent with the signal. The data schema depends on the type of signal used in the request.

For Approve and Reject signal types, the payload is an optional comment that you can send with the signal type. For example:

Comment="Looks good"

For StartStep and Resume signal types, you must send the name of the Automation step to start or resume as the payload. For example:

StepName="step1"

For the StopStep signal type, you must send the step execution ID as the payload. For example:

StepExecutionId="97fff367-fc5a-4299-aed8-0123456789ab"

Definition at line 196 of file SendAutomationSignalRequest.h.

◆ WithSignalType() [1/2]

SendAutomationSignalRequest& Aws::SSM::Model::SendAutomationSignalRequest::WithSignalType ( const SignalType value)
inline

The type of signal to send to an Automation execution.

Definition at line 112 of file SendAutomationSignalRequest.h.

◆ WithSignalType() [2/2]

SendAutomationSignalRequest& Aws::SSM::Model::SendAutomationSignalRequest::WithSignalType ( SignalType &&  value)
inline

The type of signal to send to an Automation execution.

Definition at line 117 of file SendAutomationSignalRequest.h.


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