aws_sdk_ssm/client/
update_ops_item.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`UpdateOpsItem`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`description(impl Into<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_description):<br>required: **false**<br><p>User-defined text that contains information about the OpsItem, in Markdown format.</p><br>
    ///   - [`operational_data(impl Into<String>, OpsItemDataValue)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::operational_data) / [`set_operational_data(Option<HashMap::<String, OpsItemDataValue>>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_operational_data):<br>required: **false**<br><p>Add new keys or edit existing key-value pairs of the OperationalData map in the OpsItem object.</p> <p>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.</p><important>  <p>Operational data keys <i>can't</i> begin with the following: <code>amazon</code>, <code>aws</code>, <code>amzn</code>, <code>ssm</code>, <code>/amazon</code>, <code>/aws</code>, <code>/amzn</code>, <code>/ssm</code>.</p> </important> <p>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 <code>DescribeOpsItems</code> 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 <code>GetOpsItem</code> API operation).</p> <p>Use the <code>/aws/resources</code> key in OperationalData to specify a related resource in the request. Use the <code>/aws/automations</code> key in OperationalData to associate an Automation runbook with the OpsItem. To view Amazon Web Services CLI example commands that use these keys, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-manually-create-OpsItems.html">Creating OpsItems manually</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><br>
    ///   - [`operational_data_to_delete(impl Into<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::operational_data_to_delete) / [`set_operational_data_to_delete(Option<Vec::<String>>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_operational_data_to_delete):<br>required: **false**<br><p>Keys that you want to remove from the OperationalData map.</p><br>
    ///   - [`notifications(OpsItemNotification)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::notifications) / [`set_notifications(Option<Vec::<OpsItemNotification>>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_notifications):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.</p><br>
    ///   - [`priority(i32)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::priority) / [`set_priority(Option<i32>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_priority):<br>required: **false**<br><p>The importance of this OpsItem in relation to other OpsItems in the system.</p><br>
    ///   - [`related_ops_items(RelatedOpsItem)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::related_ops_items) / [`set_related_ops_items(Option<Vec::<RelatedOpsItem>>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_related_ops_items):<br>required: **false**<br><p>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.</p><br>
    ///   - [`status(OpsItemStatus)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::status) / [`set_status(Option<OpsItemStatus>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_status):<br>required: **false**<br><p>The OpsItem status. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/OpsCenter-working-with-OpsItems-editing-details.html">Editing OpsItem details</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p><br>
    ///   - [`ops_item_id(impl Into<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::ops_item_id) / [`set_ops_item_id(Option<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_ops_item_id):<br>required: **true**<br><p>The ID of the OpsItem.</p><br>
    ///   - [`title(impl Into<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::title) / [`set_title(Option<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_title):<br>required: **false**<br><p>A short heading that describes the nature of the OpsItem and the impacted resource.</p><br>
    ///   - [`category(impl Into<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::category) / [`set_category(Option<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_category):<br>required: **false**<br><p>Specify a new category for an OpsItem.</p><br>
    ///   - [`severity(impl Into<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::severity) / [`set_severity(Option<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_severity):<br>required: **false**<br><p>Specify a new severity for an OpsItem.</p><br>
    ///   - [`actual_start_time(DateTime)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::actual_start_time) / [`set_actual_start_time(Option<DateTime>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_actual_start_time):<br>required: **false**<br><p>The time a runbook workflow started. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p><br>
    ///   - [`actual_end_time(DateTime)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::actual_end_time) / [`set_actual_end_time(Option<DateTime>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_actual_end_time):<br>required: **false**<br><p>The time a runbook workflow ended. Currently reported only for the OpsItem type <code>/aws/changerequest</code>.</p><br>
    ///   - [`planned_start_time(DateTime)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::planned_start_time) / [`set_planned_start_time(Option<DateTime>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_planned_start_time):<br>required: **false**<br><p>The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p><br>
    ///   - [`planned_end_time(DateTime)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::planned_end_time) / [`set_planned_end_time(Option<DateTime>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_planned_end_time):<br>required: **false**<br><p>The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type <code>/aws/changerequest</code>.</p><br>
    ///   - [`ops_item_arn(impl Into<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::ops_item_arn) / [`set_ops_item_arn(Option<String>)`](crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::set_ops_item_arn):<br>required: **false**<br><p>The OpsItem Amazon Resource Name (ARN).</p><br>
    /// - On success, responds with [`UpdateOpsItemOutput`](crate::operation::update_ops_item::UpdateOpsItemOutput)
    /// - On failure, responds with [`SdkError<UpdateOpsItemError>`](crate::operation::update_ops_item::UpdateOpsItemError)
    pub fn update_ops_item(&self) -> crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder {
        crate::operation::update_ops_item::builders::UpdateOpsItemFluentBuilder::new(self.handle.clone())
    }
}