Aws::SSM::Model::UpdateOpsItemRequest Class Reference

#include <UpdateOpsItemRequest.h>

Inheritance diagram for Aws::SSM::Model::UpdateOpsItemRequest:

Public Member Functions
	UpdateOpsItemRequest ()
virtual const char *	GetServiceRequestName () const override
Aws::String	SerializePayload () const override
Aws::Http::HeaderValueCollection	GetRequestSpecificHeaders () const override
const Aws::String &	GetDescription () const
bool	DescriptionHasBeenSet () const
void	SetDescription (const Aws::String &value)
void	SetDescription (Aws::String &&value)
void	SetDescription (const char *value)
UpdateOpsItemRequest &	WithDescription (const Aws::String &value)
UpdateOpsItemRequest &	WithDescription (Aws::String &&value)
UpdateOpsItemRequest &	WithDescription (const char *value)
const Aws::Map< Aws::String, OpsItemDataValue > &	GetOperationalData () const
bool	OperationalDataHasBeenSet () const
void	SetOperationalData (const Aws::Map< Aws::String, OpsItemDataValue > &value)
void	SetOperationalData (Aws::Map< Aws::String, OpsItemDataValue > &&value)
UpdateOpsItemRequest &	WithOperationalData (const Aws::Map< Aws::String, OpsItemDataValue > &value)
UpdateOpsItemRequest &	WithOperationalData (Aws::Map< Aws::String, OpsItemDataValue > &&value)
UpdateOpsItemRequest &	AddOperationalData (const Aws::String &key, const OpsItemDataValue &value)
UpdateOpsItemRequest &	AddOperationalData (Aws::String &&key, const OpsItemDataValue &value)
UpdateOpsItemRequest &	AddOperationalData (const Aws::String &key, OpsItemDataValue &&value)
UpdateOpsItemRequest &	AddOperationalData (Aws::String &&key, OpsItemDataValue &&value)
UpdateOpsItemRequest &	AddOperationalData (const char *key, OpsItemDataValue &&value)
UpdateOpsItemRequest &	AddOperationalData (const char *key, const OpsItemDataValue &value)
const Aws::Vector< Aws::String > &	GetOperationalDataToDelete () const
bool	OperationalDataToDeleteHasBeenSet () const
void	SetOperationalDataToDelete (const Aws::Vector< Aws::String > &value)
void	SetOperationalDataToDelete (Aws::Vector< Aws::String > &&value)
UpdateOpsItemRequest &	WithOperationalDataToDelete (const Aws::Vector< Aws::String > &value)
UpdateOpsItemRequest &	WithOperationalDataToDelete (Aws::Vector< Aws::String > &&value)
UpdateOpsItemRequest &	AddOperationalDataToDelete (const Aws::String &value)
UpdateOpsItemRequest &	AddOperationalDataToDelete (Aws::String &&value)
UpdateOpsItemRequest &	AddOperationalDataToDelete (const char *value)
const Aws::Vector< OpsItemNotification > &	GetNotifications () const
bool	NotificationsHasBeenSet () const
void	SetNotifications (const Aws::Vector< OpsItemNotification > &value)
void	SetNotifications (Aws::Vector< OpsItemNotification > &&value)
UpdateOpsItemRequest &	WithNotifications (const Aws::Vector< OpsItemNotification > &value)
UpdateOpsItemRequest &	WithNotifications (Aws::Vector< OpsItemNotification > &&value)
UpdateOpsItemRequest &	AddNotifications (const OpsItemNotification &value)
UpdateOpsItemRequest &	AddNotifications (OpsItemNotification &&value)
int	GetPriority () const
bool	PriorityHasBeenSet () const
void	SetPriority (int value)
UpdateOpsItemRequest &	WithPriority (int value)
const Aws::Vector< RelatedOpsItem > &	GetRelatedOpsItems () const
bool	RelatedOpsItemsHasBeenSet () const
void	SetRelatedOpsItems (const Aws::Vector< RelatedOpsItem > &value)
void	SetRelatedOpsItems (Aws::Vector< RelatedOpsItem > &&value)
UpdateOpsItemRequest &	WithRelatedOpsItems (const Aws::Vector< RelatedOpsItem > &value)
UpdateOpsItemRequest &	WithRelatedOpsItems (Aws::Vector< RelatedOpsItem > &&value)
UpdateOpsItemRequest &	AddRelatedOpsItems (const RelatedOpsItem &value)
UpdateOpsItemRequest &	AddRelatedOpsItems (RelatedOpsItem &&value)
const OpsItemStatus &	GetStatus () const
bool	StatusHasBeenSet () const
void	SetStatus (const OpsItemStatus &value)
void	SetStatus (OpsItemStatus &&value)
UpdateOpsItemRequest &	WithStatus (const OpsItemStatus &value)
UpdateOpsItemRequest &	WithStatus (OpsItemStatus &&value)
const Aws::String &	GetOpsItemId () const
bool	OpsItemIdHasBeenSet () const
void	SetOpsItemId (const Aws::String &value)
void	SetOpsItemId (Aws::String &&value)
void	SetOpsItemId (const char *value)
UpdateOpsItemRequest &	WithOpsItemId (const Aws::String &value)
UpdateOpsItemRequest &	WithOpsItemId (Aws::String &&value)
UpdateOpsItemRequest &	WithOpsItemId (const char *value)
const Aws::String &	GetTitle () const
bool	TitleHasBeenSet () const
void	SetTitle (const Aws::String &value)
void	SetTitle (Aws::String &&value)
void	SetTitle (const char *value)
UpdateOpsItemRequest &	WithTitle (const Aws::String &value)
UpdateOpsItemRequest &	WithTitle (Aws::String &&value)
UpdateOpsItemRequest &	WithTitle (const char *value)
const Aws::String &	GetCategory () const
bool	CategoryHasBeenSet () const
void	SetCategory (const Aws::String &value)
void	SetCategory (Aws::String &&value)
void	SetCategory (const char *value)
UpdateOpsItemRequest &	WithCategory (const Aws::String &value)
UpdateOpsItemRequest &	WithCategory (Aws::String &&value)
UpdateOpsItemRequest &	WithCategory (const char *value)
const Aws::String &	GetSeverity () const
bool	SeverityHasBeenSet () const
void	SetSeverity (const Aws::String &value)
void	SetSeverity (Aws::String &&value)
void	SetSeverity (const char *value)
UpdateOpsItemRequest &	WithSeverity (const Aws::String &value)
UpdateOpsItemRequest &	WithSeverity (Aws::String &&value)
UpdateOpsItemRequest &	WithSeverity (const char *value)
const Aws::Utils::DateTime &	GetActualStartTime () const
bool	ActualStartTimeHasBeenSet () const
void	SetActualStartTime (const Aws::Utils::DateTime &value)
void	SetActualStartTime (Aws::Utils::DateTime &&value)
UpdateOpsItemRequest &	WithActualStartTime (const Aws::Utils::DateTime &value)
UpdateOpsItemRequest &	WithActualStartTime (Aws::Utils::DateTime &&value)
const Aws::Utils::DateTime &	GetActualEndTime () const
bool	ActualEndTimeHasBeenSet () const
void	SetActualEndTime (const Aws::Utils::DateTime &value)
void	SetActualEndTime (Aws::Utils::DateTime &&value)
UpdateOpsItemRequest &	WithActualEndTime (const Aws::Utils::DateTime &value)
UpdateOpsItemRequest &	WithActualEndTime (Aws::Utils::DateTime &&value)
const Aws::Utils::DateTime &	GetPlannedStartTime () const
bool	PlannedStartTimeHasBeenSet () const
void	SetPlannedStartTime (const Aws::Utils::DateTime &value)
void	SetPlannedStartTime (Aws::Utils::DateTime &&value)
UpdateOpsItemRequest &	WithPlannedStartTime (const Aws::Utils::DateTime &value)
UpdateOpsItemRequest &	WithPlannedStartTime (Aws::Utils::DateTime &&value)
const Aws::Utils::DateTime &	GetPlannedEndTime () const
bool	PlannedEndTimeHasBeenSet () const
void	SetPlannedEndTime (const Aws::Utils::DateTime &value)
void	SetPlannedEndTime (Aws::Utils::DateTime &&value)
UpdateOpsItemRequest &	WithPlannedEndTime (const Aws::Utils::DateTime &value)
UpdateOpsItemRequest &	WithPlannedEndTime (Aws::Utils::DateTime &&value)
Public Member Functions inherited from Aws::SSM::SSMRequest
virtual	~SSMRequest ()
void	AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
Aws::Http::HeaderValueCollection	GetHeaders () const override
Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
	AmazonSerializableWebServiceRequest ()
virtual	~AmazonSerializableWebServiceRequest ()
std::shared_ptr< Aws::IOStream >	GetBody () const override
Public Member Functions inherited from Aws::AmazonWebServiceRequest
	AmazonWebServiceRequest ()
virtual	~AmazonWebServiceRequest ()=default
virtual void	AddQueryStringParameters (Aws::Http::URI &uri) const
virtual void	PutToPresignedUrl (Aws::Http::URI &uri) const
virtual bool	IsStreaming () const
virtual bool	IsEventStreamRequest () const
virtual bool	SignBody () const
virtual bool	IsChunked () const
virtual void	SetRequestSignedHandler (const RequestSignedHandler &handler)
virtual const RequestSignedHandler &	GetRequestSignedHandler () const
const Aws::IOStreamFactory &	GetResponseStreamFactory () const
void	SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
virtual void	SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
virtual void	SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
virtual void	SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
virtual void	SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
virtual void	SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
virtual void	SetRequestRetryHandler (const RequestRetryHandler &handler)
virtual void	SetRequestRetryHandler (RequestRetryHandler &&handler)
virtual const Aws::Http::DataReceivedEventHandler &	GetDataReceivedEventHandler () const
virtual const Aws::Http::DataSentEventHandler &	GetDataSentEventHandler () const
virtual const Aws::Http::ContinueRequestHandler &	GetContinueRequestHandler () const
virtual const RequestRetryHandler &	GetRequestRetryHandler () const
virtual bool	ShouldComputeContentMd5 () const

Additional Inherited Members
Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void	DumpBodyToUrl (Aws::Http::URI &uri) const

Detailed Description

Definition at line 28 of file UpdateOpsItemRequest.h.

Constructor & Destructor Documentation

UpdateOpsItemRequest()

Aws::SSM::Model::UpdateOpsItemRequest::UpdateOpsItemRequest

(

)

Member Function Documentation

ActualEndTimeHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::ActualEndTimeHasBeenSet ( ) const

inline

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 827 of file UpdateOpsItemRequest.h.

ActualStartTimeHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::ActualStartTimeHasBeenSet ( ) const

inline

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 790 of file UpdateOpsItemRequest.h.

AddNotifications() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddNotifications ( const OpsItemNotification &  value )

inline

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

Definition at line 468 of file UpdateOpsItemRequest.h.

AddNotifications() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddNotifications ( OpsItemNotification &&  value )

inline

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

Definition at line 474 of file UpdateOpsItemRequest.h.

AddOperationalData() [1/6]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddOperationalData ( Aws::String &&  key, const OpsItemDataValue &  value  )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 283 of file UpdateOpsItemRequest.h.

AddOperationalData() [2/6]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddOperationalData ( Aws::String &&  key, OpsItemDataValue &&  value  )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 331 of file UpdateOpsItemRequest.h.

AddOperationalData() [3/6]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddOperationalData ( const Aws::String &  key, const OpsItemDataValue &  value  )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 259 of file UpdateOpsItemRequest.h.

AddOperationalData() [4/6]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddOperationalData ( const Aws::String &  key, OpsItemDataValue &&  value  )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 307 of file UpdateOpsItemRequest.h.

AddOperationalData() [5/6]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddOperationalData ( const char *  key, const OpsItemDataValue &  value  )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 379 of file UpdateOpsItemRequest.h.

AddOperationalData() [6/6]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddOperationalData ( const char *  key, OpsItemDataValue &&  value  )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 355 of file UpdateOpsItemRequest.h.

AddOperationalDataToDelete() [1/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddOperationalDataToDelete ( Aws::String &&  value )

inline

Keys that you want to remove from the OperationalData map.

Definition at line 420 of file UpdateOpsItemRequest.h.

AddOperationalDataToDelete() [2/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddOperationalDataToDelete ( const Aws::String &  value )

inline

Keys that you want to remove from the OperationalData map.

Definition at line 415 of file UpdateOpsItemRequest.h.

AddOperationalDataToDelete() [3/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddOperationalDataToDelete ( const char *  value )

inline

Keys that you want to remove from the OperationalData map.

Definition at line 425 of file UpdateOpsItemRequest.h.

AddRelatedOpsItems() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddRelatedOpsItems ( const RelatedOpsItem &  value )

inline

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.

Definition at line 549 of file UpdateOpsItemRequest.h.

AddRelatedOpsItems() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::AddRelatedOpsItems ( RelatedOpsItem &&  value )

inline

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.

Definition at line 556 of file UpdateOpsItemRequest.h.

CategoryHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::CategoryHasBeenSet ( ) const

inline

Specify a new category for an OpsItem.

Definition at line 706 of file UpdateOpsItemRequest.h.

DescriptionHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::DescriptionHasBeenSet ( ) const

inline

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Definition at line 54 of file UpdateOpsItemRequest.h.

GetActualEndTime()

const Aws::Utils::DateTime& Aws::SSM::Model::UpdateOpsItemRequest::GetActualEndTime ( ) const

inline

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 821 of file UpdateOpsItemRequest.h.

GetActualStartTime()

const Aws::Utils::DateTime& Aws::SSM::Model::UpdateOpsItemRequest::GetActualStartTime ( ) const

inline

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 784 of file UpdateOpsItemRequest.h.

GetCategory()

const Aws::String& Aws::SSM::Model::UpdateOpsItemRequest::GetCategory ( ) const

inline

Specify a new category for an OpsItem.

Definition at line 701 of file UpdateOpsItemRequest.h.

GetDescription()

const Aws::String& Aws::SSM::Model::UpdateOpsItemRequest::GetDescription ( ) const

inline

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Definition at line 48 of file UpdateOpsItemRequest.h.

GetNotifications()

const Aws::Vector<OpsItemNotification>& Aws::SSM::Model::UpdateOpsItemRequest::GetNotifications ( ) const

inline

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

Definition at line 432 of file UpdateOpsItemRequest.h.

GetOperationalData()

const Aws::Map<Aws::String, OpsItemDataValue>& Aws::SSM::Model::UpdateOpsItemRequest::GetOperationalData ( ) const

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 115 of file UpdateOpsItemRequest.h.

GetOperationalDataToDelete()

const Aws::Vector<Aws::String>& Aws::SSM::Model::UpdateOpsItemRequest::GetOperationalDataToDelete ( ) const

inline

Keys that you want to remove from the OperationalData map.

Definition at line 385 of file UpdateOpsItemRequest.h.

GetOpsItemId()

const Aws::String& Aws::SSM::Model::UpdateOpsItemRequest::GetOpsItemId ( ) const

inline

The ID of the OpsItem.

Definition at line 611 of file UpdateOpsItemRequest.h.

GetPlannedEndTime()

const Aws::Utils::DateTime& Aws::SSM::Model::UpdateOpsItemRequest::GetPlannedEndTime ( ) const

inline

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 902 of file UpdateOpsItemRequest.h.

GetPlannedStartTime()

const Aws::Utils::DateTime& Aws::SSM::Model::UpdateOpsItemRequest::GetPlannedStartTime ( ) const

inline

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 859 of file UpdateOpsItemRequest.h.

GetPriority()

int Aws::SSM::Model::UpdateOpsItemRequest::GetPriority ( ) const

inline

The importance of this OpsItem in relation to other OpsItems in the system.

Definition at line 481 of file UpdateOpsItemRequest.h.

GetRelatedOpsItems()

const Aws::Vector<RelatedOpsItem>& Aws::SSM::Model::UpdateOpsItemRequest::GetRelatedOpsItems ( ) const

inline

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.

Definition at line 507 of file UpdateOpsItemRequest.h.

GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SSM::Model::UpdateOpsItemRequest::GetRequestSpecificHeaders ( ) const

overridevirtual

Reimplemented from Aws::SSM::SSMRequest.

GetServiceRequestName()

virtual const char* Aws::SSM::Model::UpdateOpsItemRequest::GetServiceRequestName ( ) const

inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file UpdateOpsItemRequest.h.

GetSeverity()

const Aws::String& Aws::SSM::Model::UpdateOpsItemRequest::GetSeverity ( ) const

inline

Specify a new severity for an OpsItem.

Definition at line 742 of file UpdateOpsItemRequest.h.

GetStatus()

const OpsItemStatus& Aws::SSM::Model::UpdateOpsItemRequest::GetStatus ( ) const

inline

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.

Definition at line 565 of file UpdateOpsItemRequest.h.

GetTitle()

const Aws::String& Aws::SSM::Model::UpdateOpsItemRequest::GetTitle ( ) const

inline

A short heading that describes the nature of the OpsItem and the impacted resource.

Definition at line 653 of file UpdateOpsItemRequest.h.

NotificationsHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::NotificationsHasBeenSet ( ) const

inline

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

Definition at line 438 of file UpdateOpsItemRequest.h.

OperationalDataHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::OperationalDataHasBeenSet ( ) const

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 139 of file UpdateOpsItemRequest.h.

OperationalDataToDeleteHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::OperationalDataToDeleteHasBeenSet ( ) const

inline

Keys that you want to remove from the OperationalData map.

Definition at line 390 of file UpdateOpsItemRequest.h.

OpsItemIdHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::OpsItemIdHasBeenSet ( ) const

inline

The ID of the OpsItem.

Definition at line 616 of file UpdateOpsItemRequest.h.

PlannedEndTimeHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::PlannedEndTimeHasBeenSet ( ) const

inline

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 909 of file UpdateOpsItemRequest.h.

PlannedStartTimeHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::PlannedStartTimeHasBeenSet ( ) const

inline

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 866 of file UpdateOpsItemRequest.h.

PriorityHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::PriorityHasBeenSet ( ) const

inline

The importance of this OpsItem in relation to other OpsItems in the system.

Definition at line 487 of file UpdateOpsItemRequest.h.

RelatedOpsItemsHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::RelatedOpsItemsHasBeenSet ( ) const

inline

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.

Definition at line 514 of file UpdateOpsItemRequest.h.

SerializePayload()

Aws::String Aws::SSM::Model::UpdateOpsItemRequest::SerializePayload ( ) const

overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

SetActualEndTime() [1/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetActualEndTime ( Aws::Utils::DateTime &&  value )

inline

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 839 of file UpdateOpsItemRequest.h.

SetActualEndTime() [2/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetActualEndTime ( const Aws::Utils::DateTime &  value )

inline

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 833 of file UpdateOpsItemRequest.h.

SetActualStartTime() [1/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetActualStartTime ( Aws::Utils::DateTime &&  value )

inline

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 802 of file UpdateOpsItemRequest.h.

SetActualStartTime() [2/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetActualStartTime ( const Aws::Utils::DateTime &  value )

inline

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 796 of file UpdateOpsItemRequest.h.

SetCategory() [1/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetCategory ( Aws::String &&  value )

inline

Specify a new category for an OpsItem.

Definition at line 716 of file UpdateOpsItemRequest.h.

SetCategory() [2/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetCategory ( const Aws::String &  value )

inline

Specify a new category for an OpsItem.

Definition at line 711 of file UpdateOpsItemRequest.h.

SetCategory() [3/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetCategory ( const char *  value )

inline

Specify a new category for an OpsItem.

Definition at line 721 of file UpdateOpsItemRequest.h.

SetDescription() [1/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetDescription ( Aws::String &&  value )

inline

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Definition at line 66 of file UpdateOpsItemRequest.h.

SetDescription() [2/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetDescription ( const Aws::String &  value )

inline

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Definition at line 60 of file UpdateOpsItemRequest.h.

SetDescription() [3/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetDescription ( const char *  value )

inline

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Definition at line 72 of file UpdateOpsItemRequest.h.

SetNotifications() [1/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetNotifications ( Aws::Vector< OpsItemNotification > &&  value )

inline

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

Definition at line 450 of file UpdateOpsItemRequest.h.

SetNotifications() [2/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetNotifications ( const Aws::Vector< OpsItemNotification > &  value )

inline

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

Definition at line 444 of file UpdateOpsItemRequest.h.

SetOperationalData() [1/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetOperationalData ( Aws::Map< Aws::String, OpsItemDataValue > &&  value )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 187 of file UpdateOpsItemRequest.h.

SetOperationalData() [2/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetOperationalData ( const Aws::Map< Aws::String, OpsItemDataValue > &  value )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 163 of file UpdateOpsItemRequest.h.

SetOperationalDataToDelete() [1/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetOperationalDataToDelete ( Aws::Vector< Aws::String > &&  value )

inline

Keys that you want to remove from the OperationalData map.

Definition at line 400 of file UpdateOpsItemRequest.h.

SetOperationalDataToDelete() [2/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetOperationalDataToDelete ( const Aws::Vector< Aws::String > &  value )

inline

Keys that you want to remove from the OperationalData map.

Definition at line 395 of file UpdateOpsItemRequest.h.

SetOpsItemId() [1/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetOpsItemId ( Aws::String &&  value )

inline

The ID of the OpsItem.

Definition at line 626 of file UpdateOpsItemRequest.h.

SetOpsItemId() [2/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetOpsItemId ( const Aws::String &  value )

inline

The ID of the OpsItem.

Definition at line 621 of file UpdateOpsItemRequest.h.

SetOpsItemId() [3/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetOpsItemId ( const char *  value )

inline

The ID of the OpsItem.

Definition at line 631 of file UpdateOpsItemRequest.h.

SetPlannedEndTime() [1/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetPlannedEndTime ( Aws::Utils::DateTime &&  value )

inline

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 923 of file UpdateOpsItemRequest.h.

SetPlannedEndTime() [2/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetPlannedEndTime ( const Aws::Utils::DateTime &  value )

inline

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 916 of file UpdateOpsItemRequest.h.

SetPlannedStartTime() [1/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetPlannedStartTime ( Aws::Utils::DateTime &&  value )

inline

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 880 of file UpdateOpsItemRequest.h.

SetPlannedStartTime() [2/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetPlannedStartTime ( const Aws::Utils::DateTime &  value )

inline

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 873 of file UpdateOpsItemRequest.h.

SetPriority()

void Aws::SSM::Model::UpdateOpsItemRequest::SetPriority ( int  value )

inline

The importance of this OpsItem in relation to other OpsItems in the system.

Definition at line 493 of file UpdateOpsItemRequest.h.

SetRelatedOpsItems() [1/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetRelatedOpsItems ( Aws::Vector< RelatedOpsItem > &&  value )

inline

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.

Definition at line 528 of file UpdateOpsItemRequest.h.

SetRelatedOpsItems() [2/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetRelatedOpsItems ( const Aws::Vector< RelatedOpsItem > &  value )

inline

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.

Definition at line 521 of file UpdateOpsItemRequest.h.

SetSeverity() [1/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetSeverity ( Aws::String &&  value )

inline

Specify a new severity for an OpsItem.

Definition at line 757 of file UpdateOpsItemRequest.h.

SetSeverity() [2/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetSeverity ( const Aws::String &  value )

inline

Specify a new severity for an OpsItem.

Definition at line 752 of file UpdateOpsItemRequest.h.

SetSeverity() [3/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetSeverity ( const char *  value )

inline

Specify a new severity for an OpsItem.

Definition at line 762 of file UpdateOpsItemRequest.h.

SetStatus() [1/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetStatus ( const OpsItemStatus &  value )

inline

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.

Definition at line 581 of file UpdateOpsItemRequest.h.

SetStatus() [2/2]

void Aws::SSM::Model::UpdateOpsItemRequest::SetStatus ( OpsItemStatus &&  value )

inline

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.

Definition at line 589 of file UpdateOpsItemRequest.h.

SetTitle() [1/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetTitle ( Aws::String &&  value )

inline

A short heading that describes the nature of the OpsItem and the impacted resource.

Definition at line 671 of file UpdateOpsItemRequest.h.

SetTitle() [2/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetTitle ( const Aws::String &  value )

inline

A short heading that describes the nature of the OpsItem and the impacted resource.

Definition at line 665 of file UpdateOpsItemRequest.h.

SetTitle() [3/3]

void Aws::SSM::Model::UpdateOpsItemRequest::SetTitle ( const char *  value )

inline

A short heading that describes the nature of the OpsItem and the impacted resource.

Definition at line 677 of file UpdateOpsItemRequest.h.

SeverityHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::SeverityHasBeenSet ( ) const

inline

Specify a new severity for an OpsItem.

Definition at line 747 of file UpdateOpsItemRequest.h.

StatusHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::StatusHasBeenSet ( ) const

inline

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.

Definition at line 573 of file UpdateOpsItemRequest.h.

TitleHasBeenSet()

bool Aws::SSM::Model::UpdateOpsItemRequest::TitleHasBeenSet ( ) const

inline

A short heading that describes the nature of the OpsItem and the impacted resource.

Definition at line 659 of file UpdateOpsItemRequest.h.

WithActualEndTime() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithActualEndTime ( Aws::Utils::DateTime &&  value )

inline

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 851 of file UpdateOpsItemRequest.h.

WithActualEndTime() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithActualEndTime ( const Aws::Utils::DateTime &  value )

inline

The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 845 of file UpdateOpsItemRequest.h.

WithActualStartTime() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithActualStartTime ( Aws::Utils::DateTime &&  value )

inline

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 814 of file UpdateOpsItemRequest.h.

WithActualStartTime() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithActualStartTime ( const Aws::Utils::DateTime &  value )

inline

The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest.

Definition at line 808 of file UpdateOpsItemRequest.h.

WithCategory() [1/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithCategory ( Aws::String &&  value )

inline

Specify a new category for an OpsItem.

Definition at line 731 of file UpdateOpsItemRequest.h.

WithCategory() [2/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithCategory ( const Aws::String &  value )

inline

Specify a new category for an OpsItem.

Definition at line 726 of file UpdateOpsItemRequest.h.

WithCategory() [3/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithCategory ( const char *  value )

inline

Specify a new category for an OpsItem.

Definition at line 736 of file UpdateOpsItemRequest.h.

WithDescription() [1/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithDescription ( Aws::String &&  value )

inline

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Definition at line 84 of file UpdateOpsItemRequest.h.

WithDescription() [2/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithDescription ( const Aws::String &  value )

inline

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Definition at line 78 of file UpdateOpsItemRequest.h.

WithDescription() [3/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithDescription ( const char *  value )

inline

Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.

Definition at line 90 of file UpdateOpsItemRequest.h.

WithNotifications() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithNotifications ( Aws::Vector< OpsItemNotification > &&  value )

inline

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

Definition at line 462 of file UpdateOpsItemRequest.h.

WithNotifications() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithNotifications ( const Aws::Vector< OpsItemNotification > &  value )

inline

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

Definition at line 456 of file UpdateOpsItemRequest.h.

WithOperationalData() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithOperationalData ( Aws::Map< Aws::String, OpsItemDataValue > &&  value )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 235 of file UpdateOpsItemRequest.h.

WithOperationalData() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithOperationalData ( const Aws::Map< Aws::String, OpsItemDataValue > &  value )

inline

Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.

Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.

Operational data keys can't begin with the following: amazon, aws, amzn, ssm, /amazon, /aws, /amzn, /ssm.

You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.

Definition at line 211 of file UpdateOpsItemRequest.h.

WithOperationalDataToDelete() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithOperationalDataToDelete ( Aws::Vector< Aws::String > &&  value )

inline

Keys that you want to remove from the OperationalData map.

Definition at line 410 of file UpdateOpsItemRequest.h.

WithOperationalDataToDelete() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithOperationalDataToDelete ( const Aws::Vector< Aws::String > &  value )

inline

Keys that you want to remove from the OperationalData map.

Definition at line 405 of file UpdateOpsItemRequest.h.

WithOpsItemId() [1/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithOpsItemId ( Aws::String &&  value )

inline

The ID of the OpsItem.

Definition at line 641 of file UpdateOpsItemRequest.h.

WithOpsItemId() [2/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithOpsItemId ( const Aws::String &  value )

inline

The ID of the OpsItem.

Definition at line 636 of file UpdateOpsItemRequest.h.

WithOpsItemId() [3/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithOpsItemId ( const char *  value )

inline

The ID of the OpsItem.

Definition at line 646 of file UpdateOpsItemRequest.h.

WithPlannedEndTime() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithPlannedEndTime ( Aws::Utils::DateTime &&  value )

inline

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 937 of file UpdateOpsItemRequest.h.

WithPlannedEndTime() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithPlannedEndTime ( const Aws::Utils::DateTime &  value )

inline

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 930 of file UpdateOpsItemRequest.h.

WithPlannedStartTime() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithPlannedStartTime ( Aws::Utils::DateTime &&  value )

inline

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 894 of file UpdateOpsItemRequest.h.

WithPlannedStartTime() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithPlannedStartTime ( const Aws::Utils::DateTime &  value )

inline

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

Definition at line 887 of file UpdateOpsItemRequest.h.

WithPriority()

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithPriority ( int  value )

inline

The importance of this OpsItem in relation to other OpsItems in the system.

Definition at line 499 of file UpdateOpsItemRequest.h.

WithRelatedOpsItems() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithRelatedOpsItems ( Aws::Vector< RelatedOpsItem > &&  value )

inline

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.

Definition at line 542 of file UpdateOpsItemRequest.h.

WithRelatedOpsItems() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithRelatedOpsItems ( const Aws::Vector< RelatedOpsItem > &  value )

inline

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.

Definition at line 535 of file UpdateOpsItemRequest.h.

WithSeverity() [1/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithSeverity ( Aws::String &&  value )

inline

Specify a new severity for an OpsItem.

Definition at line 772 of file UpdateOpsItemRequest.h.

WithSeverity() [2/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithSeverity ( const Aws::String &  value )

inline

Specify a new severity for an OpsItem.

Definition at line 767 of file UpdateOpsItemRequest.h.

WithSeverity() [3/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithSeverity ( const char *  value )

inline

Specify a new severity for an OpsItem.

Definition at line 777 of file UpdateOpsItemRequest.h.

WithStatus() [1/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithStatus ( const OpsItemStatus &  value )

inline

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.

Definition at line 597 of file UpdateOpsItemRequest.h.

WithStatus() [2/2]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithStatus ( OpsItemStatus &&  value )

inline

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.

Definition at line 605 of file UpdateOpsItemRequest.h.

WithTitle() [1/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithTitle ( Aws::String &&  value )

inline

A short heading that describes the nature of the OpsItem and the impacted resource.

Definition at line 689 of file UpdateOpsItemRequest.h.

WithTitle() [2/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithTitle ( const Aws::String &  value )

inline

A short heading that describes the nature of the OpsItem and the impacted resource.

Definition at line 683 of file UpdateOpsItemRequest.h.

WithTitle() [3/3]

UpdateOpsItemRequest& Aws::SSM::Model::UpdateOpsItemRequest::WithTitle ( const char *  value )

inline

A short heading that describes the nature of the OpsItem and the impacted resource.

Definition at line 695 of file UpdateOpsItemRequest.h.

---

The documentation for this class was generated from the following file:

• aws-cpp-sdk-ssm/include/aws/ssm/model/UpdateOpsItemRequest.h