/* * 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; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class UpdateOpsItemRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the * first time understand the issue. *
*/ private String description; /** ** Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object. *
** Operational data is custom data that provides useful reference details about the OpsItem. For example, you can * specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter * operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size * of 20 KB. *
*
* Operational data keys can't begin with the following: amazon
, aws
,
* amzn
, ssm
, /amazon
, /aws
, /amzn
,
* /ssm
.
*
* You can choose to make the data searchable by other users in the account or you can restrict search access. * Searchable data means that all users with access to the OpsItem Overview page (as provided by the * DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't * searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API * operation). *
*
* Use the /aws/resources
key in OperationalData to specify a related resource in the request. Use the
* /aws/automations
key in OperationalData to associate an Automation runbook with the OpsItem. To view
* Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
*
* Keys that you want to remove from the OperationalData map. *
*/ private com.amazonaws.internal.SdkInternalList* The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or * changed. *
*/ private com.amazonaws.internal.SdkInternalList* The importance of this OpsItem in relation to other OpsItems in the system. *
*/ private Integer priority; /** ** One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can * include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource. *
*/ private com.amazonaws.internal.SdkInternalList
* The OpsItem status. Status can be Open
, In Progress
, or Resolved
. For more
* information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
*
* The ID of the OpsItem. *
*/ private String opsItemId; /** ** A short heading that describes the nature of the OpsItem and the impacted resource. *
*/ private String title; /** ** Specify a new category for an OpsItem. *
*/ private String category; /** ** Specify a new severity for an OpsItem. *
*/ private String severity; /** *
* The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest
* .
*
* The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest
.
*
* The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem
* type /aws/changerequest
.
*
* The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem
* type /aws/changerequest
.
*
* The OpsItem Amazon Resource Name (ARN). *
*/ private String opsItemArn; /** ** Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the * first time understand the issue. *
* * @param description * Update the information about the OpsItem. Provide enough information so that users reading this OpsItem * for the first time understand the issue. */ public void setDescription(String description) { this.description = description; } /** ** Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the * first time understand the issue. *
* * @return Update the information about the OpsItem. Provide enough information so that users reading this OpsItem * for the first time understand the issue. */ public String getDescription() { return this.description; } /** ** Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the * first time understand the issue. *
* * @param description * Update the information about the OpsItem. Provide enough information so that users reading this OpsItem * for the first time understand the issue. * @return Returns a reference to this object so that method calls can be chained together. */ public UpdateOpsItemRequest withDescription(String description) { setDescription(description); return this; } /** ** Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object. *
** Operational data is custom data that provides useful reference details about the OpsItem. For example, you can * specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter * operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size * of 20 KB. *
*
* Operational data keys can't begin with the following: amazon
, aws
,
* amzn
, ssm
, /amazon
, /aws
, /amzn
,
* /ssm
.
*
* You can choose to make the data searchable by other users in the account or you can restrict search access. * Searchable data means that all users with access to the OpsItem Overview page (as provided by the * DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't * searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API * operation). *
*
* Use the /aws/resources
key in OperationalData to specify a related resource in the request. Use the
* /aws/automations
key in OperationalData to associate an Automation runbook with the OpsItem. To view
* Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
*
* Operational data is custom data that provides useful reference details about the OpsItem. For example, * you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You * enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has * a maximum size of 20 KB. *
*
* Operational data keys can't begin with the following: amazon
, aws
,
* amzn
, ssm
, /amazon
, /aws
, /amzn
,
* /ssm
.
*
* You can choose to make the data searchable by other users in the account or you can restrict search * access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the * DescribeOpsItems API operation) can view and search on the specified data. Operational data that * isn't searchable is only viewable by users who have access to the OpsItem (as provided by the * GetOpsItem API operation). *
*
* Use the
* Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
*
* Operational data is custom data that provides useful reference details about the OpsItem. For example, you can
* specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter
* operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size
* of 20 KB.
*
* Operational data keys can't begin with the following:
* You can choose to make the data searchable by other users in the account or you can restrict search access.
* Searchable data means that all users with access to the OpsItem Overview page (as provided by the
* DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't
* searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API
* operation).
*
* Use the /aws/resources
key in OperationalData to specify a related resource in the request.
* Use the /aws/automations
key in OperationalData to associate an Automation runbook with the
* OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
*/
public java.util.Mapamazon
, aws
,
* amzn
, ssm
, /amazon
, /aws
, /amzn
,
* /ssm
.
* /aws/resources
key in OperationalData to specify a related resource in the request. Use the
* /aws/automations
key in OperationalData to associate an Automation runbook with the OpsItem. To view
* Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
*
* Operational data is custom data that provides useful reference details about the OpsItem. For example, you * can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You * enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a * maximum size of 20 KB. *
*
* Operational data keys can't begin with the following: amazon
, aws
,
* amzn
, ssm
, /amazon
, /aws
, /amzn
,
* /ssm
.
*
* You can choose to make the data searchable by other users in the account or you can restrict search * access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the * DescribeOpsItems API operation) can view and search on the specified data. Operational data that * isn't searchable is only viewable by users who have access to the OpsItem (as provided by the * GetOpsItem API operation). *
*
* Use the
* Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
*
* Operational data is custom data that provides useful reference details about the OpsItem. For example, you can
* specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter
* operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size
* of 20 KB.
*
* Operational data keys can't begin with the following:
* You can choose to make the data searchable by other users in the account or you can restrict search access.
* Searchable data means that all users with access to the OpsItem Overview page (as provided by the
* DescribeOpsItems API operation) can view and search on the specified data. Operational data that isn't
* searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API
* operation).
*
* Use the /aws/resources
key in OperationalData to specify a related resource in the request.
* Use the /aws/automations
key in OperationalData to associate an Automation runbook with the
* OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
*/
public void setOperationalData(java.util.Mapamazon
, aws
,
* amzn
, ssm
, /amazon
, /aws
, /amzn
,
* /ssm
.
* /aws/resources
key in OperationalData to specify a related resource in the request. Use the
* /aws/automations
key in OperationalData to associate an Automation runbook with the OpsItem. To view
* Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
*
* Operational data is custom data that provides useful reference details about the OpsItem. For example, you * can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You * enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a * maximum size of 20 KB. *
*
* Operational data keys can't begin with the following: amazon
, aws
,
* amzn
, ssm
, /amazon
, /aws
, /amzn
,
* /ssm
.
*
* You can choose to make the data searchable by other users in the account or you can restrict search * access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the * DescribeOpsItems API operation) can view and search on the specified data. Operational data that * isn't searchable is only viewable by users who have access to the OpsItem (as provided by the * GetOpsItem API operation). *
*
* Use the
* Keys that you want to remove from the OperationalData map.
*
* Keys that you want to remove from the OperationalData map.
*
* Keys that you want to remove from the OperationalData map.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setOperationalDataToDelete(java.util.Collection)} or
* {@link #withOperationalDataToDelete(java.util.Collection)} if you want to override the existing values.
*
* Keys that you want to remove from the OperationalData map.
*
* The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
* changed.
*
* The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
* changed.
*
* The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
* changed.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setNotifications(java.util.Collection)} or {@link #withNotifications(java.util.Collection)} if you want
* to override the existing values.
*
* The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or
* changed.
*
* The importance of this OpsItem in relation to other OpsItems in the system.
*
* The importance of this OpsItem in relation to other OpsItems in the system.
*
* The importance of this OpsItem in relation to other OpsItems in the system.
*
* One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can
* include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
*
* One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can
* include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
*
* One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can
* include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRelatedOpsItems(java.util.Collection)} or {@link #withRelatedOpsItems(java.util.Collection)} if you
* want to override the existing values.
*
* One or more OpsItems that share something in common with the current OpsItems. For example, related OpsItems can
* include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
*
* The OpsItem status. Status can be
* The OpsItem status. Status can be
* The OpsItem status. Status can be
* The OpsItem status. Status can be
* The ID of the OpsItem.
*
* The ID of the OpsItem.
*
* The ID of the OpsItem.
*
* A short heading that describes the nature of the OpsItem and the impacted resource.
*
* A short heading that describes the nature of the OpsItem and the impacted resource.
*
* A short heading that describes the nature of the OpsItem and the impacted resource.
*
* Specify a new category for an OpsItem.
*
* Specify a new category for an OpsItem.
*
* Specify a new category for an OpsItem.
*
* Specify a new severity for an OpsItem.
*
* Specify a new severity for an OpsItem.
*
* Specify a new severity for an OpsItem.
*
* The time a runbook workflow started. Currently reported only for the OpsItem type
* The time a runbook workflow started. Currently reported only for the OpsItem type
* The time a runbook workflow started. Currently reported only for the OpsItem type
* The time a runbook workflow ended. Currently reported only for the OpsItem type
* The time a runbook workflow ended. Currently reported only for the OpsItem type
* The time a runbook workflow ended. Currently reported only for the OpsItem type
* The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem
* type
* The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem
* type
* The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem
* type
* The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem
* type
* The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem
* type
* The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem
* type
* The OpsItem Amazon Resource Name (ARN).
*
* The OpsItem Amazon Resource Name (ARN).
*
* The OpsItem Amazon Resource Name (ARN).
* /aws/resources
key in OperationalData to specify a related resource in the request.
* Use the /aws/automations
key in OperationalData to associate an Automation runbook with the
* OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateOpsItemRequest withOperationalData(java.util.MapOpen
, In Progress
, or Resolved
. For more
* information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
* Open
, In Progress
, or Resolved
.
* For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
* @see OpsItemStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
* Open
, In Progress
, or Resolved
. For more
* information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
* Open
, In Progress
, or Resolved
.
* For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
* @see OpsItemStatus
*/
public String getStatus() {
return this.status;
}
/**
* Open
, In Progress
, or Resolved
. For more
* information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
* Open
, In Progress
, or Resolved
.
* For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OpsItemStatus
*/
public UpdateOpsItemRequest withStatus(String status) {
setStatus(status);
return this;
}
/**
* Open
, In Progress
, or Resolved
. For more
* information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
* Open
, In Progress
, or Resolved
.
* For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @see OpsItemStatus
*/
public UpdateOpsItemRequest withStatus(OpsItemStatus status) {
this.status = status.toString();
return this;
}
/**
* /aws/changerequest
* .
* /aws/changerequest
.
*/
public void setActualStartTime(java.util.Date actualStartTime) {
this.actualStartTime = actualStartTime;
}
/**
* /aws/changerequest
* .
* /aws/changerequest
.
*/
public java.util.Date getActualStartTime() {
return this.actualStartTime;
}
/**
* /aws/changerequest
* .
* /aws/changerequest
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateOpsItemRequest withActualStartTime(java.util.Date actualStartTime) {
setActualStartTime(actualStartTime);
return this;
}
/**
* /aws/changerequest
.
* /aws/changerequest
.
*/
public void setActualEndTime(java.util.Date actualEndTime) {
this.actualEndTime = actualEndTime;
}
/**
* /aws/changerequest
.
* /aws/changerequest
.
*/
public java.util.Date getActualEndTime() {
return this.actualEndTime;
}
/**
* /aws/changerequest
.
* /aws/changerequest
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateOpsItemRequest withActualEndTime(java.util.Date actualEndTime) {
setActualEndTime(actualEndTime);
return this;
}
/**
* /aws/changerequest
.
* /aws/changerequest
.
*/
public void setPlannedStartTime(java.util.Date plannedStartTime) {
this.plannedStartTime = plannedStartTime;
}
/**
* /aws/changerequest
.
* /aws/changerequest
.
*/
public java.util.Date getPlannedStartTime() {
return this.plannedStartTime;
}
/**
* /aws/changerequest
.
* /aws/changerequest
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateOpsItemRequest withPlannedStartTime(java.util.Date plannedStartTime) {
setPlannedStartTime(plannedStartTime);
return this;
}
/**
* /aws/changerequest
.
* /aws/changerequest
.
*/
public void setPlannedEndTime(java.util.Date plannedEndTime) {
this.plannedEndTime = plannedEndTime;
}
/**
* /aws/changerequest
.
* /aws/changerequest
.
*/
public java.util.Date getPlannedEndTime() {
return this.plannedEndTime;
}
/**
* /aws/changerequest
.
* /aws/changerequest
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateOpsItemRequest withPlannedEndTime(java.util.Date plannedEndTime) {
setPlannedEndTime(plannedEndTime);
return this;
}
/**
*