Class: Aws::SSM::Types::UpdateOpsItemRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::SSM::Types::UpdateOpsItemRequest
- Includes:
- Aws::Structure
- Defined in:
- lib/aws-sdk-ssm/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#actual_end_time ⇒ Time
The time a runbook workflow ended.
-
#actual_start_time ⇒ Time
The time a runbook workflow started.
-
#category ⇒ String
Specify a new category for an OpsItem.
-
#description ⇒ String
User-defined text that contains information about the OpsItem, in Markdown format.
-
#notifications ⇒ Array<Types::OpsItemNotification>
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
-
#operational_data ⇒ Hash<String,Types::OpsItemDataValue>
Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.
-
#operational_data_to_delete ⇒ Array<String>
Keys that you want to remove from the OperationalData map.
-
#ops_item_arn ⇒ String
The OpsItem Amazon Resource Name (ARN).
-
#ops_item_id ⇒ String
The ID of the OpsItem.
-
#planned_end_time ⇒ Time
The time specified in a change request for a runbook workflow to end.
-
#planned_start_time ⇒ Time
The time specified in a change request for a runbook workflow to start.
-
#priority ⇒ Integer
The importance of this OpsItem in relation to other OpsItems in the system.
-
#related_ops_items ⇒ Array<Types::RelatedOpsItem>
One or more OpsItems that share something in common with the current OpsItems.
-
#severity ⇒ String
Specify a new severity for an OpsItem.
-
#status ⇒ String
The OpsItem status.
-
#title ⇒ String
A short heading that describes the nature of the OpsItem and the impacted resource.
Instance Attribute Details
#actual_end_time ⇒ Time
The time a runbook workflow ended. Currently reported only for the OpsItem type ‘/aws/changerequest`.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#actual_start_time ⇒ Time
The time a runbook workflow started. Currently reported only for the OpsItem type ‘/aws/changerequest`.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#category ⇒ String
Specify a new category for an OpsItem.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
User-defined text that contains information about the OpsItem, in Markdown format.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#notifications ⇒ Array<Types::OpsItemNotification>
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#operational_data ⇒ Hash<String,Types::OpsItemDataValue>
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*.
[1]: docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#operational_data_to_delete ⇒ Array<String>
Keys that you want to remove from the OperationalData map.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#ops_item_arn ⇒ String
The OpsItem Amazon Resource Name (ARN).
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#ops_item_id ⇒ String
The ID of the OpsItem.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#planned_end_time ⇒ Time
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type ‘/aws/changerequest`.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#planned_start_time ⇒ Time
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type ‘/aws/changerequest`.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#priority ⇒ Integer
The importance of this OpsItem in relation to other OpsItems in the system.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#related_ops_items ⇒ Array<Types::RelatedOpsItem>
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.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#severity ⇒ String
Specify a new severity for an OpsItem.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#status ⇒ String
The OpsItem status. Status can be ‘Open`, `In Progress`, or `Resolved`. For more information, see [Editing OpsItem details] in the *Amazon Web Services Systems Manager User Guide*.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |
#title ⇒ String
A short heading that describes the nature of the OpsItem and the impacted resource.
19011 19012 19013 19014 19015 19016 19017 19018 19019 19020 19021 19022 19023 19024 19025 19026 19027 19028 19029 19030 |
# File 'lib/aws-sdk-ssm/types.rb', line 19011 class UpdateOpsItemRequest < Struct.new( :description, :operational_data, :operational_data_to_delete, :notifications, :priority, :related_ops_items, :status, :ops_item_id, :title, :category, :severity, :actual_start_time, :actual_end_time, :planned_start_time, :planned_end_time, :ops_item_arn) SENSITIVE = [] include Aws::Structure end |