Package | Description |
---|---|
com.amazonaws.services.simplesystemsmanagement.model |
Modifier and Type | Method and Description |
---|---|
Command |
Command.addParametersEntry(String key,
List<String> value)
Add a single Parameters entry
|
Command |
Command.clearParametersEntries()
Removes all the entries added into Parameters.
|
Command |
Command.clone() |
Command |
SendCommandResult.getCommand()
The request as it was received by Systems Manager.
|
Command |
Command.withAlarmConfiguration(AlarmConfiguration alarmConfiguration)
The details for the CloudWatch alarm applied to your command.
|
Command |
Command.withCloudWatchOutputConfig(CloudWatchOutputConfig cloudWatchOutputConfig)
Amazon CloudWatch Logs information where you want Amazon Web Services Systems Manager to send the command output.
|
Command |
Command.withCommandId(String commandId)
A unique identifier for this command.
|
Command |
Command.withComment(String comment)
User-specified information about the command, such as a brief description of what the command should do.
|
Command |
Command.withCompletedCount(Integer completedCount)
The number of targets for which the command invocation reached a terminal state.
|
Command |
Command.withDeliveryTimedOutCount(Integer deliveryTimedOutCount)
The number of targets for which the status is Delivery Timed Out.
|
Command |
Command.withDocumentName(String documentName)
The name of the document requested for execution.
|
Command |
Command.withDocumentVersion(String documentVersion)
The Systems Manager document (SSM document) version.
|
Command |
Command.withErrorCount(Integer errorCount)
The number of targets for which the status is Failed or Execution Timed Out.
|
Command |
Command.withExpiresAfter(Date expiresAfter)
If a command expires, it changes status to
DeliveryTimedOut for all invocations that have the status
InProgress , Pending , or Delayed . |
Command |
Command.withInstanceIds(Collection<String> instanceIds)
The managed node IDs against which this command was requested.
|
Command |
Command.withInstanceIds(String... instanceIds)
The managed node IDs against which this command was requested.
|
Command |
Command.withMaxConcurrency(String maxConcurrency)
The maximum number of managed nodes that are allowed to run the command at the same time.
|
Command |
Command.withMaxErrors(String maxErrors)
The maximum number of errors allowed before the system stops sending the command to additional targets.
|
Command |
Command.withNotificationConfig(NotificationConfig notificationConfig)
Configurations for sending notifications about command status changes.
|
Command |
Command.withOutputS3BucketName(String outputS3BucketName)
The S3 bucket where the responses to the command executions should be stored.
|
Command |
Command.withOutputS3KeyPrefix(String outputS3KeyPrefix)
The S3 directory path inside the bucket where the responses to the command executions should be stored.
|
Command |
Command.withOutputS3Region(String outputS3Region)
(Deprecated) You can no longer specify this parameter.
|
Command |
Command.withParameters(Map<String,List<String>> parameters)
The parameter values to be inserted in the document when running the command.
|
Command |
Command.withRequestedDateTime(Date requestedDateTime)
The date and time the command was requested.
|
Command |
Command.withServiceRole(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.
|
Command |
Command.withStatus(CommandStatus status)
The status of the command.
|
Command |
Command.withStatus(String status)
The status of the command.
|
Command |
Command.withStatusDetails(String statusDetails)
A detailed status of the command execution.
|
Command |
Command.withTargetCount(Integer targetCount)
The number of targets for the command.
|
Command |
Command.withTargets(Collection<Target> targets)
An array of search criteria that targets managed nodes using a Key,Value combination that you specify.
|
Command |
Command.withTargets(Target... targets)
An array of search criteria that targets managed nodes using a Key,Value combination that you specify.
|
Command |
Command.withTimeoutSeconds(Integer timeoutSeconds)
The
TimeoutSeconds value specified for a command. |
Command |
Command.withTriggeredAlarms(AlarmStateInformation... triggeredAlarms)
The CloudWatch alarm that was invoked by the command.
|
Command |
Command.withTriggeredAlarms(Collection<AlarmStateInformation> triggeredAlarms)
The CloudWatch alarm that was invoked by the command.
|
Modifier and Type | Method and Description |
---|---|
List<Command> |
ListCommandsResult.getCommands()
(Optional) The list of commands requested by the user.
|
Modifier and Type | Method and Description |
---|---|
void |
SendCommandResult.setCommand(Command command)
The request as it was received by Systems Manager.
|
SendCommandResult |
SendCommandResult.withCommand(Command command)
The request as it was received by Systems Manager.
|
ListCommandsResult |
ListCommandsResult.withCommands(Command... commands)
(Optional) The list of commands requested by the user.
|
Modifier and Type | Method and Description |
---|---|
void |
ListCommandsResult.setCommands(Collection<Command> commands)
(Optional) The list of commands requested by the user.
|
ListCommandsResult |
ListCommandsResult.withCommands(Collection<Command> commands)
(Optional) The list of commands requested by the user.
|
Copyright © 2023. All rights reserved.