AWS SDK for C++  1.8.60
AWS SDK for C++
Public Member Functions | List of all members
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::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
UpdateOpsItemRequestWithDescription (const Aws::String &value)
 
UpdateOpsItemRequestWithDescription (Aws::String &&value)
 
UpdateOpsItemRequestWithDescription (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)
 
UpdateOpsItemRequestWithOperationalData (const Aws::Map< Aws::String, OpsItemDataValue > &value)
 
UpdateOpsItemRequestWithOperationalData (Aws::Map< Aws::String, OpsItemDataValue > &&value)
 
UpdateOpsItemRequestAddOperationalData (const Aws::String &key, const OpsItemDataValue &value)
 
UpdateOpsItemRequestAddOperationalData (Aws::String &&key, const OpsItemDataValue &value)
 
UpdateOpsItemRequestAddOperationalData (const Aws::String &key, OpsItemDataValue &&value)
 
UpdateOpsItemRequestAddOperationalData (Aws::String &&key, OpsItemDataValue &&value)
 
UpdateOpsItemRequestAddOperationalData (const char *key, OpsItemDataValue &&value)
 
UpdateOpsItemRequestAddOperationalData (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)
 
UpdateOpsItemRequestWithOperationalDataToDelete (const Aws::Vector< Aws::String > &value)
 
UpdateOpsItemRequestWithOperationalDataToDelete (Aws::Vector< Aws::String > &&value)
 
UpdateOpsItemRequestAddOperationalDataToDelete (const Aws::String &value)
 
UpdateOpsItemRequestAddOperationalDataToDelete (Aws::String &&value)
 
UpdateOpsItemRequestAddOperationalDataToDelete (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)
 
UpdateOpsItemRequestWithNotifications (const Aws::Vector< OpsItemNotification > &value)
 
UpdateOpsItemRequestWithNotifications (Aws::Vector< OpsItemNotification > &&value)
 
UpdateOpsItemRequestAddNotifications (const OpsItemNotification &value)
 
UpdateOpsItemRequestAddNotifications (OpsItemNotification &&value)
 
int GetPriority () const
 
bool PriorityHasBeenSet () const
 
void SetPriority (int value)
 
UpdateOpsItemRequestWithPriority (int value)
 
const Aws::Vector< RelatedOpsItem > & GetRelatedOpsItems () const
 
bool RelatedOpsItemsHasBeenSet () const
 
void SetRelatedOpsItems (const Aws::Vector< RelatedOpsItem > &value)
 
void SetRelatedOpsItems (Aws::Vector< RelatedOpsItem > &&value)
 
UpdateOpsItemRequestWithRelatedOpsItems (const Aws::Vector< RelatedOpsItem > &value)
 
UpdateOpsItemRequestWithRelatedOpsItems (Aws::Vector< RelatedOpsItem > &&value)
 
UpdateOpsItemRequestAddRelatedOpsItems (const RelatedOpsItem &value)
 
UpdateOpsItemRequestAddRelatedOpsItems (RelatedOpsItem &&value)
 
const OpsItemStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const OpsItemStatus &value)
 
void SetStatus (OpsItemStatus &&value)
 
UpdateOpsItemRequestWithStatus (const OpsItemStatus &value)
 
UpdateOpsItemRequestWithStatus (OpsItemStatus &&value)
 
const Aws::StringGetOpsItemId () const
 
bool OpsItemIdHasBeenSet () const
 
void SetOpsItemId (const Aws::String &value)
 
void SetOpsItemId (Aws::String &&value)
 
void SetOpsItemId (const char *value)
 
UpdateOpsItemRequestWithOpsItemId (const Aws::String &value)
 
UpdateOpsItemRequestWithOpsItemId (Aws::String &&value)
 
UpdateOpsItemRequestWithOpsItemId (const char *value)
 
const Aws::StringGetTitle () const
 
bool TitleHasBeenSet () const
 
void SetTitle (const Aws::String &value)
 
void SetTitle (Aws::String &&value)
 
void SetTitle (const char *value)
 
UpdateOpsItemRequestWithTitle (const Aws::String &value)
 
UpdateOpsItemRequestWithTitle (Aws::String &&value)
 
UpdateOpsItemRequestWithTitle (const char *value)
 
const Aws::StringGetCategory () const
 
bool CategoryHasBeenSet () const
 
void SetCategory (const Aws::String &value)
 
void SetCategory (Aws::String &&value)
 
void SetCategory (const char *value)
 
UpdateOpsItemRequestWithCategory (const Aws::String &value)
 
UpdateOpsItemRequestWithCategory (Aws::String &&value)
 
UpdateOpsItemRequestWithCategory (const char *value)
 
const Aws::StringGetSeverity () const
 
bool SeverityHasBeenSet () const
 
void SetSeverity (const Aws::String &value)
 
void SetSeverity (Aws::String &&value)
 
void SetSeverity (const char *value)
 
UpdateOpsItemRequestWithSeverity (const Aws::String &value)
 
UpdateOpsItemRequestWithSeverity (Aws::String &&value)
 
UpdateOpsItemRequestWithSeverity (const char *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::IOStreamGetBody () 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 RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () 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::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () 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 27 of file UpdateOpsItemRequest.h.

Constructor & Destructor Documentation

◆ UpdateOpsItemRequest()

Aws::SSM::Model::UpdateOpsItemRequest::UpdateOpsItemRequest ( )

Member Function Documentation

◆ 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 467 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 473 of file UpdateOpsItemRequest.h.

◆ AddOperationalData() [1/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 258 of file UpdateOpsItemRequest.h.

◆ AddOperationalData() [2/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 282 of file UpdateOpsItemRequest.h.

◆ AddOperationalData() [3/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 306 of file UpdateOpsItemRequest.h.

◆ AddOperationalData() [4/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 330 of file UpdateOpsItemRequest.h.

◆ AddOperationalData() [5/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 354 of file UpdateOpsItemRequest.h.

◆ AddOperationalData() [6/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 378 of file UpdateOpsItemRequest.h.

◆ AddOperationalDataToDelete() [1/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 414 of file UpdateOpsItemRequest.h.

◆ AddOperationalDataToDelete() [2/3]

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

Keys that you want to remove from the OperationalData map.

Definition at line 419 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 424 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 548 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 555 of file UpdateOpsItemRequest.h.

◆ CategoryHasBeenSet()

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

Specify a new category for an OpsItem.

Definition at line 705 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 53 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 700 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 47 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 431 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 114 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 384 of file UpdateOpsItemRequest.h.

◆ GetOpsItemId()

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

The ID of the OpsItem.

Definition at line 610 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 480 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 506 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 36 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 741 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 564 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 652 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 437 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 138 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 389 of file UpdateOpsItemRequest.h.

◆ OpsItemIdHasBeenSet()

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

The ID of the OpsItem.

Definition at line 615 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 486 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 513 of file UpdateOpsItemRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCategory() [1/3]

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

Specify a new category for an OpsItem.

Definition at line 710 of file UpdateOpsItemRequest.h.

◆ SetCategory() [2/3]

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

Specify a new category for an OpsItem.

Definition at line 715 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 720 of file UpdateOpsItemRequest.h.

◆ SetDescription() [1/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 59 of file UpdateOpsItemRequest.h.

◆ SetDescription() [2/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 65 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 71 of file UpdateOpsItemRequest.h.

◆ SetNotifications() [1/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 443 of file UpdateOpsItemRequest.h.

◆ SetNotifications() [2/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 449 of file UpdateOpsItemRequest.h.

◆ SetOperationalData() [1/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 162 of file UpdateOpsItemRequest.h.

◆ SetOperationalData() [2/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 186 of file UpdateOpsItemRequest.h.

◆ SetOperationalDataToDelete() [1/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 394 of file UpdateOpsItemRequest.h.

◆ SetOperationalDataToDelete() [2/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 399 of file UpdateOpsItemRequest.h.

◆ SetOpsItemId() [1/3]

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

The ID of the OpsItem.

Definition at line 620 of file UpdateOpsItemRequest.h.

◆ SetOpsItemId() [2/3]

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

The ID of the OpsItem.

Definition at line 625 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 630 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 492 of file UpdateOpsItemRequest.h.

◆ SetRelatedOpsItems() [1/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 520 of file UpdateOpsItemRequest.h.

◆ SetRelatedOpsItems() [2/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 527 of file UpdateOpsItemRequest.h.

◆ SetSeverity() [1/3]

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

Specify a new severity for an OpsItem.

Definition at line 751 of file UpdateOpsItemRequest.h.

◆ SetSeverity() [2/3]

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

Specify a new severity for an OpsItem.

Definition at line 756 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 761 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 580 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 588 of file UpdateOpsItemRequest.h.

◆ SetTitle() [1/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 664 of file UpdateOpsItemRequest.h.

◆ SetTitle() [2/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 670 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 676 of file UpdateOpsItemRequest.h.

◆ SeverityHasBeenSet()

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

Specify a new severity for an OpsItem.

Definition at line 746 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 572 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 658 of file UpdateOpsItemRequest.h.

◆ WithCategory() [1/3]

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

Specify a new category for an OpsItem.

Definition at line 725 of file UpdateOpsItemRequest.h.

◆ WithCategory() [2/3]

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

Specify a new category for an OpsItem.

Definition at line 730 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 735 of file UpdateOpsItemRequest.h.

◆ WithDescription() [1/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 77 of file UpdateOpsItemRequest.h.

◆ WithDescription() [2/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 83 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 89 of file UpdateOpsItemRequest.h.

◆ WithNotifications() [1/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 455 of file UpdateOpsItemRequest.h.

◆ WithNotifications() [2/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 461 of file UpdateOpsItemRequest.h.

◆ WithOperationalData() [1/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 210 of file UpdateOpsItemRequest.h.

◆ WithOperationalData() [2/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 234 of file UpdateOpsItemRequest.h.

◆ WithOperationalDataToDelete() [1/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 404 of file UpdateOpsItemRequest.h.

◆ WithOperationalDataToDelete() [2/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 409 of file UpdateOpsItemRequest.h.

◆ WithOpsItemId() [1/3]

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

The ID of the OpsItem.

Definition at line 635 of file UpdateOpsItemRequest.h.

◆ WithOpsItemId() [2/3]

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

The ID of the OpsItem.

Definition at line 640 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 645 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 498 of file UpdateOpsItemRequest.h.

◆ WithRelatedOpsItems() [1/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 534 of file UpdateOpsItemRequest.h.

◆ WithRelatedOpsItems() [2/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 541 of file UpdateOpsItemRequest.h.

◆ WithSeverity() [1/3]

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

Specify a new severity for an OpsItem.

Definition at line 766 of file UpdateOpsItemRequest.h.

◆ WithSeverity() [2/3]

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

Specify a new severity for an OpsItem.

Definition at line 771 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 776 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 596 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 604 of file UpdateOpsItemRequest.h.

◆ WithTitle() [1/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 682 of file UpdateOpsItemRequest.h.

◆ WithTitle() [2/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 688 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 694 of file UpdateOpsItemRequest.h.


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