software.amazon.awssdk.services.ssm.model

Class CreateOpsItemRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.ssm.model.SsmRequest

software.amazon.awssdk.services.ssm.model.CreateOpsItemRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateOpsItemRequest
extends SsmRequest
implements ToCopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateOpsItemRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The target Amazon Web Services account where you want to create an OpsItem.
Instant	actualEndTime() The time a runbook workflow ended.
Instant	actualStartTime() The time a runbook workflow started.
static CreateOpsItemRequest.Builder	builder()
String	category() Specify a category to assign to an OpsItem.
String	description() User-defined text that contains information about the OpsItem, in Markdown format.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNotifications() For responses, this returns true if the service returned a value for the Notifications property.
boolean	hasOperationalData() For responses, this returns true if the service returned a value for the OperationalData property.
boolean	hasRelatedOpsItems() For responses, this returns true if the service returned a value for the RelatedOpsItems property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
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	opsItemType() The type of OpsItem to create.
Instant	plannedEndTime() The time specified in a change request for a runbook workflow to end.
Instant	plannedStartTime() The time specified in a change request for a runbook workflow to start.
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 OpsItems.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateOpsItemRequest.Builder>	serializableBuilderClass()
String	severity() Specify a severity to assign to an OpsItem.
String	source() The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
List<Tag>	tags() Optional metadata that you assign to a resource.
String	title() A short heading that describes the nature of the OpsItem and the impacted resource.
CreateOpsItemRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

description

public final String description()

User-defined text that contains information about the OpsItem, in Markdown format.

Provide enough information so that users viewing this OpsItem for the first time understand the issue.

Returns:

User-defined text that contains information about the OpsItem, in Markdown format.

Provide enough information so that users viewing this OpsItem for the first time understand the issue.

opsItemType

public final String opsItemType()

The type of OpsItem to create. 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/insights

  This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

Returns:

The type of OpsItem to create. 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/insights

  This type of OpsItem is used by OpsCenter for aggregating and reporting on duplicate OpsItems.

hasOperationalData

public final boolean hasOperationalData()

For responses, this returns true if the service returned a value for the OperationalData property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

operationalData

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

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOperationalData() method.

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.

hasNotifications

public final boolean hasNotifications()

For responses, this returns true if the service returned a value for the Notifications property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

notifications

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNotifications() method.

Returns:

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

priority

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

hasRelatedOpsItems

public final boolean hasRelatedOpsItems()

For responses, this returns true if the service returned a value for the RelatedOpsItems property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

relatedOpsItems

public final List<RelatedOpsItem> relatedOpsItems()

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.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRelatedOpsItems() method.

Returns:

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.

source

public final String source()

The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

The source name can't contain the following strings: aws, amazon, and amzn .

Returns:

The origin of the OpsItem, such as Amazon EC2 or Systems Manager.

The source name can't contain the following strings: aws, amazon, and amzn.

title

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

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Optional metadata that you assign to a resource.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Optional metadata that you assign to a resource.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to a new OpsItem, a user must have IAM permissions for both the ssm:CreateOpsItems operation and the ssm:AddTagsToResource operation. To add tags to an existing OpsItem, use the AddTagsToResource operation.

category

public final String category()

Specify a category to assign to an OpsItem.

Returns:

Specify a category to assign to an OpsItem.

severity

public final String severity()

Specify a severity to assign to an OpsItem.

Returns:

Specify a severity to assign to an OpsItem.

actualStartTime

public final Instant actualStartTime()

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.

actualEndTime

public final Instant actualEndTime()

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.

plannedStartTime

public final Instant plannedStartTime()

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.

plannedEndTime

public final Instant plannedEndTime()

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.

accountId

public final String accountId()

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

Returns:

The target Amazon Web Services account where you want to create an OpsItem. To make this call, your account must be configured to work with OpsItems across accounts. For more information, see Set up OpsCenter in the Amazon Web Services Systems Manager User Guide.

toBuilder

public CreateOpsItemRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateOpsItemRequest.Builder,CreateOpsItemRequest>

Specified by:

toBuilder in class SsmRequest

builder

public static CreateOpsItemRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo