/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include Describes a command request.See Also:
AWS API
* Reference
A unique identifier for this command.
*/ inline const Aws::String& GetCommandId() const{ return m_commandId; } /** *A unique identifier for this command.
*/ inline bool CommandIdHasBeenSet() const { return m_commandIdHasBeenSet; } /** *A unique identifier for this command.
*/ inline void SetCommandId(const Aws::String& value) { m_commandIdHasBeenSet = true; m_commandId = value; } /** *A unique identifier for this command.
*/ inline void SetCommandId(Aws::String&& value) { m_commandIdHasBeenSet = true; m_commandId = std::move(value); } /** *A unique identifier for this command.
*/ inline void SetCommandId(const char* value) { m_commandIdHasBeenSet = true; m_commandId.assign(value); } /** *A unique identifier for this command.
*/ inline Command& WithCommandId(const Aws::String& value) { SetCommandId(value); return *this;} /** *A unique identifier for this command.
*/ inline Command& WithCommandId(Aws::String&& value) { SetCommandId(std::move(value)); return *this;} /** *A unique identifier for this command.
*/ inline Command& WithCommandId(const char* value) { SetCommandId(value); return *this;} /** *The name of the document requested for execution.
*/ inline const Aws::String& GetDocumentName() const{ return m_documentName; } /** *The name of the document requested for execution.
*/ inline bool DocumentNameHasBeenSet() const { return m_documentNameHasBeenSet; } /** *The name of the document requested for execution.
*/ inline void SetDocumentName(const Aws::String& value) { m_documentNameHasBeenSet = true; m_documentName = value; } /** *The name of the document requested for execution.
*/ inline void SetDocumentName(Aws::String&& value) { m_documentNameHasBeenSet = true; m_documentName = std::move(value); } /** *The name of the document requested for execution.
*/ inline void SetDocumentName(const char* value) { m_documentNameHasBeenSet = true; m_documentName.assign(value); } /** *The name of the document requested for execution.
*/ inline Command& WithDocumentName(const Aws::String& value) { SetDocumentName(value); return *this;} /** *The name of the document requested for execution.
*/ inline Command& WithDocumentName(Aws::String&& value) { SetDocumentName(std::move(value)); return *this;} /** *The name of the document requested for execution.
*/ inline Command& WithDocumentName(const char* value) { SetDocumentName(value); return *this;} /** *The Systems Manager document (SSM document) version.
*/ inline const Aws::String& GetDocumentVersion() const{ return m_documentVersion; } /** *The Systems Manager document (SSM document) version.
*/ inline bool DocumentVersionHasBeenSet() const { return m_documentVersionHasBeenSet; } /** *The Systems Manager document (SSM document) version.
*/ inline void SetDocumentVersion(const Aws::String& value) { m_documentVersionHasBeenSet = true; m_documentVersion = value; } /** *The Systems Manager document (SSM document) version.
*/ inline void SetDocumentVersion(Aws::String&& value) { m_documentVersionHasBeenSet = true; m_documentVersion = std::move(value); } /** *The Systems Manager document (SSM document) version.
*/ inline void SetDocumentVersion(const char* value) { m_documentVersionHasBeenSet = true; m_documentVersion.assign(value); } /** *The Systems Manager document (SSM document) version.
*/ inline Command& WithDocumentVersion(const Aws::String& value) { SetDocumentVersion(value); return *this;} /** *The Systems Manager document (SSM document) version.
*/ inline Command& WithDocumentVersion(Aws::String&& value) { SetDocumentVersion(std::move(value)); return *this;} /** *The Systems Manager document (SSM document) version.
*/ inline Command& WithDocumentVersion(const char* value) { SetDocumentVersion(value); return *this;} /** *User-specified information about the command, such as a brief description of * what the command should do.
*/ inline const Aws::String& GetComment() const{ return m_comment; } /** *User-specified information about the command, such as a brief description of * what the command should do.
*/ inline bool CommentHasBeenSet() const { return m_commentHasBeenSet; } /** *User-specified information about the command, such as a brief description of * what the command should do.
*/ inline void SetComment(const Aws::String& value) { m_commentHasBeenSet = true; m_comment = value; } /** *User-specified information about the command, such as a brief description of * what the command should do.
*/ inline void SetComment(Aws::String&& value) { m_commentHasBeenSet = true; m_comment = std::move(value); } /** *User-specified information about the command, such as a brief description of * what the command should do.
*/ inline void SetComment(const char* value) { m_commentHasBeenSet = true; m_comment.assign(value); } /** *User-specified information about the command, such as a brief description of * what the command should do.
*/ inline Command& WithComment(const Aws::String& value) { SetComment(value); return *this;} /** *User-specified information about the command, such as a brief description of * what the command should do.
*/ inline Command& WithComment(Aws::String&& value) { SetComment(std::move(value)); return *this;} /** *User-specified information about the command, such as a brief description of * what the command should do.
*/ inline Command& WithComment(const char* value) { SetComment(value); return *this;} /** *If a command expires, it changes status to DeliveryTimedOut
for
* all invocations that have the status InProgress
,
* Pending
, or Delayed
. ExpiresAfter
is
* calculated based on the total timeout for the overall command. For more
* information, see Understanding
* command timeout values in the Amazon Web Services Systems Manager User
* Guide.
If a command expires, it changes status to DeliveryTimedOut
for
* all invocations that have the status InProgress
,
* Pending
, or Delayed
. ExpiresAfter
is
* calculated based on the total timeout for the overall command. For more
* information, see Understanding
* command timeout values in the Amazon Web Services Systems Manager User
* Guide.
If a command expires, it changes status to DeliveryTimedOut
for
* all invocations that have the status InProgress
,
* Pending
, or Delayed
. ExpiresAfter
is
* calculated based on the total timeout for the overall command. For more
* information, see Understanding
* command timeout values in the Amazon Web Services Systems Manager User
* Guide.
If a command expires, it changes status to DeliveryTimedOut
for
* all invocations that have the status InProgress
,
* Pending
, or Delayed
. ExpiresAfter
is
* calculated based on the total timeout for the overall command. For more
* information, see Understanding
* command timeout values in the Amazon Web Services Systems Manager User
* Guide.
If a command expires, it changes status to DeliveryTimedOut
for
* all invocations that have the status InProgress
,
* Pending
, or Delayed
. ExpiresAfter
is
* calculated based on the total timeout for the overall command. For more
* information, see Understanding
* command timeout values in the Amazon Web Services Systems Manager User
* Guide.
If a command expires, it changes status to DeliveryTimedOut
for
* all invocations that have the status InProgress
,
* Pending
, or Delayed
. ExpiresAfter
is
* calculated based on the total timeout for the overall command. For more
* information, see Understanding
* command timeout values in the Amazon Web Services Systems Manager User
* Guide.
The parameter values to be inserted in the document when running the * command.
*/ inline const Aws::MapThe parameter values to be inserted in the document when running the * command.
*/ inline bool ParametersHasBeenSet() const { return m_parametersHasBeenSet; } /** *The parameter values to be inserted in the document when running the * command.
*/ inline void SetParameters(const Aws::MapThe parameter values to be inserted in the document when running the * command.
*/ inline void SetParameters(Aws::MapThe parameter values to be inserted in the document when running the * command.
*/ inline Command& WithParameters(const Aws::MapThe parameter values to be inserted in the document when running the * command.
*/ inline Command& WithParameters(Aws::MapThe parameter values to be inserted in the document when running the * command.
*/ inline Command& AddParameters(const Aws::String& key, const Aws::VectorThe parameter values to be inserted in the document when running the * command.
*/ inline Command& AddParameters(Aws::String&& key, const Aws::VectorThe parameter values to be inserted in the document when running the * command.
*/ inline Command& AddParameters(const Aws::String& key, Aws::VectorThe parameter values to be inserted in the document when running the * command.
*/ inline Command& AddParameters(Aws::String&& key, Aws::VectorThe parameter values to be inserted in the document when running the * command.
*/ inline Command& AddParameters(const char* key, Aws::VectorThe parameter values to be inserted in the document when running the * command.
*/ inline Command& AddParameters(const char* key, const Aws::VectorThe managed node IDs against which this command was requested.
*/ inline const Aws::VectorThe managed node IDs against which this command was requested.
*/ inline bool InstanceIdsHasBeenSet() const { return m_instanceIdsHasBeenSet; } /** *The managed node IDs against which this command was requested.
*/ inline void SetInstanceIds(const Aws::VectorThe managed node IDs against which this command was requested.
*/ inline void SetInstanceIds(Aws::VectorThe managed node IDs against which this command was requested.
*/ inline Command& WithInstanceIds(const Aws::VectorThe managed node IDs against which this command was requested.
*/ inline Command& WithInstanceIds(Aws::VectorThe managed node IDs against which this command was requested.
*/ inline Command& AddInstanceIds(const Aws::String& value) { m_instanceIdsHasBeenSet = true; m_instanceIds.push_back(value); return *this; } /** *The managed node IDs against which this command was requested.
*/ inline Command& AddInstanceIds(Aws::String&& value) { m_instanceIdsHasBeenSet = true; m_instanceIds.push_back(std::move(value)); return *this; } /** *The managed node IDs against which this command was requested.
*/ inline Command& AddInstanceIds(const char* value) { m_instanceIdsHasBeenSet = true; m_instanceIds.push_back(value); return *this; } /** *An array of search criteria that targets managed nodes using a Key,Value * combination that you specify. Targets is required if you don't provide one or * more managed node IDs in the call.
*/ inline const Aws::VectorAn array of search criteria that targets managed nodes using a Key,Value * combination that you specify. Targets is required if you don't provide one or * more managed node IDs in the call.
*/ inline bool TargetsHasBeenSet() const { return m_targetsHasBeenSet; } /** *An array of search criteria that targets managed nodes using a Key,Value * combination that you specify. Targets is required if you don't provide one or * more managed node IDs in the call.
*/ inline void SetTargets(const Aws::VectorAn array of search criteria that targets managed nodes using a Key,Value * combination that you specify. Targets is required if you don't provide one or * more managed node IDs in the call.
*/ inline void SetTargets(Aws::VectorAn array of search criteria that targets managed nodes using a Key,Value * combination that you specify. Targets is required if you don't provide one or * more managed node IDs in the call.
*/ inline Command& WithTargets(const Aws::VectorAn array of search criteria that targets managed nodes using a Key,Value * combination that you specify. Targets is required if you don't provide one or * more managed node IDs in the call.
*/ inline Command& WithTargets(Aws::VectorAn array of search criteria that targets managed nodes using a Key,Value * combination that you specify. Targets is required if you don't provide one or * more managed node IDs in the call.
*/ inline Command& AddTargets(const Target& value) { m_targetsHasBeenSet = true; m_targets.push_back(value); return *this; } /** *An array of search criteria that targets managed nodes using a Key,Value * combination that you specify. Targets is required if you don't provide one or * more managed node IDs in the call.
*/ inline Command& AddTargets(Target&& value) { m_targetsHasBeenSet = true; m_targets.push_back(std::move(value)); return *this; } /** *The date and time the command was requested.
*/ inline const Aws::Utils::DateTime& GetRequestedDateTime() const{ return m_requestedDateTime; } /** *The date and time the command was requested.
*/ inline bool RequestedDateTimeHasBeenSet() const { return m_requestedDateTimeHasBeenSet; } /** *The date and time the command was requested.
*/ inline void SetRequestedDateTime(const Aws::Utils::DateTime& value) { m_requestedDateTimeHasBeenSet = true; m_requestedDateTime = value; } /** *The date and time the command was requested.
*/ inline void SetRequestedDateTime(Aws::Utils::DateTime&& value) { m_requestedDateTimeHasBeenSet = true; m_requestedDateTime = std::move(value); } /** *The date and time the command was requested.
*/ inline Command& WithRequestedDateTime(const Aws::Utils::DateTime& value) { SetRequestedDateTime(value); return *this;} /** *The date and time the command was requested.
*/ inline Command& WithRequestedDateTime(Aws::Utils::DateTime&& value) { SetRequestedDateTime(std::move(value)); return *this;} /** *The status of the command.
*/ inline const CommandStatus& GetStatus() const{ return m_status; } /** *The status of the command.
*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *The status of the command.
*/ inline void SetStatus(const CommandStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *The status of the command.
*/ inline void SetStatus(CommandStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *The status of the command.
*/ inline Command& WithStatus(const CommandStatus& value) { SetStatus(value); return *this;} /** *The status of the command.
*/ inline Command& WithStatus(CommandStatus&& value) { SetStatus(std::move(value)); return *this;} /** *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 Amazon Web Services Systems Manager User
* Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but * hasn't reached a final state on all managed nodes.
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 managed nodes and one or more invocations doesn't * have a value of Success but not enough invocations failed for the status to be * Failed. This is a terminal state.
Cancelled: The command was * terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded * the account limit for pending invocations. The system has canceled the command * before running it on any managed node. This is a terminal state.
Delayed: The system attempted to send the command to the managed node but * wasn't successful. The system retries again.
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 Amazon Web Services Systems Manager User
* Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but * hasn't reached a final state on all managed nodes.
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 managed nodes and one or more invocations doesn't * have a value of Success but not enough invocations failed for the status to be * Failed. This is a terminal state.
Cancelled: The command was * terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded * the account limit for pending invocations. The system has canceled the command * before running it on any managed node. This is a terminal state.
Delayed: The system attempted to send the command to the managed node but * wasn't successful. The system retries again.
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 Amazon Web Services Systems Manager User
* Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but * hasn't reached a final state on all managed nodes.
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 managed nodes and one or more invocations doesn't * have a value of Success but not enough invocations failed for the status to be * Failed. This is a terminal state.
Cancelled: The command was * terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded * the account limit for pending invocations. The system has canceled the command * before running it on any managed node. This is a terminal state.
Delayed: The system attempted to send the command to the managed node but * wasn't successful. The system retries again.
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 Amazon Web Services Systems Manager User
* Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but * hasn't reached a final state on all managed nodes.
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 managed nodes and one or more invocations doesn't * have a value of Success but not enough invocations failed for the status to be * Failed. This is a terminal state.
Cancelled: The command was * terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded * the account limit for pending invocations. The system has canceled the command * before running it on any managed node. This is a terminal state.
Delayed: The system attempted to send the command to the managed node but * wasn't successful. The system retries again.
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 Amazon Web Services Systems Manager User
* Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but * hasn't reached a final state on all managed nodes.
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 managed nodes and one or more invocations doesn't * have a value of Success but not enough invocations failed for the status to be * Failed. This is a terminal state.
Cancelled: The command was * terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded * the account limit for pending invocations. The system has canceled the command * before running it on any managed node. This is a terminal state.
Delayed: The system attempted to send the command to the managed node but * wasn't successful. The system retries again.
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 Amazon Web Services Systems Manager User
* Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but * hasn't reached a final state on all managed nodes.
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 managed nodes and one or more invocations doesn't * have a value of Success but not enough invocations failed for the status to be * Failed. This is a terminal state.
Cancelled: The command was * terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded * the account limit for pending invocations. The system has canceled the command * before running it on any managed node. This is a terminal state.
Delayed: The system attempted to send the command to the managed node but * wasn't successful. The system retries again.
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 Amazon Web Services Systems Manager User
* Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but * hasn't reached a final state on all managed nodes.
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 managed nodes and one or more invocations doesn't * have a value of Success but not enough invocations failed for the status to be * Failed. This is a terminal state.
Cancelled: The command was * terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded * the account limit for pending invocations. The system has canceled the command * before running it on any managed node. This is a terminal state.
Delayed: The system attempted to send the command to the managed node but * wasn't successful. The system retries again.
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 Amazon Web Services Systems Manager User
* Guide. StatusDetails can be one of the following values:
Pending: The command hasn't been sent to any managed nodes.
In Progress: The command has been sent to at least one managed node but * hasn't reached a final state on all managed nodes.
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 managed nodes and one or more invocations doesn't * have a value of Success but not enough invocations failed for the status to be * Failed. This is a terminal state.
Cancelled: The command was * terminated before it was completed. This is a terminal state.
Rate Exceeded: The number of managed nodes targeted by the command exceeded * the account limit for pending invocations. The system has canceled the command * before running it on any managed node. This is a terminal state.
Delayed: The system attempted to send the command to the managed node but * wasn't successful. The system retries again.
(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.
*/ inline const Aws::String& GetOutputS3Region() const{ return m_outputS3Region; } /** *(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.
*/ inline bool OutputS3RegionHasBeenSet() const { return m_outputS3RegionHasBeenSet; } /** *(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.
*/ inline void SetOutputS3Region(const Aws::String& value) { m_outputS3RegionHasBeenSet = true; m_outputS3Region = value; } /** *(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.
*/ inline void SetOutputS3Region(Aws::String&& value) { m_outputS3RegionHasBeenSet = true; m_outputS3Region = std::move(value); } /** *(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.
*/ inline void SetOutputS3Region(const char* value) { m_outputS3RegionHasBeenSet = true; m_outputS3Region.assign(value); } /** *(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.
*/ inline Command& WithOutputS3Region(const Aws::String& value) { SetOutputS3Region(value); return *this;} /** *(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.
*/ inline Command& WithOutputS3Region(Aws::String&& value) { SetOutputS3Region(std::move(value)); return *this;} /** *(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.
*/ inline Command& WithOutputS3Region(const char* value) { SetOutputS3Region(value); return *this;} /** *The S3 bucket where the responses to the command executions should be stored. * This was requested when issuing the command.
*/ inline const Aws::String& GetOutputS3BucketName() const{ return m_outputS3BucketName; } /** *The S3 bucket where the responses to the command executions should be stored. * This was requested when issuing the command.
*/ inline bool OutputS3BucketNameHasBeenSet() const { return m_outputS3BucketNameHasBeenSet; } /** *The S3 bucket where the responses to the command executions should be stored. * This was requested when issuing the command.
*/ inline void SetOutputS3BucketName(const Aws::String& value) { m_outputS3BucketNameHasBeenSet = true; m_outputS3BucketName = value; } /** *The S3 bucket where the responses to the command executions should be stored. * This was requested when issuing the command.
*/ inline void SetOutputS3BucketName(Aws::String&& value) { m_outputS3BucketNameHasBeenSet = true; m_outputS3BucketName = std::move(value); } /** *The S3 bucket where the responses to the command executions should be stored. * This was requested when issuing the command.
*/ inline void SetOutputS3BucketName(const char* value) { m_outputS3BucketNameHasBeenSet = true; m_outputS3BucketName.assign(value); } /** *The S3 bucket where the responses to the command executions should be stored. * This was requested when issuing the command.
*/ inline Command& WithOutputS3BucketName(const Aws::String& value) { SetOutputS3BucketName(value); return *this;} /** *The S3 bucket where the responses to the command executions should be stored. * This was requested when issuing the command.
*/ inline Command& WithOutputS3BucketName(Aws::String&& value) { SetOutputS3BucketName(std::move(value)); return *this;} /** *The S3 bucket where the responses to the command executions should be stored. * This was requested when issuing the command.
*/ inline Command& WithOutputS3BucketName(const char* value) { SetOutputS3BucketName(value); return *this;} /** *The S3 directory path inside the bucket where the responses to the command * executions should be stored. This was requested when issuing the command.
*/ inline const Aws::String& GetOutputS3KeyPrefix() const{ return m_outputS3KeyPrefix; } /** *The S3 directory path inside the bucket where the responses to the command * executions should be stored. This was requested when issuing the command.
*/ inline bool OutputS3KeyPrefixHasBeenSet() const { return m_outputS3KeyPrefixHasBeenSet; } /** *The S3 directory path inside the bucket where the responses to the command * executions should be stored. This was requested when issuing the command.
*/ inline void SetOutputS3KeyPrefix(const Aws::String& value) { m_outputS3KeyPrefixHasBeenSet = true; m_outputS3KeyPrefix = value; } /** *The S3 directory path inside the bucket where the responses to the command * executions should be stored. This was requested when issuing the command.
*/ inline void SetOutputS3KeyPrefix(Aws::String&& value) { m_outputS3KeyPrefixHasBeenSet = true; m_outputS3KeyPrefix = std::move(value); } /** *The S3 directory path inside the bucket where the responses to the command * executions should be stored. This was requested when issuing the command.
*/ inline void SetOutputS3KeyPrefix(const char* value) { m_outputS3KeyPrefixHasBeenSet = true; m_outputS3KeyPrefix.assign(value); } /** *The S3 directory path inside the bucket where the responses to the command * executions should be stored. This was requested when issuing the command.
*/ inline Command& WithOutputS3KeyPrefix(const Aws::String& value) { SetOutputS3KeyPrefix(value); return *this;} /** *The S3 directory path inside the bucket where the responses to the command * executions should be stored. This was requested when issuing the command.
*/ inline Command& WithOutputS3KeyPrefix(Aws::String&& value) { SetOutputS3KeyPrefix(std::move(value)); return *this;} /** *The S3 directory path inside the bucket where the responses to the command * executions should be stored. This was requested when issuing the command.
*/ inline Command& WithOutputS3KeyPrefix(const char* value) { SetOutputS3KeyPrefix(value); return *this;} /** *The maximum number of managed nodes that are allowed to run the command at
* the same time. You can specify a number of managed nodes, such as 10, or a
* percentage of nodes, 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 Amazon Web Services
* Systems Manager User Guide.
The maximum number of managed nodes that are allowed to run the command at
* the same time. You can specify a number of managed nodes, such as 10, or a
* percentage of nodes, 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 Amazon Web Services
* Systems Manager User Guide.
The maximum number of managed nodes that are allowed to run the command at
* the same time. You can specify a number of managed nodes, such as 10, or a
* percentage of nodes, 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 Amazon Web Services
* Systems Manager User Guide.
The maximum number of managed nodes that are allowed to run the command at
* the same time. You can specify a number of managed nodes, such as 10, or a
* percentage of nodes, 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 Amazon Web Services
* Systems Manager User Guide.
The maximum number of managed nodes that are allowed to run the command at
* the same time. You can specify a number of managed nodes, such as 10, or a
* percentage of nodes, 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 Amazon Web Services
* Systems Manager User Guide.
The maximum number of managed nodes that are allowed to run the command at
* the same time. You can specify a number of managed nodes, such as 10, or a
* percentage of nodes, 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 Amazon Web Services
* Systems Manager User Guide.
The maximum number of managed nodes that are allowed to run the command at
* the same time. You can specify a number of managed nodes, such as 10, or a
* percentage of nodes, 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 Amazon Web Services
* Systems Manager User Guide.
The maximum number of managed nodes that are allowed to run the command at
* the same time. You can specify a number of managed nodes, such as 10, or a
* percentage of nodes, 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 Amazon Web Services
* Systems Manager User Guide.
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 Amazon Web Services
* Systems Manager User Guide.
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 Amazon Web Services
* Systems Manager User Guide.
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 Amazon Web Services
* Systems Manager User Guide.
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 Amazon Web Services
* Systems Manager User Guide.
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 Amazon Web Services
* Systems Manager User Guide.
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 Amazon Web Services
* Systems Manager User Guide.
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 Amazon Web Services
* Systems Manager User Guide.
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 Amazon Web Services
* Systems Manager User Guide.
The number of targets for the command.
*/ inline int GetTargetCount() const{ return m_targetCount; } /** *The number of targets for the command.
*/ inline bool TargetCountHasBeenSet() const { return m_targetCountHasBeenSet; } /** *The number of targets for the command.
*/ inline void SetTargetCount(int value) { m_targetCountHasBeenSet = true; m_targetCount = value; } /** *The number of targets for the command.
*/ inline Command& WithTargetCount(int value) { SetTargetCount(value); return *this;} /** *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, Cancelled, Terminated, or Undeliverable.
*/ inline int GetCompletedCount() const{ return m_completedCount; } /** *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, Cancelled, Terminated, or Undeliverable.
*/ inline bool CompletedCountHasBeenSet() const { return m_completedCountHasBeenSet; } /** *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, Cancelled, Terminated, or Undeliverable.
*/ inline void SetCompletedCount(int value) { m_completedCountHasBeenSet = true; m_completedCount = value; } /** *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, Cancelled, Terminated, or Undeliverable.
*/ inline Command& WithCompletedCount(int value) { SetCompletedCount(value); return *this;} /** *The number of targets for which the status is Failed or Execution Timed * Out.
*/ inline int GetErrorCount() const{ return m_errorCount; } /** *The number of targets for which the status is Failed or Execution Timed * Out.
*/ inline bool ErrorCountHasBeenSet() const { return m_errorCountHasBeenSet; } /** *The number of targets for which the status is Failed or Execution Timed * Out.
*/ inline void SetErrorCount(int value) { m_errorCountHasBeenSet = true; m_errorCount = value; } /** *The number of targets for which the status is Failed or Execution Timed * Out.
*/ inline Command& WithErrorCount(int value) { SetErrorCount(value); return *this;} /** *The number of targets for which the status is Delivery Timed Out.
*/ inline int GetDeliveryTimedOutCount() const{ return m_deliveryTimedOutCount; } /** *The number of targets for which the status is Delivery Timed Out.
*/ inline bool DeliveryTimedOutCountHasBeenSet() const { return m_deliveryTimedOutCountHasBeenSet; } /** *The number of targets for which the status is Delivery Timed Out.
*/ inline void SetDeliveryTimedOutCount(int value) { m_deliveryTimedOutCountHasBeenSet = true; m_deliveryTimedOutCount = value; } /** *The number of targets for which the status is Delivery Timed Out.
*/ inline Command& WithDeliveryTimedOutCount(int value) { SetDeliveryTimedOutCount(value); return *this;} /** *The Identity and Access Management (IAM) service role that Run Command, a * capability of Amazon Web Services Systems Manager, uses to act on your behalf * when sending notifications about command status changes.
*/ inline const Aws::String& GetServiceRole() const{ return m_serviceRole; } /** *The Identity and Access Management (IAM) service role that Run Command, a * capability of Amazon Web Services Systems Manager, uses to act on your behalf * when sending notifications about command status changes.
*/ inline bool ServiceRoleHasBeenSet() const { return m_serviceRoleHasBeenSet; } /** *The Identity and Access Management (IAM) service role that Run Command, a * capability of Amazon Web Services Systems Manager, uses to act on your behalf * when sending notifications about command status changes.
*/ inline void SetServiceRole(const Aws::String& value) { m_serviceRoleHasBeenSet = true; m_serviceRole = value; } /** *The Identity and Access Management (IAM) service role that Run Command, a * capability of Amazon Web Services Systems Manager, uses to act on your behalf * when sending notifications about command status changes.
*/ inline void SetServiceRole(Aws::String&& value) { m_serviceRoleHasBeenSet = true; m_serviceRole = std::move(value); } /** *The Identity and Access Management (IAM) service role that Run Command, a * capability of Amazon Web Services Systems Manager, uses to act on your behalf * when sending notifications about command status changes.
*/ inline void SetServiceRole(const char* value) { m_serviceRoleHasBeenSet = true; m_serviceRole.assign(value); } /** *The Identity and Access Management (IAM) service role that Run Command, a * capability of Amazon Web Services Systems Manager, uses to act on your behalf * when sending notifications about command status changes.
*/ inline Command& WithServiceRole(const Aws::String& value) { SetServiceRole(value); return *this;} /** *The Identity and Access Management (IAM) service role that Run Command, a * capability of Amazon Web Services Systems Manager, uses to act on your behalf * when sending notifications about command status changes.
*/ inline Command& WithServiceRole(Aws::String&& value) { SetServiceRole(std::move(value)); return *this;} /** *The Identity and Access Management (IAM) service role that Run Command, a * capability of Amazon Web Services Systems Manager, uses to act on your behalf * when sending notifications about command status changes.
*/ inline Command& WithServiceRole(const char* value) { SetServiceRole(value); return *this;} /** *Configurations for sending notifications about command status changes.
*/ inline const NotificationConfig& GetNotificationConfig() const{ return m_notificationConfig; } /** *Configurations for sending notifications about command status changes.
*/ inline bool NotificationConfigHasBeenSet() const { return m_notificationConfigHasBeenSet; } /** *Configurations for sending notifications about command status changes.
*/ inline void SetNotificationConfig(const NotificationConfig& value) { m_notificationConfigHasBeenSet = true; m_notificationConfig = value; } /** *Configurations for sending notifications about command status changes.
*/ inline void SetNotificationConfig(NotificationConfig&& value) { m_notificationConfigHasBeenSet = true; m_notificationConfig = std::move(value); } /** *Configurations for sending notifications about command status changes.
*/ inline Command& WithNotificationConfig(const NotificationConfig& value) { SetNotificationConfig(value); return *this;} /** *Configurations for sending notifications about command status changes.
*/ inline Command& WithNotificationConfig(NotificationConfig&& value) { SetNotificationConfig(std::move(value)); return *this;} /** *Amazon CloudWatch Logs information where you want Amazon Web Services Systems * Manager to send the command output.
*/ inline const CloudWatchOutputConfig& GetCloudWatchOutputConfig() const{ return m_cloudWatchOutputConfig; } /** *Amazon CloudWatch Logs information where you want Amazon Web Services Systems * Manager to send the command output.
*/ inline bool CloudWatchOutputConfigHasBeenSet() const { return m_cloudWatchOutputConfigHasBeenSet; } /** *Amazon CloudWatch Logs information where you want Amazon Web Services Systems * Manager to send the command output.
*/ inline void SetCloudWatchOutputConfig(const CloudWatchOutputConfig& value) { m_cloudWatchOutputConfigHasBeenSet = true; m_cloudWatchOutputConfig = value; } /** *Amazon CloudWatch Logs information where you want Amazon Web Services Systems * Manager to send the command output.
*/ inline void SetCloudWatchOutputConfig(CloudWatchOutputConfig&& value) { m_cloudWatchOutputConfigHasBeenSet = true; m_cloudWatchOutputConfig = std::move(value); } /** *Amazon CloudWatch Logs information where you want Amazon Web Services Systems * Manager to send the command output.
*/ inline Command& WithCloudWatchOutputConfig(const CloudWatchOutputConfig& value) { SetCloudWatchOutputConfig(value); return *this;} /** *Amazon CloudWatch Logs information where you want Amazon Web Services Systems * Manager to send the command output.
*/ inline Command& WithCloudWatchOutputConfig(CloudWatchOutputConfig&& value) { SetCloudWatchOutputConfig(std::move(value)); return *this;} /** *The TimeoutSeconds
value specified for a command.
The TimeoutSeconds
value specified for a command.
The TimeoutSeconds
value specified for a command.
The TimeoutSeconds
value specified for a command.
The details for the CloudWatch alarm applied to your command.
*/ inline const AlarmConfiguration& GetAlarmConfiguration() const{ return m_alarmConfiguration; } /** *The details for the CloudWatch alarm applied to your command.
*/ inline bool AlarmConfigurationHasBeenSet() const { return m_alarmConfigurationHasBeenSet; } /** *The details for the CloudWatch alarm applied to your command.
*/ inline void SetAlarmConfiguration(const AlarmConfiguration& value) { m_alarmConfigurationHasBeenSet = true; m_alarmConfiguration = value; } /** *The details for the CloudWatch alarm applied to your command.
*/ inline void SetAlarmConfiguration(AlarmConfiguration&& value) { m_alarmConfigurationHasBeenSet = true; m_alarmConfiguration = std::move(value); } /** *The details for the CloudWatch alarm applied to your command.
*/ inline Command& WithAlarmConfiguration(const AlarmConfiguration& value) { SetAlarmConfiguration(value); return *this;} /** *The details for the CloudWatch alarm applied to your command.
*/ inline Command& WithAlarmConfiguration(AlarmConfiguration&& value) { SetAlarmConfiguration(std::move(value)); return *this;} /** *The CloudWatch alarm that was invoked by the command.
*/ inline const Aws::VectorThe CloudWatch alarm that was invoked by the command.
*/ inline bool TriggeredAlarmsHasBeenSet() const { return m_triggeredAlarmsHasBeenSet; } /** *The CloudWatch alarm that was invoked by the command.
*/ inline void SetTriggeredAlarms(const Aws::VectorThe CloudWatch alarm that was invoked by the command.
*/ inline void SetTriggeredAlarms(Aws::VectorThe CloudWatch alarm that was invoked by the command.
*/ inline Command& WithTriggeredAlarms(const Aws::VectorThe CloudWatch alarm that was invoked by the command.
*/ inline Command& WithTriggeredAlarms(Aws::VectorThe CloudWatch alarm that was invoked by the command.
*/ inline Command& AddTriggeredAlarms(const AlarmStateInformation& value) { m_triggeredAlarmsHasBeenSet = true; m_triggeredAlarms.push_back(value); return *this; } /** *The CloudWatch alarm that was invoked by the command.
*/ inline Command& AddTriggeredAlarms(AlarmStateInformation&& value) { m_triggeredAlarmsHasBeenSet = true; m_triggeredAlarms.push_back(std::move(value)); return *this; } private: Aws::String m_commandId; bool m_commandIdHasBeenSet = false; Aws::String m_documentName; bool m_documentNameHasBeenSet = false; Aws::String m_documentVersion; bool m_documentVersionHasBeenSet = false; Aws::String m_comment; bool m_commentHasBeenSet = false; Aws::Utils::DateTime m_expiresAfter; bool m_expiresAfterHasBeenSet = false; Aws::Map