/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.simplesystemsmanagement.model; import java.io.Serializable; import javax.annotation.Generated; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetCommandInvocationResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable { /** *

* The parent command ID of the invocation plugin. *

*/ private String commandId; /** *

* The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud * (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for * Amazon Web Services Systems Manager. *

*/ private String instanceId; /** *

* The comment text for the command. *

*/ private String comment; /** *

* The name of the document that was run. For example, AWS-RunShellScript. *

*/ private String documentName; /** *

* The Systems Manager document (SSM document) version used in the request. *

*/ private String documentVersion; /** *

* The name of the plugin, or step name, for which details are reported. For example, * aws:RunShellScript is a plugin. *

*/ private String pluginName; /** *

* The error level response code for the plugin script. If the response code is -1, then the command * hasn't started running on the managed node, or it wasn't received by the node. *

*/ private Integer responseCode; /** *

* The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, * 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedBefore filter. *

*

* aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. *

*/ private String executionStartDateTime; /** *

* Duration since ExecutionStartDateTime. *

*/ private String executionElapsedTime; /** *

* The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, * 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedAfter filter. *

*

* aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. *

*/ private String executionEndDateTime; /** *

* The status of this invocation plugin. This status can be different than StatusDetails. *

*/ private String status; /** *

* A detailed status of the command execution for an invocation. 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: *

* */ private String statusDetails; /** *

* The first 24,000 characters written by the plugin to stdout. If the command hasn't finished running, * if ExecutionStatus is neither Succeeded nor Failed, then this string is empty. *

*/ private String standardOutputContent; /** *

* The URL for the complete text written by the plugin to stdout in Amazon Simple Storage Service * (Amazon S3). If an S3 bucket wasn't specified, then this string is empty. *

*/ private String standardOutputUrl; /** *

* The first 8,000 characters written by the plugin to stderr. If the command hasn't finished running, * then this string is empty. *

*/ private String standardErrorContent; /** *

* The URL for the complete text written by the plugin to stderr. If the command hasn't finished * running, then this string is empty. *

*/ private String standardErrorUrl; /** *

* Amazon CloudWatch Logs information where Systems Manager sent the command output. *

*/ private CloudWatchOutputConfig cloudWatchOutputConfig; /** *

* The parent command ID of the invocation plugin. *

* * @param commandId * The parent command ID of the invocation plugin. */ public void setCommandId(String commandId) { this.commandId = commandId; } /** *

* The parent command ID of the invocation plugin. *

* * @return The parent command ID of the invocation plugin. */ public String getCommandId() { return this.commandId; } /** *

* The parent command ID of the invocation plugin. *

* * @param commandId * The parent command ID of the invocation plugin. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withCommandId(String commandId) { setCommandId(commandId); return this; } /** *

* The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud * (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for * Amazon Web Services Systems Manager. *

* * @param instanceId * The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute * Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is * configured for Amazon Web Services Systems Manager. */ public void setInstanceId(String instanceId) { this.instanceId = instanceId; } /** *

* The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud * (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for * Amazon Web Services Systems Manager. *

* * @return The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic * Compute Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment * that is configured for Amazon Web Services Systems Manager. */ public String getInstanceId() { return this.instanceId; } /** *

* The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute Cloud * (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is configured for * Amazon Web Services Systems Manager. *

* * @param instanceId * The ID of the managed node targeted by the command. A managed node can be an Amazon Elastic Compute * Cloud (Amazon EC2) instance, edge device, or on-premises server or VM in your hybrid environment that is * configured for Amazon Web Services Systems Manager. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withInstanceId(String instanceId) { setInstanceId(instanceId); return this; } /** *

* The comment text for the command. *

* * @param comment * The comment text for the command. */ public void setComment(String comment) { this.comment = comment; } /** *

* The comment text for the command. *

* * @return The comment text for the command. */ public String getComment() { return this.comment; } /** *

* The comment text for the command. *

* * @param comment * The comment text for the command. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withComment(String comment) { setComment(comment); return this; } /** *

* The name of the document that was run. For example, AWS-RunShellScript. *

* * @param documentName * The name of the document that was run. For example, AWS-RunShellScript. */ public void setDocumentName(String documentName) { this.documentName = documentName; } /** *

* The name of the document that was run. For example, AWS-RunShellScript. *

* * @return The name of the document that was run. For example, AWS-RunShellScript. */ public String getDocumentName() { return this.documentName; } /** *

* The name of the document that was run. For example, AWS-RunShellScript. *

* * @param documentName * The name of the document that was run. For example, AWS-RunShellScript. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withDocumentName(String documentName) { setDocumentName(documentName); return this; } /** *

* The Systems Manager document (SSM document) version used in the request. *

* * @param documentVersion * The Systems Manager document (SSM document) version used in the request. */ public void setDocumentVersion(String documentVersion) { this.documentVersion = documentVersion; } /** *

* The Systems Manager document (SSM document) version used in the request. *

* * @return The Systems Manager document (SSM document) version used in the request. */ public String getDocumentVersion() { return this.documentVersion; } /** *

* The Systems Manager document (SSM document) version used in the request. *

* * @param documentVersion * The Systems Manager document (SSM document) version used in the request. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withDocumentVersion(String documentVersion) { setDocumentVersion(documentVersion); return this; } /** *

* The name of the plugin, or step name, for which details are reported. For example, * aws:RunShellScript is a plugin. *

* * @param pluginName * The name of the plugin, or step name, for which details are reported. For example, * aws:RunShellScript is a plugin. */ public void setPluginName(String pluginName) { this.pluginName = pluginName; } /** *

* The name of the plugin, or step name, for which details are reported. For example, * aws:RunShellScript is a plugin. *

* * @return The name of the plugin, or step name, for which details are reported. For example, * aws:RunShellScript is a plugin. */ public String getPluginName() { return this.pluginName; } /** *

* The name of the plugin, or step name, for which details are reported. For example, * aws:RunShellScript is a plugin. *

* * @param pluginName * The name of the plugin, or step name, for which details are reported. For example, * aws:RunShellScript is a plugin. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withPluginName(String pluginName) { setPluginName(pluginName); return this; } /** *

* The error level response code for the plugin script. If the response code is -1, then the command * hasn't started running on the managed node, or it wasn't received by the node. *

* * @param responseCode * The error level response code for the plugin script. If the response code is -1, then the * command hasn't started running on the managed node, or it wasn't received by the node. */ public void setResponseCode(Integer responseCode) { this.responseCode = responseCode; } /** *

* The error level response code for the plugin script. If the response code is -1, then the command * hasn't started running on the managed node, or it wasn't received by the node. *

* * @return The error level response code for the plugin script. If the response code is -1, then the * command hasn't started running on the managed node, or it wasn't received by the node. */ public Integer getResponseCode() { return this.responseCode; } /** *

* The error level response code for the plugin script. If the response code is -1, then the command * hasn't started running on the managed node, or it wasn't received by the node. *

* * @param responseCode * The error level response code for the plugin script. If the response code is -1, then the * command hasn't started running on the managed node, or it wasn't received by the node. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withResponseCode(Integer responseCode) { setResponseCode(responseCode); return this; } /** *

* The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, * 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedBefore filter. *

*

* aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. *

* * @param executionStartDateTime * The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, * June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedBefore filter.

*

* aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. */ public void setExecutionStartDateTime(String executionStartDateTime) { this.executionStartDateTime = executionStartDateTime; } /** *

* The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, * 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedBefore filter. *

*

* aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. *

* * @return The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, * June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedBefore filter.

*

* aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. */ public String getExecutionStartDateTime() { return this.executionStartDateTime; } /** *

* The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, June 7, * 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedBefore filter. *

*

* aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. *

* * @param executionStartDateTime * The date and time the plugin started running. Date and time are written in ISO 8601 format. For example, * June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedBefore filter.

*

* aws ssm list-commands --filters key=InvokedBefore,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withExecutionStartDateTime(String executionStartDateTime) { setExecutionStartDateTime(executionStartDateTime); return this; } /** *

* Duration since ExecutionStartDateTime. *

* * @param executionElapsedTime * Duration since ExecutionStartDateTime. */ public void setExecutionElapsedTime(String executionElapsedTime) { this.executionElapsedTime = executionElapsedTime; } /** *

* Duration since ExecutionStartDateTime. *

* * @return Duration since ExecutionStartDateTime. */ public String getExecutionElapsedTime() { return this.executionElapsedTime; } /** *

* Duration since ExecutionStartDateTime. *

* * @param executionElapsedTime * Duration since ExecutionStartDateTime. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withExecutionElapsedTime(String executionElapsedTime) { setExecutionElapsedTime(executionElapsedTime); return this; } /** *

* The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, * 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedAfter filter. *

*

* aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. *

* * @param executionEndDateTime * The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, * June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedAfter filter.

*

* aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. */ public void setExecutionEndDateTime(String executionEndDateTime) { this.executionEndDateTime = executionEndDateTime; } /** *

* The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, * 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedAfter filter. *

*

* aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. *

* * @return The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, * June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedAfter filter.

*

* aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. */ public String getExecutionEndDateTime() { return this.executionEndDateTime; } /** *

* The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, June 7, * 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedAfter filter. *

*

* aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. *

* * @param executionEndDateTime * The date and time the plugin finished running. Date and time are written in ISO 8601 format. For example, * June 7, 2017 is represented as 2017-06-7. The following sample Amazon Web Services CLI command uses the * InvokedAfter filter.

*

* aws ssm list-commands --filters key=InvokedAfter,value=2017-06-07T00:00:00Z *

*

* If the plugin hasn't started to run, the string is empty. * @return Returns a reference to this object so that method calls can be chained together. */ public GetCommandInvocationResult withExecutionEndDateTime(String executionEndDateTime) { setExecutionEndDateTime(executionEndDateTime); return this; } /** *

* The status of this invocation plugin. This status can be different than StatusDetails. *

* * @param status * The status of this invocation plugin. This status can be different than StatusDetails. * @see CommandInvocationStatus */ public void setStatus(String status) { this.status = status; } /** *

* The status of this invocation plugin. This status can be different than StatusDetails. *

* * @return The status of this invocation plugin. This status can be different than StatusDetails. * @see CommandInvocationStatus */ public String getStatus() { return this.status; } /** *

* The status of this invocation plugin. This status can be different than StatusDetails. *

* * @param status * The status of this invocation plugin. This status can be different than StatusDetails. * @return Returns a reference to this object so that method calls can be chained together. * @see CommandInvocationStatus */ public GetCommandInvocationResult withStatus(String status) { setStatus(status); return this; } /** *

* The status of this invocation plugin. This status can be different than StatusDetails. *

* * @param status * The status of this invocation plugin. This status can be different than StatusDetails. * @see CommandInvocationStatus */ public void setStatus(CommandInvocationStatus status) { withStatus(status); } /** *

* The status of this invocation plugin. This status can be different than StatusDetails. *

* * @param status * The status of this invocation plugin. This status can be different than StatusDetails. * @return Returns a reference to this object so that method calls can be chained together. * @see CommandInvocationStatus */ public GetCommandInvocationResult withStatus(CommandInvocationStatus status) { this.status = status.toString(); return this; } /** *

* A detailed status of the command execution for an invocation. 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: *

* * * @param statusDetails * A detailed status of the command execution for an invocation. 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:

*