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

#include <SendCommandRequest.h>

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

Public Member Functions

 SendCommandRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetInstanceIds () const
 
bool InstanceIdsHasBeenSet () const
 
void SetInstanceIds (const Aws::Vector< Aws::String > &value)
 
void SetInstanceIds (Aws::Vector< Aws::String > &&value)
 
SendCommandRequestWithInstanceIds (const Aws::Vector< Aws::String > &value)
 
SendCommandRequestWithInstanceIds (Aws::Vector< Aws::String > &&value)
 
SendCommandRequestAddInstanceIds (const Aws::String &value)
 
SendCommandRequestAddInstanceIds (Aws::String &&value)
 
SendCommandRequestAddInstanceIds (const char *value)
 
const Aws::Vector< Target > & GetTargets () const
 
bool TargetsHasBeenSet () const
 
void SetTargets (const Aws::Vector< Target > &value)
 
void SetTargets (Aws::Vector< Target > &&value)
 
SendCommandRequestWithTargets (const Aws::Vector< Target > &value)
 
SendCommandRequestWithTargets (Aws::Vector< Target > &&value)
 
SendCommandRequestAddTargets (const Target &value)
 
SendCommandRequestAddTargets (Target &&value)
 
const Aws::StringGetDocumentName () const
 
bool DocumentNameHasBeenSet () const
 
void SetDocumentName (const Aws::String &value)
 
void SetDocumentName (Aws::String &&value)
 
void SetDocumentName (const char *value)
 
SendCommandRequestWithDocumentName (const Aws::String &value)
 
SendCommandRequestWithDocumentName (Aws::String &&value)
 
SendCommandRequestWithDocumentName (const char *value)
 
const Aws::StringGetDocumentVersion () const
 
bool DocumentVersionHasBeenSet () const
 
void SetDocumentVersion (const Aws::String &value)
 
void SetDocumentVersion (Aws::String &&value)
 
void SetDocumentVersion (const char *value)
 
SendCommandRequestWithDocumentVersion (const Aws::String &value)
 
SendCommandRequestWithDocumentVersion (Aws::String &&value)
 
SendCommandRequestWithDocumentVersion (const char *value)
 
const Aws::StringGetDocumentHash () const
 
bool DocumentHashHasBeenSet () const
 
void SetDocumentHash (const Aws::String &value)
 
void SetDocumentHash (Aws::String &&value)
 
void SetDocumentHash (const char *value)
 
SendCommandRequestWithDocumentHash (const Aws::String &value)
 
SendCommandRequestWithDocumentHash (Aws::String &&value)
 
SendCommandRequestWithDocumentHash (const char *value)
 
const DocumentHashTypeGetDocumentHashType () const
 
bool DocumentHashTypeHasBeenSet () const
 
void SetDocumentHashType (const DocumentHashType &value)
 
void SetDocumentHashType (DocumentHashType &&value)
 
SendCommandRequestWithDocumentHashType (const DocumentHashType &value)
 
SendCommandRequestWithDocumentHashType (DocumentHashType &&value)
 
int GetTimeoutSeconds () const
 
bool TimeoutSecondsHasBeenSet () const
 
void SetTimeoutSeconds (int value)
 
SendCommandRequestWithTimeoutSeconds (int value)
 
const Aws::StringGetComment () const
 
bool CommentHasBeenSet () const
 
void SetComment (const Aws::String &value)
 
void SetComment (Aws::String &&value)
 
void SetComment (const char *value)
 
SendCommandRequestWithComment (const Aws::String &value)
 
SendCommandRequestWithComment (Aws::String &&value)
 
SendCommandRequestWithComment (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)
 
SendCommandRequestWithParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
SendCommandRequestWithParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
SendCommandRequestAddParameters (const Aws::String &key, const Aws::Vector< Aws::String > &value)
 
SendCommandRequestAddParameters (Aws::String &&key, const Aws::Vector< Aws::String > &value)
 
SendCommandRequestAddParameters (const Aws::String &key, Aws::Vector< Aws::String > &&value)
 
SendCommandRequestAddParameters (Aws::String &&key, Aws::Vector< Aws::String > &&value)
 
SendCommandRequestAddParameters (const char *key, Aws::Vector< Aws::String > &&value)
 
SendCommandRequestAddParameters (const char *key, const Aws::Vector< Aws::String > &value)
 
const Aws::StringGetOutputS3Region () const
 
bool OutputS3RegionHasBeenSet () const
 
void SetOutputS3Region (const Aws::String &value)
 
void SetOutputS3Region (Aws::String &&value)
 
void SetOutputS3Region (const char *value)
 
SendCommandRequestWithOutputS3Region (const Aws::String &value)
 
SendCommandRequestWithOutputS3Region (Aws::String &&value)
 
SendCommandRequestWithOutputS3Region (const char *value)
 
const Aws::StringGetOutputS3BucketName () const
 
bool OutputS3BucketNameHasBeenSet () const
 
void SetOutputS3BucketName (const Aws::String &value)
 
void SetOutputS3BucketName (Aws::String &&value)
 
void SetOutputS3BucketName (const char *value)
 
SendCommandRequestWithOutputS3BucketName (const Aws::String &value)
 
SendCommandRequestWithOutputS3BucketName (Aws::String &&value)
 
SendCommandRequestWithOutputS3BucketName (const char *value)
 
const Aws::StringGetOutputS3KeyPrefix () const
 
bool OutputS3KeyPrefixHasBeenSet () const
 
void SetOutputS3KeyPrefix (const Aws::String &value)
 
void SetOutputS3KeyPrefix (Aws::String &&value)
 
void SetOutputS3KeyPrefix (const char *value)
 
SendCommandRequestWithOutputS3KeyPrefix (const Aws::String &value)
 
SendCommandRequestWithOutputS3KeyPrefix (Aws::String &&value)
 
SendCommandRequestWithOutputS3KeyPrefix (const char *value)
 
const Aws::StringGetMaxConcurrency () const
 
bool MaxConcurrencyHasBeenSet () const
 
void SetMaxConcurrency (const Aws::String &value)
 
void SetMaxConcurrency (Aws::String &&value)
 
void SetMaxConcurrency (const char *value)
 
SendCommandRequestWithMaxConcurrency (const Aws::String &value)
 
SendCommandRequestWithMaxConcurrency (Aws::String &&value)
 
SendCommandRequestWithMaxConcurrency (const char *value)
 
const Aws::StringGetMaxErrors () const
 
bool MaxErrorsHasBeenSet () const
 
void SetMaxErrors (const Aws::String &value)
 
void SetMaxErrors (Aws::String &&value)
 
void SetMaxErrors (const char *value)
 
SendCommandRequestWithMaxErrors (const Aws::String &value)
 
SendCommandRequestWithMaxErrors (Aws::String &&value)
 
SendCommandRequestWithMaxErrors (const char *value)
 
const Aws::StringGetServiceRoleArn () const
 
bool ServiceRoleArnHasBeenSet () const
 
void SetServiceRoleArn (const Aws::String &value)
 
void SetServiceRoleArn (Aws::String &&value)
 
void SetServiceRoleArn (const char *value)
 
SendCommandRequestWithServiceRoleArn (const Aws::String &value)
 
SendCommandRequestWithServiceRoleArn (Aws::String &&value)
 
SendCommandRequestWithServiceRoleArn (const char *value)
 
const NotificationConfigGetNotificationConfig () const
 
bool NotificationConfigHasBeenSet () const
 
void SetNotificationConfig (const NotificationConfig &value)
 
void SetNotificationConfig (NotificationConfig &&value)
 
SendCommandRequestWithNotificationConfig (const NotificationConfig &value)
 
SendCommandRequestWithNotificationConfig (NotificationConfig &&value)
 
const CloudWatchOutputConfigGetCloudWatchOutputConfig () const
 
bool CloudWatchOutputConfigHasBeenSet () const
 
void SetCloudWatchOutputConfig (const CloudWatchOutputConfig &value)
 
void SetCloudWatchOutputConfig (CloudWatchOutputConfig &&value)
 
SendCommandRequestWithCloudWatchOutputConfig (const CloudWatchOutputConfig &value)
 
SendCommandRequestWithCloudWatchOutputConfig (CloudWatchOutputConfig &&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 27 of file SendCommandRequest.h.

Constructor & Destructor Documentation

◆ SendCommandRequest()

Aws::SSM::Model::SendCommandRequest::SendCommandRequest ( )

Member Function Documentation

◆ AddInstanceIds() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::AddInstanceIds ( Aws::String &&  value)
inline

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 161 of file SendCommandRequest.h.

◆ AddInstanceIds() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::AddInstanceIds ( const Aws::String value)
inline

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 146 of file SendCommandRequest.h.

◆ AddInstanceIds() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::AddInstanceIds ( const char *  value)
inline

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 176 of file SendCommandRequest.h.

◆ AddParameters() [1/6]

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

The required and optional parameters specified in the document being run.

Definition at line 680 of file SendCommandRequest.h.

◆ AddParameters() [2/6]

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

The required and optional parameters specified in the document being run.

Definition at line 670 of file SendCommandRequest.h.

◆ AddParameters() [3/6]

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

The required and optional parameters specified in the document being run.

Definition at line 675 of file SendCommandRequest.h.

◆ AddParameters() [4/6]

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

The required and optional parameters specified in the document being run.

Definition at line 665 of file SendCommandRequest.h.

◆ AddParameters() [5/6]

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

The required and optional parameters specified in the document being run.

Definition at line 685 of file SendCommandRequest.h.

◆ AddParameters() [6/6]

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

The required and optional parameters specified in the document being run.

Definition at line 690 of file SendCommandRequest.h.

◆ AddTargets() [1/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::AddTargets ( const Target value)
inline

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 282 of file SendCommandRequest.h.

◆ AddTargets() [2/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::AddTargets ( Target &&  value)
inline

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 297 of file SendCommandRequest.h.

◆ CloudWatchOutputConfigHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::CloudWatchOutputConfigHasBeenSet ( ) const
inline

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

Definition at line 1134 of file SendCommandRequest.h.

◆ CommentHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::CommentHasBeenSet ( ) const
inline

User-specified information about the command, such as a brief description of what the command should do.

Definition at line 593 of file SendCommandRequest.h.

◆ DocumentHashHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::DocumentHashHasBeenSet ( ) const
inline

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Definition at line 488 of file SendCommandRequest.h.

◆ DocumentHashTypeHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::DocumentHashTypeHasBeenSet ( ) const
inline

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Definition at line 535 of file SendCommandRequest.h.

◆ DocumentNameHasBeenSet()

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

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Definition at line 320 of file SendCommandRequest.h.

◆ DocumentVersionHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::DocumentVersionHasBeenSet ( ) const
inline

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

–document-version "\$DEFAULT"

–document-version "\$LATEST"

–document-version "3"

Definition at line 409 of file SendCommandRequest.h.

◆ GetCloudWatchOutputConfig()

const CloudWatchOutputConfig& Aws::SSM::Model::SendCommandRequest::GetCloudWatchOutputConfig ( ) const
inline

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

Definition at line 1127 of file SendCommandRequest.h.

◆ GetComment()

const Aws::String& Aws::SSM::Model::SendCommandRequest::GetComment ( ) const
inline

User-specified information about the command, such as a brief description of what the command should do.

Definition at line 587 of file SendCommandRequest.h.

◆ GetDocumentHash()

const Aws::String& Aws::SSM::Model::SendCommandRequest::GetDocumentHash ( ) const
inline

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Definition at line 482 of file SendCommandRequest.h.

◆ GetDocumentHashType()

const DocumentHashType& Aws::SSM::Model::SendCommandRequest::GetDocumentHashType ( ) const
inline

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Definition at line 530 of file SendCommandRequest.h.

◆ GetDocumentName()

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

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Definition at line 309 of file SendCommandRequest.h.

◆ GetDocumentVersion()

const Aws::String& Aws::SSM::Model::SendCommandRequest::GetDocumentVersion ( ) const
inline

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

–document-version "\$DEFAULT"

–document-version "\$LATEST"

–document-version "3"

Definition at line 398 of file SendCommandRequest.h.

◆ GetInstanceIds()

const Aws::Vector<Aws::String>& Aws::SSM::Model::SendCommandRequest::GetInstanceIds ( ) const
inline

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 56 of file SendCommandRequest.h.

◆ GetMaxConcurrency()

const Aws::String& Aws::SSM::Model::SendCommandRequest::GetMaxConcurrency ( ) const
inline

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 857 of file SendCommandRequest.h.

◆ GetMaxErrors()

const Aws::String& Aws::SSM::Model::SendCommandRequest::GetMaxErrors ( ) const
inline

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 947 of file SendCommandRequest.h.

◆ GetNotificationConfig()

const NotificationConfig& Aws::SSM::Model::SendCommandRequest::GetNotificationConfig ( ) const
inline

Configurations for sending notifications.

Definition at line 1094 of file SendCommandRequest.h.

◆ GetOutputS3BucketName()

const Aws::String& Aws::SSM::Model::SendCommandRequest::GetOutputS3BucketName ( ) const
inline

The name of the S3 bucket where command execution responses should be stored.

Definition at line 754 of file SendCommandRequest.h.

◆ GetOutputS3KeyPrefix()

const Aws::String& Aws::SSM::Model::SendCommandRequest::GetOutputS3KeyPrefix ( ) const
inline

The directory structure within the S3 bucket where the responses should be stored.

Definition at line 803 of file SendCommandRequest.h.

◆ GetOutputS3Region()

const Aws::String& Aws::SSM::Model::SendCommandRequest::GetOutputS3Region ( ) const
inline

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Definition at line 698 of file SendCommandRequest.h.

◆ GetParameters()

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

The required and optional parameters specified in the document being run.

Definition at line 635 of file SendCommandRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file SendCommandRequest.h.

◆ GetServiceRoleArn()

const Aws::String& Aws::SSM::Model::SendCommandRequest::GetServiceRoleArn ( ) const
inline

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Definition at line 1039 of file SendCommandRequest.h.

◆ GetTargets()

const Aws::Vector<Target>& Aws::SSM::Model::SendCommandRequest::GetTargets ( ) const
inline

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 192 of file SendCommandRequest.h.

◆ GetTimeoutSeconds()

int Aws::SSM::Model::SendCommandRequest::GetTimeoutSeconds ( ) const
inline

If this time is reached and the command hasn't already started running, it won't run.

Definition at line 562 of file SendCommandRequest.h.

◆ InstanceIdsHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::InstanceIdsHasBeenSet ( ) const
inline

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 71 of file SendCommandRequest.h.

◆ MaxConcurrencyHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::MaxConcurrencyHasBeenSet ( ) const
inline

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 868 of file SendCommandRequest.h.

◆ MaxErrorsHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::MaxErrorsHasBeenSet ( ) const
inline

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 959 of file SendCommandRequest.h.

◆ NotificationConfigHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::NotificationConfigHasBeenSet ( ) const
inline

Configurations for sending notifications.

Definition at line 1099 of file SendCommandRequest.h.

◆ OutputS3BucketNameHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::OutputS3BucketNameHasBeenSet ( ) const
inline

The name of the S3 bucket where command execution responses should be stored.

Definition at line 760 of file SendCommandRequest.h.

◆ OutputS3KeyPrefixHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::OutputS3KeyPrefixHasBeenSet ( ) const
inline

The directory structure within the S3 bucket where the responses should be stored.

Definition at line 809 of file SendCommandRequest.h.

◆ OutputS3RegionHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::OutputS3RegionHasBeenSet ( ) const
inline

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Definition at line 705 of file SendCommandRequest.h.

◆ ParametersHasBeenSet()

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

The required and optional parameters specified in the document being run.

Definition at line 640 of file SendCommandRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceRoleArnHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::ServiceRoleArnHasBeenSet ( ) const
inline

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Definition at line 1046 of file SendCommandRequest.h.

◆ SetCloudWatchOutputConfig() [1/2]

void Aws::SSM::Model::SendCommandRequest::SetCloudWatchOutputConfig ( CloudWatchOutputConfig &&  value)
inline

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

Definition at line 1148 of file SendCommandRequest.h.

◆ SetCloudWatchOutputConfig() [2/2]

void Aws::SSM::Model::SendCommandRequest::SetCloudWatchOutputConfig ( const CloudWatchOutputConfig value)
inline

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

Definition at line 1141 of file SendCommandRequest.h.

◆ SetComment() [1/3]

void Aws::SSM::Model::SendCommandRequest::SetComment ( Aws::String &&  value)
inline

User-specified information about the command, such as a brief description of what the command should do.

Definition at line 605 of file SendCommandRequest.h.

◆ SetComment() [2/3]

void Aws::SSM::Model::SendCommandRequest::SetComment ( const Aws::String value)
inline

User-specified information about the command, such as a brief description of what the command should do.

Definition at line 599 of file SendCommandRequest.h.

◆ SetComment() [3/3]

void Aws::SSM::Model::SendCommandRequest::SetComment ( const char *  value)
inline

User-specified information about the command, such as a brief description of what the command should do.

Definition at line 611 of file SendCommandRequest.h.

◆ SetDocumentHash() [1/3]

void Aws::SSM::Model::SendCommandRequest::SetDocumentHash ( Aws::String &&  value)
inline

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Definition at line 500 of file SendCommandRequest.h.

◆ SetDocumentHash() [2/3]

void Aws::SSM::Model::SendCommandRequest::SetDocumentHash ( const Aws::String value)
inline

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Definition at line 494 of file SendCommandRequest.h.

◆ SetDocumentHash() [3/3]

void Aws::SSM::Model::SendCommandRequest::SetDocumentHash ( const char *  value)
inline

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Definition at line 506 of file SendCommandRequest.h.

◆ SetDocumentHashType() [1/2]

void Aws::SSM::Model::SendCommandRequest::SetDocumentHashType ( const DocumentHashType value)
inline

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Definition at line 540 of file SendCommandRequest.h.

◆ SetDocumentHashType() [2/2]

void Aws::SSM::Model::SendCommandRequest::SetDocumentHashType ( DocumentHashType &&  value)
inline

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Definition at line 545 of file SendCommandRequest.h.

◆ SetDocumentName() [1/3]

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

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Definition at line 342 of file SendCommandRequest.h.

◆ SetDocumentName() [2/3]

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

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Definition at line 331 of file SendCommandRequest.h.

◆ SetDocumentName() [3/3]

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

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Definition at line 353 of file SendCommandRequest.h.

◆ SetDocumentVersion() [1/3]

void Aws::SSM::Model::SendCommandRequest::SetDocumentVersion ( Aws::String &&  value)
inline

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

–document-version "\$DEFAULT"

–document-version "\$LATEST"

–document-version "3"

Definition at line 431 of file SendCommandRequest.h.

◆ SetDocumentVersion() [2/3]

void Aws::SSM::Model::SendCommandRequest::SetDocumentVersion ( const Aws::String value)
inline

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

–document-version "\$DEFAULT"

–document-version "\$LATEST"

–document-version "3"

Definition at line 420 of file SendCommandRequest.h.

◆ SetDocumentVersion() [3/3]

void Aws::SSM::Model::SendCommandRequest::SetDocumentVersion ( const char *  value)
inline

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

–document-version "\$DEFAULT"

–document-version "\$LATEST"

–document-version "3"

Definition at line 442 of file SendCommandRequest.h.

◆ SetInstanceIds() [1/2]

void Aws::SSM::Model::SendCommandRequest::SetInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 101 of file SendCommandRequest.h.

◆ SetInstanceIds() [2/2]

void Aws::SSM::Model::SendCommandRequest::SetInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 86 of file SendCommandRequest.h.

◆ SetMaxConcurrency() [1/3]

void Aws::SSM::Model::SendCommandRequest::SetMaxConcurrency ( Aws::String &&  value)
inline

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 890 of file SendCommandRequest.h.

◆ SetMaxConcurrency() [2/3]

void Aws::SSM::Model::SendCommandRequest::SetMaxConcurrency ( const Aws::String value)
inline

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 879 of file SendCommandRequest.h.

◆ SetMaxConcurrency() [3/3]

void Aws::SSM::Model::SendCommandRequest::SetMaxConcurrency ( const char *  value)
inline

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 901 of file SendCommandRequest.h.

◆ SetMaxErrors() [1/3]

void Aws::SSM::Model::SendCommandRequest::SetMaxErrors ( Aws::String &&  value)
inline

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 983 of file SendCommandRequest.h.

◆ SetMaxErrors() [2/3]

void Aws::SSM::Model::SendCommandRequest::SetMaxErrors ( const Aws::String value)
inline

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 971 of file SendCommandRequest.h.

◆ SetMaxErrors() [3/3]

void Aws::SSM::Model::SendCommandRequest::SetMaxErrors ( const char *  value)
inline

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 995 of file SendCommandRequest.h.

◆ SetNotificationConfig() [1/2]

void Aws::SSM::Model::SendCommandRequest::SetNotificationConfig ( const NotificationConfig value)
inline

Configurations for sending notifications.

Definition at line 1104 of file SendCommandRequest.h.

◆ SetNotificationConfig() [2/2]

void Aws::SSM::Model::SendCommandRequest::SetNotificationConfig ( NotificationConfig &&  value)
inline

Configurations for sending notifications.

Definition at line 1109 of file SendCommandRequest.h.

◆ SetOutputS3BucketName() [1/3]

void Aws::SSM::Model::SendCommandRequest::SetOutputS3BucketName ( Aws::String &&  value)
inline

The name of the S3 bucket where command execution responses should be stored.

Definition at line 772 of file SendCommandRequest.h.

◆ SetOutputS3BucketName() [2/3]

void Aws::SSM::Model::SendCommandRequest::SetOutputS3BucketName ( const Aws::String value)
inline

The name of the S3 bucket where command execution responses should be stored.

Definition at line 766 of file SendCommandRequest.h.

◆ SetOutputS3BucketName() [3/3]

void Aws::SSM::Model::SendCommandRequest::SetOutputS3BucketName ( const char *  value)
inline

The name of the S3 bucket where command execution responses should be stored.

Definition at line 778 of file SendCommandRequest.h.

◆ SetOutputS3KeyPrefix() [1/3]

void Aws::SSM::Model::SendCommandRequest::SetOutputS3KeyPrefix ( Aws::String &&  value)
inline

The directory structure within the S3 bucket where the responses should be stored.

Definition at line 821 of file SendCommandRequest.h.

◆ SetOutputS3KeyPrefix() [2/3]

void Aws::SSM::Model::SendCommandRequest::SetOutputS3KeyPrefix ( const Aws::String value)
inline

The directory structure within the S3 bucket where the responses should be stored.

Definition at line 815 of file SendCommandRequest.h.

◆ SetOutputS3KeyPrefix() [3/3]

void Aws::SSM::Model::SendCommandRequest::SetOutputS3KeyPrefix ( const char *  value)
inline

The directory structure within the S3 bucket where the responses should be stored.

Definition at line 827 of file SendCommandRequest.h.

◆ SetOutputS3Region() [1/3]

void Aws::SSM::Model::SendCommandRequest::SetOutputS3Region ( Aws::String &&  value)
inline

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Definition at line 719 of file SendCommandRequest.h.

◆ SetOutputS3Region() [2/3]

void Aws::SSM::Model::SendCommandRequest::SetOutputS3Region ( const Aws::String value)
inline

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Definition at line 712 of file SendCommandRequest.h.

◆ SetOutputS3Region() [3/3]

void Aws::SSM::Model::SendCommandRequest::SetOutputS3Region ( const char *  value)
inline

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Definition at line 726 of file SendCommandRequest.h.

◆ SetParameters() [1/2]

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

The required and optional parameters specified in the document being run.

Definition at line 650 of file SendCommandRequest.h.

◆ SetParameters() [2/2]

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

The required and optional parameters specified in the document being run.

Definition at line 645 of file SendCommandRequest.h.

◆ SetServiceRoleArn() [1/3]

void Aws::SSM::Model::SendCommandRequest::SetServiceRoleArn ( Aws::String &&  value)
inline

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Definition at line 1060 of file SendCommandRequest.h.

◆ SetServiceRoleArn() [2/3]

void Aws::SSM::Model::SendCommandRequest::SetServiceRoleArn ( const Aws::String value)
inline

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Definition at line 1053 of file SendCommandRequest.h.

◆ SetServiceRoleArn() [3/3]

void Aws::SSM::Model::SendCommandRequest::SetServiceRoleArn ( const char *  value)
inline

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Definition at line 1067 of file SendCommandRequest.h.

◆ SetTargets() [1/2]

void Aws::SSM::Model::SendCommandRequest::SetTargets ( Aws::Vector< Target > &&  value)
inline

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 237 of file SendCommandRequest.h.

◆ SetTargets() [2/2]

void Aws::SSM::Model::SendCommandRequest::SetTargets ( const Aws::Vector< Target > &  value)
inline

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 222 of file SendCommandRequest.h.

◆ SetTimeoutSeconds()

void Aws::SSM::Model::SendCommandRequest::SetTimeoutSeconds ( int  value)
inline

If this time is reached and the command hasn't already started running, it won't run.

Definition at line 574 of file SendCommandRequest.h.

◆ TargetsHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::TargetsHasBeenSet ( ) const
inline

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 207 of file SendCommandRequest.h.

◆ TimeoutSecondsHasBeenSet()

bool Aws::SSM::Model::SendCommandRequest::TimeoutSecondsHasBeenSet ( ) const
inline

If this time is reached and the command hasn't already started running, it won't run.

Definition at line 568 of file SendCommandRequest.h.

◆ WithCloudWatchOutputConfig() [1/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithCloudWatchOutputConfig ( CloudWatchOutputConfig &&  value)
inline

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

Definition at line 1162 of file SendCommandRequest.h.

◆ WithCloudWatchOutputConfig() [2/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithCloudWatchOutputConfig ( const CloudWatchOutputConfig value)
inline

Enables Amazon Web Services Systems Manager to send Run Command output to Amazon CloudWatch Logs. Run Command is a capability of Amazon Web Services Systems Manager.

Definition at line 1155 of file SendCommandRequest.h.

◆ WithComment() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithComment ( Aws::String &&  value)
inline

User-specified information about the command, such as a brief description of what the command should do.

Definition at line 623 of file SendCommandRequest.h.

◆ WithComment() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithComment ( const Aws::String value)
inline

User-specified information about the command, such as a brief description of what the command should do.

Definition at line 617 of file SendCommandRequest.h.

◆ WithComment() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithComment ( const char *  value)
inline

User-specified information about the command, such as a brief description of what the command should do.

Definition at line 629 of file SendCommandRequest.h.

◆ WithDocumentHash() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithDocumentHash ( Aws::String &&  value)
inline

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Definition at line 518 of file SendCommandRequest.h.

◆ WithDocumentHash() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithDocumentHash ( const Aws::String value)
inline

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Definition at line 512 of file SendCommandRequest.h.

◆ WithDocumentHash() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithDocumentHash ( const char *  value)
inline

The Sha256 or Sha1 hash created by the system when the document was created.

Sha1 hashes have been deprecated.

Definition at line 524 of file SendCommandRequest.h.

◆ WithDocumentHashType() [1/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithDocumentHashType ( const DocumentHashType value)
inline

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Definition at line 550 of file SendCommandRequest.h.

◆ WithDocumentHashType() [2/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithDocumentHashType ( DocumentHashType &&  value)
inline

Sha256 or Sha1.

Sha1 hashes have been deprecated.

Definition at line 555 of file SendCommandRequest.h.

◆ WithDocumentName() [1/3]

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

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Definition at line 375 of file SendCommandRequest.h.

◆ WithDocumentName() [2/3]

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

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Definition at line 364 of file SendCommandRequest.h.

◆ WithDocumentName() [3/3]

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

The name of the Amazon Web Services Systems Manager document (SSM document) to run. This can be a public document or a custom document. To run a shared document belonging to another account, specify the document ARN. For more information about how to use shared documents, see Using shared SSM documents in the Amazon Web Services Systems Manager User Guide.

Definition at line 386 of file SendCommandRequest.h.

◆ WithDocumentVersion() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithDocumentVersion ( Aws::String &&  value)
inline

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

–document-version "\$DEFAULT"

–document-version "\$LATEST"

–document-version "3"

Definition at line 464 of file SendCommandRequest.h.

◆ WithDocumentVersion() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithDocumentVersion ( const Aws::String value)
inline

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

–document-version "\$DEFAULT"

–document-version "\$LATEST"

–document-version "3"

Definition at line 453 of file SendCommandRequest.h.

◆ WithDocumentVersion() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithDocumentVersion ( const char *  value)
inline

The SSM document version to use in the request. You can specify $DEFAULT, $LATEST, or a specific version number. If you run commands by using the Command Line Interface (Amazon Web Services CLI), then you must escape the first two options by using a backslash. If you specify a version number, then you don't need to use the backslash. For example:

–document-version "\$DEFAULT"

–document-version "\$LATEST"

–document-version "3"

Definition at line 475 of file SendCommandRequest.h.

◆ WithInstanceIds() [1/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithInstanceIds ( Aws::Vector< Aws::String > &&  value)
inline

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 131 of file SendCommandRequest.h.

◆ WithInstanceIds() [2/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithInstanceIds ( const Aws::Vector< Aws::String > &  value)
inline

The IDs of the instances where the command should run. Specifying instance IDs is most useful when you are targeting a limited number of instances, though you can specify up to 50 IDs.

To target a larger number of instances, or if you prefer not to list individual instance IDs, we recommend using the Targets option instead. Using Targets, which accepts tag key-value pairs to identify the instances to send commands to, you can a send command to tens, hundreds, or thousands of instances at once.

For more information about how to use targets, see Using targets and rate controls to send commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 116 of file SendCommandRequest.h.

◆ WithMaxConcurrency() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithMaxConcurrency ( Aws::String &&  value)
inline

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 923 of file SendCommandRequest.h.

◆ WithMaxConcurrency() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithMaxConcurrency ( const Aws::String value)
inline

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 912 of file SendCommandRequest.h.

◆ WithMaxConcurrency() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithMaxConcurrency ( const char *  value)
inline

(Optional) The maximum number of instances that are allowed to run the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using concurrency controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 934 of file SendCommandRequest.h.

◆ WithMaxErrors() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithMaxErrors ( Aws::String &&  value)
inline

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 1019 of file SendCommandRequest.h.

◆ WithMaxErrors() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithMaxErrors ( const Aws::String value)
inline

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 1007 of file SendCommandRequest.h.

◆ WithMaxErrors() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithMaxErrors ( const char *  value)
inline

The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 0. For more information about how to use MaxErrors, see Using error controls in the Amazon Web Services Systems Manager User Guide.

Definition at line 1031 of file SendCommandRequest.h.

◆ WithNotificationConfig() [1/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithNotificationConfig ( const NotificationConfig value)
inline

Configurations for sending notifications.

Definition at line 1114 of file SendCommandRequest.h.

◆ WithNotificationConfig() [2/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithNotificationConfig ( NotificationConfig &&  value)
inline

Configurations for sending notifications.

Definition at line 1119 of file SendCommandRequest.h.

◆ WithOutputS3BucketName() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithOutputS3BucketName ( Aws::String &&  value)
inline

The name of the S3 bucket where command execution responses should be stored.

Definition at line 790 of file SendCommandRequest.h.

◆ WithOutputS3BucketName() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithOutputS3BucketName ( const Aws::String value)
inline

The name of the S3 bucket where command execution responses should be stored.

Definition at line 784 of file SendCommandRequest.h.

◆ WithOutputS3BucketName() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithOutputS3BucketName ( const char *  value)
inline

The name of the S3 bucket where command execution responses should be stored.

Definition at line 796 of file SendCommandRequest.h.

◆ WithOutputS3KeyPrefix() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithOutputS3KeyPrefix ( Aws::String &&  value)
inline

The directory structure within the S3 bucket where the responses should be stored.

Definition at line 839 of file SendCommandRequest.h.

◆ WithOutputS3KeyPrefix() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithOutputS3KeyPrefix ( const Aws::String value)
inline

The directory structure within the S3 bucket where the responses should be stored.

Definition at line 833 of file SendCommandRequest.h.

◆ WithOutputS3KeyPrefix() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithOutputS3KeyPrefix ( const char *  value)
inline

The directory structure within the S3 bucket where the responses should be stored.

Definition at line 845 of file SendCommandRequest.h.

◆ WithOutputS3Region() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithOutputS3Region ( Aws::String &&  value)
inline

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Definition at line 740 of file SendCommandRequest.h.

◆ WithOutputS3Region() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithOutputS3Region ( const Aws::String value)
inline

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Definition at line 733 of file SendCommandRequest.h.

◆ WithOutputS3Region() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithOutputS3Region ( const char *  value)
inline

(Deprecated) You can no longer specify this parameter. The system ignores it. Instead, Systems Manager automatically determines the Amazon Web Services Region of the S3 bucket.

Definition at line 747 of file SendCommandRequest.h.

◆ WithParameters() [1/2]

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

The required and optional parameters specified in the document being run.

Definition at line 660 of file SendCommandRequest.h.

◆ WithParameters() [2/2]

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

The required and optional parameters specified in the document being run.

Definition at line 655 of file SendCommandRequest.h.

◆ WithServiceRoleArn() [1/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithServiceRoleArn ( Aws::String &&  value)
inline

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Definition at line 1081 of file SendCommandRequest.h.

◆ WithServiceRoleArn() [2/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithServiceRoleArn ( const Aws::String value)
inline

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Definition at line 1074 of file SendCommandRequest.h.

◆ WithServiceRoleArn() [3/3]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithServiceRoleArn ( const char *  value)
inline

The ARN of the Identity and Access Management (IAM) service role to use to publish Amazon Simple Notification Service (Amazon SNS) notifications for Run Command commands.

Definition at line 1088 of file SendCommandRequest.h.

◆ WithTargets() [1/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithTargets ( Aws::Vector< Target > &&  value)
inline

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 267 of file SendCommandRequest.h.

◆ WithTargets() [2/2]

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithTargets ( const Aws::Vector< Target > &  value)
inline

An array of search criteria that targets instances using a Key,Value combination that you specify. Specifying targets is most useful when you want to send a command to a large number of instances at once. Using Targets, which accepts tag key-value pairs to identify instances, you can send a command to tens, hundreds, or thousands of instances at once.

To send a command to a smaller number of instances, you can use the InstanceIds option instead.

For more information about how to use targets, see Sending commands to a fleet in the Amazon Web Services Systems Manager User Guide.

Definition at line 252 of file SendCommandRequest.h.

◆ WithTimeoutSeconds()

SendCommandRequest& Aws::SSM::Model::SendCommandRequest::WithTimeoutSeconds ( int  value)
inline

If this time is reached and the command hasn't already started running, it won't run.

Definition at line 580 of file SendCommandRequest.h.


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