OpsItem (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.simplesystemsmanagement.model.OpsItem

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class OpsItem
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational work items (OpsItems) impacting the performance and health of their Amazon Web Services resources. OpsCenter is integrated with Amazon EventBridge and Amazon CloudWatch. This means you can configure these services to automatically create an OpsItem in OpsCenter when a CloudWatch alarm enters the ALARM state or when EventBridge processes an event from any Amazon Web Services service that publishes events. Configuring Amazon CloudWatch alarms and EventBridge events to automatically create OpsItems allows you to quickly diagnose and remediate issues with Amazon Web Services resources from a single console.

To help you diagnose issues, each OpsItem includes contextually relevant information such as the name and ID of the Amazon Web Services resource that generated the OpsItem, alarm or event details, alarm history, and an alarm timeline graph. For the Amazon Web Services resource, OpsCenter aggregates information from Config, CloudTrail logs, and EventBridge, so you don't have to navigate across multiple console pages during your investigation. For more information, see Amazon Web Services Systems Manager OpsCenter in the Amazon Web Services Systems Manager User Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

OpsItem()

Constructors
Constructor and Description
`OpsItem()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`OpsItem`	`addOperationalDataEntry(String key, OpsItemDataValue value)` Add a single OperationalData entry
`OpsItem`	`clearOperationalDataEntries()` Removes all the entries added into OperationalData.
`OpsItem`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getActualEndTime()` The time a runbook workflow ended.
`Date`	`getActualStartTime()` The time a runbook workflow started.
`String`	`getCategory()` An OpsItem category.
`String`	`getCreatedBy()` The ARN of the Amazon Web Services account that created the OpsItem.
`Date`	`getCreatedTime()` The date and time the OpsItem was created.
`String`	`getDescription()` The OpsItem description.
`String`	`getLastModifiedBy()` The ARN of the Amazon Web Services account that last updated the OpsItem.
`Date`	`getLastModifiedTime()` The date and time the OpsItem was last updated.
`List<OpsItemNotification>`	`getNotifications()` The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
`Map<String,OpsItemDataValue>`	`getOperationalData()` Operational data is custom data that provides useful reference details about the OpsItem.
`String`	`getOpsItemArn()` The OpsItem Amazon Resource Name (ARN).
`String`	`getOpsItemId()` The ID of the OpsItem.
`String`	`getOpsItemType()` The type of OpsItem.
`Date`	`getPlannedEndTime()` The time specified in a change request for a runbook workflow to end.
`Date`	`getPlannedStartTime()` The time specified in a change request for a runbook workflow to start.
`Integer`	`getPriority()` The importance of this OpsItem in relation to other OpsItems in the system.
`List<RelatedOpsItem>`	`getRelatedOpsItems()` One or more OpsItems that share something in common with the current OpsItem.
`String`	`getSeverity()` The severity of the OpsItem.
`String`	`getSource()` The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
`String`	`getStatus()` The OpsItem status.
`String`	`getTitle()` A short heading that describes the nature of the OpsItem and the impacted resource.
`String`	`getVersion()` The version of this OpsItem.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActualEndTime(Date actualEndTime)` The time a runbook workflow ended.
`void`	`setActualStartTime(Date actualStartTime)` The time a runbook workflow started.
`void`	`setCategory(String category)` An OpsItem category.
`void`	`setCreatedBy(String createdBy)` The ARN of the Amazon Web Services account that created the OpsItem.
`void`	`setCreatedTime(Date createdTime)` The date and time the OpsItem was created.
`void`	`setDescription(String description)` The OpsItem description.
`void`	`setLastModifiedBy(String lastModifiedBy)` The ARN of the Amazon Web Services account that last updated the OpsItem.
`void`	`setLastModifiedTime(Date lastModifiedTime)` The date and time the OpsItem was last updated.
`void`	`setNotifications(Collection<OpsItemNotification> notifications)` The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
`void`	`setOperationalData(Map<String,OpsItemDataValue> operationalData)` Operational data is custom data that provides useful reference details about the OpsItem.
`void`	`setOpsItemArn(String opsItemArn)` The OpsItem Amazon Resource Name (ARN).
`void`	`setOpsItemId(String opsItemId)` The ID of the OpsItem.
`void`	`setOpsItemType(String opsItemType)` The type of OpsItem.
`void`	`setPlannedEndTime(Date plannedEndTime)` The time specified in a change request for a runbook workflow to end.
`void`	`setPlannedStartTime(Date plannedStartTime)` The time specified in a change request for a runbook workflow to start.
`void`	`setPriority(Integer priority)` The importance of this OpsItem in relation to other OpsItems in the system.
`void`	`setRelatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)` One or more OpsItems that share something in common with the current OpsItem.
`void`	`setSeverity(String severity)` The severity of the OpsItem.
`void`	`setSource(String source)` The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
`void`	`setStatus(String status)` The OpsItem status.
`void`	`setTitle(String title)` A short heading that describes the nature of the OpsItem and the impacted resource.
`void`	`setVersion(String version)` The version of this OpsItem.
`String`	`toString()` Returns a string representation of this object.
`OpsItem`	`withActualEndTime(Date actualEndTime)` The time a runbook workflow ended.
`OpsItem`	`withActualStartTime(Date actualStartTime)` The time a runbook workflow started.
`OpsItem`	`withCategory(String category)` An OpsItem category.
`OpsItem`	`withCreatedBy(String createdBy)` The ARN of the Amazon Web Services account that created the OpsItem.
`OpsItem`	`withCreatedTime(Date createdTime)` The date and time the OpsItem was created.
`OpsItem`	`withDescription(String description)` The OpsItem description.
`OpsItem`	`withLastModifiedBy(String lastModifiedBy)` The ARN of the Amazon Web Services account that last updated the OpsItem.
`OpsItem`	`withLastModifiedTime(Date lastModifiedTime)` The date and time the OpsItem was last updated.
`OpsItem`	`withNotifications(Collection<OpsItemNotification> notifications)` The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
`OpsItem`	`withNotifications(OpsItemNotification... notifications)` The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
`OpsItem`	`withOperationalData(Map<String,OpsItemDataValue> operationalData)` Operational data is custom data that provides useful reference details about the OpsItem.
`OpsItem`	`withOpsItemArn(String opsItemArn)` The OpsItem Amazon Resource Name (ARN).
`OpsItem`	`withOpsItemId(String opsItemId)` The ID of the OpsItem.
`OpsItem`	`withOpsItemType(String opsItemType)` The type of OpsItem.
`OpsItem`	`withPlannedEndTime(Date plannedEndTime)` The time specified in a change request for a runbook workflow to end.
`OpsItem`	`withPlannedStartTime(Date plannedStartTime)` The time specified in a change request for a runbook workflow to start.
`OpsItem`	`withPriority(Integer priority)` The importance of this OpsItem in relation to other OpsItems in the system.
`OpsItem`	`withRelatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)` One or more OpsItems that share something in common with the current OpsItem.
`OpsItem`	`withRelatedOpsItems(RelatedOpsItem... relatedOpsItems)` One or more OpsItems that share something in common with the current OpsItem.
`OpsItem`	`withSeverity(String severity)` The severity of the OpsItem.
`OpsItem`	`withSource(String source)` The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
`OpsItem`	`withStatus(OpsItemStatus status)` The OpsItem status.
`OpsItem`	`withStatus(String status)` The OpsItem status.
`OpsItem`	`withTitle(String title)` A short heading that describes the nature of the OpsItem and the impacted resource.
`OpsItem`	`withVersion(String version)` The version of this OpsItem.

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

- Constructor Detail
  - OpsItem
```
public OpsItem()
```
- Method Detail
  - setCreatedBy
```
public void setCreatedBy(String createdBy)
```
    The ARN of the Amazon Web Services account that created the OpsItem.
    
    Parameters:
    
    createdBy - The ARN of the Amazon Web Services account that created the OpsItem.
  - getCreatedBy
```
public String getCreatedBy()
```
    The ARN of the Amazon Web Services account that created the OpsItem.
    
    Returns:
    
    The ARN of the Amazon Web Services account that created the OpsItem.
  - withCreatedBy
```
public OpsItem withCreatedBy(String createdBy)
```
    The ARN of the Amazon Web Services account that created the OpsItem.
    
    Parameters:
    
    createdBy - The ARN of the Amazon Web Services account that created the OpsItem.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOpsItemType
```
public void setOpsItemType(String opsItemType)
```
    The type of OpsItem. Systems Manager supports the following types of OpsItems:
    - /aws/issue
      
      This type of OpsItem is used for default OpsItems created by OpsCenter.
    - /aws/changerequest
      
      This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
    - /aws/insight
      
      This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
    Parameters:
    opsItemType - The type of OpsItem. Systems Manager supports the following types of OpsItems:
    
    /aws/issue
    
    This type of OpsItem is used for default OpsItems created by OpsCenter.
    
    /aws/changerequest
    
    This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
    
    /aws/insight
    
    This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
  - getOpsItemType
```
public String getOpsItemType()
```
    The type of OpsItem. Systems Manager supports the following types of OpsItems:
    - /aws/issue
      
      This type of OpsItem is used for default OpsItems created by OpsCenter.
    - /aws/changerequest
      
      This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
    - /aws/insight
      
      This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
    Returns:
    The type of OpsItem. Systems Manager supports the following types of OpsItems:
    
    /aws/issue
    
    This type of OpsItem is used for default OpsItems created by OpsCenter.
    
    /aws/changerequest
    
    This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
    
    /aws/insight
    
    This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
  - withOpsItemType
```
public OpsItem withOpsItemType(String opsItemType)
```
    The type of OpsItem. Systems Manager supports the following types of OpsItems:
    - /aws/issue
      
      This type of OpsItem is used for default OpsItems created by OpsCenter.
    - /aws/changerequest
      
      This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
    - /aws/insight
      
      This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
    Parameters:
    opsItemType - The type of OpsItem. Systems Manager supports the following types of OpsItems:
    
    /aws/issue
    
    This type of OpsItem is used for default OpsItems created by OpsCenter.
    
    /aws/changerequest
    
    This type of OpsItem is used by Change Manager for reviewing and approving or rejecting change requests.
    
    /aws/insight
    
    This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
    The date and time the OpsItem was created.
    
    Parameters:
    
    createdTime - The date and time the OpsItem was created.
  - getCreatedTime
```
public Date getCreatedTime()
```
    The date and time the OpsItem was created.
    
    Returns:
    
    The date and time the OpsItem was created.
  - withCreatedTime
```
public OpsItem withCreatedTime(Date createdTime)
```
    The date and time the OpsItem was created.
    
    Parameters:
    
    createdTime - The date and time the OpsItem was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The OpsItem description.
    
    Parameters:
    
    description - The OpsItem description.
  - getDescription
```
public String getDescription()
```
    The OpsItem description.
    
    Returns:
    
    The OpsItem description.
  - withDescription
```
public OpsItem withDescription(String description)
```
    The OpsItem description.
    
    Parameters:
    
    description - The OpsItem description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedBy
```
public void setLastModifiedBy(String lastModifiedBy)
```
    The ARN of the Amazon Web Services account that last updated the OpsItem.
    
    Parameters:
    
    lastModifiedBy - The ARN of the Amazon Web Services account that last updated the OpsItem.
  - getLastModifiedBy
```
public String getLastModifiedBy()
```
    The ARN of the Amazon Web Services account that last updated the OpsItem.
    
    Returns:
    
    The ARN of the Amazon Web Services account that last updated the OpsItem.
  - withLastModifiedBy
```
public OpsItem withLastModifiedBy(String lastModifiedBy)
```
    The ARN of the Amazon Web Services account that last updated the OpsItem.
    
    Parameters:
    
    lastModifiedBy - The ARN of the Amazon Web Services account that last updated the OpsItem.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    The date and time the OpsItem was last updated.
    
    Parameters:
    
    lastModifiedTime - The date and time the OpsItem was last updated.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    The date and time the OpsItem was last updated.
    
    Returns:
    
    The date and time the OpsItem was last updated.
  - withLastModifiedTime
```
public OpsItem withLastModifiedTime(Date lastModifiedTime)
```
    The date and time the OpsItem was last updated.
    
    Parameters:
    
    lastModifiedTime - The date and time the OpsItem was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNotifications
```
public List<OpsItemNotification> getNotifications()
```
    The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
  - setNotifications
```
public void setNotifications(Collection<OpsItemNotification> notifications)
```
    The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
    
    Parameters:
    
    notifications - The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
  - withNotifications
```
public OpsItem withNotifications(OpsItemNotification... notifications)
```
    The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon 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 setNotifications(java.util.Collection) or withNotifications(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    notifications - The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNotifications
```
public OpsItem withNotifications(Collection<OpsItemNotification> notifications)
```
    The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
    
    Parameters:
    
    notifications - The Amazon Resource Name (ARN) of an Amazon Simple Notification Service (Amazon SNS) topic where notifications are sent when this OpsItem is edited or changed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPriority
```
public void setPriority(Integer priority)
```
    The importance of this OpsItem in relation to other OpsItems in the system.
    
    Parameters:
    
    priority - The importance of this OpsItem in relation to other OpsItems in the system.
  - getPriority
```
public Integer getPriority()
```
    The importance of this OpsItem in relation to other OpsItems in the system.
    
    Returns:
    
    The importance of this OpsItem in relation to other OpsItems in the system.
  - withPriority
```
public OpsItem withPriority(Integer priority)
```
    The importance of this OpsItem in relation to other OpsItems in the system.
    
    Parameters:
    
    priority - The importance of this OpsItem in relation to other OpsItems in the system.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRelatedOpsItems
```
public List<RelatedOpsItem> getRelatedOpsItems()
```
    One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
    
    Returns:
    
    One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
  - setRelatedOpsItems
```
public void setRelatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)
```
    One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
    
    Parameters:
    
    relatedOpsItems - One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
  - withRelatedOpsItems
```
public OpsItem withRelatedOpsItems(RelatedOpsItem... relatedOpsItems)
```
    One or more OpsItems that share something in common with the current OpsItem. 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 setRelatedOpsItems(java.util.Collection) or withRelatedOpsItems(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    relatedOpsItems - One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRelatedOpsItems
```
public OpsItem withRelatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems)
```
    One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
    
    Parameters:
    
    relatedOpsItems - One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    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.
    
    Parameters:
    
    status - 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.
    
    See Also:
    
    OpsItemStatus
  - getStatus
```
public String getStatus()
```
    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.
    
    Returns:
    
    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.
    
    See Also:
    
    OpsItemStatus
  - withStatus
```
public OpsItem withStatus(String status)
```
    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.
    
    Parameters:
    
    status - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OpsItemStatus
  - withStatus
```
public OpsItem withStatus(OpsItemStatus status)
```
    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.
    
    Parameters:
    
    status - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    OpsItemStatus
  - setOpsItemId
```
public void setOpsItemId(String opsItemId)
```
    The ID of the OpsItem.
    
    Parameters:
    
    opsItemId - The ID of the OpsItem.
  - getOpsItemId
```
public String getOpsItemId()
```
    The ID of the OpsItem.
    
    Returns:
    
    The ID of the OpsItem.
  - withOpsItemId
```
public OpsItem withOpsItemId(String opsItemId)
```
    The ID of the OpsItem.
    
    Parameters:
    
    opsItemId - The ID of the OpsItem.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(String version)
```
    The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
    
    Parameters:
    
    version - The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
  - getVersion
```
public String getVersion()
```
    The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
    
    Returns:
    
    The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
  - withVersion
```
public OpsItem withVersion(String version)
```
    The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
    
    Parameters:
    
    version - The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTitle
```
public void setTitle(String title)
```
    A short heading that describes the nature of the OpsItem and the impacted resource.
    
    Parameters:
    
    title - A short heading that describes the nature of the OpsItem and the impacted resource.
  - getTitle
```
public String getTitle()
```
    A short heading that describes the nature of the OpsItem and the impacted resource.
    
    Returns:
    
    A short heading that describes the nature of the OpsItem and the impacted resource.
  - withTitle
```
public OpsItem withTitle(String title)
```
    A short heading that describes the nature of the OpsItem and the impacted resource.
    
    Parameters:
    
    title - A short heading that describes the nature of the OpsItem and the impacted resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSource
```
public void setSource(String source)
```
    The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
    
    Parameters:
    
    source - The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
  - getSource
```
public String getSource()
```
    The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
    
    Returns:
    
    The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
  - withSource
```
public OpsItem withSource(String source)
```
    The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
    
    Parameters:
    
    source - The origin of the OpsItem, such as Amazon EC2 or Systems Manager. The impacted resource is a subset of source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getOperationalData
```
public Map<String,OpsItemDataValue> getOperationalData()
```
    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.
    
    Returns:
    
    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.
  - setOperationalData
```
public void setOperationalData(Map<String,OpsItemDataValue> operationalData)
```
    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.
    
    Parameters:
    
    operationalData - 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.
  - withOperationalData
```
public OpsItem withOperationalData(Map<String,OpsItemDataValue> operationalData)
```
    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.
    
    Parameters:
    
    operationalData - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addOperationalDataEntry
```
public OpsItem addOperationalDataEntry(String key,
                                       OpsItemDataValue value)
```
    Add a single OperationalData entry
    
    See Also:
    
    withOperationalData(java.util.Map<java.lang.String, com.amazonaws.services.simplesystemsmanagement.model.OpsItemDataValue>)
  - clearOperationalDataEntries
```
public OpsItem clearOperationalDataEntries()
```
    Removes all the entries added into OperationalData.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCategory
```
public void setCategory(String category)
```
    An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
    
    Parameters:
    
    category - An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
  - getCategory
```
public String getCategory()
```
    An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
    
    Returns:
    
    An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
  - withCategory
```
public OpsItem withCategory(String category)
```
    An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
    
    Parameters:
    
    category - An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSeverity
```
public void setSeverity(String severity)
```
    The severity of the OpsItem. Severity options range from 1 to 4.
    
    Parameters:
    
    severity - The severity of the OpsItem. Severity options range from 1 to 4.
  - getSeverity
```
public String getSeverity()
```
    The severity of the OpsItem. Severity options range from 1 to 4.
    
    Returns:
    
    The severity of the OpsItem. Severity options range from 1 to 4.
  - withSeverity
```
public OpsItem withSeverity(String severity)
```
    The severity of the OpsItem. Severity options range from 1 to 4.
    
    Parameters:
    
    severity - The severity of the OpsItem. Severity options range from 1 to 4.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setActualStartTime
```
public void setActualStartTime(Date actualStartTime)
```
    The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest .
    
    Parameters:
    
    actualStartTime - The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
  - getActualStartTime
```
public Date getActualStartTime()
```
    The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest .
    
    Returns:
    
    The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
  - withActualStartTime
```
public OpsItem withActualStartTime(Date actualStartTime)
```
    The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest .
    
    Parameters:
    
    actualStartTime - The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setActualEndTime
```
public void setActualEndTime(Date actualEndTime)
```
    The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
    
    Parameters:
    
    actualEndTime - The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
  - getActualEndTime
```
public Date getActualEndTime()
```
    The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
  - withActualEndTime
```
public OpsItem withActualEndTime(Date actualEndTime)
```
    The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
    
    Parameters:
    
    actualEndTime - The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlannedStartTime
```
public void setPlannedStartTime(Date plannedStartTime)
```
    The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
    
    Parameters:
    
    plannedStartTime - The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
  - getPlannedStartTime
```
public Date getPlannedStartTime()
```
    The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
  - withPlannedStartTime
```
public OpsItem withPlannedStartTime(Date plannedStartTime)
```
    The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
    
    Parameters:
    
    plannedStartTime - The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPlannedEndTime
```
public void setPlannedEndTime(Date plannedEndTime)
```
    The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
    
    Parameters:
    
    plannedEndTime - The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
  - getPlannedEndTime
```
public Date getPlannedEndTime()
```
    The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
  - withPlannedEndTime
```
public OpsItem withPlannedEndTime(Date plannedEndTime)
```
    The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
    
    Parameters:
    
    plannedEndTime - The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOpsItemArn
```
public void setOpsItemArn(String opsItemArn)
```
    The OpsItem Amazon Resource Name (ARN).
    
    Parameters:
    
    opsItemArn - The OpsItem Amazon Resource Name (ARN).
  - getOpsItemArn
```
public String getOpsItemArn()
```
    The OpsItem Amazon Resource Name (ARN).
    
    Returns:
    
    The OpsItem Amazon Resource Name (ARN).
  - withOpsItemArn
```
public OpsItem withOpsItemArn(String opsItemArn)
```
    The OpsItem Amazon Resource Name (ARN).
    
    Parameters:
    
    opsItemArn - The OpsItem Amazon Resource Name (ARN).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public OpsItem clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.772

Class OpsItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OpsItem

Method Detail

setCreatedBy

getCreatedBy

withCreatedBy

setOpsItemType

getOpsItemType

withOpsItemType

setCreatedTime

getCreatedTime

withCreatedTime

setDescription

getDescription

withDescription

setLastModifiedBy

getLastModifiedBy

withLastModifiedBy

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

getNotifications

setNotifications

withNotifications

withNotifications

setPriority

getPriority

withPriority

getRelatedOpsItems

setRelatedOpsItems

withRelatedOpsItems

withRelatedOpsItems

setStatus

getStatus

withStatus

withStatus

setOpsItemId

getOpsItemId

withOpsItemId

setVersion

getVersion

withVersion

setTitle

getTitle

withTitle

setSource

getSource

withSource

getOperationalData

setOperationalData

withOperationalData

addOperationalDataEntry

clearOperationalDataEntries

setCategory

getCategory

withCategory

setSeverity

getSeverity

withSeverity

setActualStartTime

getActualStartTime

withActualStartTime

setActualEndTime

getActualEndTime

withActualEndTime

setPlannedStartTime

getPlannedStartTime

withPlannedStartTime

setPlannedEndTime

getPlannedEndTime

withPlannedEndTime

setOpsItemArn

getOpsItemArn

withOpsItemArn

toString