StartAutomationExecutionRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ssm.model.SsmRequest
    - - software.amazon.awssdk.services.ssm.model.StartAutomationExecutionRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class StartAutomationExecutionRequest
extends SsmRequest
implements ToCopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StartAutomationExecutionRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`StartAutomationExecutionRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StartAutomationExecutionRequest.Builder`	`builder()`
`String`	`clientToken()` User-provided idempotency token.
`String`	`documentName()` The name of the Automation document to use for this execution.
`String`	`documentVersion()` The version of the Automation document to use for this execution.
`boolean`	`equals(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`String`	`maxConcurrency()` The maximum number of targets allowed to run this task in parallel.
`String`	`maxErrors()` The number of errors that are allowed before the system stops running the automation on additional targets.
`ExecutionMode`	`mode()` The execution mode of the automation.
`String`	`modeAsString()` The execution mode of the automation.
`Map<String,List<String>>`	`parameters()` A key-value map of execution parameters, which match the declared parameters in the Automation document.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartAutomationExecutionRequest.Builder>`	`serializableBuilderClass()`
`List<TargetLocation>`	`targetLocations()` A location is a combination of AWS Regions and/or AWS accounts where you want to execute the Automation.
`List<Map<String,List<String>>>`	`targetMaps()` A key-value mapping of document parameters to target resources.
`String`	`targetParameterName()` The name of the parameter used as the target resource for the rate-controlled execution.
`List<Target>`	`targets()` A key-value mapping to target resources.
`StartAutomationExecutionRequest.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - documentName
```
public String documentName()
```
    The name of the Automation document to use for this execution.
    
    Returns:
    
    The name of the Automation document to use for this execution.
  - documentVersion
```
public String documentVersion()
```
    The version of the Automation document to use for this execution.
    
    Returns:
    
    The version of the Automation document to use for this execution.
  - parameters
```
public Map<String,List<String>> parameters()
```
    A key-value map of execution parameters, which match the declared parameters in the Automation document.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A key-value map of execution parameters, which match the declared parameters in the Automation document.
  - clientToken
```
public String clientToken()
```
    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.
  - mode
```
public ExecutionMode mode()
```
    The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return ExecutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
    
    See Also:
    
    ExecutionMode
  - modeAsString
```
public String modeAsString()
```
    The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
    
    If the service returns an enum value that is not available in the current SDK version, mode will return ExecutionMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from modeAsString().
    
    Returns:
    
    The execution mode of the automation. Valid modes include the following: Auto and Interactive. The default mode is Auto.
    
    See Also:
    
    ExecutionMode
  - targetParameterName
```
public String targetParameterName()
```
    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.
  - targets
```
public List<Target> targets()
```
    A key-value mapping to target resources. Required if you specify TargetParameterName.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A key-value mapping to target resources. Required if you specify TargetParameterName.
  - targetMaps
```
public List<Map<String,List<String>>> targetMaps()
```
    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A key-value mapping of document parameters to target resources. Both Targets and TargetMaps cannot be specified together.
  - maxConcurrency
```
public 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.
    
    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.
  - maxErrors
```
public 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.
    
    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.
  - targetLocations
```
public List<TargetLocation> targetLocations()
```
    A location is a combination of AWS Regions and/or AWS accounts where you want to execute the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Concurrently Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    A location is a combination of AWS Regions and/or AWS accounts where you want to execute the Automation. Use this action to start an Automation in multiple Regions and multiple accounts. For more information, see Concurrently Executing Automations in Multiple AWS Regions and Accounts in the AWS Systems Manager User Guide.
  - toBuilder
```
public StartAutomationExecutionRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartAutomationExecutionRequest.Builder,StartAutomationExecutionRequest>
    
    Specified by:
    
    toBuilder in class SsmRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static StartAutomationExecutionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartAutomationExecutionRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class StartAutomationExecutionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

documentName

documentVersion

parameters

clientToken

mode

modeAsString

targetParameterName

targets

targetMaps

maxConcurrency

maxErrors

targetLocations

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields