software.amazon.awssdk.services.ssm.model

Class OpsItem

java.lang.Object

software.amazon.awssdk.services.ssm.model.OpsItem

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<OpsItem.Builder,OpsItem>

@Generated(value="software.amazon.awssdk:codegen")
public final class OpsItem
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<OpsItem.Builder,OpsItem>

Operations engineers and IT professionals use OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their AWS resources. For more information, see AWS Systems Manager OpsCenter in the AWS Systems Manager User Guide.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OpsItem.Builder

Method Summary

Modifier and Type	Method and Description
static OpsItem.Builder	builder()
String	createdBy() The ARN of the AWS account that created the OpsItem.
Instant	createdTime() The date and time the OpsItem was created.
String	description() The OpsItem description.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	lastModifiedBy() The ARN of the AWS account that last updated the OpsItem.
Instant	lastModifiedTime() The date and time the OpsItem was last updated.
List<OpsItemNotification>	notifications() The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
Map<String,OpsItemDataValue>	operationalData() Operational data is custom data that provides useful reference details about the OpsItem.
String	opsItemId() The ID of the OpsItem.
Integer	priority() The importance of this OpsItem in relation to other OpsItems in the system.
List<RelatedOpsItem>	relatedOpsItems() One or more OpsItems that share something in common with the current OpsItem.
List<SdkField<?>>	sdkFields()
static Class<? extends OpsItem.Builder>	serializableBuilderClass()
String	source() The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager.
OpsItemStatus	status() The OpsItem status.
String	statusAsString() The OpsItem status.
String	title() A short heading that describes the nature of the OpsItem and the impacted resource.
OpsItem.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	version() The version of this OpsItem.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

createdBy

public String createdBy()

The ARN of the AWS account that created the OpsItem.

Returns:

The ARN of the AWS account that created the OpsItem.

createdTime

public Instant createdTime()

The date and time the OpsItem was created.

Returns:

The date and time the OpsItem was created.

description

public String description()

The OpsItem description.

Returns:

The OpsItem description.

lastModifiedBy

public String lastModifiedBy()

The ARN of the AWS account that last updated the OpsItem.

Returns:

The ARN of the AWS account that last updated the OpsItem.

lastModifiedTime

public Instant lastModifiedTime()

The date and time the OpsItem was last updated.

Returns:

The date and time the OpsItem was last updated.

notifications

public List<OpsItemNotification> notifications()

The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

priority

public Integer priority()

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.

relatedOpsItems

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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.

status

public OpsItemStatus status()

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.

If the service returns an enum value that is not available in the current SDK version, status will return OpsItemStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.

See Also:

OpsItemStatus

statusAsString

public String statusAsString()

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.

If the service returns an enum value that is not available in the current SDK version, status will return OpsItemStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The OpsItem status. Status can be Open, In Progress, or Resolved. For more information, see Editing OpsItem Details in the AWS Systems Manager User Guide.

See Also:

OpsItemStatus

opsItemId

public String opsItemId()

The ID of the OpsItem.

Returns:

The ID of the OpsItem.

version

public String version()

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.

title

public String title()

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.

source

public String source()

The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of source.

Returns:

The origin of the OpsItem, such as Amazon EC2 or AWS Systems Manager. The impacted resource is a subset of source.

operationalData

public 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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

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 AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

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 action) can view and search on the specified data. Operational data that is not searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API action).

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 AWS CLI example commands that use these keys, see Creating OpsItems Manually in the AWS Systems Manager User Guide.

toBuilder

public OpsItem.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<OpsItem.Builder,OpsItem>

builder

public static OpsItem.Builder builder()

serializableBuilderClass

public static Class<? extends OpsItem.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo