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

#include <GetCommandInvocationRequest.h>

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

Public Member Functions

 GetCommandInvocationRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetCommandId () const
 
bool CommandIdHasBeenSet () const
 
void SetCommandId (const Aws::String &value)
 
void SetCommandId (Aws::String &&value)
 
void SetCommandId (const char *value)
 
GetCommandInvocationRequestWithCommandId (const Aws::String &value)
 
GetCommandInvocationRequestWithCommandId (Aws::String &&value)
 
GetCommandInvocationRequestWithCommandId (const char *value)
 
const Aws::StringGetInstanceId () const
 
bool InstanceIdHasBeenSet () const
 
void SetInstanceId (const Aws::String &value)
 
void SetInstanceId (Aws::String &&value)
 
void SetInstanceId (const char *value)
 
GetCommandInvocationRequestWithInstanceId (const Aws::String &value)
 
GetCommandInvocationRequestWithInstanceId (Aws::String &&value)
 
GetCommandInvocationRequestWithInstanceId (const char *value)
 
const Aws::StringGetPluginName () const
 
bool PluginNameHasBeenSet () const
 
void SetPluginName (const Aws::String &value)
 
void SetPluginName (Aws::String &&value)
 
void SetPluginName (const char *value)
 
GetCommandInvocationRequestWithPluginName (const Aws::String &value)
 
GetCommandInvocationRequestWithPluginName (Aws::String &&value)
 
GetCommandInvocationRequestWithPluginName (const char *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 21 of file GetCommandInvocationRequest.h.

Constructor & Destructor Documentation

◆ GetCommandInvocationRequest()

Aws::SSM::Model::GetCommandInvocationRequest::GetCommandInvocationRequest ( )

Member Function Documentation

◆ CommandIdHasBeenSet()

bool Aws::SSM::Model::GetCommandInvocationRequest::CommandIdHasBeenSet ( ) const
inline

(Required) The parent command ID of the invocation plugin.

Definition at line 45 of file GetCommandInvocationRequest.h.

◆ GetCommandId()

const Aws::String& Aws::SSM::Model::GetCommandInvocationRequest::GetCommandId ( ) const
inline

(Required) The parent command ID of the invocation plugin.

Definition at line 40 of file GetCommandInvocationRequest.h.

◆ GetInstanceId()

const Aws::String& Aws::SSM::Model::GetCommandInvocationRequest::GetInstanceId ( ) const
inline

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Definition at line 84 of file GetCommandInvocationRequest.h.

◆ GetPluginName()

const Aws::String& Aws::SSM::Model::GetCommandInvocationRequest::GetPluginName ( ) const
inline

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Definition at line 156 of file GetCommandInvocationRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file GetCommandInvocationRequest.h.

◆ InstanceIdHasBeenSet()

bool Aws::SSM::Model::GetCommandInvocationRequest::InstanceIdHasBeenSet ( ) const
inline

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Definition at line 92 of file GetCommandInvocationRequest.h.

◆ PluginNameHasBeenSet()

bool Aws::SSM::Model::GetCommandInvocationRequest::PluginNameHasBeenSet ( ) const
inline

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Definition at line 171 of file GetCommandInvocationRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCommandId() [1/3]

void Aws::SSM::Model::GetCommandInvocationRequest::SetCommandId ( Aws::String &&  value)
inline

(Required) The parent command ID of the invocation plugin.

Definition at line 55 of file GetCommandInvocationRequest.h.

◆ SetCommandId() [2/3]

void Aws::SSM::Model::GetCommandInvocationRequest::SetCommandId ( const Aws::String value)
inline

(Required) The parent command ID of the invocation plugin.

Definition at line 50 of file GetCommandInvocationRequest.h.

◆ SetCommandId() [3/3]

void Aws::SSM::Model::GetCommandInvocationRequest::SetCommandId ( const char *  value)
inline

(Required) The parent command ID of the invocation plugin.

Definition at line 60 of file GetCommandInvocationRequest.h.

◆ SetInstanceId() [1/3]

void Aws::SSM::Model::GetCommandInvocationRequest::SetInstanceId ( Aws::String &&  value)
inline

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Definition at line 108 of file GetCommandInvocationRequest.h.

◆ SetInstanceId() [2/3]

void Aws::SSM::Model::GetCommandInvocationRequest::SetInstanceId ( const Aws::String value)
inline

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Definition at line 100 of file GetCommandInvocationRequest.h.

◆ SetInstanceId() [3/3]

void Aws::SSM::Model::GetCommandInvocationRequest::SetInstanceId ( const char *  value)
inline

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Definition at line 116 of file GetCommandInvocationRequest.h.

◆ SetPluginName() [1/3]

void Aws::SSM::Model::GetCommandInvocationRequest::SetPluginName ( Aws::String &&  value)
inline

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Definition at line 201 of file GetCommandInvocationRequest.h.

◆ SetPluginName() [2/3]

void Aws::SSM::Model::GetCommandInvocationRequest::SetPluginName ( const Aws::String value)
inline

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Definition at line 186 of file GetCommandInvocationRequest.h.

◆ SetPluginName() [3/3]

void Aws::SSM::Model::GetCommandInvocationRequest::SetPluginName ( const char *  value)
inline

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Definition at line 216 of file GetCommandInvocationRequest.h.

◆ WithCommandId() [1/3]

GetCommandInvocationRequest& Aws::SSM::Model::GetCommandInvocationRequest::WithCommandId ( Aws::String &&  value)
inline

(Required) The parent command ID of the invocation plugin.

Definition at line 70 of file GetCommandInvocationRequest.h.

◆ WithCommandId() [2/3]

GetCommandInvocationRequest& Aws::SSM::Model::GetCommandInvocationRequest::WithCommandId ( const Aws::String value)
inline

(Required) The parent command ID of the invocation plugin.

Definition at line 65 of file GetCommandInvocationRequest.h.

◆ WithCommandId() [3/3]

GetCommandInvocationRequest& Aws::SSM::Model::GetCommandInvocationRequest::WithCommandId ( const char *  value)
inline

(Required) The parent command ID of the invocation plugin.

Definition at line 75 of file GetCommandInvocationRequest.h.

◆ WithInstanceId() [1/3]

GetCommandInvocationRequest& Aws::SSM::Model::GetCommandInvocationRequest::WithInstanceId ( Aws::String &&  value)
inline

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Definition at line 132 of file GetCommandInvocationRequest.h.

◆ WithInstanceId() [2/3]

GetCommandInvocationRequest& Aws::SSM::Model::GetCommandInvocationRequest::WithInstanceId ( const Aws::String value)
inline

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Definition at line 124 of file GetCommandInvocationRequest.h.

◆ WithInstanceId() [3/3]

GetCommandInvocationRequest& Aws::SSM::Model::GetCommandInvocationRequest::WithInstanceId ( const char *  value)
inline

(Required) The ID of the managed instance targeted by the command. A managed instance can be an Amazon Elastic Compute Cloud (Amazon EC2) instance or an instance in your hybrid environment that is configured for Amazon Web Services Systems Manager.

Definition at line 140 of file GetCommandInvocationRequest.h.

◆ WithPluginName() [1/3]

GetCommandInvocationRequest& Aws::SSM::Model::GetCommandInvocationRequest::WithPluginName ( Aws::String &&  value)
inline

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Definition at line 246 of file GetCommandInvocationRequest.h.

◆ WithPluginName() [2/3]

GetCommandInvocationRequest& Aws::SSM::Model::GetCommandInvocationRequest::WithPluginName ( const Aws::String value)
inline

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Definition at line 231 of file GetCommandInvocationRequest.h.

◆ WithPluginName() [3/3]

GetCommandInvocationRequest& Aws::SSM::Model::GetCommandInvocationRequest::WithPluginName ( const char *  value)
inline

The name of the plugin for which you want detailed results. If the document contains only one plugin, you can omit the name and details for that plugin. If the document contains more than one plugin, you must specify the name of the plugin for which you want to view details.

Plugin names are also referred to as step names in Systems Manager documents (SSM documents). For example, aws:RunShellScript is a plugin.

To find the PluginName, check the document content and find the name of the plugin. Alternatively, use ListCommandInvocations with the CommandId and Details parameters. The PluginName is the Name attribute of the CommandPlugin object in the CommandPlugins list.

Definition at line 261 of file GetCommandInvocationRequest.h.


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