Struct aws_sdk_ssm::operation::update_ops_item::UpdateOpsItemInput

#[non_exhaustive]
pub struct UpdateOpsItemInput {

    pub description: Option<String>,
    pub operational_data: Option<HashMap<String, OpsItemDataValue>>,
    pub operational_data_to_delete: Option<Vec<String>>,
    pub notifications: Option<Vec<OpsItemNotification>>,
    pub priority: Option<i32>,
    pub related_ops_items: Option<Vec<RelatedOpsItem>>,
    pub status: Option<OpsItemStatus>,
    pub ops_item_id: Option<String>,
    pub title: Option<String>,
    pub category: Option<String>,
    pub severity: Option<String>,
    pub actual_start_time: Option<DateTime>,
    pub actual_end_time: Option<DateTime>,
    pub planned_start_time: Option<DateTime>,
    pub planned_end_time: Option<DateTime>,
    pub ops_item_arn: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: Option<String>

User-defined text that contains information about the OpsItem, in Markdown format.

operational_data: Option<HashMap<String, 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.

operational_data_to_delete: Option<Vec<String>>

Keys that you want to remove from the OperationalData map.

notifications: Option<Vec<OpsItemNotification>>

The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

priority: Option<i32>

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

related_ops_items: Option<Vec<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.

status: Option<OpsItemStatus>

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.

ops_item_id: Option<String>

The ID of the OpsItem.

title: Option<String>

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

category: Option<String>

Specify a new category for an OpsItem.

severity: Option<String>

Specify a new severity for an OpsItem.

actual_start_time: Option<DateTime>

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

actual_end_time: Option<DateTime>

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

planned_start_time: Option<DateTime>

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

planned_end_time: Option<DateTime>

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

ops_item_arn: Option<String>

The OpsItem Amazon Resource Name (ARN).

Implementations

impl UpdateOpsItemInput

pub fn description(&self) -> Option<&str>

User-defined text that contains information about the OpsItem, in Markdown format.

pub fn operational_data(&self) -> Option<&HashMap<String, 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.

pub fn operational_data_to_delete(&self) -> &[String]

Keys that you want to remove from the OperationalData map.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .operational_data_to_delete.is_none().

pub fn notifications(&self) -> &[OpsItemNotification]

The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .notifications.is_none().

pub fn priority(&self) -> Option<i32>

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

pub fn related_ops_items(&self) -> &[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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .related_ops_items.is_none().

pub fn status(&self) -> Option<&OpsItemStatus>

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.

pub fn ops_item_id(&self) -> Option<&str>

The ID of the OpsItem.

pub fn title(&self) -> Option<&str>

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

pub fn category(&self) -> Option<&str>

Specify a new category for an OpsItem.

pub fn severity(&self) -> Option<&str>

Specify a new severity for an OpsItem.

pub fn actual_start_time(&self) -> Option<&DateTime>

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

pub fn actual_end_time(&self) -> Option<&DateTime>

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

pub fn planned_start_time(&self) -> Option<&DateTime>

The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest.

pub fn planned_end_time(&self) -> Option<&DateTime>

The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest.

pub fn ops_item_arn(&self) -> Option<&str>

The OpsItem Amazon Resource Name (ARN).

impl UpdateOpsItemInput

pub fn builder() -> UpdateOpsItemInputBuilder

Creates a new builder-style object to manufacture UpdateOpsItemInput.

Trait Implementations

impl Clone for UpdateOpsItemInput

fn clone(&self) -> UpdateOpsItemInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UpdateOpsItemInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for UpdateOpsItemInput

fn eq(&self, other: &UpdateOpsItemInput) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for UpdateOpsItemInput