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

#include <StartAutomationExecutionRequest.h>

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

Public Member Functions

 StartAutomationExecutionRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetDocumentName () const
 
bool DocumentNameHasBeenSet () const
 
void SetDocumentName (const Aws::String &value)
 
void SetDocumentName (Aws::String &&value)
 
void SetDocumentName (const char *value)
 
StartAutomationExecutionRequestWithDocumentName (const Aws::String &value)
 
StartAutomationExecutionRequestWithDocumentName (Aws::String &&value)
 
StartAutomationExecutionRequestWithDocumentName (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)
 
StartAutomationExecutionRequestWithDocumentVersion (const Aws::String &value)
 
StartAutomationExecutionRequestWithDocumentVersion (Aws::String &&value)
 
StartAutomationExecutionRequestWithDocumentVersion (const char *value)
 
const Aws::Map< Aws::String, Aws::Vector< Aws::String > > & GetParameters () const
 
bool ParametersHasBeenSet () const
 
void SetParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
void SetParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
StartAutomationExecutionRequestWithParameters (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
StartAutomationExecutionRequestWithParameters (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
StartAutomationExecutionRequestAddParameters (const Aws::String &key, const Aws::Vector< Aws::String > &value)
 
StartAutomationExecutionRequestAddParameters (Aws::String &&key, const Aws::Vector< Aws::String > &value)
 
StartAutomationExecutionRequestAddParameters (const Aws::String &key, Aws::Vector< Aws::String > &&value)
 
StartAutomationExecutionRequestAddParameters (Aws::String &&key, Aws::Vector< Aws::String > &&value)
 
StartAutomationExecutionRequestAddParameters (const char *key, Aws::Vector< Aws::String > &&value)
 
StartAutomationExecutionRequestAddParameters (const char *key, const Aws::Vector< Aws::String > &value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
StartAutomationExecutionRequestWithClientToken (const Aws::String &value)
 
StartAutomationExecutionRequestWithClientToken (Aws::String &&value)
 
StartAutomationExecutionRequestWithClientToken (const char *value)
 
const ExecutionModeGetMode () const
 
bool ModeHasBeenSet () const
 
void SetMode (const ExecutionMode &value)
 
void SetMode (ExecutionMode &&value)
 
StartAutomationExecutionRequestWithMode (const ExecutionMode &value)
 
StartAutomationExecutionRequestWithMode (ExecutionMode &&value)
 
const Aws::StringGetTargetParameterName () const
 
bool TargetParameterNameHasBeenSet () const
 
void SetTargetParameterName (const Aws::String &value)
 
void SetTargetParameterName (Aws::String &&value)
 
void SetTargetParameterName (const char *value)
 
StartAutomationExecutionRequestWithTargetParameterName (const Aws::String &value)
 
StartAutomationExecutionRequestWithTargetParameterName (Aws::String &&value)
 
StartAutomationExecutionRequestWithTargetParameterName (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)
 
StartAutomationExecutionRequestWithTargets (const Aws::Vector< Target > &value)
 
StartAutomationExecutionRequestWithTargets (Aws::Vector< Target > &&value)
 
StartAutomationExecutionRequestAddTargets (const Target &value)
 
StartAutomationExecutionRequestAddTargets (Target &&value)
 
const Aws::Vector< Aws::Map< Aws::String, Aws::Vector< Aws::String > > > & GetTargetMaps () const
 
bool TargetMapsHasBeenSet () const
 
void SetTargetMaps (const Aws::Vector< Aws::Map< Aws::String, Aws::Vector< Aws::String >>> &value)
 
void SetTargetMaps (Aws::Vector< Aws::Map< Aws::String, Aws::Vector< Aws::String >>> &&value)
 
StartAutomationExecutionRequestWithTargetMaps (const Aws::Vector< Aws::Map< Aws::String, Aws::Vector< Aws::String >>> &value)
 
StartAutomationExecutionRequestWithTargetMaps (Aws::Vector< Aws::Map< Aws::String, Aws::Vector< Aws::String >>> &&value)
 
StartAutomationExecutionRequestAddTargetMaps (const Aws::Map< Aws::String, Aws::Vector< Aws::String >> &value)
 
StartAutomationExecutionRequestAddTargetMaps (Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&value)
 
const Aws::StringGetMaxConcurrency () const
 
bool MaxConcurrencyHasBeenSet () const
 
void SetMaxConcurrency (const Aws::String &value)
 
void SetMaxConcurrency (Aws::String &&value)
 
void SetMaxConcurrency (const char *value)
 
StartAutomationExecutionRequestWithMaxConcurrency (const Aws::String &value)
 
StartAutomationExecutionRequestWithMaxConcurrency (Aws::String &&value)
 
StartAutomationExecutionRequestWithMaxConcurrency (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)
 
StartAutomationExecutionRequestWithMaxErrors (const Aws::String &value)
 
StartAutomationExecutionRequestWithMaxErrors (Aws::String &&value)
 
StartAutomationExecutionRequestWithMaxErrors (const char *value)
 
const Aws::Vector< TargetLocation > & GetTargetLocations () const
 
bool TargetLocationsHasBeenSet () const
 
void SetTargetLocations (const Aws::Vector< TargetLocation > &value)
 
void SetTargetLocations (Aws::Vector< TargetLocation > &&value)
 
StartAutomationExecutionRequestWithTargetLocations (const Aws::Vector< TargetLocation > &value)
 
StartAutomationExecutionRequestWithTargetLocations (Aws::Vector< TargetLocation > &&value)
 
StartAutomationExecutionRequestAddTargetLocations (const TargetLocation &value)
 
StartAutomationExecutionRequestAddTargetLocations (TargetLocation &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
StartAutomationExecutionRequestWithTags (const Aws::Vector< Tag > &value)
 
StartAutomationExecutionRequestWithTags (Aws::Vector< Tag > &&value)
 
StartAutomationExecutionRequestAddTags (const Tag &value)
 
StartAutomationExecutionRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::SSM::SSMRequest
virtual ~SSMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 27 of file StartAutomationExecutionRequest.h.

Constructor & Destructor Documentation

◆ StartAutomationExecutionRequest()

Aws::SSM::Model::StartAutomationExecutionRequest::StartAutomationExecutionRequest ( )

Member Function Documentation

◆ AddParameters() [1/6]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 223 of file StartAutomationExecutionRequest.h.

◆ AddParameters() [2/6]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 211 of file StartAutomationExecutionRequest.h.

◆ AddParameters() [3/6]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 217 of file StartAutomationExecutionRequest.h.

◆ AddParameters() [4/6]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 205 of file StartAutomationExecutionRequest.h.

◆ AddParameters() [5/6]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 229 of file StartAutomationExecutionRequest.h.

◆ AddParameters() [6/6]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 235 of file StartAutomationExecutionRequest.h.

◆ AddTags() [1/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::AddTags ( const Tag value)
inline

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • Key=environment,Value=test

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.

Definition at line 828 of file StartAutomationExecutionRequest.h.

◆ AddTags() [2/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::AddTags ( Tag &&  value)
inline

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • Key=environment,Value=test

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.

Definition at line 840 of file StartAutomationExecutionRequest.h.

◆ AddTargetLocations() [1/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::AddTargetLocations ( const TargetLocation value)
inline

A location is a combination of Regions and/or accounts where you want to run the automation. Use this operation to start an automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.

Definition at line 733 of file StartAutomationExecutionRequest.h.

◆ AddTargetLocations() [2/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::AddTargetLocations ( TargetLocation &&  value)
inline

A location is a combination of Regions and/or accounts where you want to run the automation. Use this operation to start an automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.

Definition at line 743 of file StartAutomationExecutionRequest.h.

◆ AddTargetMaps() [1/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::AddTargetMaps ( Aws::Map< Aws::String, Aws::Vector< Aws::String >> &&  value)
inline

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Definition at line 468 of file StartAutomationExecutionRequest.h.

◆ AddTargetMaps() [2/2]

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

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Definition at line 462 of file StartAutomationExecutionRequest.h.

◆ AddTargets() [1/2]

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

A key-value mapping to target resources. Required if you specify TargetParameterName.

Definition at line 413 of file StartAutomationExecutionRequest.h.

◆ AddTargets() [2/2]

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

A key-value mapping to target resources. Required if you specify TargetParameterName.

Definition at line 419 of file StartAutomationExecutionRequest.h.

◆ ClientTokenHasBeenSet()

bool Aws::SSM::Model::StartAutomationExecutionRequest::ClientTokenHasBeenSet ( ) const
inline

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Definition at line 248 of file StartAutomationExecutionRequest.h.

◆ DocumentNameHasBeenSet()

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

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

Definition at line 61 of file StartAutomationExecutionRequest.h.

◆ DocumentVersionHasBeenSet()

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

The version of the Automation runbook to use for this execution.

Definition at line 132 of file StartAutomationExecutionRequest.h.

◆ GetClientToken()

const Aws::String& Aws::SSM::Model::StartAutomationExecutionRequest::GetClientToken ( ) const
inline

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Definition at line 242 of file StartAutomationExecutionRequest.h.

◆ GetDocumentName()

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

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

Definition at line 51 of file StartAutomationExecutionRequest.h.

◆ GetDocumentVersion()

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

The version of the Automation runbook to use for this execution.

Definition at line 127 of file StartAutomationExecutionRequest.h.

◆ GetMaxConcurrency()

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

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

Definition at line 476 of file StartAutomationExecutionRequest.h.

◆ GetMaxErrors()

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

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Definition at line 543 of file StartAutomationExecutionRequest.h.

◆ GetMode()

const ExecutionMode& Aws::SSM::Model::StartAutomationExecutionRequest::GetMode ( ) const
inline

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

Definition at line 291 of file StartAutomationExecutionRequest.h.

◆ GetParameters()

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 169 of file StartAutomationExecutionRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 36 of file StartAutomationExecutionRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::SSM::Model::StartAutomationExecutionRequest::GetTags ( ) const
inline

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • Key=environment,Value=test

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.

Definition at line 756 of file StartAutomationExecutionRequest.h.

◆ GetTargetLocations()

const Aws::Vector<TargetLocation>& Aws::SSM::Model::StartAutomationExecutionRequest::GetTargetLocations ( ) const
inline

A location is a combination of Regions and/or accounts where you want to run the automation. Use this operation to start an automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.

Definition at line 673 of file StartAutomationExecutionRequest.h.

◆ GetTargetMaps()

const Aws::Vector<Aws::Map<Aws::String, Aws::Vector<Aws::String> > >& Aws::SSM::Model::StartAutomationExecutionRequest::GetTargetMaps ( ) const
inline

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Definition at line 426 of file StartAutomationExecutionRequest.h.

◆ GetTargetParameterName()

const Aws::String& Aws::SSM::Model::StartAutomationExecutionRequest::GetTargetParameterName ( ) const
inline

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Definition at line 328 of file StartAutomationExecutionRequest.h.

◆ GetTargets()

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

A key-value mapping to target resources. Required if you specify TargetParameterName.

Definition at line 377 of file StartAutomationExecutionRequest.h.

◆ MaxConcurrencyHasBeenSet()

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

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

Definition at line 483 of file StartAutomationExecutionRequest.h.

◆ MaxErrorsHasBeenSet()

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

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Definition at line 560 of file StartAutomationExecutionRequest.h.

◆ ModeHasBeenSet()

bool Aws::SSM::Model::StartAutomationExecutionRequest::ModeHasBeenSet ( ) const
inline

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

Definition at line 297 of file StartAutomationExecutionRequest.h.

◆ ParametersHasBeenSet()

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 175 of file StartAutomationExecutionRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetClientToken ( Aws::String &&  value)
inline

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Definition at line 260 of file StartAutomationExecutionRequest.h.

◆ SetClientToken() [2/3]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetClientToken ( const Aws::String value)
inline

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Definition at line 254 of file StartAutomationExecutionRequest.h.

◆ SetClientToken() [3/3]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetClientToken ( const char *  value)
inline

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Definition at line 266 of file StartAutomationExecutionRequest.h.

◆ SetDocumentName() [1/3]

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

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

Definition at line 81 of file StartAutomationExecutionRequest.h.

◆ SetDocumentName() [2/3]

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

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

Definition at line 71 of file StartAutomationExecutionRequest.h.

◆ SetDocumentName() [3/3]

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

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

Definition at line 91 of file StartAutomationExecutionRequest.h.

◆ SetDocumentVersion() [1/3]

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

The version of the Automation runbook to use for this execution.

Definition at line 142 of file StartAutomationExecutionRequest.h.

◆ SetDocumentVersion() [2/3]

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

The version of the Automation runbook to use for this execution.

Definition at line 137 of file StartAutomationExecutionRequest.h.

◆ SetDocumentVersion() [3/3]

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

The version of the Automation runbook to use for this execution.

Definition at line 147 of file StartAutomationExecutionRequest.h.

◆ SetMaxConcurrency() [1/3]

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

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

Definition at line 497 of file StartAutomationExecutionRequest.h.

◆ SetMaxConcurrency() [2/3]

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

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

Definition at line 490 of file StartAutomationExecutionRequest.h.

◆ SetMaxConcurrency() [3/3]

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

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

Definition at line 504 of file StartAutomationExecutionRequest.h.

◆ SetMaxErrors() [1/3]

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

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Definition at line 594 of file StartAutomationExecutionRequest.h.

◆ SetMaxErrors() [2/3]

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

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Definition at line 577 of file StartAutomationExecutionRequest.h.

◆ SetMaxErrors() [3/3]

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

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Definition at line 611 of file StartAutomationExecutionRequest.h.

◆ SetMode() [1/2]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetMode ( const ExecutionMode value)
inline

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

Definition at line 303 of file StartAutomationExecutionRequest.h.

◆ SetMode() [2/2]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetMode ( ExecutionMode &&  value)
inline

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

Definition at line 309 of file StartAutomationExecutionRequest.h.

◆ SetParameters() [1/2]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 187 of file StartAutomationExecutionRequest.h.

◆ SetParameters() [2/2]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 181 of file StartAutomationExecutionRequest.h.

◆ SetTags() [1/2]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • Key=environment,Value=test

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.

Definition at line 792 of file StartAutomationExecutionRequest.h.

◆ SetTags() [2/2]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • Key=environment,Value=test

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.

Definition at line 780 of file StartAutomationExecutionRequest.h.

◆ SetTargetLocations() [1/2]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetTargetLocations ( Aws::Vector< TargetLocation > &&  value)
inline

A location is a combination of Regions and/or accounts where you want to run the automation. Use this operation to start an automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.

Definition at line 703 of file StartAutomationExecutionRequest.h.

◆ SetTargetLocations() [2/2]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetTargetLocations ( const Aws::Vector< TargetLocation > &  value)
inline

A location is a combination of Regions and/or accounts where you want to run the automation. Use this operation to start an automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.

Definition at line 693 of file StartAutomationExecutionRequest.h.

◆ SetTargetMaps() [1/2]

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

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Definition at line 444 of file StartAutomationExecutionRequest.h.

◆ SetTargetMaps() [2/2]

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

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Definition at line 438 of file StartAutomationExecutionRequest.h.

◆ SetTargetParameterName() [1/3]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetTargetParameterName ( Aws::String &&  value)
inline

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Definition at line 346 of file StartAutomationExecutionRequest.h.

◆ SetTargetParameterName() [2/3]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetTargetParameterName ( const Aws::String value)
inline

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Definition at line 340 of file StartAutomationExecutionRequest.h.

◆ SetTargetParameterName() [3/3]

void Aws::SSM::Model::StartAutomationExecutionRequest::SetTargetParameterName ( const char *  value)
inline

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Definition at line 352 of file StartAutomationExecutionRequest.h.

◆ SetTargets() [1/2]

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

A key-value mapping to target resources. Required if you specify TargetParameterName.

Definition at line 395 of file StartAutomationExecutionRequest.h.

◆ SetTargets() [2/2]

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

A key-value mapping to target resources. Required if you specify TargetParameterName.

Definition at line 389 of file StartAutomationExecutionRequest.h.

◆ TagsHasBeenSet()

bool Aws::SSM::Model::StartAutomationExecutionRequest::TagsHasBeenSet ( ) const
inline

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • Key=environment,Value=test

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.

Definition at line 768 of file StartAutomationExecutionRequest.h.

◆ TargetLocationsHasBeenSet()

bool Aws::SSM::Model::StartAutomationExecutionRequest::TargetLocationsHasBeenSet ( ) const
inline

A location is a combination of Regions and/or accounts where you want to run the automation. Use this operation to start an automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.

Definition at line 683 of file StartAutomationExecutionRequest.h.

◆ TargetMapsHasBeenSet()

bool Aws::SSM::Model::StartAutomationExecutionRequest::TargetMapsHasBeenSet ( ) const
inline

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Definition at line 432 of file StartAutomationExecutionRequest.h.

◆ TargetParameterNameHasBeenSet()

bool Aws::SSM::Model::StartAutomationExecutionRequest::TargetParameterNameHasBeenSet ( ) const
inline

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Definition at line 334 of file StartAutomationExecutionRequest.h.

◆ TargetsHasBeenSet()

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

A key-value mapping to target resources. Required if you specify TargetParameterName.

Definition at line 383 of file StartAutomationExecutionRequest.h.

◆ WithClientToken() [1/3]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithClientToken ( Aws::String &&  value)
inline

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Definition at line 278 of file StartAutomationExecutionRequest.h.

◆ WithClientToken() [2/3]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithClientToken ( const Aws::String value)
inline

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Definition at line 272 of file StartAutomationExecutionRequest.h.

◆ WithClientToken() [3/3]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithClientToken ( const char *  value)
inline

User-provided idempotency token. The token must be unique, is case insensitive, enforces the UUID format, and can't be reused.

Definition at line 284 of file StartAutomationExecutionRequest.h.

◆ WithDocumentName() [1/3]

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

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

Definition at line 111 of file StartAutomationExecutionRequest.h.

◆ WithDocumentName() [2/3]

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

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

Definition at line 101 of file StartAutomationExecutionRequest.h.

◆ WithDocumentName() [3/3]

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

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

Definition at line 121 of file StartAutomationExecutionRequest.h.

◆ WithDocumentVersion() [1/3]

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

The version of the Automation runbook to use for this execution.

Definition at line 157 of file StartAutomationExecutionRequest.h.

◆ WithDocumentVersion() [2/3]

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

The version of the Automation runbook to use for this execution.

Definition at line 152 of file StartAutomationExecutionRequest.h.

◆ WithDocumentVersion() [3/3]

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

The version of the Automation runbook to use for this execution.

Definition at line 162 of file StartAutomationExecutionRequest.h.

◆ WithMaxConcurrency() [1/3]

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

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

Definition at line 518 of file StartAutomationExecutionRequest.h.

◆ WithMaxConcurrency() [2/3]

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

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

Definition at line 511 of file StartAutomationExecutionRequest.h.

◆ WithMaxConcurrency() [3/3]

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

The maximum number of targets allowed to run this task in parallel. You can specify a number, such as 10, or a percentage, such as 10%. The default value is 10.

Definition at line 525 of file StartAutomationExecutionRequest.h.

◆ WithMaxErrors() [1/3]

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

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Definition at line 645 of file StartAutomationExecutionRequest.h.

◆ WithMaxErrors() [2/3]

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

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Definition at line 628 of file StartAutomationExecutionRequest.h.

◆ WithMaxErrors() [3/3]

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

The number of errors that are allowed before the system stops running the automation on additional targets. You can specify either an absolute number of errors, for example 10, or a percentage of the target set, for example 10%. If you specify 3, for example, the system stops running the automation when the fourth error is received. If you specify 0, then the system stops running the automation on additional targets after the first error result is returned. If you run an automation on 50 resources and set max-errors to 10%, then the system stops running the automation on additional targets when the sixth error is received.

Executions that are already running an automation when max-errors is reached are allowed to complete, but some of these executions may fail as well. If you need to ensure that there won't be more than max-errors failed executions, set max-concurrency to 1 so the executions proceed one at a time.

Definition at line 662 of file StartAutomationExecutionRequest.h.

◆ WithMode() [1/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithMode ( const ExecutionMode value)
inline

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

Definition at line 315 of file StartAutomationExecutionRequest.h.

◆ WithMode() [2/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithMode ( ExecutionMode &&  value)
inline

The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.

Definition at line 321 of file StartAutomationExecutionRequest.h.

◆ WithParameters() [1/2]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 199 of file StartAutomationExecutionRequest.h.

◆ WithParameters() [2/2]

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

A key-value map of execution parameters, which match the declared parameters in the Automation runbook.

Definition at line 193 of file StartAutomationExecutionRequest.h.

◆ WithTags() [1/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • Key=environment,Value=test

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.

Definition at line 816 of file StartAutomationExecutionRequest.h.

◆ WithTags() [2/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Optional metadata that you assign to a resource. You can specify a maximum of five tags for an automation. Tags enable you to categorize a resource in different ways, such as by purpose, owner, or environment. For example, you might want to tag an automation to identify an environment or operating system. In this case, you could specify the following key-value pairs:

  • Key=environment,Value=test

  • Key=OS,Value=Windows

To add tags to an existing patch baseline, use the AddTagsToResource operation.

Definition at line 804 of file StartAutomationExecutionRequest.h.

◆ WithTargetLocations() [1/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithTargetLocations ( Aws::Vector< TargetLocation > &&  value)
inline

A location is a combination of Regions and/or accounts where you want to run the automation. Use this operation to start an automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.

Definition at line 723 of file StartAutomationExecutionRequest.h.

◆ WithTargetLocations() [2/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithTargetLocations ( const Aws::Vector< TargetLocation > &  value)
inline

A location is a combination of Regions and/or accounts where you want to run the automation. Use this operation to start an automation in multiple Regions and multiple accounts. For more information, see Running Automation workflows in multiple Regions and accounts in the Amazon Web Services Systems Manager User Guide.

Definition at line 713 of file StartAutomationExecutionRequest.h.

◆ WithTargetMaps() [1/2]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithTargetMaps ( Aws::Vector< Aws::Map< Aws::String, Aws::Vector< Aws::String >>> &&  value)
inline

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Definition at line 456 of file StartAutomationExecutionRequest.h.

◆ WithTargetMaps() [2/2]

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

A key-value mapping of document parameters to target resources. Both Targets and TargetMaps can't be specified together.

Definition at line 450 of file StartAutomationExecutionRequest.h.

◆ WithTargetParameterName() [1/3]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithTargetParameterName ( Aws::String &&  value)
inline

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Definition at line 364 of file StartAutomationExecutionRequest.h.

◆ WithTargetParameterName() [2/3]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithTargetParameterName ( const Aws::String value)
inline

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Definition at line 358 of file StartAutomationExecutionRequest.h.

◆ WithTargetParameterName() [3/3]

StartAutomationExecutionRequest& Aws::SSM::Model::StartAutomationExecutionRequest::WithTargetParameterName ( const char *  value)
inline

The name of the parameter used as the target resource for the rate-controlled execution. Required if you specify targets.

Definition at line 370 of file StartAutomationExecutionRequest.h.

◆ WithTargets() [1/2]

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

A key-value mapping to target resources. Required if you specify TargetParameterName.

Definition at line 407 of file StartAutomationExecutionRequest.h.

◆ WithTargets() [2/2]

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

A key-value mapping to target resources. Required if you specify TargetParameterName.

Definition at line 401 of file StartAutomationExecutionRequest.h.


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