Struct aws_sdk_ssm::client::fluent_builders::UpdateOpsItem
source · [−]pub struct UpdateOpsItem { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateOpsItem
.
Edit or change an OpsItem. You must have permission in Identity and Access Management (IAM) to update an OpsItem. For more information, see Getting started with OpsCenter in the Amazon Web Services Systems Manager User Guide.
Operations engineers and IT professionals use Amazon Web Services Systems Manager OpsCenter to view, investigate, and remediate operational issues impacting the performance and health of their Amazon Web Services resources. For more information, see OpsCenter in the Amazon Web Services Systems Manager User Guide.
Implementations
sourceimpl UpdateOpsItem
impl UpdateOpsItem
sourcepub async fn send(
self
) -> Result<UpdateOpsItemOutput, SdkError<UpdateOpsItemError>>
pub async fn send(
self
) -> Result<UpdateOpsItemOutput, SdkError<UpdateOpsItemError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
Update the information about the OpsItem. Provide enough information so that users reading this OpsItem for the first time understand the issue.
sourcepub fn operational_data(self, k: impl Into<String>, v: OpsItemDataValue) -> Self
pub fn operational_data(self, k: impl Into<String>, v: OpsItemDataValue) -> Self
Adds a key-value pair to OperationalData
.
To override the contents of this collection use set_operational_data
.
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 set_operational_data(
self,
input: Option<HashMap<String, OpsItemDataValue>>
) -> Self
pub fn set_operational_data(
self,
input: Option<HashMap<String, OpsItemDataValue>>
) -> Self
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, input: impl Into<String>) -> Self
pub fn operational_data_to_delete(self, input: impl Into<String>) -> Self
Appends an item to OperationalDataToDelete
.
To override the contents of this collection use set_operational_data_to_delete
.
Keys that you want to remove from the OperationalData map.
sourcepub fn set_operational_data_to_delete(self, input: Option<Vec<String>>) -> Self
pub fn set_operational_data_to_delete(self, input: Option<Vec<String>>) -> Self
Keys that you want to remove from the OperationalData map.
sourcepub fn notifications(self, input: OpsItemNotification) -> Self
pub fn notifications(self, input: OpsItemNotification) -> Self
Appends an item to Notifications
.
To override the contents of this collection use set_notifications
.
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
sourcepub fn set_notifications(self, input: Option<Vec<OpsItemNotification>>) -> Self
pub fn set_notifications(self, input: Option<Vec<OpsItemNotification>>) -> Self
The Amazon Resource Name (ARN) of an SNS topic where notifications are sent when this OpsItem is edited or changed.
sourcepub fn priority(self, input: i32) -> Self
pub fn priority(self, input: i32) -> Self
The importance of this OpsItem in relation to other OpsItems in the system.
sourcepub fn set_priority(self, input: Option<i32>) -> Self
pub fn set_priority(self, input: Option<i32>) -> Self
The importance of this OpsItem in relation to other OpsItems in the system.
Appends an item to RelatedOpsItems
.
To override the contents of this collection use set_related_ops_items
.
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.
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.
sourcepub fn status(self, input: OpsItemStatus) -> Self
pub fn status(self, input: OpsItemStatus) -> Self
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.
sourcepub fn set_status(self, input: Option<OpsItemStatus>) -> Self
pub fn set_status(self, input: Option<OpsItemStatus>) -> Self
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.
sourcepub fn ops_item_id(self, input: impl Into<String>) -> Self
pub fn ops_item_id(self, input: impl Into<String>) -> Self
The ID of the OpsItem.
sourcepub fn set_ops_item_id(self, input: Option<String>) -> Self
pub fn set_ops_item_id(self, input: Option<String>) -> Self
The ID of the OpsItem.
sourcepub fn title(self, input: impl Into<String>) -> Self
pub fn title(self, input: impl Into<String>) -> Self
A short heading that describes the nature of the OpsItem and the impacted resource.
sourcepub fn set_title(self, input: Option<String>) -> Self
pub fn set_title(self, input: Option<String>) -> Self
A short heading that describes the nature of the OpsItem and the impacted resource.
sourcepub fn set_category(self, input: Option<String>) -> Self
pub fn set_category(self, input: Option<String>) -> Self
Specify a new category for an OpsItem.
sourcepub fn set_severity(self, input: Option<String>) -> Self
pub fn set_severity(self, input: Option<String>) -> Self
Specify a new severity for an OpsItem.
sourcepub fn actual_start_time(self, input: DateTime) -> Self
pub fn actual_start_time(self, input: DateTime) -> Self
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest
.
sourcepub fn set_actual_start_time(self, input: Option<DateTime>) -> Self
pub fn set_actual_start_time(self, input: Option<DateTime>) -> Self
The time a runbook workflow started. Currently reported only for the OpsItem type /aws/changerequest
.
sourcepub fn actual_end_time(self, input: DateTime) -> Self
pub fn actual_end_time(self, input: DateTime) -> Self
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest
.
sourcepub fn set_actual_end_time(self, input: Option<DateTime>) -> Self
pub fn set_actual_end_time(self, input: Option<DateTime>) -> Self
The time a runbook workflow ended. Currently reported only for the OpsItem type /aws/changerequest
.
sourcepub fn planned_start_time(self, input: DateTime) -> Self
pub fn planned_start_time(self, input: DateTime) -> Self
The time specified in a change request for a runbook workflow to start. Currently supported only for the OpsItem type /aws/changerequest
.
sourcepub fn set_planned_start_time(self, input: Option<DateTime>) -> Self
pub fn set_planned_start_time(self, input: Option<DateTime>) -> Self
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, input: DateTime) -> Self
pub fn planned_end_time(self, input: DateTime) -> Self
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest
.
sourcepub fn set_planned_end_time(self, input: Option<DateTime>) -> Self
pub fn set_planned_end_time(self, input: Option<DateTime>) -> Self
The time specified in a change request for a runbook workflow to end. Currently supported only for the OpsItem type /aws/changerequest
.
Trait Implementations
sourceimpl Clone for UpdateOpsItem
impl Clone for UpdateOpsItem
sourcefn clone(&self) -> UpdateOpsItem
fn clone(&self) -> UpdateOpsItem
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for UpdateOpsItem
impl Send for UpdateOpsItem
impl Sync for UpdateOpsItem
impl Unpin for UpdateOpsItem
impl !UnwindSafe for UpdateOpsItem
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more