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

#include <CreateOpsItemRequest.h>

+ Inheritance diagram for Aws::SSM::Model::CreateOpsItemRequest:

Public Member Functions

 CreateOpsItemRequest ()
 
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)
 
CreateOpsItemRequestWithDescription (const Aws::String &value)
 
CreateOpsItemRequestWithDescription (Aws::String &&value)
 
CreateOpsItemRequestWithDescription (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)
 
CreateOpsItemRequestWithOpsItemType (const Aws::String &value)
 
CreateOpsItemRequestWithOpsItemType (Aws::String &&value)
 
CreateOpsItemRequestWithOpsItemType (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)
 
CreateOpsItemRequestWithOperationalData (const Aws::Map< Aws::String, OpsItemDataValue > &value)
 
CreateOpsItemRequestWithOperationalData (Aws::Map< Aws::String, OpsItemDataValue > &&value)
 
CreateOpsItemRequestAddOperationalData (const Aws::String &key, const OpsItemDataValue &value)
 
CreateOpsItemRequestAddOperationalData (Aws::String &&key, const OpsItemDataValue &value)
 
CreateOpsItemRequestAddOperationalData (const Aws::String &key, OpsItemDataValue &&value)
 
CreateOpsItemRequestAddOperationalData (Aws::String &&key, OpsItemDataValue &&value)
 
CreateOpsItemRequestAddOperationalData (const char *key, OpsItemDataValue &&value)
 
CreateOpsItemRequestAddOperationalData (const char *key, const OpsItemDataValue &value)
 
const Aws::Vector< OpsItemNotification > & GetNotifications () const
 
bool NotificationsHasBeenSet () const
 
void SetNotifications (const Aws::Vector< OpsItemNotification > &value)
 
void SetNotifications (Aws::Vector< OpsItemNotification > &&value)
 
CreateOpsItemRequestWithNotifications (const Aws::Vector< OpsItemNotification > &value)
 
CreateOpsItemRequestWithNotifications (Aws::Vector< OpsItemNotification > &&value)
 
CreateOpsItemRequestAddNotifications (const OpsItemNotification &value)
 
CreateOpsItemRequestAddNotifications (OpsItemNotification &&value)
 
int GetPriority () const
 
bool PriorityHasBeenSet () const
 
void SetPriority (int value)
 
CreateOpsItemRequestWithPriority (int value)
 
const Aws::Vector< RelatedOpsItem > & GetRelatedOpsItems () const
 
bool RelatedOpsItemsHasBeenSet () const
 
void SetRelatedOpsItems (const Aws::Vector< RelatedOpsItem > &value)
 
void SetRelatedOpsItems (Aws::Vector< RelatedOpsItem > &&value)
 
CreateOpsItemRequestWithRelatedOpsItems (const Aws::Vector< RelatedOpsItem > &value)
 
CreateOpsItemRequestWithRelatedOpsItems (Aws::Vector< RelatedOpsItem > &&value)
 
CreateOpsItemRequestAddRelatedOpsItems (const RelatedOpsItem &value)
 
CreateOpsItemRequestAddRelatedOpsItems (RelatedOpsItem &&value)
 
const Aws::StringGetSource () const
 
bool SourceHasBeenSet () const
 
void SetSource (const Aws::String &value)
 
void SetSource (Aws::String &&value)
 
void SetSource (const char *value)
 
CreateOpsItemRequestWithSource (const Aws::String &value)
 
CreateOpsItemRequestWithSource (Aws::String &&value)
 
CreateOpsItemRequestWithSource (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)
 
CreateOpsItemRequestWithTitle (const Aws::String &value)
 
CreateOpsItemRequestWithTitle (Aws::String &&value)
 
CreateOpsItemRequestWithTitle (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateOpsItemRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateOpsItemRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateOpsItemRequestAddTags (const Tag &value)
 
CreateOpsItemRequestAddTags (Tag &&value)
 
const Aws::StringGetCategory () const
 
bool CategoryHasBeenSet () const
 
void SetCategory (const Aws::String &value)
 
void SetCategory (Aws::String &&value)
 
void SetCategory (const char *value)
 
CreateOpsItemRequestWithCategory (const Aws::String &value)
 
CreateOpsItemRequestWithCategory (Aws::String &&value)
 
CreateOpsItemRequestWithCategory (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)
 
CreateOpsItemRequestWithSeverity (const Aws::String &value)
 
CreateOpsItemRequestWithSeverity (Aws::String &&value)
 
CreateOpsItemRequestWithSeverity (const char *value)
 
const Aws::Utils::DateTimeGetActualStartTime () const
 
bool ActualStartTimeHasBeenSet () const
 
void SetActualStartTime (const Aws::Utils::DateTime &value)
 
void SetActualStartTime (Aws::Utils::DateTime &&value)
 
CreateOpsItemRequestWithActualStartTime (const Aws::Utils::DateTime &value)
 
CreateOpsItemRequestWithActualStartTime (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)
 
CreateOpsItemRequestWithActualEndTime (const Aws::Utils::DateTime &value)
 
CreateOpsItemRequestWithActualEndTime (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)
 
CreateOpsItemRequestWithPlannedStartTime (const Aws::Utils::DateTime &value)
 
CreateOpsItemRequestWithPlannedStartTime (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)
 
CreateOpsItemRequestWithPlannedEndTime (const Aws::Utils::DateTime &value)
 
CreateOpsItemRequestWithPlannedEndTime (Aws::Utils::DateTime &&value)
 
- Public Member Functions inherited from Aws::SSM::SSMRequest
virtual ~SSMRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::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 28 of file CreateOpsItemRequest.h.

Constructor & Destructor Documentation

◆ CreateOpsItemRequest()

Aws::SSM::Model::CreateOpsItemRequest::CreateOpsItemRequest ( )

Member Function Documentation

◆ ActualEndTimeHasBeenSet()

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

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

Definition at line 922 of file CreateOpsItemRequest.h.

◆ ActualStartTimeHasBeenSet()

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

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

Definition at line 885 of file CreateOpsItemRequest.h.

◆ AddNotifications() [1/2]

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

◆ AddNotifications() [2/2]

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

◆ AddOperationalData() [1/6]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 332 of file CreateOpsItemRequest.h.

◆ AddOperationalData() [2/6]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 382 of file CreateOpsItemRequest.h.

◆ AddOperationalData() [3/6]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 307 of file CreateOpsItemRequest.h.

◆ AddOperationalData() [4/6]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 357 of file CreateOpsItemRequest.h.

◆ AddOperationalData() [5/6]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 432 of file CreateOpsItemRequest.h.

◆ AddOperationalData() [6/6]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 407 of file CreateOpsItemRequest.h.

◆ AddRelatedOpsItems() [1/2]

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

◆ AddRelatedOpsItems() [2/2]

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

◆ AddTags() [1/2]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::AddTags ( const Tag value)
inline

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

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

Definition at line 775 of file CreateOpsItemRequest.h.

◆ AddTags() [2/2]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::AddTags ( Tag &&  value)
inline

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

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

Definition at line 790 of file CreateOpsItemRequest.h.

◆ CategoryHasBeenSet()

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

Specify a category to assign to an OpsItem.

Definition at line 801 of file CreateOpsItemRequest.h.

◆ DescriptionHasBeenSet()

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

Information about the OpsItem.

Definition at line 52 of file CreateOpsItemRequest.h.

◆ GetActualEndTime()

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

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

Definition at line 916 of file CreateOpsItemRequest.h.

◆ GetActualStartTime()

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

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

Definition at line 879 of file CreateOpsItemRequest.h.

◆ GetCategory()

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

Specify a category to assign to an OpsItem.

Definition at line 796 of file CreateOpsItemRequest.h.

◆ GetDescription()

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

Information about the OpsItem.

Definition at line 47 of file CreateOpsItemRequest.h.

◆ GetNotifications()

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

◆ GetOperationalData()

const Aws::Map<Aws::String, OpsItemDataValue>& Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 157 of file CreateOpsItemRequest.h.

◆ GetOpsItemType()

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

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

Definition at line 89 of file CreateOpsItemRequest.h.

◆ GetPlannedEndTime()

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

◆ GetPlannedStartTime()

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

◆ GetPriority()

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

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

Definition at line 488 of file CreateOpsItemRequest.h.

◆ GetRelatedOpsItems()

const Aws::Vector<RelatedOpsItem>& Aws::SSM::Model::CreateOpsItemRequest::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 514 of file CreateOpsItemRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SSM::Model::CreateOpsItemRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SSM::Model::CreateOpsItemRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file CreateOpsItemRequest.h.

◆ GetSeverity()

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

Specify a severity to assign to an OpsItem.

Definition at line 837 of file CreateOpsItemRequest.h.

◆ GetSource()

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

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

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

Definition at line 571 of file CreateOpsItemRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::SSM::Model::CreateOpsItemRequest::GetTags ( ) const
inline

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

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

Definition at line 685 of file CreateOpsItemRequest.h.

◆ GetTitle()

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

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

Definition at line 627 of file CreateOpsItemRequest.h.

◆ NotificationsHasBeenSet()

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

◆ OperationalDataHasBeenSet()

bool Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 182 of file CreateOpsItemRequest.h.

◆ OpsItemTypeHasBeenSet()

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

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

Definition at line 95 of file CreateOpsItemRequest.h.

◆ PlannedEndTimeHasBeenSet()

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

◆ PlannedStartTimeHasBeenSet()

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

◆ PriorityHasBeenSet()

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

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

Definition at line 494 of file CreateOpsItemRequest.h.

◆ RelatedOpsItemsHasBeenSet()

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

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetActualEndTime() [1/2]

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

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

Definition at line 934 of file CreateOpsItemRequest.h.

◆ SetActualEndTime() [2/2]

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

◆ SetActualStartTime() [1/2]

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

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

Definition at line 897 of file CreateOpsItemRequest.h.

◆ SetActualStartTime() [2/2]

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

◆ SetCategory() [1/3]

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

Specify a category to assign to an OpsItem.

Definition at line 811 of file CreateOpsItemRequest.h.

◆ SetCategory() [2/3]

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

Specify a category to assign to an OpsItem.

Definition at line 806 of file CreateOpsItemRequest.h.

◆ SetCategory() [3/3]

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

Specify a category to assign to an OpsItem.

Definition at line 816 of file CreateOpsItemRequest.h.

◆ SetDescription() [1/3]

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

Information about the OpsItem.

Definition at line 62 of file CreateOpsItemRequest.h.

◆ SetDescription() [2/3]

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

Information about the OpsItem.

Definition at line 57 of file CreateOpsItemRequest.h.

◆ SetDescription() [3/3]

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

Information about the OpsItem.

Definition at line 67 of file CreateOpsItemRequest.h.

◆ SetNotifications() [1/2]

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

◆ SetNotifications() [2/2]

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

◆ SetOperationalData() [1/2]

void Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 232 of file CreateOpsItemRequest.h.

◆ SetOperationalData() [2/2]

void Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 207 of file CreateOpsItemRequest.h.

◆ SetOpsItemType() [1/3]

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

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

Definition at line 107 of file CreateOpsItemRequest.h.

◆ SetOpsItemType() [2/3]

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

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

Definition at line 101 of file CreateOpsItemRequest.h.

◆ SetOpsItemType() [3/3]

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

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

Definition at line 113 of file CreateOpsItemRequest.h.

◆ SetPlannedEndTime() [1/2]

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

◆ SetPlannedEndTime() [2/2]

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

◆ SetPlannedStartTime() [1/2]

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

◆ SetPlannedStartTime() [2/2]

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

◆ SetPriority()

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

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

Definition at line 500 of file CreateOpsItemRequest.h.

◆ SetRelatedOpsItems() [1/2]

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

◆ SetRelatedOpsItems() [2/2]

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

◆ SetSeverity() [1/3]

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

Specify a severity to assign to an OpsItem.

Definition at line 852 of file CreateOpsItemRequest.h.

◆ SetSeverity() [2/3]

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

Specify a severity to assign to an OpsItem.

Definition at line 847 of file CreateOpsItemRequest.h.

◆ SetSeverity() [3/3]

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

Specify a severity to assign to an OpsItem.

Definition at line 857 of file CreateOpsItemRequest.h.

◆ SetSource() [1/3]

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

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

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

Definition at line 592 of file CreateOpsItemRequest.h.

◆ SetSource() [2/3]

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

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

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

Definition at line 585 of file CreateOpsItemRequest.h.

◆ SetSource() [3/3]

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

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

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

Definition at line 599 of file CreateOpsItemRequest.h.

◆ SetTags() [1/2]

void Aws::SSM::Model::CreateOpsItemRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

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

Definition at line 730 of file CreateOpsItemRequest.h.

◆ SetTags() [2/2]

void Aws::SSM::Model::CreateOpsItemRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

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

Definition at line 715 of file CreateOpsItemRequest.h.

◆ SetTitle() [1/3]

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

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

Definition at line 645 of file CreateOpsItemRequest.h.

◆ SetTitle() [2/3]

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

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

Definition at line 639 of file CreateOpsItemRequest.h.

◆ SetTitle() [3/3]

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

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

Definition at line 651 of file CreateOpsItemRequest.h.

◆ SeverityHasBeenSet()

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

Specify a severity to assign to an OpsItem.

Definition at line 842 of file CreateOpsItemRequest.h.

◆ SourceHasBeenSet()

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

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

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

Definition at line 578 of file CreateOpsItemRequest.h.

◆ TagsHasBeenSet()

bool Aws::SSM::Model::CreateOpsItemRequest::TagsHasBeenSet ( ) const
inline

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

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

Definition at line 700 of file CreateOpsItemRequest.h.

◆ TitleHasBeenSet()

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

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

Definition at line 633 of file CreateOpsItemRequest.h.

◆ WithActualEndTime() [1/2]

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

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

Definition at line 946 of file CreateOpsItemRequest.h.

◆ WithActualEndTime() [2/2]

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

◆ WithActualStartTime() [1/2]

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

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

Definition at line 909 of file CreateOpsItemRequest.h.

◆ WithActualStartTime() [2/2]

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

◆ WithCategory() [1/3]

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

Specify a category to assign to an OpsItem.

Definition at line 826 of file CreateOpsItemRequest.h.

◆ WithCategory() [2/3]

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

Specify a category to assign to an OpsItem.

Definition at line 821 of file CreateOpsItemRequest.h.

◆ WithCategory() [3/3]

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

Specify a category to assign to an OpsItem.

Definition at line 831 of file CreateOpsItemRequest.h.

◆ WithDescription() [1/3]

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

Information about the OpsItem.

Definition at line 77 of file CreateOpsItemRequest.h.

◆ WithDescription() [2/3]

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

Information about the OpsItem.

Definition at line 72 of file CreateOpsItemRequest.h.

◆ WithDescription() [3/3]

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

Information about the OpsItem.

Definition at line 82 of file CreateOpsItemRequest.h.

◆ WithNotifications() [1/2]

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

◆ WithNotifications() [2/2]

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

◆ WithOperationalData() [1/2]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 282 of file CreateOpsItemRequest.h.

◆ WithOperationalData() [2/2]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::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 operation) can view and search on the specified data. Operational data that isn't searchable is only viewable by users who have access to the OpsItem (as provided by the GetOpsItem API operation).

Use the /aws/resources key in OperationalData to specify a related resource in the request. Use the /aws/automations key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see Creating OpsItems manually in the Amazon Web Services Systems Manager User Guide.

Definition at line 257 of file CreateOpsItemRequest.h.

◆ WithOpsItemType() [1/3]

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

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

Definition at line 125 of file CreateOpsItemRequest.h.

◆ WithOpsItemType() [2/3]

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

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

Definition at line 119 of file CreateOpsItemRequest.h.

◆ WithOpsItemType() [3/3]

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

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

Definition at line 131 of file CreateOpsItemRequest.h.

◆ WithPlannedEndTime() [1/2]

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

◆ WithPlannedEndTime() [2/2]

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

◆ WithPlannedStartTime() [1/2]

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

◆ WithPlannedStartTime() [2/2]

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

◆ WithPriority()

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

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

Definition at line 506 of file CreateOpsItemRequest.h.

◆ WithRelatedOpsItems() [1/2]

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

◆ WithRelatedOpsItems() [2/2]

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

◆ WithSeverity() [1/3]

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

Specify a severity to assign to an OpsItem.

Definition at line 867 of file CreateOpsItemRequest.h.

◆ WithSeverity() [2/3]

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

Specify a severity to assign to an OpsItem.

Definition at line 862 of file CreateOpsItemRequest.h.

◆ WithSeverity() [3/3]

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

Specify a severity to assign to an OpsItem.

Definition at line 872 of file CreateOpsItemRequest.h.

◆ WithSource() [1/3]

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

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

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

Definition at line 613 of file CreateOpsItemRequest.h.

◆ WithSource() [2/3]

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

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

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

Definition at line 606 of file CreateOpsItemRequest.h.

◆ WithSource() [3/3]

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

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

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

Definition at line 620 of file CreateOpsItemRequest.h.

◆ WithTags() [1/2]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

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

Definition at line 760 of file CreateOpsItemRequest.h.

◆ WithTags() [2/2]

CreateOpsItemRequest& Aws::SSM::Model::CreateOpsItemRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

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

Tags use a key-value pair. For example:

Key=Department,Value=Finance

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

Definition at line 745 of file CreateOpsItemRequest.h.

◆ WithTitle() [1/3]

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

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

Definition at line 663 of file CreateOpsItemRequest.h.

◆ WithTitle() [2/3]

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

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

Definition at line 657 of file CreateOpsItemRequest.h.

◆ WithTitle() [3/3]

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

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

Definition at line 669 of file CreateOpsItemRequest.h.


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