com.amazonaws.services.simplesystemsmanagement.model

Class StartAutomationExecutionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.StartAutomationExecutionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StartAutomationExecutionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
StartAutomationExecutionRequest()

Method Summary

Modifier and Type	Method and Description
StartAutomationExecutionRequest	addParametersEntry(String key, List<String> value)
StartAutomationExecutionRequest	clearParametersEntries() Removes all the entries added into Parameters.
StartAutomationExecutionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() User-provided idempotency token.
String	getDocumentName() The name of the Automation document to use for this execution.
String	getDocumentVersion() The version of the Automation document to use for this execution.
String	getMaxConcurrency() The maximum number of targets allowed to run this task in parallel.
String	getMaxErrors() The number of errors that are allowed before the system stops running the automation on additional targets.
String	getMode() The execution mode of the automation.
Map<String,List<String>>	getParameters() A key-value map of execution parameters, which match the declared parameters in the Automation document.
List<TargetLocation>	getTargetLocations() A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
List<Map<String,List<String>>>	getTargetMaps() A key-value mapping of document parameters to target resources.
String	getTargetParameterName() The name of the parameter used as the target resource for the rate-controlled execution.
List<Target>	getTargets() A key-value mapping to target resources.
int	hashCode()
void	setClientToken(String clientToken) User-provided idempotency token.
void	setDocumentName(String documentName) The name of the Automation document to use for this execution.
void	setDocumentVersion(String documentVersion) The version of the Automation document to use for this execution.
void	setMaxConcurrency(String maxConcurrency) The maximum number of targets allowed to run this task in parallel.
void	setMaxErrors(String maxErrors) The number of errors that are allowed before the system stops running the automation on additional targets.
void	setMode(String mode) The execution mode of the automation.
void	setParameters(Map<String,List<String>> parameters) A key-value map of execution parameters, which match the declared parameters in the Automation document.
void	setTargetLocations(Collection<TargetLocation> targetLocations) A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
void	setTargetMaps(Collection<Map<String,List<String>>> targetMaps) A key-value mapping of document parameters to target resources.
void	setTargetParameterName(String targetParameterName) The name of the parameter used as the target resource for the rate-controlled execution.
void	setTargets(Collection<Target> targets) A key-value mapping to target resources.
String	toString() Returns a string representation of this object.
StartAutomationExecutionRequest	withClientToken(String clientToken) User-provided idempotency token.
StartAutomationExecutionRequest	withDocumentName(String documentName) The name of the Automation document to use for this execution.
StartAutomationExecutionRequest	withDocumentVersion(String documentVersion) The version of the Automation document to use for this execution.
StartAutomationExecutionRequest	withMaxConcurrency(String maxConcurrency) The maximum number of targets allowed to run this task in parallel.
StartAutomationExecutionRequest	withMaxErrors(String maxErrors) The number of errors that are allowed before the system stops running the automation on additional targets.
StartAutomationExecutionRequest	withMode(ExecutionMode mode) The execution mode of the automation.
StartAutomationExecutionRequest	withMode(String mode) The execution mode of the automation.
StartAutomationExecutionRequest	withParameters(Map<String,List<String>> parameters) A key-value map of execution parameters, which match the declared parameters in the Automation document.
StartAutomationExecutionRequest	withTargetLocations(Collection<TargetLocation> targetLocations) A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
StartAutomationExecutionRequest	withTargetLocations(TargetLocation... targetLocations) A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation.
StartAutomationExecutionRequest	withTargetMaps(Collection<Map<String,List<String>>> targetMaps) A key-value mapping of document parameters to target resources.
StartAutomationExecutionRequest	withTargetMaps(Map<String,List<String>>... targetMaps) A key-value mapping of document parameters to target resources.
StartAutomationExecutionRequest	withTargetParameterName(String targetParameterName) The name of the parameter used as the target resource for the rate-controlled execution.
StartAutomationExecutionRequest	withTargets(Collection<Target> targets) A key-value mapping to target resources.
StartAutomationExecutionRequest	withTargets(Target... targets) A key-value mapping to target resources.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartAutomationExecutionRequest

public StartAutomationExecutionRequest()

Method Detail

setDocumentName

public void setDocumentName(String documentName)

The name of the Automation document to use for this execution.

Parameters:

documentName - The name of the Automation document to use for this execution.

getDocumentName

public String getDocumentName()

The name of the Automation document to use for this execution.

Returns:

The name of the Automation document to use for this execution.

withDocumentName

public StartAutomationExecutionRequest withDocumentName(String documentName)

The name of the Automation document to use for this execution.

Parameters:

documentName - The name of the Automation document to use for this execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDocumentVersion

public void setDocumentVersion(String documentVersion)

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

Parameters:

documentVersion - The version of the Automation document to use for this execution.

getDocumentVersion

public String getDocumentVersion()

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

Returns:

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

withDocumentVersion

public StartAutomationExecutionRequest withDocumentVersion(String documentVersion)

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

Parameters:

documentVersion - The version of the Automation document to use for this execution.

Returns:

Returns a reference to this object so that method calls can be chained together.

getParameters

public Map<String,List<String>> getParameters()

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

Returns:

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

setParameters

public void setParameters(Map<String,List<String>> parameters)

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

Parameters:

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

withParameters

public StartAutomationExecutionRequest withParameters(Map<String,List<String>> parameters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addParametersEntry

public StartAutomationExecutionRequest addParametersEntry(String key,
                                                          List<String> value)

clearParametersEntries

public StartAutomationExecutionRequest clearParametersEntries()

Removes all the entries added into Parameters.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

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

Parameters:

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

getClientToken

public String getClientToken()

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

Returns:

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

withClientToken

public StartAutomationExecutionRequest withClientToken(String clientToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMode

public void setMode(String mode)

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

Parameters:

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

See Also:

ExecutionMode

getMode

public String getMode()

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

Returns:

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

See Also:

ExecutionMode

withMode

public StartAutomationExecutionRequest withMode(String mode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExecutionMode

withMode

public StartAutomationExecutionRequest withMode(ExecutionMode mode)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ExecutionMode

setTargetParameterName

public void setTargetParameterName(String targetParameterName)

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

Parameters:

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

getTargetParameterName

public String getTargetParameterName()

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

Returns:

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

withTargetParameterName

public StartAutomationExecutionRequest withTargetParameterName(String targetParameterName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTargets

public List<Target> getTargets()

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

Returns:

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

setTargets

public void setTargets(Collection<Target> targets)

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

Parameters:

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

withTargets

public StartAutomationExecutionRequest withTargets(Target... targets)

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

NOTE: This method appends the values to the existing list (if any). Use setTargets(java.util.Collection) or withTargets(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargets

public StartAutomationExecutionRequest withTargets(Collection<Target> targets)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTargetMaps

public List<Map<String,List<String>>> getTargetMaps()

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

Returns:

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

setTargetMaps

public void setTargetMaps(Collection<Map<String,List<String>>> targetMaps)

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

Parameters:

targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.

withTargetMaps

public StartAutomationExecutionRequest withTargetMaps(Map<String,List<String>>... targetMaps)

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

NOTE: This method appends the values to the existing list (if any). Use setTargetMaps(java.util.Collection) or withTargetMaps(java.util.Collection) if you want to override the existing values.

Parameters:

targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargetMaps

public StartAutomationExecutionRequest withTargetMaps(Collection<Map<String,List<String>>> targetMaps)

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

Parameters:

targetMaps - A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxConcurrency

public void setMaxConcurrency(String maxConcurrency)

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.

Parameters:

maxConcurrency - 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.

getMaxConcurrency

public String getMaxConcurrency()

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.

Returns:

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.

withMaxConcurrency

public StartAutomationExecutionRequest withMaxConcurrency(String maxConcurrency)

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.

Parameters:

maxConcurrency - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxErrors

public void setMaxErrors(String maxErrors)

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.

Parameters:

maxErrors - 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.

getMaxErrors

public String getMaxErrors()

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.

Returns:

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.

withMaxErrors

public StartAutomationExecutionRequest withMaxErrors(String maxErrors)

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.

Parameters:

maxErrors - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTargetLocations

public List<TargetLocation> getTargetLocations()

A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

Returns:

A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

setTargetLocations

public void setTargetLocations(Collection<TargetLocation> targetLocations)

A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

Parameters:

targetLocations - A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

withTargetLocations

public StartAutomationExecutionRequest withTargetLocations(TargetLocation... targetLocations)

A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

NOTE: This method appends the values to the existing list (if any). Use setTargetLocations(java.util.Collection) or withTargetLocations(java.util.Collection) if you want to override the existing values.

Parameters:

targetLocations - A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTargetLocations

public StartAutomationExecutionRequest withTargetLocations(Collection<TargetLocation> targetLocations)

A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

Parameters:

targetLocations - A location is a combination of AWS Regions and/or AWS accounts where you want to run the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public StartAutomationExecutionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()