#[non_exhaustive]pub struct UpdateOpsItemInput {Show 16 fields
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)§
This struct is marked as non-exhaustive
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.
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. 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§
Source§impl UpdateOpsItemInput
impl UpdateOpsItemInput
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
User-defined text that contains information about the OpsItem, in Markdown format.
Sourcepub fn operational_data(&self) -> Option<&HashMap<String, OpsItemDataValue>>
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.
Sourcepub fn operational_data_to_delete(&self) -> &[String]
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()
.
Sourcepub fn notifications(&self) -> &[OpsItemNotification]
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()
.
Sourcepub fn priority(&self) -> Option<i32>
pub fn priority(&self) -> Option<i32>
The importance of this OpsItem in relation to other OpsItems in the system.
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()
.
Sourcepub fn status(&self) -> Option<&OpsItemStatus>
pub fn status(&self) -> Option<&OpsItemStatus>
The OpsItem status. For more information, see Editing OpsItem details in the Amazon Web Services Systems Manager User Guide.
Sourcepub fn ops_item_id(&self) -> Option<&str>
pub fn ops_item_id(&self) -> Option<&str>
The ID of the OpsItem.
Sourcepub fn title(&self) -> Option<&str>
pub fn title(&self) -> Option<&str>
A short heading that describes the nature of the OpsItem and the impacted resource.
Sourcepub fn actual_start_time(&self) -> Option<&DateTime>
pub fn actual_start_time(&self) -> Option<&DateTime>
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest
.
Sourcepub fn actual_end_time(&self) -> Option<&DateTime>
pub fn actual_end_time(&self) -> Option<&DateTime>
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest
.
Sourcepub fn planned_start_time(&self) -> Option<&DateTime>
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
.
Sourcepub fn planned_end_time(&self) -> Option<&DateTime>
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
.
Sourcepub fn ops_item_arn(&self) -> Option<&str>
pub fn ops_item_arn(&self) -> Option<&str>
The OpsItem Amazon Resource Name (ARN).
Source§impl UpdateOpsItemInput
impl UpdateOpsItemInput
Sourcepub fn builder() -> UpdateOpsItemInputBuilder
pub fn builder() -> UpdateOpsItemInputBuilder
Creates a new builder-style object to manufacture UpdateOpsItemInput
.
Trait Implementations§
Source§impl Clone for UpdateOpsItemInput
impl Clone for UpdateOpsItemInput
Source§fn clone(&self) -> UpdateOpsItemInput
fn clone(&self) -> UpdateOpsItemInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for UpdateOpsItemInput
impl Debug for UpdateOpsItemInput
Source§impl PartialEq for UpdateOpsItemInput
impl PartialEq for UpdateOpsItemInput
impl StructuralPartialEq for UpdateOpsItemInput
Auto Trait Implementations§
impl Freeze for UpdateOpsItemInput
impl RefUnwindSafe for UpdateOpsItemInput
impl Send for UpdateOpsItemInput
impl Sync for UpdateOpsItemInput
impl Unpin for UpdateOpsItemInput
impl UnwindSafe for UpdateOpsItemInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);