class
Amazonite::Ssm::UpdateOpsItemRequest
- Amazonite::Ssm::UpdateOpsItemRequest
- Reference
- Object
Included Modules
- JSON::Serializable
Defined in:
ssm/update_ops_item_request.crConstructors
- .new(pull : JSON::PullParser)
- .new(ops_item_id : String, description : String | Nil = nil, operational_data : Hash(String, OpsItemDataValue) | Nil = nil, operational_data_to_delete : Array(String) | Nil = nil, notifications : Array(OpsItemNotification) | Nil = nil, priority : Int32 | Nil = nil, related_ops_items : Array(RelatedOpsItem) | Nil = nil, status : OpsItemStatus | Nil = nil, title : String | Nil = nil, category : String | Nil = nil, severity : String | Nil = nil, actual_start_time : Time | Nil = nil, actual_end_time : Time | Nil = nil, planned_start_time : Time | Nil = nil, planned_end_time : Time | Nil = nil, ops_item_arn : String | Nil = nil)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#actual_end_time : Time | Nil
The time a runbook workflow ended.
-
#actual_end_time=(actual_end_time : Time | Nil)
The time a runbook workflow ended.
-
#actual_start_time : Time | Nil
The time a runbook workflow started.
-
#actual_start_time=(actual_start_time : Time | Nil)
The time a runbook workflow started.
-
#category : String | Nil
Specify a new category for an OpsItem.
-
#category=(category : String | Nil)
Specify a new category for an OpsItem.
-
#description : String | Nil
User-defined text that contains information about the OpsItem, in Markdown format.
-
#description=(description : String | Nil)
User-defined text that contains information about the OpsItem, in Markdown format.
-
#hash(hasher)
See
Object#hash(hasher) -
#notifications : Array(OpsItemNotification) | Nil
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
-
#notifications=(notifications : Array(OpsItemNotification) | Nil)
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
-
#operational_data : Hash(String, OpsItemDataValue) | Nil
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
-
#operational_data=(operational_data : Hash(String, OpsItemDataValue) | Nil)
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
-
#operational_data_to_delete : Array(String) | Nil
Keys that you want to remove from the OperationalData map.
-
#operational_data_to_delete=(operational_data_to_delete : Array(String) | Nil)
Keys that you want to remove from the OperationalData map.
-
#ops_item_arn : String | Nil
The OpsItem Amazon Resource Name (ARN).
-
#ops_item_arn=(ops_item_arn : String | Nil)
The OpsItem Amazon Resource Name (ARN).
-
#ops_item_id : String
The ID of the OpsItem.
-
#ops_item_id=(ops_item_id : String)
The ID of the OpsItem.
-
#planned_end_time : Time | Nil
The time specified in a change request for a runbook workflow to end.
-
#planned_end_time=(planned_end_time : Time | Nil)
The time specified in a change request for a runbook workflow to end.
-
#planned_start_time : Time | Nil
The time specified in a change request for a runbook workflow to start.
-
#planned_start_time=(planned_start_time : Time | Nil)
The time specified in a change request for a runbook workflow to start.
-
#priority : Int32 | Nil
The importance of this OpsItem in relation to other OpsItems in the system.
-
#priority=(priority : Int32 | Nil)
The importance of this OpsItem in relation to other OpsItems in the system.
-
#related_ops_items : Array(RelatedOpsItem) | Nil
One or more OpsItems that share something in common with the current OpsItems.
-
#related_ops_items=(related_ops_items : Array(RelatedOpsItem) | Nil)
One or more OpsItems that share something in common with the current OpsItems.
-
#severity : String | Nil
Specify a new severity for an OpsItem.
-
#severity=(severity : String | Nil)
Specify a new severity for an OpsItem.
-
#status : OpsItemStatus | Nil
The OpsItem status.
-
#status=(status : OpsItemStatus | Nil)
The OpsItem status.
-
#title : String | Nil
A short heading that describes the nature of the OpsItem and the impacted resource.
-
#title=(title : String | Nil)
A short heading that describes the nature of the OpsItem and the impacted resource.
- #validate! : Nil
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
The time a runbook workflow ended. Currently reported only for the OpsItem type
/aws/changerequest.
The time a runbook workflow ended. Currently reported only for the OpsItem type
/aws/changerequest.
The time a runbook workflow started. Currently reported only for the OpsItem type
/aws/changerequest.
The time a runbook workflow started. Currently reported only for the OpsItem type
/aws/changerequest.
User-defined text that contains information about the OpsItem, in Markdown format.
User-defined text that contains information about the OpsItem, in Markdown format.
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm,
/amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
Operational data is custom data that provides useful reference details about the OpsItem. For example, you can specify log files, error strings, license keys, troubleshooting tips, or other relevant data. You enter operational data as key-value pairs. The key has a maximum length of 128 characters. The value has a maximum size of 20 KB.
Operational data keys can't begin with the following: amazon, aws, amzn, ssm,
/amazon, /aws, /amzn, /ssm.
You can choose to make the data searchable by other users in the account or you can restrict search access. Searchable data means that all users with access to the OpsItem Overview page (as provided by the DescribeOpsItems API 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.
Keys that you want to remove from the OperationalData map.
Keys that you want to remove from the OperationalData map.
The time specified in a change request for a runbook workflow to end. Currently supported only
for the OpsItem type /aws/changerequest.
The time specified in a change request for a runbook workflow to end. Currently supported only
for the OpsItem type /aws/changerequest.
The time specified in a change request for a runbook workflow to start. Currently supported only
for the OpsItem type /aws/changerequest.
The time specified in a change request for a runbook workflow to start. Currently supported only
for the OpsItem type /aws/changerequest.
The importance of this OpsItem in relation to other OpsItems in the system.
The importance of this OpsItem in relation to other OpsItems in the system.
The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
A short heading that describes the nature of the OpsItem and the impacted resource.
A short heading that describes the nature of the OpsItem and the impacted resource.