Struct aws_sdk_ssm::operation::update_ops_item::builders::UpdateOpsItemInputBuilder

#[non_exhaustive]
pub struct UpdateOpsItemInputBuilder { /* private fields */ }

A builder for UpdateOpsItemInput.

Implementations

impl UpdateOpsItemInputBuilder

pub fn description(self, input: impl Into<String>) -> Self

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

pub fn set_description(self, input: Option<String>) -> Self

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

pub fn get_description(&self) -> &Option<String>

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

pub fn operational_data(self, k: impl Into<String>, v: OpsItemDataValue) -> Self

Adds a key-value pair to operational_data.

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.

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.

pub fn get_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, input: impl Into<String>) -> Self

Appends an item to operational_data_to_delete.

To override the contents of this collection use set_operational_data_to_delete.

Keys that you want to remove from the OperationalData map.

pub fn set_operational_data_to_delete(self, input: Option<Vec<String>>) -> Self

Keys that you want to remove from the OperationalData map.

pub fn get_operational_data_to_delete(&self) -> &Option<Vec<String>>

Keys that you want to remove from the OperationalData map.

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.

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.

pub fn get_notifications(&self) -> &Option<Vec<OpsItemNotification>>

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

pub fn priority(self, input: i32) -> Self

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

pub fn set_priority(self, input: Option<i32>) -> Self

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

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

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

pub fn related_ops_items(self, input: RelatedOpsItem) -> Self

Appends an item to related_ops_items.

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.

pub fn set_related_ops_items(self, input: Option<Vec<RelatedOpsItem>>) -> Self

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.

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

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.

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.

pub fn get_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, input: impl Into<String>) -> Self

The ID of the OpsItem.

This field is required.

pub fn set_ops_item_id(self, input: Option<String>) -> Self

The ID of the OpsItem.

pub fn get_ops_item_id(&self) -> &Option<String>

The ID of the OpsItem.

pub fn title(self, input: impl Into<String>) -> Self

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

pub fn set_title(self, input: Option<String>) -> Self

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

pub fn get_title(&self) -> &Option<String>

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

pub fn category(self, input: impl Into<String>) -> Self

Specify a new category for an OpsItem.

pub fn set_category(self, input: Option<String>) -> Self

Specify a new category for an OpsItem.

pub fn get_category(&self) -> &Option<String>

Specify a new category for an OpsItem.

pub fn severity(self, input: impl Into<String>) -> Self

Specify a new severity for an OpsItem.

pub fn set_severity(self, input: Option<String>) -> Self

Specify a new severity for an OpsItem.

pub fn get_severity(&self) -> &Option<String>

Specify a new severity for an OpsItem.

pub fn actual_start_time(self, input: DateTime) -> Self

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

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.

pub fn get_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, input: DateTime) -> Self

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

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.

pub fn get_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, 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.

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.

pub fn get_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, 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.

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.

pub fn get_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, input: impl Into<String>) -> Self

The OpsItem Amazon Resource Name (ARN).

pub fn set_ops_item_arn(self, input: Option<String>) -> Self

The OpsItem Amazon Resource Name (ARN).

pub fn get_ops_item_arn(&self) -> &Option<String>

The OpsItem Amazon Resource Name (ARN).

pub fn build(self) -> Result<UpdateOpsItemInput, BuildError>

Consumes the builder and constructs a UpdateOpsItemInput.

impl UpdateOpsItemInputBuilder

pub async fn send_with( self, client: &Client ) -> Result<UpdateOpsItemOutput, SdkError<UpdateOpsItemError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for UpdateOpsItemInputBuilder

fn clone(&self) -> UpdateOpsItemInputBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateOpsItemInputBuilder

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

Formats the value using the given formatter.

impl Default for UpdateOpsItemInputBuilder

fn default() -> UpdateOpsItemInputBuilder

Returns the “default value” for a type.

impl PartialEq for UpdateOpsItemInputBuilder

fn eq(&self, other: &UpdateOpsItemInputBuilder) -> 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 UpdateOpsItemInputBuilder