com.amazonaws.services.simplesystemsmanagement.model

Class CreateOpsItemRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.simplesystemsmanagement.model.CreateOpsItemRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateOpsItemRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateOpsItemRequest()

Method Summary

Modifier and Type	Method and Description
CreateOpsItemRequest	addOperationalDataEntry(String key, OpsItemDataValue value) Add a single OperationalData entry
CreateOpsItemRequest	clearOperationalDataEntries() Removes all the entries added into OperationalData.
CreateOpsItemRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCategory() Specify a category to assign to an OpsItem.
String	getDescription() Information about the OpsItem.
List<OpsItemNotification>	getNotifications() The Amazon Resource Name (ARN) of an 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.
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 OpsItems.
String	getSeverity() Specify a severity to assign to an OpsItem.
String	getSource() The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
List<Tag>	getTags() Optional metadata that you assign to a resource.
String	getTitle() A short heading that describes the nature of the OpsItem and the impacted resource.
int	hashCode()
void	setCategory(String category) Specify a category to assign to an OpsItem.
void	setDescription(String description) Information about the OpsItem.
void	setNotifications(Collection<OpsItemNotification> notifications) The Amazon Resource Name (ARN) of an 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	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 OpsItems.
void	setSeverity(String severity) Specify a severity to assign to an OpsItem.
void	setSource(String source) The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
void	setTags(Collection<Tag> tags) Optional metadata that you assign to a resource.
void	setTitle(String title) A short heading that describes the nature of the OpsItem and the impacted resource.
String	toString() Returns a string representation of this object.
CreateOpsItemRequest	withCategory(String category) Specify a category to assign to an OpsItem.
CreateOpsItemRequest	withDescription(String description) Information about the OpsItem.
CreateOpsItemRequest	withNotifications(Collection<OpsItemNotification> notifications) The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
CreateOpsItemRequest	withNotifications(OpsItemNotification... notifications) The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
CreateOpsItemRequest	withOperationalData(Map<String,OpsItemDataValue> operationalData) Operational data is custom data that provides useful reference details about the OpsItem.
CreateOpsItemRequest	withPriority(Integer priority) The importance of this OpsItem in relation to other OpsItems in the system.
CreateOpsItemRequest	withRelatedOpsItems(Collection<RelatedOpsItem> relatedOpsItems) One or more OpsItems that share something in common with the current OpsItems.
CreateOpsItemRequest	withRelatedOpsItems(RelatedOpsItem... relatedOpsItems) One or more OpsItems that share something in common with the current OpsItems.
CreateOpsItemRequest	withSeverity(String severity) Specify a severity to assign to an OpsItem.
CreateOpsItemRequest	withSource(String source) The origin of the OpsItem, such as Amazon EC2 or Systems Manager.
CreateOpsItemRequest	withTags(Collection<Tag> tags) Optional metadata that you assign to a resource.
CreateOpsItemRequest	withTags(Tag... tags) Optional metadata that you assign to a resource.
CreateOpsItemRequest	withTitle(String title) A short heading that describes the nature of the OpsItem and the impacted resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateOpsItemRequest

public CreateOpsItemRequest()

Method Detail

setDescription

public void setDescription(String description)

Information about the OpsItem.

Parameters:

description - Information about the OpsItem.

getDescription

public String getDescription()

Information about the OpsItem.

Returns:

Information about the OpsItem.

withDescription

public CreateOpsItemRequest withDescription(String description)

Information about the OpsItem.

Parameters:

description - Information about the OpsItem.

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

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.

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

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

withOperationalData

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

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

Returns:

Returns a reference to this object so that method calls can be chained together.

addOperationalDataEntry

public CreateOpsItemRequest 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 CreateOpsItemRequest clearOperationalDataEntries()

Removes all the entries added into OperationalData.

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 SNS topic where notifications are sent when this OpsItem is edited or changed.

Returns:

The Amazon Resource Name (ARN) of an 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 SNS topic where notifications are sent when this OpsItem is edited or changed.

Parameters:

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

withNotifications

public CreateOpsItemRequest withNotifications(OpsItemNotification... notifications)

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 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 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 CreateOpsItemRequest withNotifications(Collection<OpsItemNotification> notifications)

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

Parameters:

notifications - The Amazon Resource Name (ARN) of an 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 CreateOpsItemRequest 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 OpsItems. 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 OpsItems. 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 OpsItems. 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 OpsItems. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

withRelatedOpsItems

public CreateOpsItemRequest withRelatedOpsItems(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.

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 OpsItems. 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 CreateOpsItemRequest withRelatedOpsItems(Collection<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.

Parameters:

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.

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 source name can't contain the following strings: aws, amazon, and amzn.

Parameters:

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.

getSource

public String getSource()

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.

withSource

public CreateOpsItemRequest withSource(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.

Parameters:

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:

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 CreateOpsItemRequest 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.

getTags

public List<Tag> getTags()

Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

Returns:

Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

setTags

public void setTags(Collection<Tag> tags)

Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

Parameters:

tags - Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

withTags

public CreateOpsItemRequest withTags(Tag... tags)

Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateOpsItemRequest withTags(Collection<Tag> tags)

Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

Parameters:

tags - Optional metadata that you assign to a resource. You can restrict access to OpsItems by using an inline IAM policy that specifies tags. For more information, see Getting started with OpsCenter in the AWS Systems Manager User Guide.

Tags use a key-value pair. For example:

Key=Department,Value=Finance

To add tags to an existing OpsItem, use the AddTagsToResource action.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCategory

public void setCategory(String category)

Specify a category to assign to an OpsItem.

Parameters:

category - Specify a category to assign to an OpsItem.

getCategory

public String getCategory()

Specify a category to assign to an OpsItem.

Returns:

Specify a category to assign to an OpsItem.

withCategory

public CreateOpsItemRequest withCategory(String category)

Specify a category to assign to an OpsItem.

Parameters:

category - Specify a category to assign to an OpsItem.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSeverity

public void setSeverity(String severity)

Specify a severity to assign to an OpsItem.

Parameters:

severity - Specify a severity to assign to an OpsItem.

getSeverity

public String getSeverity()

Specify a severity to assign to an OpsItem.

Returns:

Specify a severity to assign to an OpsItem.

withSeverity

public CreateOpsItemRequest withSeverity(String severity)

Specify a severity to assign to an OpsItem.

Parameters:

severity - Specify a severity to assign to an OpsItem.

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 CreateOpsItemRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()