AWS SDK for C++  1.9.40
AWS SDK for C++
Public Member Functions | List of all members
Aws::SSM::Model::OpsItem Class Reference

#include <OpsItem.h>

Public Member Functions

 OpsItem ()
 
 OpsItem (Aws::Utils::Json::JsonView jsonValue)
 
OpsItemoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetCreatedBy () const
 
bool CreatedByHasBeenSet () const
 
void SetCreatedBy (const Aws::String &value)
 
void SetCreatedBy (Aws::String &&value)
 
void SetCreatedBy (const char *value)
 
OpsItemWithCreatedBy (const Aws::String &value)
 
OpsItemWithCreatedBy (Aws::String &&value)
 
OpsItemWithCreatedBy (const char *value)
 
const Aws::StringGetOpsItemType () const
 
bool OpsItemTypeHasBeenSet () const
 
void SetOpsItemType (const Aws::String &value)
 
void SetOpsItemType (Aws::String &&value)
 
void SetOpsItemType (const char *value)
 
OpsItemWithOpsItemType (const Aws::String &value)
 
OpsItemWithOpsItemType (Aws::String &&value)
 
OpsItemWithOpsItemType (const char *value)
 
const Aws::Utils::DateTimeGetCreatedTime () const
 
bool CreatedTimeHasBeenSet () const
 
void SetCreatedTime (const Aws::Utils::DateTime &value)
 
void SetCreatedTime (Aws::Utils::DateTime &&value)
 
OpsItemWithCreatedTime (const Aws::Utils::DateTime &value)
 
OpsItemWithCreatedTime (Aws::Utils::DateTime &&value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
OpsItemWithDescription (const Aws::String &value)
 
OpsItemWithDescription (Aws::String &&value)
 
OpsItemWithDescription (const char *value)
 
const Aws::StringGetLastModifiedBy () const
 
bool LastModifiedByHasBeenSet () const
 
void SetLastModifiedBy (const Aws::String &value)
 
void SetLastModifiedBy (Aws::String &&value)
 
void SetLastModifiedBy (const char *value)
 
OpsItemWithLastModifiedBy (const Aws::String &value)
 
OpsItemWithLastModifiedBy (Aws::String &&value)
 
OpsItemWithLastModifiedBy (const char *value)
 
const Aws::Utils::DateTimeGetLastModifiedTime () const
 
bool LastModifiedTimeHasBeenSet () const
 
void SetLastModifiedTime (const Aws::Utils::DateTime &value)
 
void SetLastModifiedTime (Aws::Utils::DateTime &&value)
 
OpsItemWithLastModifiedTime (const Aws::Utils::DateTime &value)
 
OpsItemWithLastModifiedTime (Aws::Utils::DateTime &&value)
 
const Aws::Vector< OpsItemNotification > & GetNotifications () const
 
bool NotificationsHasBeenSet () const
 
void SetNotifications (const Aws::Vector< OpsItemNotification > &value)
 
void SetNotifications (Aws::Vector< OpsItemNotification > &&value)
 
OpsItemWithNotifications (const Aws::Vector< OpsItemNotification > &value)
 
OpsItemWithNotifications (Aws::Vector< OpsItemNotification > &&value)
 
OpsItemAddNotifications (const OpsItemNotification &value)
 
OpsItemAddNotifications (OpsItemNotification &&value)
 
int GetPriority () const
 
bool PriorityHasBeenSet () const
 
void SetPriority (int value)
 
OpsItemWithPriority (int value)
 
const Aws::Vector< RelatedOpsItem > & GetRelatedOpsItems () const
 
bool RelatedOpsItemsHasBeenSet () const
 
void SetRelatedOpsItems (const Aws::Vector< RelatedOpsItem > &value)
 
void SetRelatedOpsItems (Aws::Vector< RelatedOpsItem > &&value)
 
OpsItemWithRelatedOpsItems (const Aws::Vector< RelatedOpsItem > &value)
 
OpsItemWithRelatedOpsItems (Aws::Vector< RelatedOpsItem > &&value)
 
OpsItemAddRelatedOpsItems (const RelatedOpsItem &value)
 
OpsItemAddRelatedOpsItems (RelatedOpsItem &&value)
 
const OpsItemStatusGetStatus () const
 
bool StatusHasBeenSet () const
 
void SetStatus (const OpsItemStatus &value)
 
void SetStatus (OpsItemStatus &&value)
 
OpsItemWithStatus (const OpsItemStatus &value)
 
OpsItemWithStatus (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)
 
OpsItemWithOpsItemId (const Aws::String &value)
 
OpsItemWithOpsItemId (Aws::String &&value)
 
OpsItemWithOpsItemId (const char *value)
 
const Aws::StringGetVersion () const
 
bool VersionHasBeenSet () const
 
void SetVersion (const Aws::String &value)
 
void SetVersion (Aws::String &&value)
 
void SetVersion (const char *value)
 
OpsItemWithVersion (const Aws::String &value)
 
OpsItemWithVersion (Aws::String &&value)
 
OpsItemWithVersion (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)
 
OpsItemWithTitle (const Aws::String &value)
 
OpsItemWithTitle (Aws::String &&value)
 
OpsItemWithTitle (const char *value)
 
const Aws::StringGetSource () const
 
bool SourceHasBeenSet () const
 
void SetSource (const Aws::String &value)
 
void SetSource (Aws::String &&value)
 
void SetSource (const char *value)
 
OpsItemWithSource (const Aws::String &value)
 
OpsItemWithSource (Aws::String &&value)
 
OpsItemWithSource (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)
 
OpsItemWithOperationalData (const Aws::Map< Aws::String, OpsItemDataValue > &value)
 
OpsItemWithOperationalData (Aws::Map< Aws::String, OpsItemDataValue > &&value)
 
OpsItemAddOperationalData (const Aws::String &key, const OpsItemDataValue &value)
 
OpsItemAddOperationalData (Aws::String &&key, const OpsItemDataValue &value)
 
OpsItemAddOperationalData (const Aws::String &key, OpsItemDataValue &&value)
 
OpsItemAddOperationalData (Aws::String &&key, OpsItemDataValue &&value)
 
OpsItemAddOperationalData (const char *key, OpsItemDataValue &&value)
 
OpsItemAddOperationalData (const char *key, const OpsItemDataValue &value)
 
const Aws::StringGetCategory () const
 
bool CategoryHasBeenSet () const
 
void SetCategory (const Aws::String &value)
 
void SetCategory (Aws::String &&value)
 
void SetCategory (const char *value)
 
OpsItemWithCategory (const Aws::String &value)
 
OpsItemWithCategory (Aws::String &&value)
 
OpsItemWithCategory (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)
 
OpsItemWithSeverity (const Aws::String &value)
 
OpsItemWithSeverity (Aws::String &&value)
 
OpsItemWithSeverity (const char *value)
 
const Aws::Utils::DateTimeGetActualStartTime () const
 
bool ActualStartTimeHasBeenSet () const
 
void SetActualStartTime (const Aws::Utils::DateTime &value)
 
void SetActualStartTime (Aws::Utils::DateTime &&value)
 
OpsItemWithActualStartTime (const Aws::Utils::DateTime &value)
 
OpsItemWithActualStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetActualEndTime () const
 
bool ActualEndTimeHasBeenSet () const
 
void SetActualEndTime (const Aws::Utils::DateTime &value)
 
void SetActualEndTime (Aws::Utils::DateTime &&value)
 
OpsItemWithActualEndTime (const Aws::Utils::DateTime &value)
 
OpsItemWithActualEndTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetPlannedStartTime () const
 
bool PlannedStartTimeHasBeenSet () const
 
void SetPlannedStartTime (const Aws::Utils::DateTime &value)
 
void SetPlannedStartTime (Aws::Utils::DateTime &&value)
 
OpsItemWithPlannedStartTime (const Aws::Utils::DateTime &value)
 
OpsItemWithPlannedStartTime (Aws::Utils::DateTime &&value)
 
const Aws::Utils::DateTimeGetPlannedEndTime () const
 
bool PlannedEndTimeHasBeenSet () const
 
void SetPlannedEndTime (const Aws::Utils::DateTime &value)
 
void SetPlannedEndTime (Aws::Utils::DateTime &&value)
 
OpsItemWithPlannedEndTime (const Aws::Utils::DateTime &value)
 
OpsItemWithPlannedEndTime (Aws::Utils::DateTime &&value)
 

Detailed Description

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

See Also:

AWS API Reference

Definition at line 43 of file OpsItem.h.

Constructor & Destructor Documentation

◆ OpsItem() [1/2]

Aws::SSM::Model::OpsItem::OpsItem ( )

◆ OpsItem() [2/2]

Aws::SSM::Model::OpsItem::OpsItem ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ActualEndTimeHasBeenSet()

bool Aws::SSM::Model::OpsItem::ActualEndTimeHasBeenSet ( ) const
inline

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

Definition at line 1056 of file OpsItem.h.

◆ ActualStartTimeHasBeenSet()

bool Aws::SSM::Model::OpsItem::ActualStartTimeHasBeenSet ( ) const
inline

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

Definition at line 1019 of file OpsItem.h.

◆ AddNotifications() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::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 326 of file OpsItem.h.

◆ AddNotifications() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::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 332 of file OpsItem.h.

◆ AddOperationalData() [1/6]

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

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 828 of file OpsItem.h.

◆ AddOperationalData() [2/6]

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

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 872 of file OpsItem.h.

◆ AddOperationalData() [3/6]

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

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 806 of file OpsItem.h.

◆ AddOperationalData() [4/6]

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

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 850 of file OpsItem.h.

◆ AddOperationalData() [5/6]

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

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 916 of file OpsItem.h.

◆ AddOperationalData() [6/6]

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

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 894 of file OpsItem.h.

◆ AddRelatedOpsItems() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::AddRelatedOpsItems ( const RelatedOpsItem value)
inline

One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

Definition at line 407 of file OpsItem.h.

◆ AddRelatedOpsItems() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::AddRelatedOpsItems ( RelatedOpsItem &&  value)
inline

One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

Definition at line 414 of file OpsItem.h.

◆ CategoryHasBeenSet()

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

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Definition at line 929 of file OpsItem.h.

◆ CreatedByHasBeenSet()

bool Aws::SSM::Model::OpsItem::CreatedByHasBeenSet ( ) const
inline

The ARN of the AWS account that created the OpsItem.

Definition at line 60 of file OpsItem.h.

◆ CreatedTimeHasBeenSet()

bool Aws::SSM::Model::OpsItem::CreatedTimeHasBeenSet ( ) const
inline

The date and time the OpsItem was created.

Definition at line 150 of file OpsItem.h.

◆ DescriptionHasBeenSet()

bool Aws::SSM::Model::OpsItem::DescriptionHasBeenSet ( ) const
inline

The OpsItem description.

Definition at line 181 of file OpsItem.h.

◆ GetActualEndTime()

const Aws::Utils::DateTime& Aws::SSM::Model::OpsItem::GetActualEndTime ( ) const
inline

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

Definition at line 1050 of file OpsItem.h.

◆ GetActualStartTime()

const Aws::Utils::DateTime& Aws::SSM::Model::OpsItem::GetActualStartTime ( ) const
inline

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

Definition at line 1013 of file OpsItem.h.

◆ GetCategory()

const Aws::String& Aws::SSM::Model::OpsItem::GetCategory ( ) const
inline

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Definition at line 923 of file OpsItem.h.

◆ GetCreatedBy()

const Aws::String& Aws::SSM::Model::OpsItem::GetCreatedBy ( ) const
inline

The ARN of the AWS account that created the OpsItem.

Definition at line 55 of file OpsItem.h.

◆ GetCreatedTime()

const Aws::Utils::DateTime& Aws::SSM::Model::OpsItem::GetCreatedTime ( ) const
inline

The date and time the OpsItem was created.

Definition at line 145 of file OpsItem.h.

◆ GetDescription()

const Aws::String& Aws::SSM::Model::OpsItem::GetDescription ( ) const
inline

The OpsItem description.

Definition at line 176 of file OpsItem.h.

◆ GetLastModifiedBy()

const Aws::String& Aws::SSM::Model::OpsItem::GetLastModifiedBy ( ) const
inline

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

Definition at line 217 of file OpsItem.h.

◆ GetLastModifiedTime()

const Aws::Utils::DateTime& Aws::SSM::Model::OpsItem::GetLastModifiedTime ( ) const
inline

The date and time the OpsItem was last updated.

Definition at line 258 of file OpsItem.h.

◆ GetNotifications()

const Aws::Vector<OpsItemNotification>& Aws::SSM::Model::OpsItem::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 290 of file OpsItem.h.

◆ GetOperationalData()

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

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 674 of file OpsItem.h.

◆ GetOpsItemId()

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

The ID of the OpsItem.

Definition at line 469 of file OpsItem.h.

◆ GetOpsItemType()

const Aws::String& Aws::SSM::Model::OpsItem::GetOpsItemType ( ) const
inline

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Definition at line 97 of file OpsItem.h.

◆ GetPlannedEndTime()

const Aws::Utils::DateTime& Aws::SSM::Model::OpsItem::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 1131 of file OpsItem.h.

◆ GetPlannedStartTime()

const Aws::Utils::DateTime& Aws::SSM::Model::OpsItem::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 1088 of file OpsItem.h.

◆ GetPriority()

int Aws::SSM::Model::OpsItem::GetPriority ( ) const
inline

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

Definition at line 339 of file OpsItem.h.

◆ GetRelatedOpsItems()

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

One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

Definition at line 365 of file OpsItem.h.

◆ GetSeverity()

const Aws::String& Aws::SSM::Model::OpsItem::GetSeverity ( ) const
inline

The severity of the OpsItem. Severity options range from 1 to 4.

Definition at line 971 of file OpsItem.h.

◆ GetSource()

const Aws::String& Aws::SSM::Model::OpsItem::GetSource ( ) const
inline

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

Definition at line 609 of file OpsItem.h.

◆ GetStatus()

const OpsItemStatus& Aws::SSM::Model::OpsItem::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 423 of file OpsItem.h.

◆ GetTitle()

const Aws::String& Aws::SSM::Model::OpsItem::GetTitle ( ) const
inline

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

Definition at line 560 of file OpsItem.h.

◆ GetVersion()

const Aws::String& Aws::SSM::Model::OpsItem::GetVersion ( ) const
inline

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Definition at line 511 of file OpsItem.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::SSM::Model::OpsItem::Jsonize ( ) const

◆ LastModifiedByHasBeenSet()

bool Aws::SSM::Model::OpsItem::LastModifiedByHasBeenSet ( ) const
inline

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

Definition at line 222 of file OpsItem.h.

◆ LastModifiedTimeHasBeenSet()

bool Aws::SSM::Model::OpsItem::LastModifiedTimeHasBeenSet ( ) const
inline

The date and time the OpsItem was last updated.

Definition at line 263 of file OpsItem.h.

◆ NotificationsHasBeenSet()

bool Aws::SSM::Model::OpsItem::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 296 of file OpsItem.h.

◆ OperationalDataHasBeenSet()

bool Aws::SSM::Model::OpsItem::OperationalDataHasBeenSet ( ) const
inline

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 696 of file OpsItem.h.

◆ operator=()

OpsItem& Aws::SSM::Model::OpsItem::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OpsItemIdHasBeenSet()

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

The ID of the OpsItem.

Definition at line 474 of file OpsItem.h.

◆ OpsItemTypeHasBeenSet()

bool Aws::SSM::Model::OpsItem::OpsItemTypeHasBeenSet ( ) const
inline

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Definition at line 103 of file OpsItem.h.

◆ PlannedEndTimeHasBeenSet()

bool Aws::SSM::Model::OpsItem::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 1138 of file OpsItem.h.

◆ PlannedStartTimeHasBeenSet()

bool Aws::SSM::Model::OpsItem::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 1095 of file OpsItem.h.

◆ PriorityHasBeenSet()

bool Aws::SSM::Model::OpsItem::PriorityHasBeenSet ( ) const
inline

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

Definition at line 345 of file OpsItem.h.

◆ RelatedOpsItemsHasBeenSet()

bool Aws::SSM::Model::OpsItem::RelatedOpsItemsHasBeenSet ( ) const
inline

One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

Definition at line 372 of file OpsItem.h.

◆ SetActualEndTime() [1/2]

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

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

Definition at line 1068 of file OpsItem.h.

◆ SetActualEndTime() [2/2]

void Aws::SSM::Model::OpsItem::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 1062 of file OpsItem.h.

◆ SetActualStartTime() [1/2]

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

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

Definition at line 1031 of file OpsItem.h.

◆ SetActualStartTime() [2/2]

void Aws::SSM::Model::OpsItem::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 1025 of file OpsItem.h.

◆ SetCategory() [1/3]

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

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Definition at line 941 of file OpsItem.h.

◆ SetCategory() [2/3]

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

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Definition at line 935 of file OpsItem.h.

◆ SetCategory() [3/3]

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

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Definition at line 947 of file OpsItem.h.

◆ SetCreatedBy() [1/3]

void Aws::SSM::Model::OpsItem::SetCreatedBy ( Aws::String &&  value)
inline

The ARN of the AWS account that created the OpsItem.

Definition at line 70 of file OpsItem.h.

◆ SetCreatedBy() [2/3]

void Aws::SSM::Model::OpsItem::SetCreatedBy ( const Aws::String value)
inline

The ARN of the AWS account that created the OpsItem.

Definition at line 65 of file OpsItem.h.

◆ SetCreatedBy() [3/3]

void Aws::SSM::Model::OpsItem::SetCreatedBy ( const char *  value)
inline

The ARN of the AWS account that created the OpsItem.

Definition at line 75 of file OpsItem.h.

◆ SetCreatedTime() [1/2]

void Aws::SSM::Model::OpsItem::SetCreatedTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the OpsItem was created.

Definition at line 160 of file OpsItem.h.

◆ SetCreatedTime() [2/2]

void Aws::SSM::Model::OpsItem::SetCreatedTime ( const Aws::Utils::DateTime value)
inline

The date and time the OpsItem was created.

Definition at line 155 of file OpsItem.h.

◆ SetDescription() [1/3]

void Aws::SSM::Model::OpsItem::SetDescription ( Aws::String &&  value)
inline

The OpsItem description.

Definition at line 191 of file OpsItem.h.

◆ SetDescription() [2/3]

void Aws::SSM::Model::OpsItem::SetDescription ( const Aws::String value)
inline

The OpsItem description.

Definition at line 186 of file OpsItem.h.

◆ SetDescription() [3/3]

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

The OpsItem description.

Definition at line 196 of file OpsItem.h.

◆ SetLastModifiedBy() [1/3]

void Aws::SSM::Model::OpsItem::SetLastModifiedBy ( Aws::String &&  value)
inline

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

Definition at line 232 of file OpsItem.h.

◆ SetLastModifiedBy() [2/3]

void Aws::SSM::Model::OpsItem::SetLastModifiedBy ( const Aws::String value)
inline

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

Definition at line 227 of file OpsItem.h.

◆ SetLastModifiedBy() [3/3]

void Aws::SSM::Model::OpsItem::SetLastModifiedBy ( const char *  value)
inline

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

Definition at line 237 of file OpsItem.h.

◆ SetLastModifiedTime() [1/2]

void Aws::SSM::Model::OpsItem::SetLastModifiedTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the OpsItem was last updated.

Definition at line 273 of file OpsItem.h.

◆ SetLastModifiedTime() [2/2]

void Aws::SSM::Model::OpsItem::SetLastModifiedTime ( const Aws::Utils::DateTime value)
inline

The date and time the OpsItem was last updated.

Definition at line 268 of file OpsItem.h.

◆ SetNotifications() [1/2]

void Aws::SSM::Model::OpsItem::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 308 of file OpsItem.h.

◆ SetNotifications() [2/2]

void Aws::SSM::Model::OpsItem::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 302 of file OpsItem.h.

◆ SetOperationalData() [1/2]

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

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 740 of file OpsItem.h.

◆ SetOperationalData() [2/2]

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

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 718 of file OpsItem.h.

◆ SetOpsItemId() [1/3]

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

The ID of the OpsItem.

Definition at line 484 of file OpsItem.h.

◆ SetOpsItemId() [2/3]

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

The ID of the OpsItem.

Definition at line 479 of file OpsItem.h.

◆ SetOpsItemId() [3/3]

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

The ID of the OpsItem.

Definition at line 489 of file OpsItem.h.

◆ SetOpsItemType() [1/3]

void Aws::SSM::Model::OpsItem::SetOpsItemType ( Aws::String &&  value)
inline

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Definition at line 115 of file OpsItem.h.

◆ SetOpsItemType() [2/3]

void Aws::SSM::Model::OpsItem::SetOpsItemType ( const Aws::String value)
inline

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Definition at line 109 of file OpsItem.h.

◆ SetOpsItemType() [3/3]

void Aws::SSM::Model::OpsItem::SetOpsItemType ( const char *  value)
inline

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Definition at line 121 of file OpsItem.h.

◆ SetPlannedEndTime() [1/2]

void Aws::SSM::Model::OpsItem::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 1152 of file OpsItem.h.

◆ SetPlannedEndTime() [2/2]

void Aws::SSM::Model::OpsItem::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 1145 of file OpsItem.h.

◆ SetPlannedStartTime() [1/2]

void Aws::SSM::Model::OpsItem::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 1109 of file OpsItem.h.

◆ SetPlannedStartTime() [2/2]

void Aws::SSM::Model::OpsItem::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 1102 of file OpsItem.h.

◆ SetPriority()

void Aws::SSM::Model::OpsItem::SetPriority ( int  value)
inline

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

Definition at line 351 of file OpsItem.h.

◆ SetRelatedOpsItems() [1/2]

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

One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

Definition at line 386 of file OpsItem.h.

◆ SetRelatedOpsItems() [2/2]

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

One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

Definition at line 379 of file OpsItem.h.

◆ SetSeverity() [1/3]

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

The severity of the OpsItem. Severity options range from 1 to 4.

Definition at line 986 of file OpsItem.h.

◆ SetSeverity() [2/3]

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

The severity of the OpsItem. Severity options range from 1 to 4.

Definition at line 981 of file OpsItem.h.

◆ SetSeverity() [3/3]

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

The severity of the OpsItem. Severity options range from 1 to 4.

Definition at line 991 of file OpsItem.h.

◆ SetSource() [1/3]

void Aws::SSM::Model::OpsItem::SetSource ( Aws::String &&  value)
inline

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

Definition at line 627 of file OpsItem.h.

◆ SetSource() [2/3]

void Aws::SSM::Model::OpsItem::SetSource ( const Aws::String value)
inline

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

Definition at line 621 of file OpsItem.h.

◆ SetSource() [3/3]

void Aws::SSM::Model::OpsItem::SetSource ( const char *  value)
inline

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

Definition at line 633 of file OpsItem.h.

◆ SetStatus() [1/2]

void Aws::SSM::Model::OpsItem::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 439 of file OpsItem.h.

◆ SetStatus() [2/2]

void Aws::SSM::Model::OpsItem::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 447 of file OpsItem.h.

◆ SetTitle() [1/3]

void Aws::SSM::Model::OpsItem::SetTitle ( Aws::String &&  value)
inline

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

Definition at line 578 of file OpsItem.h.

◆ SetTitle() [2/3]

void Aws::SSM::Model::OpsItem::SetTitle ( const Aws::String value)
inline

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

Definition at line 572 of file OpsItem.h.

◆ SetTitle() [3/3]

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

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

Definition at line 584 of file OpsItem.h.

◆ SetVersion() [1/3]

void Aws::SSM::Model::OpsItem::SetVersion ( Aws::String &&  value)
inline

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Definition at line 529 of file OpsItem.h.

◆ SetVersion() [2/3]

void Aws::SSM::Model::OpsItem::SetVersion ( const Aws::String value)
inline

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Definition at line 523 of file OpsItem.h.

◆ SetVersion() [3/3]

void Aws::SSM::Model::OpsItem::SetVersion ( const char *  value)
inline

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Definition at line 535 of file OpsItem.h.

◆ SeverityHasBeenSet()

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

The severity of the OpsItem. Severity options range from 1 to 4.

Definition at line 976 of file OpsItem.h.

◆ SourceHasBeenSet()

bool Aws::SSM::Model::OpsItem::SourceHasBeenSet ( ) const
inline

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

Definition at line 615 of file OpsItem.h.

◆ StatusHasBeenSet()

bool Aws::SSM::Model::OpsItem::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 431 of file OpsItem.h.

◆ TitleHasBeenSet()

bool Aws::SSM::Model::OpsItem::TitleHasBeenSet ( ) const
inline

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

Definition at line 566 of file OpsItem.h.

◆ VersionHasBeenSet()

bool Aws::SSM::Model::OpsItem::VersionHasBeenSet ( ) const
inline

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Definition at line 517 of file OpsItem.h.

◆ WithActualEndTime() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::WithActualEndTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 1080 of file OpsItem.h.

◆ WithActualEndTime() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::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 1074 of file OpsItem.h.

◆ WithActualStartTime() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::WithActualStartTime ( Aws::Utils::DateTime &&  value)
inline

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

Definition at line 1043 of file OpsItem.h.

◆ WithActualStartTime() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::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 1037 of file OpsItem.h.

◆ WithCategory() [1/3]

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

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Definition at line 959 of file OpsItem.h.

◆ WithCategory() [2/3]

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

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Definition at line 953 of file OpsItem.h.

◆ WithCategory() [3/3]

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

An OpsItem category. Category options include: Availability, Cost, Performance, Recovery, Security.

Definition at line 965 of file OpsItem.h.

◆ WithCreatedBy() [1/3]

OpsItem& Aws::SSM::Model::OpsItem::WithCreatedBy ( Aws::String &&  value)
inline

The ARN of the AWS account that created the OpsItem.

Definition at line 85 of file OpsItem.h.

◆ WithCreatedBy() [2/3]

OpsItem& Aws::SSM::Model::OpsItem::WithCreatedBy ( const Aws::String value)
inline

The ARN of the AWS account that created the OpsItem.

Definition at line 80 of file OpsItem.h.

◆ WithCreatedBy() [3/3]

OpsItem& Aws::SSM::Model::OpsItem::WithCreatedBy ( const char *  value)
inline

The ARN of the AWS account that created the OpsItem.

Definition at line 90 of file OpsItem.h.

◆ WithCreatedTime() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::WithCreatedTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the OpsItem was created.

Definition at line 170 of file OpsItem.h.

◆ WithCreatedTime() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::WithCreatedTime ( const Aws::Utils::DateTime value)
inline

The date and time the OpsItem was created.

Definition at line 165 of file OpsItem.h.

◆ WithDescription() [1/3]

OpsItem& Aws::SSM::Model::OpsItem::WithDescription ( Aws::String &&  value)
inline

The OpsItem description.

Definition at line 206 of file OpsItem.h.

◆ WithDescription() [2/3]

OpsItem& Aws::SSM::Model::OpsItem::WithDescription ( const Aws::String value)
inline

The OpsItem description.

Definition at line 201 of file OpsItem.h.

◆ WithDescription() [3/3]

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

The OpsItem description.

Definition at line 211 of file OpsItem.h.

◆ WithLastModifiedBy() [1/3]

OpsItem& Aws::SSM::Model::OpsItem::WithLastModifiedBy ( Aws::String &&  value)
inline

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

Definition at line 247 of file OpsItem.h.

◆ WithLastModifiedBy() [2/3]

OpsItem& Aws::SSM::Model::OpsItem::WithLastModifiedBy ( const Aws::String value)
inline

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

Definition at line 242 of file OpsItem.h.

◆ WithLastModifiedBy() [3/3]

OpsItem& Aws::SSM::Model::OpsItem::WithLastModifiedBy ( const char *  value)
inline

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

Definition at line 252 of file OpsItem.h.

◆ WithLastModifiedTime() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::WithLastModifiedTime ( Aws::Utils::DateTime &&  value)
inline

The date and time the OpsItem was last updated.

Definition at line 283 of file OpsItem.h.

◆ WithLastModifiedTime() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::WithLastModifiedTime ( const Aws::Utils::DateTime value)
inline

The date and time the OpsItem was last updated.

Definition at line 278 of file OpsItem.h.

◆ WithNotifications() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::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 320 of file OpsItem.h.

◆ WithNotifications() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::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 314 of file OpsItem.h.

◆ WithOperationalData() [1/2]

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

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 784 of file OpsItem.h.

◆ WithOperationalData() [2/2]

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

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 762 of file OpsItem.h.

◆ WithOpsItemId() [1/3]

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

The ID of the OpsItem.

Definition at line 499 of file OpsItem.h.

◆ WithOpsItemId() [2/3]

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

The ID of the OpsItem.

Definition at line 494 of file OpsItem.h.

◆ WithOpsItemId() [3/3]

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

The ID of the OpsItem.

Definition at line 504 of file OpsItem.h.

◆ WithOpsItemType() [1/3]

OpsItem& Aws::SSM::Model::OpsItem::WithOpsItemType ( Aws::String &&  value)
inline

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Definition at line 133 of file OpsItem.h.

◆ WithOpsItemType() [2/3]

OpsItem& Aws::SSM::Model::OpsItem::WithOpsItemType ( const Aws::String value)
inline

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Definition at line 127 of file OpsItem.h.

◆ WithOpsItemType() [3/3]

OpsItem& Aws::SSM::Model::OpsItem::WithOpsItemType ( const char *  value)
inline

The type of OpsItem. Currently, the only valid values are /aws/changerequest and /aws/issue.

Definition at line 139 of file OpsItem.h.

◆ WithPlannedEndTime() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::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 1166 of file OpsItem.h.

◆ WithPlannedEndTime() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::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 1159 of file OpsItem.h.

◆ WithPlannedStartTime() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::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 1123 of file OpsItem.h.

◆ WithPlannedStartTime() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::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 1116 of file OpsItem.h.

◆ WithPriority()

OpsItem& Aws::SSM::Model::OpsItem::WithPriority ( int  value)
inline

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

Definition at line 357 of file OpsItem.h.

◆ WithRelatedOpsItems() [1/2]

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

One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

Definition at line 400 of file OpsItem.h.

◆ WithRelatedOpsItems() [2/2]

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

One or more OpsItems that share something in common with the current OpsItem. For example, related OpsItems can include OpsItems with similar error messages, impacted resources, or statuses for the impacted resource.

Definition at line 393 of file OpsItem.h.

◆ WithSeverity() [1/3]

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

The severity of the OpsItem. Severity options range from 1 to 4.

Definition at line 1001 of file OpsItem.h.

◆ WithSeverity() [2/3]

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

The severity of the OpsItem. Severity options range from 1 to 4.

Definition at line 996 of file OpsItem.h.

◆ WithSeverity() [3/3]

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

The severity of the OpsItem. Severity options range from 1 to 4.

Definition at line 1006 of file OpsItem.h.

◆ WithSource() [1/3]

OpsItem& Aws::SSM::Model::OpsItem::WithSource ( Aws::String &&  value)
inline

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

Definition at line 645 of file OpsItem.h.

◆ WithSource() [2/3]

OpsItem& Aws::SSM::Model::OpsItem::WithSource ( const Aws::String value)
inline

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

Definition at line 639 of file OpsItem.h.

◆ WithSource() [3/3]

OpsItem& Aws::SSM::Model::OpsItem::WithSource ( const char *  value)
inline

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

Definition at line 651 of file OpsItem.h.

◆ WithStatus() [1/2]

OpsItem& Aws::SSM::Model::OpsItem::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 455 of file OpsItem.h.

◆ WithStatus() [2/2]

OpsItem& Aws::SSM::Model::OpsItem::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 463 of file OpsItem.h.

◆ WithTitle() [1/3]

OpsItem& Aws::SSM::Model::OpsItem::WithTitle ( Aws::String &&  value)
inline

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

Definition at line 596 of file OpsItem.h.

◆ WithTitle() [2/3]

OpsItem& Aws::SSM::Model::OpsItem::WithTitle ( const Aws::String value)
inline

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

Definition at line 590 of file OpsItem.h.

◆ WithTitle() [3/3]

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

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

Definition at line 602 of file OpsItem.h.

◆ WithVersion() [1/3]

OpsItem& Aws::SSM::Model::OpsItem::WithVersion ( Aws::String &&  value)
inline

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Definition at line 547 of file OpsItem.h.

◆ WithVersion() [2/3]

OpsItem& Aws::SSM::Model::OpsItem::WithVersion ( const Aws::String value)
inline

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Definition at line 541 of file OpsItem.h.

◆ WithVersion() [3/3]

OpsItem& Aws::SSM::Model::OpsItem::WithVersion ( const char *  value)
inline

The version of this OpsItem. Each time the OpsItem is edited the version number increments by one.

Definition at line 553 of file OpsItem.h.


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