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

#include <Command.h>

Public Member Functions

 Command ()
 
 Command (Aws::Utils::Json::JsonView jsonValue)
 
Commandoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetCommandId () const
 
bool CommandIdHasBeenSet () const
 
void SetCommandId (const Aws::String &value)
 
void SetCommandId (Aws::String &&value)
 
void SetCommandId (const char *value)
 
CommandWithCommandId (const Aws::String &value)
 
CommandWithCommandId (Aws::String &&value)
 
CommandWithCommandId (const char *value)
 
const Aws::StringGetDocumentName () const
 
bool DocumentNameHasBeenSet () const
 
void SetDocumentName (const Aws::String &value)
 
void SetDocumentName (Aws::String &&value)
 
void SetDocumentName (const char *value)
 
CommandWithDocumentName (const Aws::String &value)
 
CommandWithDocumentName (Aws::String &&value)
 
CommandWithDocumentName (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)
 
CommandWithDocumentVersion (const Aws::String &value)
 
CommandWithDocumentVersion (Aws::String &&value)
 
CommandWithDocumentVersion (const char *value)
 
const Aws::StringGetComment () const
 
bool CommentHasBeenSet () const
 
void SetComment (const Aws::String &value)
 
void SetComment (Aws::String &&value)
 
void SetComment (const char *value)
 
CommandWithComment (const Aws::String &value)
 
CommandWithComment (Aws::String &&value)
 
CommandWithComment (const char *value)
 
const Aws::Utils::DateTimeGetExpiresAfter () const
 
bool ExpiresAfterHasBeenSet () const
 
void SetExpiresAfter (const Aws::Utils::DateTime &value)
 
void SetExpiresAfter (Aws::Utils::DateTime &&value)
 
CommandWithExpiresAfter (const Aws::Utils::DateTime &value)
 
CommandWithExpiresAfter (Aws::Utils::DateTime &&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)
 
CommandWithParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
CommandWithParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
CommandAddParameters (const Aws::String &key, const Aws::Vector< Aws::String > &value)
 
CommandAddParameters (Aws::String &&key, const Aws::Vector< Aws::String > &value)
 
CommandAddParameters (const Aws::String &key, Aws::Vector< Aws::String > &&value)
 
CommandAddParameters (Aws::String &&key, Aws::Vector< Aws::String > &&value)
 
CommandAddParameters (const char *key, Aws::Vector< Aws::String > &&value)
 
CommandAddParameters (const char *key, const Aws::Vector< Aws::String > &value)
 
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)
 
CommandWithInstanceIds (const Aws::Vector< Aws::String > &value)
 
CommandWithInstanceIds (Aws::Vector< Aws::String > &&value)
 
CommandAddInstanceIds (const Aws::String &value)
 
CommandAddInstanceIds (Aws::String &&value)
 
CommandAddInstanceIds (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)
 
CommandWithTargets (const Aws::Vector< Target > &value)
 
CommandWithTargets (Aws::Vector< Target > &&value)
 
CommandAddTargets (const Target &value)
 
CommandAddTargets (Target &&value)
 
const Aws::Utils::DateTimeGetRequestedDateTime () const
 
bool RequestedDateTimeHasBeenSet () const
 
void SetRequestedDateTime (const Aws::Utils::DateTime &value)
 
void SetRequestedDateTime (Aws::Utils::DateTime &&value)
 
CommandWithRequestedDateTime (const Aws::Utils::DateTime &value)
 
CommandWithRequestedDateTime (Aws::Utils::DateTime &&value)
 
const CommandStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const CommandStatus &value)
 
void SetStatus (CommandStatus &&value)
 
CommandWithStatus (const CommandStatus &value)
 
CommandWithStatus (CommandStatus &&value)
 
const Aws::StringGetStatusDetails () const
 
bool StatusDetailsHasBeenSet () const
 
void SetStatusDetails (const Aws::String &value)
 
void SetStatusDetails (Aws::String &&value)
 
void SetStatusDetails (const char *value)
 
CommandWithStatusDetails (const Aws::String &value)
 
CommandWithStatusDetails (Aws::String &&value)
 
CommandWithStatusDetails (const char *value)
 
const Aws::StringGetOutputS3Region () const
 
bool OutputS3RegionHasBeenSet () const
 
void SetOutputS3Region (const Aws::String &value)
 
void SetOutputS3Region (Aws::String &&value)
 
void SetOutputS3Region (const char *value)
 
CommandWithOutputS3Region (const Aws::String &value)
 
CommandWithOutputS3Region (Aws::String &&value)
 
CommandWithOutputS3Region (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)
 
CommandWithOutputS3BucketName (const Aws::String &value)
 
CommandWithOutputS3BucketName (Aws::String &&value)
 
CommandWithOutputS3BucketName (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)
 
CommandWithOutputS3KeyPrefix (const Aws::String &value)
 
CommandWithOutputS3KeyPrefix (Aws::String &&value)
 
CommandWithOutputS3KeyPrefix (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)
 
CommandWithMaxConcurrency (const Aws::String &value)
 
CommandWithMaxConcurrency (Aws::String &&value)
 
CommandWithMaxConcurrency (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)
 
CommandWithMaxErrors (const Aws::String &value)
 
CommandWithMaxErrors (Aws::String &&value)
 
CommandWithMaxErrors (const char *value)
 
int GetTargetCount () const
 
bool TargetCountHasBeenSet () const
 
void SetTargetCount (int value)
 
CommandWithTargetCount (int value)
 
int GetCompletedCount () const
 
bool CompletedCountHasBeenSet () const
 
void SetCompletedCount (int value)
 
CommandWithCompletedCount (int value)
 
int GetErrorCount () const
 
bool ErrorCountHasBeenSet () const
 
void SetErrorCount (int value)
 
CommandWithErrorCount (int value)
 
int GetDeliveryTimedOutCount () const
 
bool DeliveryTimedOutCountHasBeenSet () const
 
void SetDeliveryTimedOutCount (int value)
 
CommandWithDeliveryTimedOutCount (int value)
 
const Aws::StringGetServiceRole () const
 
bool ServiceRoleHasBeenSet () const
 
void SetServiceRole (const Aws::String &value)
 
void SetServiceRole (Aws::String &&value)
 
void SetServiceRole (const char *value)
 
CommandWithServiceRole (const Aws::String &value)
 
CommandWithServiceRole (Aws::String &&value)
 
CommandWithServiceRole (const char *value)
 
const NotificationConfigGetNotificationConfig () const
 
bool NotificationConfigHasBeenSet () const
 
void SetNotificationConfig (const NotificationConfig &value)
 
void SetNotificationConfig (NotificationConfig &&value)
 
CommandWithNotificationConfig (const NotificationConfig &value)
 
CommandWithNotificationConfig (NotificationConfig &&value)
 
const CloudWatchOutputConfigGetCloudWatchOutputConfig () const
 
bool CloudWatchOutputConfigHasBeenSet () const
 
void SetCloudWatchOutputConfig (const CloudWatchOutputConfig &value)
 
void SetCloudWatchOutputConfig (CloudWatchOutputConfig &&value)
 
CommandWithCloudWatchOutputConfig (const CloudWatchOutputConfig &value)
 
CommandWithCloudWatchOutputConfig (CloudWatchOutputConfig &&value)
 
int GetTimeoutSeconds () const
 
bool TimeoutSecondsHasBeenSet () const
 
void SetTimeoutSeconds (int value)
 
CommandWithTimeoutSeconds (int value)
 

Detailed Description

Describes a command request.

See Also:

AWS API Reference

Definition at line 38 of file Command.h.

Constructor & Destructor Documentation

◆ Command() [1/2]

Aws::SSM::Model::Command::Command ( )

◆ Command() [2/2]

Aws::SSM::Model::Command::Command ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AddInstanceIds() [1/3]

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

The instance IDs against which this command was requested.

Definition at line 368 of file Command.h.

◆ AddInstanceIds() [2/3]

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

The instance IDs against which this command was requested.

Definition at line 373 of file Command.h.

◆ AddInstanceIds() [3/3]

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

The instance IDs against which this command was requested.

Definition at line 378 of file Command.h.

◆ AddParameters() [1/6]

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

The parameter values to be inserted in the document when running the command.

Definition at line 302 of file Command.h.

◆ AddParameters() [2/6]

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

The parameter values to be inserted in the document when running the command.

Definition at line 308 of file Command.h.

◆ AddParameters() [3/6]

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

The parameter values to be inserted in the document when running the command.

Definition at line 314 of file Command.h.

◆ AddParameters() [4/6]

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

The parameter values to be inserted in the document when running the command.

Definition at line 320 of file Command.h.

◆ AddParameters() [5/6]

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

The parameter values to be inserted in the document when running the command.

Definition at line 326 of file Command.h.

◆ AddParameters() [6/6]

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

The parameter values to be inserted in the document when running the command.

Definition at line 332 of file Command.h.

◆ AddTargets() [1/2]

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

Definition at line 428 of file Command.h.

◆ AddTargets() [2/2]

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

Definition at line 435 of file Command.h.

◆ CloudWatchOutputConfigHasBeenSet()

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

CloudWatch Logs information where you want Systems Manager to send the command output.

Definition at line 1244 of file Command.h.

◆ CommandIdHasBeenSet()

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

A unique identifier for this command.

Definition at line 55 of file Command.h.

◆ CommentHasBeenSet()

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

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

Definition at line 180 of file Command.h.

◆ CompletedCountHasBeenSet()

bool Aws::SSM::Model::Command::CompletedCountHasBeenSet ( ) const
inline

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

Definition at line 1091 of file Command.h.

◆ DeliveryTimedOutCountHasBeenSet()

bool Aws::SSM::Model::Command::DeliveryTimedOutCountHasBeenSet ( ) const
inline

The number of targets for which the status is Delivery Timed Out.

Definition at line 1141 of file Command.h.

◆ DocumentNameHasBeenSet()

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

The name of the document requested for execution.

Definition at line 96 of file Command.h.

◆ DocumentVersionHasBeenSet()

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

The SSM document version.

Definition at line 137 of file Command.h.

◆ ErrorCountHasBeenSet()

bool Aws::SSM::Model::Command::ErrorCountHasBeenSet ( ) const
inline

The number of targets for which the status is Failed or Execution Timed Out.

Definition at line 1118 of file Command.h.

◆ ExpiresAfterHasBeenSet()

bool Aws::SSM::Model::Command::ExpiresAfterHasBeenSet ( ) const
inline

If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

Definition at line 231 of file Command.h.

◆ GetCloudWatchOutputConfig()

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

CloudWatch Logs information where you want Systems Manager to send the command output.

Definition at line 1238 of file Command.h.

◆ GetCommandId()

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

A unique identifier for this command.

Definition at line 50 of file Command.h.

◆ GetComment()

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

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

Definition at line 174 of file Command.h.

◆ GetCompletedCount()

int Aws::SSM::Model::Command::GetCompletedCount ( ) const
inline

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

Definition at line 1084 of file Command.h.

◆ GetDeliveryTimedOutCount()

int Aws::SSM::Model::Command::GetDeliveryTimedOutCount ( ) const
inline

The number of targets for which the status is Delivery Timed Out.

Definition at line 1136 of file Command.h.

◆ GetDocumentName()

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

The name of the document requested for execution.

Definition at line 91 of file Command.h.

◆ GetDocumentVersion()

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

The SSM document version.

Definition at line 132 of file Command.h.

◆ GetErrorCount()

int Aws::SSM::Model::Command::GetErrorCount ( ) const
inline

The number of targets for which the status is Failed or Execution Timed Out.

Definition at line 1112 of file Command.h.

◆ GetExpiresAfter()

const Aws::Utils::DateTime& Aws::SSM::Model::Command::GetExpiresAfter ( ) const
inline

If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

Definition at line 224 of file Command.h.

◆ GetInstanceIds()

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

The instance IDs against which this command was requested.

Definition at line 338 of file Command.h.

◆ GetMaxConcurrency()

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

The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 889 of file Command.h.

◆ GetMaxErrors()

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 978 of file Command.h.

◆ GetNotificationConfig()

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

Configurations for sending notifications about command status changes.

Definition at line 1206 of file Command.h.

◆ GetOutputS3BucketName()

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

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 786 of file Command.h.

◆ GetOutputS3KeyPrefix()

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

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 835 of file Command.h.

◆ GetOutputS3Region()

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

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

Definition at line 730 of file Command.h.

◆ GetParameters()

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

The parameter values to be inserted in the document when running the command.

Definition at line 266 of file Command.h.

◆ GetRequestedDateTime()

const Aws::Utils::DateTime& Aws::SSM::Model::Command::GetRequestedDateTime ( ) const
inline

The date and time the command was requested.

Definition at line 441 of file Command.h.

◆ GetServiceRole()

const Aws::String& Aws::SSM::Model::Command::GetServiceRole ( ) const
inline

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Definition at line 1158 of file Command.h.

◆ GetStatus()

const CommandStatus& Aws::SSM::Model::Command::GetStatus ( ) const
inline

The status of the command.

Definition at line 472 of file Command.h.

◆ GetStatusDetails()

const Aws::String& Aws::SSM::Model::Command::GetStatusDetails ( ) const
inline

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

  • Pending: The command has not been sent to any instances.

  • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success: The command successfully ran on all invocations. This is a terminal state.

  • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

Definition at line 526 of file Command.h.

◆ GetTargetCount()

int Aws::SSM::Model::Command::GetTargetCount ( ) const
inline

The number of targets for the command.

Definition at line 1061 of file Command.h.

◆ GetTargets()

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

Definition at line 386 of file Command.h.

◆ GetTimeoutSeconds()

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

The TimeoutSeconds value specified for a command.

Definition at line 1274 of file Command.h.

◆ InstanceIdsHasBeenSet()

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

The instance IDs against which this command was requested.

Definition at line 343 of file Command.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SSM::Model::Command::Jsonize ( ) const

◆ MaxConcurrencyHasBeenSet()

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

The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 900 of file Command.h.

◆ MaxErrorsHasBeenSet()

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 989 of file Command.h.

◆ NotificationConfigHasBeenSet()

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

Configurations for sending notifications about command status changes.

Definition at line 1211 of file Command.h.

◆ operator=()

Command& Aws::SSM::Model::Command::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutputS3BucketNameHasBeenSet()

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

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 792 of file Command.h.

◆ OutputS3KeyPrefixHasBeenSet()

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

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 841 of file Command.h.

◆ OutputS3RegionHasBeenSet()

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

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

Definition at line 737 of file Command.h.

◆ ParametersHasBeenSet()

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

The parameter values to be inserted in the document when running the command.

Definition at line 272 of file Command.h.

◆ RequestedDateTimeHasBeenSet()

bool Aws::SSM::Model::Command::RequestedDateTimeHasBeenSet ( ) const
inline

The date and time the command was requested.

Definition at line 446 of file Command.h.

◆ ServiceRoleHasBeenSet()

bool Aws::SSM::Model::Command::ServiceRoleHasBeenSet ( ) const
inline

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Definition at line 1164 of file Command.h.

◆ SetCloudWatchOutputConfig() [1/2]

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

CloudWatch Logs information where you want Systems Manager to send the command output.

Definition at line 1250 of file Command.h.

◆ SetCloudWatchOutputConfig() [2/2]

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

CloudWatch Logs information where you want Systems Manager to send the command output.

Definition at line 1256 of file Command.h.

◆ SetCommandId() [1/3]

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

A unique identifier for this command.

Definition at line 60 of file Command.h.

◆ SetCommandId() [2/3]

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

A unique identifier for this command.

Definition at line 65 of file Command.h.

◆ SetCommandId() [3/3]

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

A unique identifier for this command.

Definition at line 70 of file Command.h.

◆ SetComment() [1/3]

void Aws::SSM::Model::Command::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 186 of file Command.h.

◆ SetComment() [2/3]

void Aws::SSM::Model::Command::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 192 of file Command.h.

◆ SetComment() [3/3]

void Aws::SSM::Model::Command::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 198 of file Command.h.

◆ SetCompletedCount()

void Aws::SSM::Model::Command::SetCompletedCount ( int  value)
inline

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

Definition at line 1098 of file Command.h.

◆ SetDeliveryTimedOutCount()

void Aws::SSM::Model::Command::SetDeliveryTimedOutCount ( int  value)
inline

The number of targets for which the status is Delivery Timed Out.

Definition at line 1146 of file Command.h.

◆ SetDocumentName() [1/3]

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

The name of the document requested for execution.

Definition at line 101 of file Command.h.

◆ SetDocumentName() [2/3]

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

The name of the document requested for execution.

Definition at line 106 of file Command.h.

◆ SetDocumentName() [3/3]

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

The name of the document requested for execution.

Definition at line 111 of file Command.h.

◆ SetDocumentVersion() [1/3]

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

The SSM document version.

Definition at line 142 of file Command.h.

◆ SetDocumentVersion() [2/3]

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

The SSM document version.

Definition at line 147 of file Command.h.

◆ SetDocumentVersion() [3/3]

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

The SSM document version.

Definition at line 152 of file Command.h.

◆ SetErrorCount()

void Aws::SSM::Model::Command::SetErrorCount ( int  value)
inline

The number of targets for which the status is Failed or Execution Timed Out.

Definition at line 1124 of file Command.h.

◆ SetExpiresAfter() [1/2]

void Aws::SSM::Model::Command::SetExpiresAfter ( const Aws::Utils::DateTime value)
inline

If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

Definition at line 238 of file Command.h.

◆ SetExpiresAfter() [2/2]

void Aws::SSM::Model::Command::SetExpiresAfter ( Aws::Utils::DateTime &&  value)
inline

If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

Definition at line 245 of file Command.h.

◆ SetInstanceIds() [1/2]

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

The instance IDs against which this command was requested.

Definition at line 348 of file Command.h.

◆ SetInstanceIds() [2/2]

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

The instance IDs against which this command was requested.

Definition at line 353 of file Command.h.

◆ SetMaxConcurrency() [1/3]

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

The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 911 of file Command.h.

◆ SetMaxConcurrency() [2/3]

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

The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 922 of file Command.h.

◆ SetMaxConcurrency() [3/3]

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

The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 933 of file Command.h.

◆ SetMaxErrors() [1/3]

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 1000 of file Command.h.

◆ SetMaxErrors() [2/3]

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 1011 of file Command.h.

◆ SetMaxErrors() [3/3]

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 1022 of file Command.h.

◆ SetNotificationConfig() [1/2]

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

Configurations for sending notifications about command status changes.

Definition at line 1216 of file Command.h.

◆ SetNotificationConfig() [2/2]

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

Configurations for sending notifications about command status changes.

Definition at line 1221 of file Command.h.

◆ SetOutputS3BucketName() [1/3]

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

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 798 of file Command.h.

◆ SetOutputS3BucketName() [2/3]

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

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 804 of file Command.h.

◆ SetOutputS3BucketName() [3/3]

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

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 810 of file Command.h.

◆ SetOutputS3KeyPrefix() [1/3]

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

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 847 of file Command.h.

◆ SetOutputS3KeyPrefix() [2/3]

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

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 853 of file Command.h.

◆ SetOutputS3KeyPrefix() [3/3]

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

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 859 of file Command.h.

◆ SetOutputS3Region() [1/3]

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

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

Definition at line 744 of file Command.h.

◆ SetOutputS3Region() [2/3]

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

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

Definition at line 751 of file Command.h.

◆ SetOutputS3Region() [3/3]

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

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

Definition at line 758 of file Command.h.

◆ SetParameters() [1/2]

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

The parameter values to be inserted in the document when running the command.

Definition at line 278 of file Command.h.

◆ SetParameters() [2/2]

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

The parameter values to be inserted in the document when running the command.

Definition at line 284 of file Command.h.

◆ SetRequestedDateTime() [1/2]

void Aws::SSM::Model::Command::SetRequestedDateTime ( const Aws::Utils::DateTime value)
inline

The date and time the command was requested.

Definition at line 451 of file Command.h.

◆ SetRequestedDateTime() [2/2]

void Aws::SSM::Model::Command::SetRequestedDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the command was requested.

Definition at line 456 of file Command.h.

◆ SetServiceRole() [1/3]

void Aws::SSM::Model::Command::SetServiceRole ( const Aws::String value)
inline

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Definition at line 1170 of file Command.h.

◆ SetServiceRole() [2/3]

void Aws::SSM::Model::Command::SetServiceRole ( Aws::String &&  value)
inline

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Definition at line 1176 of file Command.h.

◆ SetServiceRole() [3/3]

void Aws::SSM::Model::Command::SetServiceRole ( const char *  value)
inline

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Definition at line 1182 of file Command.h.

◆ SetStatus() [1/2]

void Aws::SSM::Model::Command::SetStatus ( const CommandStatus value)
inline

The status of the command.

Definition at line 482 of file Command.h.

◆ SetStatus() [2/2]

void Aws::SSM::Model::Command::SetStatus ( CommandStatus &&  value)
inline

The status of the command.

Definition at line 487 of file Command.h.

◆ SetStatusDetails() [1/3]

void Aws::SSM::Model::Command::SetStatusDetails ( const Aws::String value)
inline

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

  • Pending: The command has not been sent to any instances.

  • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success: The command successfully ran on all invocations. This is a terminal state.

  • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

Definition at line 582 of file Command.h.

◆ SetStatusDetails() [2/3]

void Aws::SSM::Model::Command::SetStatusDetails ( Aws::String &&  value)
inline

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

  • Pending: The command has not been sent to any instances.

  • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success: The command successfully ran on all invocations. This is a terminal state.

  • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

Definition at line 610 of file Command.h.

◆ SetStatusDetails() [3/3]

void Aws::SSM::Model::Command::SetStatusDetails ( const char *  value)
inline

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

  • Pending: The command has not been sent to any instances.

  • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success: The command successfully ran on all invocations. This is a terminal state.

  • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

Definition at line 638 of file Command.h.

◆ SetTargetCount()

void Aws::SSM::Model::Command::SetTargetCount ( int  value)
inline

The number of targets for the command.

Definition at line 1071 of file Command.h.

◆ SetTargets() [1/2]

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

Definition at line 400 of file Command.h.

◆ SetTargets() [2/2]

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

Definition at line 407 of file Command.h.

◆ SetTimeoutSeconds()

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

The TimeoutSeconds value specified for a command.

Definition at line 1284 of file Command.h.

◆ StatusDetailsHasBeenSet()

bool Aws::SSM::Model::Command::StatusDetailsHasBeenSet ( ) const
inline

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

  • Pending: The command has not been sent to any instances.

  • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success: The command successfully ran on all invocations. This is a terminal state.

  • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

Definition at line 554 of file Command.h.

◆ StatusHasBeenSet()

bool Aws::SSM::Model::Command::StatusHasBeenSet ( ) const
inline

The status of the command.

Definition at line 477 of file Command.h.

◆ TargetCountHasBeenSet()

bool Aws::SSM::Model::Command::TargetCountHasBeenSet ( ) const
inline

The number of targets for the command.

Definition at line 1066 of file Command.h.

◆ TargetsHasBeenSet()

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

Definition at line 393 of file Command.h.

◆ TimeoutSecondsHasBeenSet()

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

The TimeoutSeconds value specified for a command.

Definition at line 1279 of file Command.h.

◆ WithCloudWatchOutputConfig() [1/2]

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

CloudWatch Logs information where you want Systems Manager to send the command output.

Definition at line 1262 of file Command.h.

◆ WithCloudWatchOutputConfig() [2/2]

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

CloudWatch Logs information where you want Systems Manager to send the command output.

Definition at line 1268 of file Command.h.

◆ WithCommandId() [1/3]

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

A unique identifier for this command.

Definition at line 75 of file Command.h.

◆ WithCommandId() [2/3]

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

A unique identifier for this command.

Definition at line 80 of file Command.h.

◆ WithCommandId() [3/3]

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

A unique identifier for this command.

Definition at line 85 of file Command.h.

◆ WithComment() [1/3]

Command& Aws::SSM::Model::Command::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 204 of file Command.h.

◆ WithComment() [2/3]

Command& Aws::SSM::Model::Command::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 210 of file Command.h.

◆ WithComment() [3/3]

Command& Aws::SSM::Model::Command::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 216 of file Command.h.

◆ WithCompletedCount()

Command& Aws::SSM::Model::Command::WithCompletedCount ( int  value)
inline

The number of targets for which the command invocation reached a terminal state. Terminal states include the following: Success, Failed, Execution Timed Out, Delivery Timed Out, Canceled, Terminated, or Undeliverable.

Definition at line 1105 of file Command.h.

◆ WithDeliveryTimedOutCount()

Command& Aws::SSM::Model::Command::WithDeliveryTimedOutCount ( int  value)
inline

The number of targets for which the status is Delivery Timed Out.

Definition at line 1151 of file Command.h.

◆ WithDocumentName() [1/3]

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

The name of the document requested for execution.

Definition at line 116 of file Command.h.

◆ WithDocumentName() [2/3]

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

The name of the document requested for execution.

Definition at line 121 of file Command.h.

◆ WithDocumentName() [3/3]

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

The name of the document requested for execution.

Definition at line 126 of file Command.h.

◆ WithDocumentVersion() [1/3]

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

The SSM document version.

Definition at line 157 of file Command.h.

◆ WithDocumentVersion() [2/3]

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

The SSM document version.

Definition at line 162 of file Command.h.

◆ WithDocumentVersion() [3/3]

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

The SSM document version.

Definition at line 167 of file Command.h.

◆ WithErrorCount()

Command& Aws::SSM::Model::Command::WithErrorCount ( int  value)
inline

The number of targets for which the status is Failed or Execution Timed Out.

Definition at line 1130 of file Command.h.

◆ WithExpiresAfter() [1/2]

Command& Aws::SSM::Model::Command::WithExpiresAfter ( const Aws::Utils::DateTime value)
inline

If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

Definition at line 252 of file Command.h.

◆ WithExpiresAfter() [2/2]

Command& Aws::SSM::Model::Command::WithExpiresAfter ( Aws::Utils::DateTime &&  value)
inline

If this time is reached and the command has not already started running, it will not run. Calculated based on the ExpiresAfter user input provided as part of the SendCommand API.

Definition at line 259 of file Command.h.

◆ WithInstanceIds() [1/2]

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

The instance IDs against which this command was requested.

Definition at line 358 of file Command.h.

◆ WithInstanceIds() [2/2]

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

The instance IDs against which this command was requested.

Definition at line 363 of file Command.h.

◆ WithMaxConcurrency() [1/3]

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

The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 944 of file Command.h.

◆ WithMaxConcurrency() [2/3]

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

The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 955 of file Command.h.

◆ WithMaxConcurrency() [3/3]

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

The maximum number of instances that are allowed to run the command at the same time. You can specify a number of instances, such as 10, or a percentage of instances, such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 966 of file Command.h.

◆ WithMaxErrors() [1/3]

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 1033 of file Command.h.

◆ WithMaxErrors() [2/3]

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 1044 of file Command.h.

◆ WithMaxErrors() [3/3]

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

The maximum number of errors allowed before the system stops sending the command to additional targets. You can specify a number of errors, such as 10, or a percentage or errors, such as 10%. The default value is 0. For more information about how to use MaxErrors, see Running commands using Systems Manager Run Command in the AWS Systems Manager User Guide.

Definition at line 1055 of file Command.h.

◆ WithNotificationConfig() [1/2]

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

Configurations for sending notifications about command status changes.

Definition at line 1226 of file Command.h.

◆ WithNotificationConfig() [2/2]

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

Configurations for sending notifications about command status changes.

Definition at line 1231 of file Command.h.

◆ WithOutputS3BucketName() [1/3]

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

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 816 of file Command.h.

◆ WithOutputS3BucketName() [2/3]

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

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 822 of file Command.h.

◆ WithOutputS3BucketName() [3/3]

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

The S3 bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 828 of file Command.h.

◆ WithOutputS3KeyPrefix() [1/3]

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

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 865 of file Command.h.

◆ WithOutputS3KeyPrefix() [2/3]

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

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 871 of file Command.h.

◆ WithOutputS3KeyPrefix() [3/3]

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

The S3 directory path inside the bucket where the responses to the command executions should be stored. This was requested when issuing the command.

Definition at line 877 of file Command.h.

◆ WithOutputS3Region() [1/3]

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

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

Definition at line 765 of file Command.h.

◆ WithOutputS3Region() [2/3]

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

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

Definition at line 772 of file Command.h.

◆ WithOutputS3Region() [3/3]

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

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

Definition at line 779 of file Command.h.

◆ WithParameters() [1/2]

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

The parameter values to be inserted in the document when running the command.

Definition at line 290 of file Command.h.

◆ WithParameters() [2/2]

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

The parameter values to be inserted in the document when running the command.

Definition at line 296 of file Command.h.

◆ WithRequestedDateTime() [1/2]

Command& Aws::SSM::Model::Command::WithRequestedDateTime ( const Aws::Utils::DateTime value)
inline

The date and time the command was requested.

Definition at line 461 of file Command.h.

◆ WithRequestedDateTime() [2/2]

Command& Aws::SSM::Model::Command::WithRequestedDateTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the command was requested.

Definition at line 466 of file Command.h.

◆ WithServiceRole() [1/3]

Command& Aws::SSM::Model::Command::WithServiceRole ( const Aws::String value)
inline

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Definition at line 1188 of file Command.h.

◆ WithServiceRole() [2/3]

Command& Aws::SSM::Model::Command::WithServiceRole ( Aws::String &&  value)
inline

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Definition at line 1194 of file Command.h.

◆ WithServiceRole() [3/3]

Command& Aws::SSM::Model::Command::WithServiceRole ( const char *  value)
inline

The IAM service role that Run Command uses to act on your behalf when sending notifications about command status changes.

Definition at line 1200 of file Command.h.

◆ WithStatus() [1/2]

Command& Aws::SSM::Model::Command::WithStatus ( const CommandStatus value)
inline

The status of the command.

Definition at line 492 of file Command.h.

◆ WithStatus() [2/2]

Command& Aws::SSM::Model::Command::WithStatus ( CommandStatus &&  value)
inline

The status of the command.

Definition at line 497 of file Command.h.

◆ WithStatusDetails() [1/3]

Command& Aws::SSM::Model::Command::WithStatusDetails ( const Aws::String value)
inline

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

  • Pending: The command has not been sent to any instances.

  • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success: The command successfully ran on all invocations. This is a terminal state.

  • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

Definition at line 666 of file Command.h.

◆ WithStatusDetails() [2/3]

Command& Aws::SSM::Model::Command::WithStatusDetails ( Aws::String &&  value)
inline

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

  • Pending: The command has not been sent to any instances.

  • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success: The command successfully ran on all invocations. This is a terminal state.

  • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

Definition at line 694 of file Command.h.

◆ WithStatusDetails() [3/3]

Command& Aws::SSM::Model::Command::WithStatusDetails ( const char *  value)
inline

A detailed status of the command execution. StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the AWS Systems Manager User Guide. StatusDetails can be one of the following values:

  • Pending: The command has not been sent to any instances.

  • In Progress: The command has been sent to at least one instance but has not reached a final state on all instances.

  • Success: The command successfully ran on all invocations. This is a terminal state.

  • Delivery Timed Out: The value of MaxErrors or more command invocations shows a status of Delivery Timed Out. This is a terminal state.

  • Execution Timed Out: The value of MaxErrors or more command invocations shows a status of Execution Timed Out. This is a terminal state.

  • Failed: The value of MaxErrors or more command invocations shows a status of Failed. This is a terminal state.

  • Incomplete: The command was attempted on all instances and one or more invocations does not have a value of Success but not enough invocations failed for the status to be Failed. This is a terminal state.

  • Canceled: The command was terminated before it was completed. This is a terminal state.

  • Rate Exceeded: The number of instances targeted by the command exceeded the account limit for pending invocations. The system has canceled the command before running it on any instance. This is a terminal state.

Definition at line 722 of file Command.h.

◆ WithTargetCount()

Command& Aws::SSM::Model::Command::WithTargetCount ( int  value)
inline

The number of targets for the command.

Definition at line 1076 of file Command.h.

◆ WithTargets() [1/2]

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

Definition at line 414 of file Command.h.

◆ WithTargets() [2/2]

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

An array of search criteria that targets instances using a Key,Value combination that you specify. Targets is required if you don't provide one or more instance IDs in the call.

Definition at line 421 of file Command.h.

◆ WithTimeoutSeconds()

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

The TimeoutSeconds value specified for a command.

Definition at line 1289 of file Command.h.


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