CommandInvocation (AWS Java SDK :: Services :: AWS Simple Systems Management (SSM) 2.17.85 API)

java.lang.Object
- software.amazon.awssdk.services.ssm.model.CommandInvocation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<CommandInvocation.Builder,CommandInvocation>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class CommandInvocation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<CommandInvocation.Builder,CommandInvocation>
```
An invocation is copy of a command sent to a specific instance. A command can apply to one or more instances. A command invocation applies to one instance. For example, if a user runs SendCommand against three instances, then a command invocation is created for each requested instance ID. A command invocation returns status and detail information about a command you ran.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CommandInvocation.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CommandInvocation.Builder`	`builder()`
`CloudWatchOutputConfig`	`cloudWatchOutputConfig()` Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
`String`	`commandId()` The command against which this invocation was requested.
`List<CommandPlugin>`	`commandPlugins()` Plugins processed by the command.
`String`	`comment()` User-specified information about the command, such as a brief description of what the command should do.
`String`	`documentName()` The document name that was requested for execution.
`String`	`documentVersion()` The Systems Manager document (SSM document) version.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasCommandPlugins()` For responses, this returns true if the service returned a value for the CommandPlugins property.
`int`	`hashCode()`
`String`	`instanceId()` The instance ID in which this invocation was requested.
`String`	`instanceName()` The fully qualified host name of the managed instance.
`NotificationConfig`	`notificationConfig()` Configurations for sending notifications about command status changes on a per instance basis.
`Instant`	`requestedDateTime()` The time and date the request was sent to this instance.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CommandInvocation.Builder>`	`serializableBuilderClass()`
`String`	`serviceRole()` The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per instance basis.
`String`	`standardErrorUrl()` The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command.
`String`	`standardOutputUrl()` The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command.
`CommandInvocationStatus`	`status()` Whether or not the invocation succeeded, failed, or is pending.
`String`	`statusAsString()` Whether or not the invocation succeeded, failed, or is pending.
`String`	`statusDetails()` A detailed status of the command execution for each invocation (each instance targeted by the command).
`CommandInvocation.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`traceOutput()` Gets the trace output sent by the agent.

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

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

- Method Detail
  - commandId
```
public final String commandId()
```
    The command against which this invocation was requested.
    
    Returns:
    
    The command against which this invocation was requested.
  - instanceId
```
public final String instanceId()
```
    The instance ID in which this invocation was requested.
    
    Returns:
    
    The instance ID in which this invocation was requested.
  - instanceName
```
public final String instanceName()
```
    The fully qualified host name of the managed instance.
    
    Returns:
    
    The fully qualified host name of the managed instance.
  - comment
```
public final String comment()
```
    User-specified information about the command, such as a brief description of what the command should do.
    
    Returns:
    
    User-specified information about the command, such as a brief description of what the command should do.
  - documentName
```
public final String documentName()
```
    The document name that was requested for execution.
    
    Returns:
    
    The document name that was requested for execution.
  - documentVersion
```
public final String documentVersion()
```
    The Systems Manager document (SSM document) version.
    
    Returns:
    
    The Systems Manager document (SSM document) version.
  - requestedDateTime
```
public final Instant requestedDateTime()
```
    The time and date the request was sent to this instance.
    
    Returns:
    
    The time and date the request was sent to this instance.
  - status
```
public final CommandInvocationStatus status()
```
    Whether or not the invocation succeeded, failed, or is pending.
    
    If the service returns an enum value that is not available in the current SDK version, status will return CommandInvocationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    Whether or not the invocation succeeded, failed, or is pending.
    
    See Also:
    
    CommandInvocationStatus
  - statusAsString
```
public final String statusAsString()
```
    Whether or not the invocation succeeded, failed, or is pending.
    
    If the service returns an enum value that is not available in the current SDK version, status will return CommandInvocationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    Whether or not the invocation succeeded, failed, or is pending.
    
    See Also:
    
    CommandInvocationStatus
  - statusDetails
```
public final String statusDetails()
```
    A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
    - Pending: The command hasn't been sent to the instance.
    - In Progress: The command has been sent to the instance but hasn't reached a terminal state.
    - Success: The execution of the command or plugin was successfully completed. This is a terminal state.
    - Delivery Timed Out: The command wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
    - Execution Timed Out: Command execution started on the instance, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
    - Failed: The command wasn't successful on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
    - Canceled: The command was terminated before it was completed. This is a terminal state.
    - Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
    - Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
    Returns:
    A detailed status of the command execution for each invocation (each instance targeted by the command). StatusDetails includes more information than Status because it includes states resulting from error and concurrency control parameters. StatusDetails can show different results than Status. For more information about these statuses, see Understanding command statuses in the Amazon Web Services Systems Manager User Guide. StatusDetails can be one of the following values:
    
    Pending: The command hasn't been sent to the instance.
    
    In Progress: The command has been sent to the instance but hasn't reached a terminal state.
    
    Success: The execution of the command or plugin was successfully completed. This is a terminal state.
    
    Delivery Timed Out: The command wasn't delivered to the instance before the delivery timeout expired. Delivery timeouts don't count against the parent command's MaxErrors limit, but they do contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
    
    Execution Timed Out: Command execution started on the instance, but the execution wasn't complete before the execution timeout expired. Execution timeouts count against the MaxErrors limit of the parent command. This is a terminal state.
    
    Failed: The command wasn't successful on the instance. For a plugin, this indicates that the result code wasn't zero. For a command invocation, this indicates that the result code for one or more plugins wasn't zero. Invocation failures count against the MaxErrors limit of the parent command. This is a terminal state.
    
    Canceled: The command was terminated before it was completed. This is a terminal state.
    
    Undeliverable: The command can't be delivered to the instance. The instance might not exist or might not be responding. Undeliverable invocations don't count against the parent command's MaxErrors limit and don't contribute to whether the parent command status is Success or Incomplete. This is a terminal state.
    
    Terminated: The parent command exceeded its MaxErrors limit and subsequent command invocations were canceled by the system. This is a terminal state.
  - traceOutput
```
public final String traceOutput()
```
    Gets the trace output sent by the agent.
    
    Returns:
    
    Gets the trace output sent by the agent.
  - standardOutputUrl
```
public final String standardOutputUrl()
```
    The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
    
    Returns:
    
    The URL to the plugin's StdOut file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardOutputUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
  - standardErrorUrl
```
public final String standardErrorUrl()
```
    The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
    
    Returns:
    
    The URL to the plugin's StdErr file in Amazon Simple Storage Service (Amazon S3), if the S3 bucket was defined for the parent command. For an invocation, StandardErrorUrl is populated if there is just one plugin defined for the command, and the S3 bucket was defined for the command.
  - hasCommandPlugins
```
public final boolean hasCommandPlugins()
```
    For responses, this returns true if the service returned a value for the CommandPlugins property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - commandPlugins
```
public final List<CommandPlugin> commandPlugins()
```
    Plugins processed by the command.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCommandPlugins() method.
    
    Returns:
    
    Plugins processed by the command.
  - serviceRole
```
public final String serviceRole()
```
    The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per instance basis.
    
    Returns:
    
    The Identity and Access Management (IAM) service role that Run Command, a capability of Amazon Web Services Systems Manager, uses to act on your behalf when sending notifications about command status changes on a per instance basis.
  - notificationConfig
```
public final NotificationConfig notificationConfig()
```
    Configurations for sending notifications about command status changes on a per instance basis.
    
    Returns:
    
    Configurations for sending notifications about command status changes on a per instance basis.
  - cloudWatchOutputConfig
```
public final CloudWatchOutputConfig cloudWatchOutputConfig()
```
    Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
    
    Returns:
    
    Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
  - toBuilder
```
public CommandInvocation.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CommandInvocation.Builder,CommandInvocation>
  - builder
```
public static CommandInvocation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CommandInvocation.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CommandInvocation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

commandId

instanceId

instanceName

comment

documentName

documentVersion

requestedDateTime

status

statusAsString

statusDetails

traceOutput

standardOutputUrl

standardErrorUrl

hasCommandPlugins

commandPlugins

serviceRole

notificationConfig

cloudWatchOutputConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields